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