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