More man pages. Added include files for 2 common paragraphs.
[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 @manpage gpgsm.1
12 @ifset manverb
13 .B gpgsm
14 \- CMS encryption and signing tool
15 @end ifset
16
17 @mansect synopsis
18 @ifset manverb
19 .B  gpgsm
20 .RB [ \-\-homedir
21 .IR dir ]
22 .RB [ \-\-options
23 .IR file ]
24 .RI [ options ]  
25 .I command
26 .RI [ args ]
27 @end ifset
28
29
30 @mansect description
31 @command{gpgsm} is a tool similar to @command{gpg} to provide digital
32 encryption and signing servicesd on X.509 certificates and the CMS
33 protocol.  It is mainly used as a backend for S/MIME mail processing.
34 @command{gpgsm} includes a full features certificate management and
35 complies with all rules defined for the German Sphinx project.
36
37 @manpause
38 @xref{Option Index}, for an index to @command{GPGSM}'s commands and options.
39 @mancont
40
41 @menu
42 * GPGSM Commands::        List of all commands.
43 * GPGSM Options::         List of all options.
44 * GPGSM Configuration::   Configuration files.
45 * GPGSM Examples::        Some usage examples.
46
47 Developer information:
48 * Unattended Usage::      Using @command{gpgsm} from other programs.
49 * GPGSM Protocol::        The protocol the server mode uses.
50 @end menu
51
52 @c *******************************************
53 @c ***************            ****************
54 @c ***************  COMMANDS  ****************
55 @c ***************            ****************
56 @c *******************************************
57 @mansect commands
58 @node GPGSM Commands
59 @section Commands
60
61 Commands are not distinguished from options execpt for the fact that
62 only one command is allowed.
63
64 @menu
65 * General GPGSM Commands::        Commands not specific to the functionality.
66 * Operational GPGSM Commands::    Commands to select the type of operation.
67 * Certificate Management::        How to manage certificates.
68 @end menu
69
70
71 @c *******************************************
72 @c **********  GENERAL COMMANDS  *************
73 @c *******************************************
74 @node General GPGSM Commands
75 @subsection Commands not specific to the function
76
77 @table @gnupgtabopt
78 @item --version
79 @opindex version
80 Print the program version and licensing information.  Not that you can
81 abbreviate this command.
82
83 @item --help, -h
84 @opindex help
85 Print a usage message summarizing the most usefule command-line options.
86 Not that you can abbreviate this command.
87
88 @item --warranty
89 @opindex warranty
90 Print warranty information.
91
92 @item --dump-options
93 @opindex dump-options
94 Print a list of all available options and commands.  Not that you can
95 abbreviate this command.
96 @end table
97
98
99 @c *******************************************
100 @c ********  OPERATIONAL COMMANDS  ***********
101 @c *******************************************
102 @node Operational GPGSM Commands
103 @subsection Commands to select the type of operation
104
105 @table @gnupgtabopt
106 @item --encrypt
107 @opindex encrypt
108 Perform an encryption.
109
110 @item --decrypt
111 @opindex decrypt
112 Perform a decryption; the type of input is automatically detmerined.  It
113 may either be in binary form or PEM encoded; automatic determination of
114 base-64 encoding is not done.
115
116 @item --sign
117 @opindex sign
118 Create a digital signature.  The key used is either the fist one found
119 in the keybox or thise set with the -u option
120
121 @item --verify
122 @opindex verify
123 Check a signature file for validity.  Depending on the arguments a
124 detached signatrue may also be checked.
125  
126 @item --server
127 @opindex server
128 Run in server mode and wait for commands on the @code{stdin}.
129
130 @item --call-dirmngr @var{command} [@var{args}]
131 @opindex call-dirmngr
132 Behave as a Dirmngr client issuing the request @var{command} with the
133 optional list of @var{args}.  The output of the Dirmngr is printed
134 stdout.  Please note that file names given as arguments should have an
135 absulte file name (i.e. commencing with @code{/} because they are
136 passed verbatim to the Dirmngr and the working directory of the
137 Dirmngr might not be the same as the one of this client.  Currently it
138 is not possible to pass data via stdin to the Dirmngr.  @var{command}
139 should not contain spaces.
140
141 This is command is required for certain maintaining tasks of the dirmngr
142 where a dirmngr must be able to call back to @command{gpgsm}.  See the Dirmngr
143 manual for details.
144
145 @item --call-protect-tool @var{arguments}
146 @opindex call-protect-tool
147 Certain maintenance operations are done by an external program call
148 @command{gpg-protect-tool}; this is usually not installed in a directory
149 listed in the PATH variable.  This command provides a simple wrapper to
150 access this tool.  @var{arguments} are passed verbatim to this command;
151 use @samp{--help} to get a list of supported operations. 
152
153
154 @end table
155
156
157 @c *******************************************
158 @c *******  CERTIFICATE MANAGEMENT  **********
159 @c *******************************************
160 @node Certificate Management
161 @subsection How to manage the certificates and keys
162
163 @table @gnupgtabopt
164 @item --gen-key
165 @opindex gen-key
166 Generate a new key and a certificate request.
167
168 @item --list-keys
169 @itemx -k 
170 @opindex list-keys
171 List all available certificates stored in the local key database.
172 Note that the displayed data might be reformatted for better human
173 readability and illegal characters are replaced by safe substitutes.
174
175 @item --list-secret-keys
176 @itemx -K
177 @opindex list-secret-keys
178 List all available certificates for which a corresponding a secret key
179 is available.
180
181 @item --list-external-keys @var{pattern}
182 @opindex list-keys
183 List certificates matching @var{pattern} using an external server.  This
184 utilizes the @code{dirmngr} service.  
185
186 @item --dump-keys
187 @opindex dump-keys
188 List all available certificates stored in the local key database using a
189 format useful mainly for debugging.
190
191 @item --dump-secret-keys
192 @opindex dump-secret-keys
193 List all available certificates for which a corresponding a secret key
194 is available using a format useful mainly for debugging.
195
196 @item --dump-external-keys @var{pattern}
197 @opindex dump-external-keys
198 List certificates matching @var{pattern} using an external server.
199 This utilizes the @code{dirmngr} service.  It uses a format useful
200 mainly for debugging.
201
202 @item --keydb-clear-some-cert-flags
203 @opindex keydb-clear-some-cert-flags
204 This is a debugging aid to reset certain flags in the key database
205 which are used to cache certain certificate stati.  It is especially
206 useful if a bad CRL or a weird running OCSP reponder did accidently
207 revoke certificate.  There is no security issue with this command
208 because @command{gpgsm} always make sure that the validity of a certificate is
209 checked right before it is used.
210
211 @item --delete-keys @var{pattern}
212 @opindex delete-keys
213 Delete the keys matching @var{pattern}.
214
215 @item --export [@var{pattern}]
216 @opindex export
217 Export all certificates stored in the Keybox or those specified by the
218 optional @var{pattern}.  When using along with the @code{--armor} option
219 a few informational lines are prepended before each block.
220
221 @item --export-secret-key-p12 @var{key-id}
222 @opindex export
223 Export the private key and the certificate identified by @var{key-id}
224 in a PKCS#12 format. When using along with the @code{--armor} option
225 a few informational lines are prepended to the output.  Note, that the
226 PKCS#12 format is higly insecure and this command is only provided if
227 there is no other way to exchange the private key.
228
229 @item --import [@var{files}]
230 @opindex import
231 Import the certificates from the PEM or binary encoded files as well as
232 from signed-only messages.  This command may also be used to import a
233 secret key from a PKCS#12 file.
234
235 @item --learn-card
236 @opindex learn-card
237 Read information about the private keys from the smartcard and import
238 the certificates from there.  This command utilizes the @command{gpg-agent}
239 and in turn the @command{scdaemon}.
240
241 @item --passwd @var{user_id}
242 @opindex passwd
243 Change the passphrase of the private key belonging to the certificate
244 specified as @var{user_id}.  Note, that changing the passphrase/PIN of a
245 smartcard is not yet supported.
246
247 @end table
248
249
250 @c *******************************************
251 @c ***************            ****************
252 @c ***************  OPTIONS   ****************
253 @c ***************            ****************
254 @c *******************************************
255 @mansect options
256 @node GPGSM Options
257 @section Option Summary
258
259 @command{GPGSM} comes features a bunch ofoptions to control the exact behaviour
260 and to change the default configuration.
261
262 @menu 
263 * Configuration Options::   How to change the configuration.
264 * Certificate Options::     Certificate related options.
265 * Input and Output::        Input and Output.
266 * CMS Options::             How to change how the CMS is created.
267 * Esoteric Options::        Doing things one usually don't want to do.
268 @end menu
269
270
271 @c *******************************************
272 @c ********  CONFIGURATION OPTIONS  **********
273 @c *******************************************
274 @node Configuration Options
275 @subsection How to change the configuration
276
277 These options are used to change the configuraton and are usually found
278 in the option file.
279
280 @table @gnupgtabopt
281
282 @item --options @var{file}
283 @opindex options
284 Reads configuration from @var{file} instead of from the default
285 per-user configuration file.  The default configuration file is named
286 @file{gpgsm.conf} and expected in the @file{.gnupg} directory directly
287 below the home directory of the user.
288
289 @include opt-homedir.texi
290
291
292 @item -v
293 @item --verbose
294 @opindex v
295 @opindex verbose
296 Outputs additional information while running.
297 You can increase the verbosity by giving several
298 verbose commands to @command{gpgsm}, such as @samp{-vv}.
299
300 @item --policy-file @var{filename}
301 @opindex policy-file
302 Change the default name of the policy file to @var{filename}.
303
304 @item --agent-program @var{file}
305 @opindex agent-program
306 Specify an agent program to be used for secret key operations.  The
307 default value is the @file{/usr/local/bin/gpg-agent}.  This is only used
308 as a fallback when the envrionment variable @code{GPG_AGENT_INFO} is not
309 set or a running agent can't be connected.
310   
311 @item --dirmngr-program @var{file}
312 @opindex dirmnr-program
313 Specify a dirmngr program to be used for @acronym{CRL} checks.  The
314 default value is @file{/usr/sbin/dirmngr}.  This is only used as a
315 fallback when the environment variable @code{DIRMNGR_INFO} is not set or
316 a running dirmngr can't be connected.
317
318 @item --prefer-system-dirmngr
319 @opindex prefer-system-dirmngr
320 If a system wide @command{dirmngr} is running in daemon mode, first try
321 to connect to this one.  Fallback to a pipe based server if this does
322 not work.
323
324 @item --no-secmem-warning
325 @opindex no-secmem-warning
326 Don't print a warning when the so called "secure memory" can't be used.
327
328 @item --log-file @var{file}
329 @opindex log-file
330 When running in server mode, append all logging output to @var{file}.
331
332 @end table
333
334
335 @c *******************************************
336 @c ********  CERTIFICATE OPTIONS  ************
337 @c *******************************************
338 @node Certificate Options
339 @subsection Certificate related options
340
341 @table @gnupgtabopt
342
343 @item  --enable-policy-checks
344 @itemx --disable-policy-checks
345 @opindex enable-policy-checks
346 @opindex disable-policy-checks
347 By default policy checks are enabled.  These options may be used to
348 change it.
349
350 @item  --enable-crl-checks
351 @itemx --disable-crl-checks
352 @opindex enable-crl-checks
353 @opindex disable-crl-checks
354 By default the @acronym{CRL} checks are enabled and the DirMngr is used
355 to check for revoked certificates.  The disable option is most useful
356 with an off-line network connection to suppress this check.
357
358 @item  --enable-trusted-cert-crl-check
359 @itemx --disable-trusted-cert-crl-check
360 @opindex enable-trusted-cert-crl-check
361 @opindex disable-trusted-cert-crl-check
362 By default the @acronym{CRL} for trusted root certificates are checked
363 like for any other certificates.  This allows a CA to revoke its own
364 certificates voluntary without the need of putting all ever issued
365 certificates into a CRL.  The disable option may be used to switch this
366 extra check off.  Due to the caching done by the Dirmngr, there won't be
367 any noticeable performance gain.  Note, that this also disables possible
368 OCSP checks for trusted root certificates.
369
370 @item --force-crl-refresh
371 @opindex force-crl-refresh
372 Tell the dirmngr to reload the CRL for each request.  For better
373 performance, the dirmngr will actually optimize this by suppressing
374 the loading for short time intervalls (e.g. 30 minutes). This option
375 is useful to make sure that a fresh CRL is available for certificates
376 hold in the keybox.  The suggested way of doing this is by using it
377 along with the option @option{--with-validation} for a key listing
378 command.  This option should not be used in a configuration file. 
379
380 @item  --enable-ocsp
381 @itemx --disable-ocsp
382 @opindex enable-ocsp
383 @opindex disable-ocsp
384 Be default @acronym{OCSP} checks are disabled.  The enable opton may
385 be used to enable OCSP checks via Dirmngr.  If @acronym{CRL} checks
386 are also enabled, CRLs will be used as a fallback if for some reason an
387 OCSP request won't succeed.  Note, that you have to allow OCSP
388 requests in Dirmngr's configuration too (option 
389 @option{--allow-ocsp} and configure dirmngr properly.  If you don't do
390 so you will get the error code @samp{Not supported}.
391
392 @end table
393
394 @c *******************************************
395 @c ***********  INPUT AND OUTPUT  ************
396 @c *******************************************
397 @node Input and Output
398 @subsection Input and Output
399
400 @table @gnupgtabopt
401 @item --armor
402 @itemx -a
403 @opindex armor
404 @opindex -a
405 Create PEM encoded output.  Default is binary output. 
406
407 @item --base64 
408 @opindex base64
409 Create Base-64 encoded output; i.e. PEM without the header lines.
410
411 @item --assume-armor
412 @opindex assume-armor
413 Assume the input data is PEM encoded.  Default is to autodetect the
414 encoding but this is may fail.
415
416 @item --assume-base64
417 @opindex assume-base64
418 Assume the input data is plain base-64 encoded.
419
420 @item --assume-binary
421 @opindex assume-binary
422 Assume the input data is binary encoded.
423
424 @item --local-user @var{user_id}
425 @item -u @var{user_id}
426 @opindex local-user
427 @opindex -u
428 Set the user(s) to be used for signing.  The default is the first
429 secret key found in the database.
430
431 @item --with-key-data
432 @opindex with-key-data
433 Displays extra information with the @code{--list-keys} commands.  Especially
434 a line tagged @code{grp} is printed which tells you the keygrip of a
435 key.  This string is for example used as the file name of the
436 secret key.
437
438 @item --with-validation
439 @opindex with-validation
440 When doing a key listing, do a full validation check for each key and
441 print the result.  This is usually a slow operation because it
442 requires a CRL lookup and other operations. 
443
444 When used along with --import, a validation of the certificate to
445 import is done and only imported if it succeeds the test.  Note that
446 this does not affect an already available cwertificate in the DB.
447 This option is therefore useful to simply verify a certificate.
448
449
450 @item --with-md5-fingerprint
451 For standard key listings, also print the MD5 fingerprint of the
452 certificate.
453
454 @end table
455
456 @c *******************************************
457 @c *************  CMS OPTIONS  ***************
458 @c *******************************************
459 @node CMS Options
460 @subsection How to change how the CMS is created.
461
462 @table @gnupgtabopt
463 @item --include-certs @var{n}
464 Using @var{n} of -2 includes all certificate except for the root cert,
465 -1 includes all certs, 0 does not include any certs, 1 includes only
466 the signers cert (this is the default) and all other positive
467 values include up to @var{n} certificates starting with the signer cert.
468   
469 @end table
470
471
472
473 @c *******************************************
474 @c ********  ESOTERIC OPTIONS  ***************
475 @c *******************************************
476 @node Esoteric Options
477 @subsection Doing things one usually don't want to do.
478
479
480 @table @gnupgtabopt
481
482 @item --faked-system-time @var{epoch}
483 @opindex faked-system-time
484 This option is only useful for testing; it sets the system time back or
485 forth to @var{epoch} which is the number of seconds elapsed since the year
486 1970.
487
488 @item --with-ephemeral-keys
489 @opindex with-ephemeral-keys
490 Include ephemeral flagged keys in the output of key listings.
491
492 @item --debug-level @var{level}
493 @opindex debug-level
494 Select the debug level for investigating problems. @var{level} may be
495 one of:
496
497    @table @code
498    @item none
499    no debugging at all.
500    @item basic  
501    some basic debug messages
502    @item advanced
503    more verbose debug messages
504    @item expert
505    even more detailed messages
506    @item guru
507    all of the debug messages you can get
508    @end table
509
510 How these messages are mapped to the actual debugging flags is not
511 specified and may change with newer releaes of this program. They are
512 however carefully selected to best aid in debugging.
513
514 @item --debug @var{flags}
515 @opindex debug
516 This option is only useful for debugging and the behaviour may change
517 at any time without notice; using @code{--debug-levels} is the
518 preferred method to select the debug verbosity.  FLAGS are bit encoded
519 and may be given in usual C-Syntax. The currently defined bits are:
520
521    @table @code
522    @item 0  (1)
523    X.509 or OpenPGP protocol related data
524    @item 1  (2)  
525    values of big number integers 
526    @item 2  (4)
527    low level crypto operations
528    @item 5  (32)
529    memory allocation
530    @item 6  (64)
531    caching
532    @item 7  (128)
533    show memory statistics.
534    @item 9  (512)
535    write hashed data to files named @code{dbgmd-000*}
536    @item 10 (1024)
537    trace Assuan protocol
538    @end table
539
540 Note, that all flags set using this option may get overriden by
541 @code{--debug-level}.
542
543 @item --debug-all
544 @opindex debug-all
545 Same as @code{--debug=0xffffffff}
546
547 @item --debug-allow-core-dump
548 @opindex debug-allow-core-dump
549 Usually @command{gpgsm} tries to avoid dumping core by well written code and by
550 disabling core dumps for security reasons.  However, bugs are pretty
551 durable beasts and to squash them it is sometimes useful to have a core
552 dump.  This option enables core dumps unless the Bad Thing happened
553 before the option parsing.
554
555 @item --debug-no-chain-validation
556 @opindex debug-no-chain-validation
557 This is actually not a debugging option but only useful as such.  It
558 lets @command{gpgsm} bypass all certificate chain validation checks.
559
560 @item --debug-ignore-expiration
561 @opindex debug-ignore-expiration
562 This is actually not a debugging option but only useful as such.  It
563 lets @command{gpgsm} ignore all notAfter dates, this is used by the regresssion
564 tests.
565
566 @item --fixed-passphrase @var{string}
567 @opindex fixed-passphrase
568 Supply the passphrase @var{string} to the gpg-protect-tool.  This
569 option is only useful for the regression tests included with this
570 package and may be revised or removed at any time without notice.
571
572 @end table
573
574 All the long options may also be given in the configuration file after
575 stripping off the two leading dashes.
576
577
578 @c *******************************************
579 @c ***************            ****************
580 @c ***************   FILES    ****************
581 @c ***************            ****************
582 @c *******************************************
583 @mansect files
584 @node GPGSM Configuration
585 @section Configuration files
586
587 There are a few configuration files to control certain aspects of
588 @command{gpgsm}'s operation. Unless noted, they are expected in the
589 current home directory (@pxref{option --homedir}).
590
591 @table @file
592
593 @item gpgsm.conf
594 @cindex gpgsm.conf
595 This is the standard configuration file read by @command{gpgsm} on
596 startup.  It may contain any valid long option; the leading two dashes
597 may not be entered and the option may not be abbreviated.  This default
598 name may be changed on the command line (@pxref{option
599   --options}).
600
601 @item policies.txt
602 @cindex policies.txt
603 This is a list of allowed CA policies.  This file should list the
604 object identifiers of the policies line by line.  Empty lines and
605 lines starting with a hash mark are ignored.  Policies missing in this
606 file and not marked as critical in the certificate will print only a
607 warning; certificates with policies marked as critical and not listed
608 in this file will fail the signature verification.
609
610 For example, to allow only the policy 2.289.9.9, the file should look
611 like this:
612
613 @c man:.RS
614 @example
615 # Allowed policies
616 2.289.9.9  
617 @end example
618 @c man:.RE
619
620 @item qualified.txt
621 @cindex qualified.txt
622 This is the list of root certificates used for qualified certificates.
623 They are defined as certificates capable of creating legally binding
624 signatures in the same way as handwritten signatures are.  Comments
625 start with a hash mark and empty lines are ignored.  Lines do have a
626 length limit but this is not a serious limitation as the format of the
627 entries is fixed and checked by gpgsm: A non-comment line starts with
628 optional white spaces, followed by exactly 40 hex character, white space
629 and a lowercased 2 letter country code.  Additional data delimited with
630 by a white space is current ignored but might late be used for other
631 purposes.
632
633 Note that even if a certificate is listed in this file, this does not
634 mean that thecertificate is trusted; in general the certificates listed
635 in this file need to be listed also in @file{trustlist.txt}.
636
637 This is a global file an installed in the data directory
638 (e.g. @file{/usr/share/gnupg/qualified.txt}).  GnuPG installs a suitable
639 file with root certificates as used in Germany.  As new Root-CA
640 certificates may be issued over time, these entries may need to be
641 updated; new distributions of this software should come with an updated
642 list but it is still the responsibility of the Administrator to check
643 that this list is correct.
644
645 Everytime @command{gpgsm} uses a certificate for signing or verification
646 this file will be consulted to check whether the certificate under
647 question has ultimately been issued by one of these CAs.  If this is the
648 case the user will be informed that the verified signature represents a
649 legally binding (``qualified'') signature.  When creating a signature
650 using such a certificate an extra prompt will be issued to let the user
651 confirm that such a legally binding signature shall really be created.
652
653 Because this software has not yet been approved for use with such
654 certificates, appropriate notices will be shown to indicate this fact.
655
656 @end table
657
658 @c man:.RE
659 Note that on larger installations, it is useful to put predefined files
660 into the directory @file{/etc/skel/.gnupg/} so that newly created users
661 start up with a working configuration.  For existing users the a small
662 helper script is provided to create these files (@pxref{addgnupghome}).
663
664 For internal purposes gpgsm creates and maintaines a few other files;
665 They all live in in the current home directory (@pxref{option
666 --homedir}).  Only @command{gpgsm} may modify these files.
667
668
669 @table @file
670 @item pubring.kbx
671 @cindex pubring.kbx
672 This a database file storing the certificates as well as meta
673 information.  For debugging purposes the tool @command{kbxutil} may be
674 used to show the internal structure of this file.
675       
676 @item random_seed
677 @cindex random_seed
678 This content of this file is used to maintain the internal state of the
679 random number generator accross invocations.  The same file is used by
680 other programs of this software too.
681
682 @end table
683
684
685 @c *******************************************
686 @c ***************            ****************
687 @c ***************  EXAMPLES  ****************
688 @c ***************            ****************
689 @c *******************************************
690 @mansect examples
691 @node GPGSM Examples
692 @section Examples
693
694 @example
695 $ gpgsm -er goo@@bar.net <plaintext >ciphertext
696 @end example
697
698
699 @c man end
700
701
702 @c *******************************************
703 @c ***************              **************
704 @c ***************  UNATTENDED  **************
705 @c ***************              **************
706 @c *******************************************
707 @node Unattended Usage
708 @section Unattended Usage
709
710 @command{gpgsm} is often used as a backend engine by other software.  To help
711 with this a machine interface has been defined to have an unambiguous
712 way to do this.  This is most likely used with the @code{--server} command
713 but may also be used in the standard operation mode by using the
714 @code{--status-fd} option.
715
716 @menu
717 * Automated signature checking::  Automated signature checking.
718 @end menu
719
720 @node Automated signature checking,,,Unattended Usage
721 @section Automated signature checking
722
723 It is very important to understand the semantics used with signature
724 verification.  Checking a signature is not as simple as it may sound and
725 so the ooperation si a bit complicated.  In mosted cases it is required
726 to look at several status lines.  Here is a table of all cases a signed
727 message may have:
728
729 @table @asis
730 @item The signature is valid
731 This does mean that the signature has been successfully verified, the
732 certificates are all sane.  However there are two subcases with
733 important information:  One of the certificates may have expired or a
734 signature of a message itself as expired.  It is a sound practise to
735 consider such a signature still as valid but additional information
736 should be displayed.  Depending on the subcase @command{gpgsm} will issue
737 these status codes:
738   @table @asis 
739   @item signature valid and nothing did expire
740   @code{GOODSIG}, @code{VALIDSIG}, @code{TRUST_FULLY}
741   @item signature valid but at least one certificate has expired
742   @code{EXPKEYSIG}, @code{VALIDSIG}, @code{TRUST_FULLY}
743   @item signature valid but expired
744   @code{EXPSIG}, @code{VALIDSIG}, @code{TRUST_FULLY}
745   Note, that this case is currently not implemented.
746   @end table
747
748 @item The signature is invalid
749 This means that the signature verification failed (this is an indication
750 of af a transfer error, a programm error or tampering with the message).
751 @command{gpgsm} issues one of these status codes sequences:
752   @table @code
753   @item  @code{BADSIG}
754   @item  @code{GOODSIG}, @code{VALIDSIG} @code{TRUST_NEVER}
755   @end table
756
757 @item Error verifying a signature
758 For some reason the signature could not be verified, i.e. it can't be
759 decided whether the signature is valid or invalid.  A common reason for
760 this is a missing certificate.
761
762 @end table
763
764
765 @c *******************************************
766 @c ***************           *****************
767 @c ***************  ASSSUAN  *****************
768 @c ***************           *****************
769 @c *******************************************
770 @mansect assuan
771 @node GPGSM Protocol
772 @section The Protocol the Server Mode Uses.
773
774 Description of the protocol used to access @command{GPGSM}.
775 @command{GPGSM} does implement the Assuan protocol and in addition
776 provides a regular command line interface which exhibits a full client
777 to this protocol (but uses internal linking).  To start
778 @command{gpgsm} as a server the command line the option
779 @code{--server} must be used.  Additional options are provided to
780 select the communication method (i.e. the name of the socket).
781
782 We assume that the connection has already been established; see the
783 Assuan manual for details.
784
785 @menu
786 * GPGSM ENCRYPT::         Encrypting a message.
787 * GPGSM DECRYPT::         Decrypting a message.
788 * GPGSM SIGN::            Signing a message.
789 * GPGSM VERIFY::          Verifying a message.
790 * GPGSM GENKEY::          Generating a key.
791 * GPGSM LISTKEYS::        List available keys.
792 * GPGSM EXPORT::          Export certificates.
793 * GPGSM IMPORT::          Import certificates.
794 * GPGSM DELETE::          Delete certificates.
795 @end menu
796
797
798 @node GPGSM ENCRYPT
799 @subsection Encrypting a Message
800
801 Before encrytion can be done the recipient must be set using the
802 command:
803
804 @example
805   RECIPIENT @var{userID}
806 @end example
807
808 Set the recipient for the encryption.  @var{userID} should be the
809 internal representation of the key; the server may accept any other way
810 of specification.  If this is a valid and trusted recipient the server
811 does respond with OK, otherwise the return is an ERR with the reason why
812 the recipient can't be used, the encryption will then not be done for
813 this recipient.  If the policy is not to encrypt at all if not all
814 recipients are valid, the client has to take care of this.  All
815 @code{RECIPIENT} commands are cumulative until a @code{RESET} or an
816 successful @code{ENCRYPT} command.
817
818 @example
819   INPUT FD=@var{n} [--armor|--base64|--binary]
820 @end example
821
822 Set the file descriptor for the message to be encrypted to @var{n}.
823 Obviously the pipe must be open at that point, the server establishes
824 its own end.  If the server returns an error the client should consider
825 this session failed.
826
827 The @code{--armor} option may be used to advice the server that the
828 input data is in @acronym{PEM} format, @code{--base64} advices that a
829 raw base-64 encoding is used, @code{--binary} advices of raw binary
830 input (@acronym{BER}).  If none of these options is used, the server
831 tries to figure out the used encoding, but this may not always be
832 correct.
833
834 @example
835   OUTPUT FD=@var{n} [--armor|--base64]
836 @end example
837
838 Set the file descriptor to be used for the output (i.e. the encrypted
839 message). Obviously the pipe must be open at that point, the server
840 establishes its own end.  If the server returns an error he client
841 should consider this session failed.
842
843 The option armor encodes the output in @acronym{PEM} format, the
844 @code{--base64} option applies just a base 64 encoding.  No option
845 creates binary output (@acronym{BER}).
846   
847 The actual encryption is done using the command
848
849 @example
850   ENCRYPT 
851 @end example
852
853 It takes the plaintext from the @code{INPUT} command, writes to the
854 ciphertext to the file descriptor set with the @code{OUTPUT} command,
855 take the recipients from all the recipients set so far.  If this command
856 fails the clients should try to delete all output currently done or
857 otherwise mark it as invalid.  @command{GPGSM} does ensure that there won't be any
858 security problem with leftover data on the output in this case.
859
860 This command should in general not fail, as all necessary checks have
861 been done while setting the recipients.  The input and output pipes are
862 closed.
863
864
865 @node GPGSM DECRYPT
866 @subsection Decrypting a message
867
868 Input and output FDs are set the same way as in encryption, but
869 @code{INPUT} refers to the ciphertext and output to the plaintext. There
870 is no need to set recipients.  @command{GPGSM} automatically strips any
871 @acronym{S/MIME} headers from the input, so it is valid to pass an
872 entire MIME part to the INPUT pipe.
873
874 The encryption is done by using the command
875
876 @example
877   DECRYPT
878 @end example
879
880 It performs the decrypt operation after doing some check on the internal
881 state. (e.g. that all needed data has been set).  Because it utilizes
882 the GPG-Agent for the session key decryption, there is no need to ask
883 the client for a protecting passphrase - GpgAgent takes care of this by
884 requesting this from the user.
885
886
887 @node GPGSM SIGN
888 @subsection Signing a Message
889
890 Signing is usually done with these commands:
891
892 @example
893   INPUT FD=@var{n} [--armor|--base64|--binary]
894 @end example
895
896 This tells @command{GPGSM} to read the data to sign from file descriptor @var{n}.
897
898 @example
899   OUTPUT FD=@var{m} [--armor|--base64]
900 @end example
901
902 Write the output to file descriptor @var{m}.  If a detached signature is
903 requested, only the signature is written.
904
905 @example
906   SIGN [--detached] 
907 @end example
908
909 Sign the data set with the INPUT command and write it to the sink set by
910 OUTPUT.  With @code{--detached}, a detached signature is created
911 (surprise).
912
913 The key used for signining is the default one or the one specified in
914 the configuration file.  To get finer control over the keys, it is
915 possible to use the command
916
917 @example
918   SIGNER @var{userID}
919 @end example
920
921 to the signer's key.  @var{userID} should be the
922 internal representation of the key; the server may accept any other way
923 of specification.  If this is a valid and trusted recipient the server
924 does respond with OK, otherwise the return is an ERR with the reason why
925 the key can't be used, the signature will then not be created using
926 this key.  If the policy is not to sign at all if not all
927 keys are valid, the client has to take care of this.  All
928 @code{SIGNER} commands are cumulative until a @code{RESET} is done.
929 Note that a @code{SIGN} does not reset this list of signers which is in
930 contrats to the @code{RECIPIENT} command.
931
932
933 @node GPGSM VERIFY
934 @subsection Verifying a Message
935
936 To verify a mesage the command:
937
938 @example
939   VERIFY
940 @end example
941
942 is used. It does a verify operation on the message send to the input FD.
943 The result is written out using status lines.  If an output FD was
944 given, the signed text will be written to that.  If the signature is a
945 detached one, the server will inquire about the signed material and the
946 client must provide it.
947
948 @node GPGSM GENKEY
949 @subsection Generating a Key
950
951 This is used to generate a new keypair, store the secret part in the
952 @acronym{PSE} and the public key in the key database.  We will probably
953 add optional commands to allow the client to select whether a hardware
954 token is used to store the key.  Configuration options to
955 @command{GPGSM} can be used to restrict the use of this command.
956
957 @example
958   GENKEY 
959 @end example
960
961 @command{GPGSM} checks whether this command is allowed and then does an
962 INQUIRY to get the key parameters, the client should then send the
963 key parameters in the native format:
964
965 @example
966     S: INQUIRE KEY_PARAM native
967     C: D foo:fgfgfg
968     C: D bar
969     C: END
970 @end example    
971
972 Please note that the server may send Status info lines while reading the
973 data lines from the client.  After this the key generation takes place
974 and the server eventually does send an ERR or OK response.  Status lines
975 may be issued as a progress indicator.
976
977
978 @node GPGSM LISTKEYS
979 @subsection List available keys
980
981 To list the keys in the internal database or using an external key
982 provider, the command:
983
984 @example
985   LISTKEYS  @var{pattern}
986 @end example
987
988 is used.  To allow multiple patterns (which are ORed during the search)
989 quoting is required: Spaces are to be translated into "+" or into "%20";
990 in turn this requires that the usual escape quoting rules are done.
991
992 @example
993   LISTSECRETKEYS @var{pattern}
994 @end example
995
996 Lists only the keys where a secret key is available.
997
998 The list commands  commands are affected by the option
999
1000 @example
1001   OPTION list-mode=@var{mode}
1002 @end example
1003
1004 where mode may be:
1005 @table @code
1006 @item 0 
1007 Use default (which is usually the same as 1).
1008 @item 1
1009 List only the internal keys.
1010 @item 2
1011 List only the external keys.
1012 @item 3
1013 List internal and external keys.
1014 @end table
1015
1016 Note that options are valid for the entire session.
1017     
1018
1019 @node GPGSM EXPORT
1020 @subsection Export certificates
1021
1022 To export certificate from the internal key database the command:
1023
1024 @example
1025   EXPORT @var{pattern}
1026 @end example
1027
1028 is used.  To allow multiple patterns (which are ORed) quoting is
1029 required: Spaces are to be translated into "+" or into "%20"; in turn
1030 this requires that the usual escape quoting rules are done.
1031
1032 The format of the output depends on what was set with the OUTPUT
1033 command.  When using @acronym{PEM} encoding a few informational lines
1034 are prepended.
1035
1036
1037 @node GPGSM IMPORT
1038 @subsection Import certificates
1039
1040 To import certificates into the internal key database, the command
1041
1042 @example
1043   IMPORT
1044 @end example
1045
1046 is used.  The data is expected on the file descriptor set with the
1047 @code{INPUT} command.  Certain checks are performend on the
1048 certificate.  Note that the code will also handle PKCS\#12 files and
1049 import private keys; a helper program is used for that.
1050
1051
1052 @node GPGSM DELETE
1053 @subsection Delete certificates
1054
1055 To delete certificate the command
1056
1057 @example
1058   DELKEYS @var{pattern}
1059 @end example
1060
1061 is used.  To allow multiple patterns (which are ORed) quoting is
1062 required: Spaces are to be translated into "+" or into "%20"; in turn
1063 this requires that the usual escape quoting rules are done.
1064
1065 The certificates must be specified unambiguously otherwise an error is
1066 returned.
1067