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