* sysutils.c (disable_core_dumps): Only set the current limit.
[gnupg.git] / doc / gpgsm.texi
1 @c Copyright (C) 2002 Free Software Foundation, Inc.
2 @c This is part of the GnuPG manual.
3 @c For copying conditions, see the file gnupg.texi.
4
5 @node Invoking GPGSM
6 @chapter Invoking GPGSM
7 @cindex GPGSM command options
8 @cindex command options
9 @cindex options, GPGSM command
10
11 @c man begin DESCRIPTION
12
13 @sc{gpgsm} is a tool similar to @sc{gpg} to provide digital encryption
14 and signing servicesd on X.509 certificates and the CMS protocoll.  It
15 is mainly used as a backend for S/MIME mail processing.  @sc{gpgsm}
16 includes a full features certificate management and complies with all
17 rules defined for the German Sphinx project.
18
19 @c man end
20
21 @xref{Option Index}, for an index to GPGSM's commands and options.
22
23 @menu
24 * GPGSM Commands::        List of all commands.
25 * GPGSM Options::         List of all options.
26 * GPGSM Examples::        Some usage examples.
27
28 Developer information:
29 * Unattended Usage::      Using @sc{gpgsm} from other programs.
30 * GPGSM Protocol::        The protocol the server mode uses.
31 @end menu
32
33 @c man begin COMMANDS
34
35 @node GPGSM Commands
36 @section Commands
37
38 Commands are not distinguished from options execpt for the fact that
39 only one one command is allowed.
40
41 @menu
42 * General Commands::        Commands not specific to the functionality.
43 * Operational Commands::    Commands to select the type of operation.
44 * Certificate Management::  How to manage certificates.
45 @end menu
46
47 @node General Commands
48 @subsection Commands not specific to the function
49
50 @table @gnupgtabopt
51 @item --version
52 @opindex version
53 Print the program version and licensing information.  Not that you can
54 abbreviate this command.
55
56 @item --help, -h
57 @opindex help
58 Print a usage message summarizing the most usefule command-line options.
59 Not that you can abbreviate this command.
60
61 @item --dump-options
62 @opindex dump-options
63 Print a list of all available options and commands.  Not that you can
64 abbreviate this command.
65 @end table
66
67
68
69 @node Operational Commands
70 @subsection Commands to select the type of operation
71
72 @table @gnupgtabopt
73 @item --encrypt
74 @opindex encrypt
75 Perform an encryption.
76
77 @item --decrypt
78 @opindex decrypt
79 Perform a decryption; the type of input is automatically detmerined.  It
80 may either be in binary form or PEM encoded; automatic determination of
81 base-64 encoding is not done.
82
83 @item --sign
84 @opindex sign
85 Create a digital signature.  The key used is either the fist one found
86 in the keybox or thise set with the -u option
87
88 @item --verify
89 @opindex verify
90 Check a signature file for validity.  Depending on the arguments a
91 detached signatrue may also be checked.
92  
93 @item --server
94 @opindex server
95 Run in server mode and wait for commands on the @code{stdin}.
96
97 @item --call-dirmngr @var{command} [@var{args}]
98 @opindex call-dirmngr
99 Behave as a Dirmngr client issuing the request @var{command} with the
100 optional list of @var{args}.  The output of the Dirmngr is printed
101 stdout.  Please note that file names given as arguments should have an
102 absulte file name (i.e. commencing with @code{/} because they are
103 passed verbatim to the Dirmngr and the working directory of the
104 Dirmngr might not be the same as the one of this client.  Currently it
105 is not possible to pass data via stdin to the Dirmngr.  @var{command}
106 should not contain spaces.
107
108 This is command is required for certain maintaining tasks of the dirmngr
109 where a dirmngr must be able to call back to gpgsm.  See the Dirmngr
110 manual for details.
111
112 @item --call-protect-tool @var{arguments}
113 @opindex call-protect-tool
114 Certain maintenance operations are done by an external program call
115 @command{gpg-protect-tool}; this is usually not installed in a directory
116 listed in the PATH variable.  This command provides a simple wrapper to
117 access this tool.  @var{arguments} are passed verbatim to this command;
118 use @samp{--help} to get a list of supported operations. 
119
120
121 @end table
122
123
124 @node Certificate Management
125 @subsection How to manage the certificate and keys
126
127 @table @gnupgtabopt
128 @item --gen-key
129 @opindex gen-key
130 Generate a new key and a certificate request.
131
132 @item --list-keys
133 @itemx -k 
134 @opindex list-keys
135 List all available certificates stored in the local key database.
136
137 @item --list-secret-keys
138 @itemx -K
139 @opindex list-secret-keys
140 List all available certificates for which a corresponding a secret key
141 is available.
142
143 @item --list-external-keys @var{pattern}
144 @opindex list-keys
145 List certificates matching @var{pattern} using an external server.  This
146 utilizes the @code{dirmngr} service.  
147
148 @item --dump-keys
149 @opindex dump-keys
150 List all available certificates stored in the local key database using a
151 format useful mainly for debugging.
152
153 @item --dump-secret-keys
154 @opindex dump-secret-keys
155 List all available certificates for which a corresponding a secret key
156 is available using a format useful mainly for debugging.
157
158 @item --dump-external-keys @var{pattern}
159 @opindex dump-keys
160 List certificates matching @var{pattern} using an external server.
161 This utilizes the @code{dirmngr} service.  It uses a format useful
162 mainly for debugging.
163
164 @item --keydb-clear-some-cert-flags
165 @opindex keydb-clear-some-cert-flags
166 This is a debugging aid to reset certain flags in the key database
167 which are used to cache certain certificate stati.  It is especially
168 useful if a bad CRL or a weird running OCSP reponder did accidently
169 revoke certificate.  There is no security issue with this command
170 because gpgsm always make sure that the validity of a certificate is
171 checked right before it is used.
172
173 @item --delete-keys @var{pattern}
174 @opindex delete-keys
175 Delete the keys matching @var{pattern}.
176
177 @item --export [@var{pattern}]
178 @opindex export
179 Export all certificates stored in the Keybox or those specified by the
180 optional @var{pattern}.  When using along with the @code{--armor} option
181 a few informational lines are prepended before each block.
182
183 @item --export-secret-key-p12 @var{key-id}
184 @opindex export
185 Export the private key and the certificate identified by @var{key-id}
186 in a PKCS#12 format. When using along with the @code{--armor} option
187 a few informational lines are prepended to the output.  Note, that the
188 PKCS#12 format is higly insecure and this command is only provided if
189 there is no other way to exchange the private key.
190
191 @item --learn-card
192 @opindex learn-card
193 Read information about the private keys from the smartcard and import
194 the certificates from there.  This command utilizes the @sc{gpg-agent}
195 and in turn the @sc{scdaemon}.
196
197 @item --passwd @var{user_id}
198 @opindex passwd
199 Change the passphrase of the private key belonging to the certificate
200 specified as @var{user_id}.  Note, that changing the passphrase/PIN of a
201 smartcard is not yet supported.
202
203 @end table
204
205
206 @node GPGSM Options
207 @section Option Summary
208
209 GPGSM comes features a bunch ofoptions to control the exact behaviour
210 and to change the default configuration.
211
212 @menu 
213 * Configuration Options::   How to change the configuration.
214 * Certificate Options::     Certificate related options.
215 * Input and Output::        Input and Output.
216 * CMS Options::             How to change how the CMS is created.
217 * Esoteric Options::        Doing things one usually don't want to do.
218 @end menu
219
220 @c man begin OPTIONS
221
222 @node Configuration Options
223 @subsection How to change the configuration
224
225 These options are used to change the configuraton and are usually found
226 in the option file.
227
228 @table @gnupgtabopt
229
230 @item --options @var{file}
231 @opindex options
232 Reads configuration from @var{file} instead of from the default
233 per-user configuration file.  The default configuration file is named
234 @file{gpgsm.conf} and expected in the @file{.gnupg} directory directly
235 below the home directory of the user.
236
237 @item -v
238 @item --verbose
239 @opindex v
240 @opindex verbose
241 Outputs additional information while running.
242 You can increase the verbosity by giving several
243 verbose commands to @sc{gpgsm}, such as @samp{-vv}.
244
245 @item --policy-file @var{filename}
246 @opindex policy-file
247 Change the default name of the policy file to @var{filename}.
248
249 @item --agent-program @var{file}
250 @opindex agent-program
251 Specify an agent program to be used for secret key operations.  The
252 default value is the @file{/usr/local/bin/gpg-agent}.  This is only used
253 as a fallback when the envrionment variable @code{GPG_AGENT_INFO} is not
254 set or a running agent can't be connected.
255   
256 @item --dirmngr-program @var{file}
257 @opindex dirmnr-program
258 Specify a dirmngr program to be used for @acronym{CRL} checks.  The
259 default value is @file{/usr/sbin/dirmngr}.  This is only used as a
260 fallback when the environment variable @code{DIRMNGR_INFO} is not set or
261 a running dirmngr can't be connected.
262
263 @item --no-secmem-warning
264 @opindex no-secmem-warning
265 Don't print a warning when the so called "secure memory" can't be used.
266
267
268
269 @end table
270
271
272 @node Certificate Options
273 @subsection Certificate related options
274
275 @table @gnupgtabopt
276
277 @item  --enable-policy-checks
278 @itemx --disable-policy-checks
279 @opindex enable-policy-checks
280 @opindex disable-policy-checks
281 By default policy checks are enabled.  These options may be used to
282 change it.
283
284 @item  --enable-crl-checks
285 @itemx --disable-crl-checks
286 @opindex enable-crl-checks
287 @opindex disable-crl-checks
288 By default the @acronym{CRL} checks are enabled and the DirMngr is used
289 to check for revoked certificates.  The disable option is most useful
290 with an off-line network connection to suppress this check.
291
292 @item --force-crl-refresh
293 @opindex force-crl-refresh
294 Tell the dirmngr to reload the CRL for each request.  For better
295 performance, the dirmngr will actually optimize this by suppressing
296 the loading for short time intervalls (e.g. 30 minutes). This option
297 is useful to make sure that a fresh CRL is available for certificates
298 hold in the keybox.  The suggested way of doing this is by using it
299 along with the option @code{--with-validation} for a ke listing
300 command.  This option should not be used in a configuration file. 
301
302 @item  --enable-ocsp
303 @itemx --disable-ocsp
304 @opindex enable-ocsp
305 @opindex disable-ocsp
306 Be default @acronym{OCSP} checks are disabled.  The enable opton may
307 be used to enable OCSP checks via Dirmngr.  If @acronym{CRL} checks
308 are also enabled, CRLs willbe used as a fallback if for some reason an
309 OCSP request won't succeed.
310
311 @end table
312
313 @node Input and Output
314 @subsection Input and Output
315
316 @table @gnupgtabopt
317 @item --armor
318 @itemx -a
319 @opindex armor
320 @opindex -a
321 Create PEM encoded output.  Default is binary output. 
322
323 @item --base64 
324 @opindex base64
325 Create Base-64 encoded output; i.e. PEM without the header lines.
326
327 @item --assume-armor
328 @opindex assume-armor
329 Assume the input data is PEM encoded.  Default is to autodetect the
330 encoding but this is may fail.
331
332 @item --assume-base64
333 @opindex assume-base64
334 Assume the input data is plain base-64 encoded.
335
336 @item --assume-binary
337 @opindex assume-binary
338 Assume the input data is binary encoded.
339
340 @item --local-user @var{user_id}
341 @item -u @var{user_id}
342 @opindex local-user
343 @opindex -u
344 Set the user(s) to be used for signing.  The default is the first
345 secret key found in the database.
346
347 @item --with-key-data
348 @opindex with-key-data
349 Displays extra information with the @code{--list-keys} commands.  Especially
350 a line tagged @code{grp} is printed which tells you the keygrip of a
351 key.  This string is for example used as the file name of the
352 secret key.
353
354 @item --with-validation
355 @opindex with-validation
356 When doing a key listing, do a full validation check for each key and
357 print the result.  This is usually a slow operation because it
358 requires a CRL lookup and other operations.
359
360 @item --with-md5-fingerprint
361 For standard key listings, also print the MD5 fingerprint of the
362 certificate.
363
364 @end table
365
366 @node CMS Options
367 @subsection How to change how the CMS is created.
368
369 @table @gnupgtabopt
370 @item --include-certs @var{n}
371 Using @var{n} of -2 includes all certificate except for the root cert,
372 -1 includes all certs, 0 does not include any certs, 1 includes only
373 the signers cert (this is the default) and all other positive
374 values include up to @var{n} certificates starting with the signer cert.
375   
376 @end table
377
378
379
380 @node Esoteric Options
381 @subsection Doing things one usually don't want todo.
382
383
384 @table @gnupgtabopt
385
386 @item --faked-system-time @var{epoch}
387 @opindex faked-system-time
388 This option is only useful for testing; it sets the system time back or
389 forth to @var{epoch} which is the number of seconds elapsed since the year
390 1970.
391
392 @item --debug-level @var{level}
393 @opindex debug-level
394 Select the debug level for investigating problems. @var{level} may be
395 one of:
396
397    @table @code
398    @item none
399    no debugging at all.
400    @item basic  
401    some basic debug messages
402    @item advanced
403    more verbose debug messages
404    @item expert
405    even more detailed messages
406    @item guru
407    all of the debug messages you can get
408    @end table
409
410 How these messages are mapped to the actual debugging flags is not
411 specified and may change with newer releaes of this program. They are
412 however carefully selected to best aid in debugging.
413
414 @item --debug @var{flags}
415 @opindex debug
416 This option is only useful for debugging and the behaviour may change
417 at any time without notice; using @code{--debug-levels} is the
418 preferred method to select the debug verbosity.  FLAGS are bit encoded
419 and may be given in usual C-Syntax. The currently defined bits are:
420
421    @table @code
422    @item 0  (1)
423    X.509 or OpenPGP protocol related data
424    @item 1  (2)  
425    values of big number integers 
426    @item 2  (4)
427    low level crypto operations
428    @item 5  (32)
429    memory allocation
430    @item 6  (64)
431    caching
432    @item 7  (128)
433    show memory statistics.
434    @item 9  (512)
435    write hashed data to files named @code{dbgmd-000*}
436    @item 10 (1024)
437    trace Assuan protocol
438    @end table
439
440 Note, that all flags set using this option may get overriden by
441 @code{--debug-level}.
442
443 @item --debug-all
444 @opindex debug-all
445 Same as @code{--debug=0xffffffff}
446
447 @item --debug-allow-core-dump
448 @opindex debug-allow-core-dump
449 Usually gpgsm tries to avoid dumping core by well written code and by
450 disabling core dumps for security reasons.  However, bugs are pretty
451 durable beasts and to squash them it is sometimes useful to have a core
452 dump.  This option enables core dumps unless the Bad Thing happened
453 before the option parsing.
454
455 @item --debug-no-chain-validation
456 @opindex debug-no-chain-validation
457 This is actually not a debugging option but only useful as such.  It
458 lets gpgsm bypass all certificate chain validation checks.
459
460 @item --debug-ignore-expiration
461 @opindex debug-ignore-expiration
462 This is actually not a debugging option but only useful as such.  It
463 lets gpgsm ignore all notAfter dates, this is used by the regresssion
464 tests.
465
466 @end table
467
468 All the long options may also be given in the configuration file after
469 stripping off the two leading dashes.
470
471
472
473 @c 
474 @c  Examples
475 @c
476 @node GPGSM Examples
477 @section Examples
478
479 @c man begin EXAMPLES
480
481 @example
482 $ gpgsm -er goo@@bar.net <plaintext >ciphertext
483 @end example
484
485 @c man end
486
487
488
489 @c ---------------------------------
490 @c    The machine interface
491 @c --------------------------------
492 @node Unattended Usage
493 @section Unattended Usage
494
495 @sc{gpgsm} is often used as a backend engine by other software.  To help
496 with this a machine interface has been defined to have an unambiguous
497 way to do this.  This is most likely used with the @code{--server} command
498 but may also be used in the standard operation mode by using the
499 @code{--status-fd} option.
500
501 @menu
502 * Automated signature checking::  Automated signature checking.
503 @end menu
504
505 @node Automated signature checking,,,Unattended Usage
506 @section Automated signature checking
507
508 It is very important to understand the semantics used with signature
509 verification.  Checking a signature is not as simple as it may sound and
510 so the ooperation si a bit complicated.  In mosted cases it is required
511 to look at several status lines.  Here is a table of all cases a signed
512 message may have:
513
514 @table @asis
515 @item The signature is valid
516 This does mean that the signature has been successfully verified, the
517 certificates are all sane.  However there are two subcases with
518 important information:  One of the certificates may have expired or a
519 signature of a message itself as expired.  It is a sound practise to
520 consider such a signature still as valid but additional information
521 should be displayed.  Depending on the subcase @sc{gpgsm} will issue
522 these status codes:
523   @table @asis 
524   @item signature valid and nothing did expire
525   @code{GOODSIG}, @code{VALIDSIG}, @code{TRUST_FULLY}
526   @item signature valid but at least one certificate has expired
527   @code{EXPKEYSIG}, @code{VALIDSIG}, @code{TRUST_FULLY}
528   @item signature valid but expired
529   @code{EXPSIG}, @code{VALIDSIG}, @code{TRUST_FULLY}
530   Note, that this case is currently not implemented.
531   @end table
532
533 @item The signature is invalid
534 This means that the signature verification failed (this is an indication
535 of af a transfer error, a programm error or tampering with the message).
536 @sc{gpgsm} issues one of these status codes sequences:
537   @table @code
538   @item  @code{BADSIG}
539   @item  @code{GOODSIG}, @code{VALIDSIG} @code{TRUST_NEVER}
540   @end table
541
542 @item Error verifying a signature
543 For some reason the signature could not be verified, i.e. it can't be
544 decided whether the signature is valid or invalid.  A common reason for
545 this is a missing certificate.
546
547 @end table
548
549
550 @c 
551 @c  Assuan Protocol
552 @c
553 @node GPGSM Protocol
554 @section The Protocol the Server Mode Uses.
555
556 Description of the protocol used to access GPGSM.  GPGSM does implement
557 the Assuan protocol and in addition provides a regular command line
558 interface which exhibits a full client to this protocol (but uses
559 internal linking).  To start gpgsm as a server the commandline "gpgsm
560 --server" must be used.  Additional options are provided to select the
561 communication method (i.e. the name of the socket).
562
563 We assume that the connection has already been established; see the
564 Assuan manual for details.
565
566 @menu
567 * GPGSM ENCRYPT::         Encrypting a message.
568 * GPGSM DECRYPT::         Decrypting a message.
569 * GPGSM SIGN::            Signing a message.
570 * GPGSM VERIFY::          Verifying a message.
571 * GPGSM GENKEY::          Generating a key.
572 * GPGSM LISTKEYS::        List available keys.
573 * GPGSM EXPORT::          Export certificates.
574 * GPGSM IMPORT::          Import certificates.
575 * GPGSM DELETE::          Delete certificates.
576 @end menu
577
578
579 @node GPGSM ENCRYPT
580 @subsection Encrypting a Message
581
582 Before encrytion can be done the recipient must be set using the
583 command:
584
585 @example
586   RECIPIENT @var{userID}
587 @end example
588
589 Set the recipient for the encryption.  @var{userID} should be the
590 internal representation of the key; the server may accept any other way
591 of specification.  If this is a valid and trusted recipient the server
592 does respond with OK, otherwise the return is an ERR with the reason why
593 the recipient can't be used, the encryption will then not be done for
594 this recipient.  If the policy is not to encrypt at all if not all
595 recipients are valid, the client has to take care of this.  All
596 @code{RECIPIENT} commands are cumulative until a @code{RESET} or an
597 successful @code{ENCRYPT} command.
598
599 @example
600   INPUT FD=@var{n} [--armor|--base64|--binary]
601 @end example
602
603 Set the file descriptor for the message to be encrypted to @var{n}.
604 Obviously the pipe must be open at that point, the server establishes
605 its own end.  If the server returns an error the client should consider
606 this session failed.
607
608 The @code{--armor} option may be used to advice the server that the
609 input data is in @acronym{PEM} format, @code{--base64} advices that a
610 raw base-64 encoding is used, @code{--binary} advices of raw binary
611 input (@acronym{BER}).  If none of these options is used, the server
612 tries to figure out the used encoding, but this may not always be
613 correct.
614
615 @example
616   OUTPUT FD=@var{n} [--armor|--base64]
617 @end example
618
619 Set the file descriptor to be used for the output (i.e. the encrypted
620 message). Obviously the pipe must be open at that point, the server
621 establishes its own end.  If the server returns an error he client
622 should consider this session failed.
623
624 The option armor encodes the output in @acronym{PEM} format, the
625 @code{--base64} option applies just a base 64 encoding.  No option
626 creates binary output (@acronym{BER}).
627   
628 The actual encryption is done using the command
629
630 @example
631   ENCRYPT 
632 @end example
633
634 It takes the plaintext from the @code{INPUT} command, writes to the
635 ciphertext to the file descriptor set with the @code{OUTPUT} command,
636 take the recipients from all the recipients set so far.  If this command
637 fails the clients should try to delete all output currently done or
638 otherwise mark it as invalid.  GPGSM does ensure that there won't be any
639 security problem with leftover data on the output in this case.
640
641 This command should in general not fail, as all necessary checks have
642 been done while setting the recipients.  The input and output pipes are
643 closed.
644
645
646 @node GPGSM DECRYPT
647 @subsection Decrypting a message
648
649 Input and output FDs are set the same way as in encryption, but
650 @code{INPUT} refers to the ciphertext and output to the plaintext. There
651 is no need to set recipients.  GPGSM automatically strips any
652 @acronym{S/MIME} headers from the input, so it is valid to pass an
653 entire MIME part to the INPUT pipe.
654
655 The encryption is done by using the command
656
657 @example
658   DECRYPT
659 @end example
660
661 It performs the decrypt operation after doing some check on the internal
662 state. (e.g. that all needed data has been set).  Because it utilizes
663 the GPG-Agent for the session key decryption, there is no need to ask
664 the client for a protecting passphrase - GpgAgent takes care of this by
665 requesting this from the user.
666
667
668 @node GPGSM SIGN
669 @subsection Signing a Message
670
671 Signing is usually done with these commands:
672
673 @example
674   INPUT FD=@var{n} [--armor|--base64|--binary]
675 @end example
676
677 This tells GPGSM to read the data to sign from file descriptor @var{n}.
678
679 @example
680   OUTPUT FD=@var{m} [--armor|--base64]
681 @end example
682
683 Write the output to file descriptor @var{m}.  If a detached signature is
684 requested, only the signature is written.
685
686 @example
687   SIGN [--detached] 
688 @end example
689
690 Sign the data set with the INPUT command and write it to the sink set by
691 OUTPUT.  With @code{--detached}, a detached signature is created
692 (surprise).
693
694 The key used for signining is the default one or the one specified in
695 the configuration file.  To get finer control over the keys, it is
696 possible to use the command
697
698 @example
699   SIGNER @var{userID}
700 @end example
701
702 to the signer's key.  @var{userID} should be the
703 internal representation of the key; the server may accept any other way
704 of specification.  If this is a valid and trusted recipient the server
705 does respond with OK, otherwise the return is an ERR with the reason why
706 the key can't be used, the signature will then not be created using
707 this key.  If the policy is not to sign at all if not all
708 keys are valid, the client has to take care of this.  All
709 @code{SIGNER} commands are cumulative until a @code{RESET} is done.
710 Note that a @code{SIGN} does not reset this list of signers which is in
711 contrats to the @code{RECIPIENT} command.
712
713
714 @node GPGSM VERIFY
715 @subsection Verifying a Message
716
717 To verify a mesage the command:
718
719 @example
720   VERIFY
721 @end example
722
723 is used. It does a verify operation on the message send to the input FD.
724 The result is written out using status lines.  If an output FD was
725 given, the signed text will be written to that.  If the signature is a
726 detached one, the server will inquire about the signed material and the
727 client must provide it.
728
729 @node GPGSM GENKEY
730 @subsection Generating a Key
731
732 This is used to generate a new keypair, store the secret part in the
733 @acronym{PSE} and the public key in the key database.  We will probably
734 add optional commands to allow the client to select whether a hardware
735 token is used to store the key.  Configuration options to GPGSM can be
736 used to restrict the use of this command.
737
738 @example
739   GENKEY 
740 @end example
741
742 GPGSM checks whether this command is allowed and then does an
743 INQUIRY to get the key parameters, the client should then send the
744 key parameters in the native format:
745
746 @example
747     S: INQUIRE KEY_PARAM native
748     C: D foo:fgfgfg
749     C: D bar
750     C: END
751 @end example    
752
753 Please note that the server may send Status info lines while reading the
754 data lines from the client.  After this the key generation takes place
755 and the server eventually does send an ERR or OK response.  Status lines
756 may be issued as a progress indicator.
757
758
759 @node GPGSM LISTKEYS
760 @subsection List available keys
761
762 To list the keys in the internal database or using an external key
763 provider, the command:
764
765 @example
766   LISTKEYS  @var{pattern}
767 @end example
768
769 is used.  To allow multiple patterns (which are ORed during the search)
770 quoting is required: Spaces are to be translated into "+" or into "%20";
771 in turn this requires that the usual escape quoting rules are done.
772
773 @example
774   LISTSECRETKEYS @var{pattern}
775 @end example
776
777 Lists only the keys where a secret key is available.
778
779 The list commands  commands are affected by the option
780
781 @example
782   OPTION list-mode=@var{mode}
783 @end example
784
785 where mode may be:
786 @table @code
787 @item 0 
788 Use default (which is usually the same as 1).
789 @item 1
790 List only the internal keys.
791 @item 2
792 List only the external keys.
793 @item 3
794 List internal and external keys.
795 @end table
796
797 Note that options are valid for the entire session.
798     
799
800 @node GPGSM EXPORT
801 @subsection Export certificates
802
803 To export certificate from the internal key database the command:
804
805 @example
806   EXPORT @var{pattern}
807 @end example
808
809 is used.  To allow multiple patterns (which are ORed) quoting is
810 required: Spaces are to be translated into "+" or into "%20"; in turn
811 this requires that the usual escape quoting rules are done.
812
813 The format of the output depends on what was set with the OUTPUT
814 command.  When using @acronym{PEM} encoding a few informational lines
815 are prepended.
816
817
818 @node GPGSM IMPORT
819 @subsection Import certificates
820
821 To import certificates into the internal key database, the command
822
823 @example
824   IMPORT
825 @end example
826
827 is used.  The data is expected on the file descriptor set with the
828 @code{INPUT} command.  Certain checks are performend on the
829 certificate.  Note that the code will also handle PKCS\#12 files and
830 import private keys; a helper program is used for that.
831
832
833 @node GPGSM DELETE
834 @subsection Delete certificates
835
836 To delete certificate the command
837
838 @example
839   DELKEYS @var{pattern}
840 @end example
841
842 is used.  To allow multiple patterns (which are ORed) quoting is
843 required: Spaces are to be translated into "+" or into "%20"; in turn
844 this requires that the usual escape quoting rules are done.
845
846 The certificates must be specified unambiguously otherwise an error is
847 returned.
848