* import.c (check_and_store): Do a full validation if
[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 @option{--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 will be used as a fallback if for some reason an
309 OCSP request won't succeed.  Note, that you have to allow OCSP
310 requests in Dirmngr's configuration too (option 
311 @option{--allow-ocsp} and configure dirmngr properly.  If you don't do
312 so you will get the error code @samp{Not supported}.
313
314 @end table
315
316 @node Input and Output
317 @subsection Input and Output
318
319 @table @gnupgtabopt
320 @item --armor
321 @itemx -a
322 @opindex armor
323 @opindex -a
324 Create PEM encoded output.  Default is binary output. 
325
326 @item --base64 
327 @opindex base64
328 Create Base-64 encoded output; i.e. PEM without the header lines.
329
330 @item --assume-armor
331 @opindex assume-armor
332 Assume the input data is PEM encoded.  Default is to autodetect the
333 encoding but this is may fail.
334
335 @item --assume-base64
336 @opindex assume-base64
337 Assume the input data is plain base-64 encoded.
338
339 @item --assume-binary
340 @opindex assume-binary
341 Assume the input data is binary encoded.
342
343 @item --local-user @var{user_id}
344 @item -u @var{user_id}
345 @opindex local-user
346 @opindex -u
347 Set the user(s) to be used for signing.  The default is the first
348 secret key found in the database.
349
350 @item --with-key-data
351 @opindex with-key-data
352 Displays extra information with the @code{--list-keys} commands.  Especially
353 a line tagged @code{grp} is printed which tells you the keygrip of a
354 key.  This string is for example used as the file name of the
355 secret key.
356
357 @item --with-validation
358 @opindex with-validation
359 When doing a key listing, do a full validation check for each key and
360 print the result.  This is usually a slow operation because it
361 requires a CRL lookup and other operations. 
362
363 When used along with --import, a validation of the certificate to
364 import is done and only imported if it succeeds the test.  Note that
365 this does not affect an already available cwertificate in the DB.
366 This option is therefore useful to simply verify a certificate.
367
368
369 @item --with-md5-fingerprint
370 For standard key listings, also print the MD5 fingerprint of the
371 certificate.
372
373 @end table
374
375 @node CMS Options
376 @subsection How to change how the CMS is created.
377
378 @table @gnupgtabopt
379 @item --include-certs @var{n}
380 Using @var{n} of -2 includes all certificate except for the root cert,
381 -1 includes all certs, 0 does not include any certs, 1 includes only
382 the signers cert (this is the default) and all other positive
383 values include up to @var{n} certificates starting with the signer cert.
384   
385 @end table
386
387
388
389 @node Esoteric Options
390 @subsection Doing things one usually don't want to do.
391
392
393 @table @gnupgtabopt
394
395 @item --faked-system-time @var{epoch}
396 @opindex faked-system-time
397 This option is only useful for testing; it sets the system time back or
398 forth to @var{epoch} which is the number of seconds elapsed since the year
399 1970.
400
401 @item --with-ephemeral-keys
402 @opindex with-ephemeral-keys
403 Include ephemeral flagged keys in the output of key listings.
404
405 @item --debug-level @var{level}
406 @opindex debug-level
407 Select the debug level for investigating problems. @var{level} may be
408 one of:
409
410    @table @code
411    @item none
412    no debugging at all.
413    @item basic  
414    some basic debug messages
415    @item advanced
416    more verbose debug messages
417    @item expert
418    even more detailed messages
419    @item guru
420    all of the debug messages you can get
421    @end table
422
423 How these messages are mapped to the actual debugging flags is not
424 specified and may change with newer releaes of this program. They are
425 however carefully selected to best aid in debugging.
426
427 @item --debug @var{flags}
428 @opindex debug
429 This option is only useful for debugging and the behaviour may change
430 at any time without notice; using @code{--debug-levels} is the
431 preferred method to select the debug verbosity.  FLAGS are bit encoded
432 and may be given in usual C-Syntax. The currently defined bits are:
433
434    @table @code
435    @item 0  (1)
436    X.509 or OpenPGP protocol related data
437    @item 1  (2)  
438    values of big number integers 
439    @item 2  (4)
440    low level crypto operations
441    @item 5  (32)
442    memory allocation
443    @item 6  (64)
444    caching
445    @item 7  (128)
446    show memory statistics.
447    @item 9  (512)
448    write hashed data to files named @code{dbgmd-000*}
449    @item 10 (1024)
450    trace Assuan protocol
451    @end table
452
453 Note, that all flags set using this option may get overriden by
454 @code{--debug-level}.
455
456 @item --debug-all
457 @opindex debug-all
458 Same as @code{--debug=0xffffffff}
459
460 @item --debug-allow-core-dump
461 @opindex debug-allow-core-dump
462 Usually gpgsm tries to avoid dumping core by well written code and by
463 disabling core dumps for security reasons.  However, bugs are pretty
464 durable beasts and to squash them it is sometimes useful to have a core
465 dump.  This option enables core dumps unless the Bad Thing happened
466 before the option parsing.
467
468 @item --debug-no-chain-validation
469 @opindex debug-no-chain-validation
470 This is actually not a debugging option but only useful as such.  It
471 lets gpgsm bypass all certificate chain validation checks.
472
473 @item --debug-ignore-expiration
474 @opindex debug-ignore-expiration
475 This is actually not a debugging option but only useful as such.  It
476 lets gpgsm ignore all notAfter dates, this is used by the regresssion
477 tests.
478
479 @item --fixed-passphrase @var{string}
480 @opindex fixed-passphrase
481 Supply the passphrase @var{string} to the gpg-protect-tool.  This
482 option is only useful for the regression tests included with this
483 package and may be revised or removed at any time without notice.
484
485 @end table
486
487 All the long options may also be given in the configuration file after
488 stripping off the two leading dashes.
489
490
491
492 @c 
493 @c  Examples
494 @c
495 @node GPGSM Examples
496 @section Examples
497
498 @c man begin EXAMPLES
499
500 @example
501 $ gpgsm -er goo@@bar.net <plaintext >ciphertext
502 @end example
503
504 @c man end
505
506
507
508 @c ---------------------------------
509 @c    The machine interface
510 @c --------------------------------
511 @node Unattended Usage
512 @section Unattended Usage
513
514 @sc{gpgsm} is often used as a backend engine by other software.  To help
515 with this a machine interface has been defined to have an unambiguous
516 way to do this.  This is most likely used with the @code{--server} command
517 but may also be used in the standard operation mode by using the
518 @code{--status-fd} option.
519
520 @menu
521 * Automated signature checking::  Automated signature checking.
522 @end menu
523
524 @node Automated signature checking,,,Unattended Usage
525 @section Automated signature checking
526
527 It is very important to understand the semantics used with signature
528 verification.  Checking a signature is not as simple as it may sound and
529 so the ooperation si a bit complicated.  In mosted cases it is required
530 to look at several status lines.  Here is a table of all cases a signed
531 message may have:
532
533 @table @asis
534 @item The signature is valid
535 This does mean that the signature has been successfully verified, the
536 certificates are all sane.  However there are two subcases with
537 important information:  One of the certificates may have expired or a
538 signature of a message itself as expired.  It is a sound practise to
539 consider such a signature still as valid but additional information
540 should be displayed.  Depending on the subcase @sc{gpgsm} will issue
541 these status codes:
542   @table @asis 
543   @item signature valid and nothing did expire
544   @code{GOODSIG}, @code{VALIDSIG}, @code{TRUST_FULLY}
545   @item signature valid but at least one certificate has expired
546   @code{EXPKEYSIG}, @code{VALIDSIG}, @code{TRUST_FULLY}
547   @item signature valid but expired
548   @code{EXPSIG}, @code{VALIDSIG}, @code{TRUST_FULLY}
549   Note, that this case is currently not implemented.
550   @end table
551
552 @item The signature is invalid
553 This means that the signature verification failed (this is an indication
554 of af a transfer error, a programm error or tampering with the message).
555 @sc{gpgsm} issues one of these status codes sequences:
556   @table @code
557   @item  @code{BADSIG}
558   @item  @code{GOODSIG}, @code{VALIDSIG} @code{TRUST_NEVER}
559   @end table
560
561 @item Error verifying a signature
562 For some reason the signature could not be verified, i.e. it can't be
563 decided whether the signature is valid or invalid.  A common reason for
564 this is a missing certificate.
565
566 @end table
567
568
569 @c 
570 @c  Assuan Protocol
571 @c
572 @node GPGSM Protocol
573 @section The Protocol the Server Mode Uses.
574
575 Description of the protocol used to access GPGSM.  GPGSM does implement
576 the Assuan protocol and in addition provides a regular command line
577 interface which exhibits a full client to this protocol (but uses
578 internal linking).  To start gpgsm as a server the commandline "gpgsm
579 --server" must be used.  Additional options are provided to select the
580 communication method (i.e. the name of the socket).
581
582 We assume that the connection has already been established; see the
583 Assuan manual for details.
584
585 @menu
586 * GPGSM ENCRYPT::         Encrypting a message.
587 * GPGSM DECRYPT::         Decrypting a message.
588 * GPGSM SIGN::            Signing a message.
589 * GPGSM VERIFY::          Verifying a message.
590 * GPGSM GENKEY::          Generating a key.
591 * GPGSM LISTKEYS::        List available keys.
592 * GPGSM EXPORT::          Export certificates.
593 * GPGSM IMPORT::          Import certificates.
594 * GPGSM DELETE::          Delete certificates.
595 @end menu
596
597
598 @node GPGSM ENCRYPT
599 @subsection Encrypting a Message
600
601 Before encrytion can be done the recipient must be set using the
602 command:
603
604 @example
605   RECIPIENT @var{userID}
606 @end example
607
608 Set the recipient for the encryption.  @var{userID} should be the
609 internal representation of the key; the server may accept any other way
610 of specification.  If this is a valid and trusted recipient the server
611 does respond with OK, otherwise the return is an ERR with the reason why
612 the recipient can't be used, the encryption will then not be done for
613 this recipient.  If the policy is not to encrypt at all if not all
614 recipients are valid, the client has to take care of this.  All
615 @code{RECIPIENT} commands are cumulative until a @code{RESET} or an
616 successful @code{ENCRYPT} command.
617
618 @example
619   INPUT FD=@var{n} [--armor|--base64|--binary]
620 @end example
621
622 Set the file descriptor for the message to be encrypted to @var{n}.
623 Obviously the pipe must be open at that point, the server establishes
624 its own end.  If the server returns an error the client should consider
625 this session failed.
626
627 The @code{--armor} option may be used to advice the server that the
628 input data is in @acronym{PEM} format, @code{--base64} advices that a
629 raw base-64 encoding is used, @code{--binary} advices of raw binary
630 input (@acronym{BER}).  If none of these options is used, the server
631 tries to figure out the used encoding, but this may not always be
632 correct.
633
634 @example
635   OUTPUT FD=@var{n} [--armor|--base64]
636 @end example
637
638 Set the file descriptor to be used for the output (i.e. the encrypted
639 message). Obviously the pipe must be open at that point, the server
640 establishes its own end.  If the server returns an error he client
641 should consider this session failed.
642
643 The option armor encodes the output in @acronym{PEM} format, the
644 @code{--base64} option applies just a base 64 encoding.  No option
645 creates binary output (@acronym{BER}).
646   
647 The actual encryption is done using the command
648
649 @example
650   ENCRYPT 
651 @end example
652
653 It takes the plaintext from the @code{INPUT} command, writes to the
654 ciphertext to the file descriptor set with the @code{OUTPUT} command,
655 take the recipients from all the recipients set so far.  If this command
656 fails the clients should try to delete all output currently done or
657 otherwise mark it as invalid.  GPGSM does ensure that there won't be any
658 security problem with leftover data on the output in this case.
659
660 This command should in general not fail, as all necessary checks have
661 been done while setting the recipients.  The input and output pipes are
662 closed.
663
664
665 @node GPGSM DECRYPT
666 @subsection Decrypting a message
667
668 Input and output FDs are set the same way as in encryption, but
669 @code{INPUT} refers to the ciphertext and output to the plaintext. There
670 is no need to set recipients.  GPGSM automatically strips any
671 @acronym{S/MIME} headers from the input, so it is valid to pass an
672 entire MIME part to the INPUT pipe.
673
674 The encryption is done by using the command
675
676 @example
677   DECRYPT
678 @end example
679
680 It performs the decrypt operation after doing some check on the internal
681 state. (e.g. that all needed data has been set).  Because it utilizes
682 the GPG-Agent for the session key decryption, there is no need to ask
683 the client for a protecting passphrase - GpgAgent takes care of this by
684 requesting this from the user.
685
686
687 @node GPGSM SIGN
688 @subsection Signing a Message
689
690 Signing is usually done with these commands:
691
692 @example
693   INPUT FD=@var{n} [--armor|--base64|--binary]
694 @end example
695
696 This tells GPGSM to read the data to sign from file descriptor @var{n}.
697
698 @example
699   OUTPUT FD=@var{m} [--armor|--base64]
700 @end example
701
702 Write the output to file descriptor @var{m}.  If a detached signature is
703 requested, only the signature is written.
704
705 @example
706   SIGN [--detached] 
707 @end example
708
709 Sign the data set with the INPUT command and write it to the sink set by
710 OUTPUT.  With @code{--detached}, a detached signature is created
711 (surprise).
712
713 The key used for signining is the default one or the one specified in
714 the configuration file.  To get finer control over the keys, it is
715 possible to use the command
716
717 @example
718   SIGNER @var{userID}
719 @end example
720
721 to the signer's key.  @var{userID} should be the
722 internal representation of the key; the server may accept any other way
723 of specification.  If this is a valid and trusted recipient the server
724 does respond with OK, otherwise the return is an ERR with the reason why
725 the key can't be used, the signature will then not be created using
726 this key.  If the policy is not to sign at all if not all
727 keys are valid, the client has to take care of this.  All
728 @code{SIGNER} commands are cumulative until a @code{RESET} is done.
729 Note that a @code{SIGN} does not reset this list of signers which is in
730 contrats to the @code{RECIPIENT} command.
731
732
733 @node GPGSM VERIFY
734 @subsection Verifying a Message
735
736 To verify a mesage the command:
737
738 @example
739   VERIFY
740 @end example
741
742 is used. It does a verify operation on the message send to the input FD.
743 The result is written out using status lines.  If an output FD was
744 given, the signed text will be written to that.  If the signature is a
745 detached one, the server will inquire about the signed material and the
746 client must provide it.
747
748 @node GPGSM GENKEY
749 @subsection Generating a Key
750
751 This is used to generate a new keypair, store the secret part in the
752 @acronym{PSE} and the public key in the key database.  We will probably
753 add optional commands to allow the client to select whether a hardware
754 token is used to store the key.  Configuration options to GPGSM can be
755 used to restrict the use of this command.
756
757 @example
758   GENKEY 
759 @end example
760
761 GPGSM checks whether this command is allowed and then does an
762 INQUIRY to get the key parameters, the client should then send the
763 key parameters in the native format:
764
765 @example
766     S: INQUIRE KEY_PARAM native
767     C: D foo:fgfgfg
768     C: D bar
769     C: END
770 @end example    
771
772 Please note that the server may send Status info lines while reading the
773 data lines from the client.  After this the key generation takes place
774 and the server eventually does send an ERR or OK response.  Status lines
775 may be issued as a progress indicator.
776
777
778 @node GPGSM LISTKEYS
779 @subsection List available keys
780
781 To list the keys in the internal database or using an external key
782 provider, the command:
783
784 @example
785   LISTKEYS  @var{pattern}
786 @end example
787
788 is used.  To allow multiple patterns (which are ORed during the search)
789 quoting is required: Spaces are to be translated into "+" or into "%20";
790 in turn this requires that the usual escape quoting rules are done.
791
792 @example
793   LISTSECRETKEYS @var{pattern}
794 @end example
795
796 Lists only the keys where a secret key is available.
797
798 The list commands  commands are affected by the option
799
800 @example
801   OPTION list-mode=@var{mode}
802 @end example
803
804 where mode may be:
805 @table @code
806 @item 0 
807 Use default (which is usually the same as 1).
808 @item 1
809 List only the internal keys.
810 @item 2
811 List only the external keys.
812 @item 3
813 List internal and external keys.
814 @end table
815
816 Note that options are valid for the entire session.
817     
818
819 @node GPGSM EXPORT
820 @subsection Export certificates
821
822 To export certificate from the internal key database the command:
823
824 @example
825   EXPORT @var{pattern}
826 @end example
827
828 is used.  To allow multiple patterns (which are ORed) quoting is
829 required: Spaces are to be translated into "+" or into "%20"; in turn
830 this requires that the usual escape quoting rules are done.
831
832 The format of the output depends on what was set with the OUTPUT
833 command.  When using @acronym{PEM} encoding a few informational lines
834 are prepended.
835
836
837 @node GPGSM IMPORT
838 @subsection Import certificates
839
840 To import certificates into the internal key database, the command
841
842 @example
843   IMPORT
844 @end example
845
846 is used.  The data is expected on the file descriptor set with the
847 @code{INPUT} command.  Certain checks are performend on the
848 certificate.  Note that the code will also handle PKCS\#12 files and
849 import private keys; a helper program is used for that.
850
851
852 @node GPGSM DELETE
853 @subsection Delete certificates
854
855 To delete certificate the command
856
857 @example
858   DELKEYS @var{pattern}
859 @end example
860
861 is used.  To allow multiple patterns (which are ORed) quoting is
862 required: Spaces are to be translated into "+" or into "%20"; in turn
863 this requires that the usual escape quoting rules are done.
864
865 The certificates must be specified unambiguously otherwise an error is
866 returned.
867