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