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