More man pages.
[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 .R \- 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 @item --homedir @var{dir}
290 @opindex homedir
291 Set the name of the home directory to @var{dir}. If his option is not
292 used, the home directory defaults to @file{~/.gnupg}.  It is only
293 recognized when given on the command line.  It also overrides any home
294 directory stated through the environment variable @env{GNUPGHOME} or
295 (on W32 systems) by means on the Registry entry
296 @var{HKCU\Software\GNU\GnuPG:HomeDir}.
297
298
299 @item -v
300 @item --verbose
301 @opindex v
302 @opindex verbose
303 Outputs additional information while running.
304 You can increase the verbosity by giving several
305 verbose commands to @command{gpgsm}, such as @samp{-vv}.
306
307 @item --policy-file @var{filename}
308 @opindex policy-file
309 Change the default name of the policy file to @var{filename}.
310
311 @item --agent-program @var{file}
312 @opindex agent-program
313 Specify an agent program to be used for secret key operations.  The
314 default value is the @file{/usr/local/bin/gpg-agent}.  This is only used
315 as a fallback when the envrionment variable @code{GPG_AGENT_INFO} is not
316 set or a running agent can't be connected.
317   
318 @item --dirmngr-program @var{file}
319 @opindex dirmnr-program
320 Specify a dirmngr program to be used for @acronym{CRL} checks.  The
321 default value is @file{/usr/sbin/dirmngr}.  This is only used as a
322 fallback when the environment variable @code{DIRMNGR_INFO} is not set or
323 a running dirmngr can't be connected.
324
325 @item --prefer-system-dirmngr
326 @opindex prefer-system-dirmngr
327 If a system wide @command{dirmngr} is running in daemon mode, first try
328 to connect to this one.  Fallback to a pipe based server if this does
329 not work.
330
331 @item --no-secmem-warning
332 @opindex no-secmem-warning
333 Don't print a warning when the so called "secure memory" can't be used.
334
335 @item --log-file @var{file}
336 @opindex log-file
337 When running in server mode, append all logging output to @var{file}.
338
339 @end table
340
341
342 @c *******************************************
343 @c ********  CERTIFICATE OPTIONS  ************
344 @c *******************************************
345 @node Certificate Options
346 @subsection Certificate related options
347
348 @table @gnupgtabopt
349
350 @item  --enable-policy-checks
351 @itemx --disable-policy-checks
352 @opindex enable-policy-checks
353 @opindex disable-policy-checks
354 By default policy checks are enabled.  These options may be used to
355 change it.
356
357 @item  --enable-crl-checks
358 @itemx --disable-crl-checks
359 @opindex enable-crl-checks
360 @opindex disable-crl-checks
361 By default the @acronym{CRL} checks are enabled and the DirMngr is used
362 to check for revoked certificates.  The disable option is most useful
363 with an off-line network connection to suppress this check.
364
365 @item  --enable-trusted-cert-crl-check
366 @itemx --disable-trusted-cert-crl-check
367 @opindex enable-trusted-cert-crl-check
368 @opindex disable-trusted-cert-crl-check
369 By default the @acronym{CRL} for trusted root certificates are checked
370 like for any other certificates.  This allows a CA to revoke its own
371 certificates voluntary without the need of putting all ever issued
372 certificates into a CRL.  The disable option may be used to switch this
373 extra check off.  Due to the caching done by the Dirmngr, there won't be
374 any noticeable performance gain.  Note, that this also disables possible
375 OCSP checks for trusted root certificates.
376
377 @item --force-crl-refresh
378 @opindex force-crl-refresh
379 Tell the dirmngr to reload the CRL for each request.  For better
380 performance, the dirmngr will actually optimize this by suppressing
381 the loading for short time intervalls (e.g. 30 minutes). This option
382 is useful to make sure that a fresh CRL is available for certificates
383 hold in the keybox.  The suggested way of doing this is by using it
384 along with the option @option{--with-validation} for a key listing
385 command.  This option should not be used in a configuration file. 
386
387 @item  --enable-ocsp
388 @itemx --disable-ocsp
389 @opindex enable-ocsp
390 @opindex disable-ocsp
391 Be default @acronym{OCSP} checks are disabled.  The enable opton may
392 be used to enable OCSP checks via Dirmngr.  If @acronym{CRL} checks
393 are also enabled, CRLs will be used as a fallback if for some reason an
394 OCSP request won't succeed.  Note, that you have to allow OCSP
395 requests in Dirmngr's configuration too (option 
396 @option{--allow-ocsp} and configure dirmngr properly.  If you don't do
397 so you will get the error code @samp{Not supported}.
398
399 @end table
400
401 @c *******************************************
402 @c ***********  INPUT AND OUTPUT  ************
403 @c *******************************************
404 @node Input and Output
405 @subsection Input and Output
406
407 @table @gnupgtabopt
408 @item --armor
409 @itemx -a
410 @opindex armor
411 @opindex -a
412 Create PEM encoded output.  Default is binary output. 
413
414 @item --base64 
415 @opindex base64
416 Create Base-64 encoded output; i.e. PEM without the header lines.
417
418 @item --assume-armor
419 @opindex assume-armor
420 Assume the input data is PEM encoded.  Default is to autodetect the
421 encoding but this is may fail.
422
423 @item --assume-base64
424 @opindex assume-base64
425 Assume the input data is plain base-64 encoded.
426
427 @item --assume-binary
428 @opindex assume-binary
429 Assume the input data is binary encoded.
430
431 @item --local-user @var{user_id}
432 @item -u @var{user_id}
433 @opindex local-user
434 @opindex -u
435 Set the user(s) to be used for signing.  The default is the first
436 secret key found in the database.
437
438 @item --with-key-data
439 @opindex with-key-data
440 Displays extra information with the @code{--list-keys} commands.  Especially
441 a line tagged @code{grp} is printed which tells you the keygrip of a
442 key.  This string is for example used as the file name of the
443 secret key.
444
445 @item --with-validation
446 @opindex with-validation
447 When doing a key listing, do a full validation check for each key and
448 print the result.  This is usually a slow operation because it
449 requires a CRL lookup and other operations. 
450
451 When used along with --import, a validation of the certificate to
452 import is done and only imported if it succeeds the test.  Note that
453 this does not affect an already available cwertificate in the DB.
454 This option is therefore useful to simply verify a certificate.
455
456
457 @item --with-md5-fingerprint
458 For standard key listings, also print the MD5 fingerprint of the
459 certificate.
460
461 @end table
462
463 @c *******************************************
464 @c *************  CMS OPTIONS  ***************
465 @c *******************************************
466 @node CMS Options
467 @subsection How to change how the CMS is created.
468
469 @table @gnupgtabopt
470 @item --include-certs @var{n}
471 Using @var{n} of -2 includes all certificate except for the root cert,
472 -1 includes all certs, 0 does not include any certs, 1 includes only
473 the signers cert (this is the default) and all other positive
474 values include up to @var{n} certificates starting with the signer cert.
475   
476 @end table
477
478
479
480 @c *******************************************
481 @c ********  ESOTERIC OPTIONS  ***************
482 @c *******************************************
483 @node Esoteric Options
484 @subsection Doing things one usually don't want to do.
485
486
487 @table @gnupgtabopt
488
489 @item --faked-system-time @var{epoch}
490 @opindex faked-system-time
491 This option is only useful for testing; it sets the system time back or
492 forth to @var{epoch} which is the number of seconds elapsed since the year
493 1970.
494
495 @item --with-ephemeral-keys
496 @opindex with-ephemeral-keys
497 Include ephemeral flagged keys in the output of key listings.
498
499 @item --debug-level @var{level}
500 @opindex debug-level
501 Select the debug level for investigating problems. @var{level} may be
502 one of:
503
504    @table @code
505    @item none
506    no debugging at all.
507    @item basic  
508    some basic debug messages
509    @item advanced
510    more verbose debug messages
511    @item expert
512    even more detailed messages
513    @item guru
514    all of the debug messages you can get
515    @end table
516
517 How these messages are mapped to the actual debugging flags is not
518 specified and may change with newer releaes of this program. They are
519 however carefully selected to best aid in debugging.
520
521 @item --debug @var{flags}
522 @opindex debug
523 This option is only useful for debugging and the behaviour may change
524 at any time without notice; using @code{--debug-levels} is the
525 preferred method to select the debug verbosity.  FLAGS are bit encoded
526 and may be given in usual C-Syntax. The currently defined bits are:
527
528    @table @code
529    @item 0  (1)
530    X.509 or OpenPGP protocol related data
531    @item 1  (2)  
532    values of big number integers 
533    @item 2  (4)
534    low level crypto operations
535    @item 5  (32)
536    memory allocation
537    @item 6  (64)
538    caching
539    @item 7  (128)
540    show memory statistics.
541    @item 9  (512)
542    write hashed data to files named @code{dbgmd-000*}
543    @item 10 (1024)
544    trace Assuan protocol
545    @end table
546
547 Note, that all flags set using this option may get overriden by
548 @code{--debug-level}.
549
550 @item --debug-all
551 @opindex debug-all
552 Same as @code{--debug=0xffffffff}
553
554 @item --debug-allow-core-dump
555 @opindex debug-allow-core-dump
556 Usually @command{gpgsm} tries to avoid dumping core by well written code and by
557 disabling core dumps for security reasons.  However, bugs are pretty
558 durable beasts and to squash them it is sometimes useful to have a core
559 dump.  This option enables core dumps unless the Bad Thing happened
560 before the option parsing.
561
562 @item --debug-no-chain-validation
563 @opindex debug-no-chain-validation
564 This is actually not a debugging option but only useful as such.  It
565 lets @command{gpgsm} bypass all certificate chain validation checks.
566
567 @item --debug-ignore-expiration
568 @opindex debug-ignore-expiration
569 This is actually not a debugging option but only useful as such.  It
570 lets @command{gpgsm} ignore all notAfter dates, this is used by the regresssion
571 tests.
572
573 @item --fixed-passphrase @var{string}
574 @opindex fixed-passphrase
575 Supply the passphrase @var{string} to the gpg-protect-tool.  This
576 option is only useful for the regression tests included with this
577 package and may be revised or removed at any time without notice.
578
579 @end table
580
581 All the long options may also be given in the configuration file after
582 stripping off the two leading dashes.
583
584
585 @c *******************************************
586 @c ***************            ****************
587 @c ***************   FILES    ****************
588 @c ***************            ****************
589 @c *******************************************
590 @mansect files
591 @node GPGSM Configuration
592 @section Configuration files
593
594 There are a few configuration files to control certain aspects of
595 @command{gpgsm}'s operation. Unless noted, they are expected in the
596 current home directory (@pxref{option --homedir}).
597
598 @table @file
599
600 @item gpgsm.conf
601 @cindex gpgsm.conf
602 This is the standard configuration file read by @command{gpgsm} on
603 startup.  It may contain any valid long option; the leading two dashes
604 may not be entered and the option may not be abbreviated.  This default
605 name may be changed on the command line (@pxref{option
606   --options}).
607
608 @item policies.txt
609 @cindex policies.txt
610 This is a list of allowed CA policies.  This file should list the
611 object identifiers of the policies line by line.  Empty lines and
612 lines starting with a hash mark are ignored.  Policies missing in this
613 file and not marked as critical in the certificate will print only a
614 warning; certificates with policies marked as critical and not listed
615 in this file will fail the signature verification.
616
617 For example, to allow only the policy 2.289.9.9, the file should look
618 like this:
619
620 @c man:.RS
621 @example
622 # Allowed policies
623 2.289.9.9  
624 @end example
625 @c man:.RE
626
627 @item qualified.txt
628 @cindex qualified.txt
629 This is the list of root certificates used for qualified certificates.
630 They are defined as certificates capable of creating legally binding
631 signatures in the same way as handwritten signatures are.  Comments
632 start with a hash mark and empty lines are ignored.  Lines do have a
633 length limit but this is not a serious limitation as the format of the
634 entries is fixed and checked by gpgsm: A non-comment line starts with
635 optional white spaces, followed by exactly 40 hex character, white space
636 and a lowercased 2 letter country code.  Additional data delimited with
637 by a white space is current ignored but might late be used for other
638 purposes.
639
640 Note that even if a certificate is listed in this file, this does not
641 mean that thecertificate is trusted; in general the certificates listed
642 in this file need to be listed also in @file{trustlist.txt}.
643
644 This is a global file an installed in the data directory
645 (e.g. @file{/usr/share/gnupg/qualified.txt}).  GnuPG installs a suitable
646 file with root certificates as used in Germany.  As new Root-CA
647 certificates may be issued over time, these entries may need to be
648 updated; new distributions of this software should come with an updated
649 list but it is still the responsibility of the Administrator to check
650 that this list is correct.
651
652 Everytime @command{gpgsm} uses a certificate for signing or verification
653 this file will be consulted to check whether the certificate under
654 question has ultimately been issued by one of these CAs.  If this is the
655 case the user will be informed that the verified signature represents a
656 legally binding (``qualified'') signature.  When creating a signature
657 using such a certificate an extra prompt will be issued to let the user
658 confirm that such a legally binding signature shall really be created.
659
660 Because this software has not yet been approved for use with such
661 certificates, appropriate notices will be shown to indicate this fact.
662
663 @end table
664
665 @c man:.RE
666 Note that on larger installations, it is useful to put predefined files
667 into the directory @file{/etc/skel/.gnupg/} so that newly created users
668 start up with a working configuration.  For existing users the a small
669 helper script is provided to create these files (@pxref{addgnupghome}).
670
671 For internal purposes gpgsm creates and maintaines a few other files;
672 They all live in in the current home directory (@pxref{option
673 --homedir}).  Only @command{gpgsm} may modify these files.
674
675
676 @table @file
677 @item pubring.kbx
678 @cindex pubring.kbx
679 This a database file storing the certificates as well as meta
680 information.  For debugging purposes the tool @command{kbxutil} may be
681 used to show the internal structure of this file.
682       
683 @item random_seed
684 @cindex random_seed
685 This content of this file is used to maintain the internal state of the
686 random number generator accross invocations.  The same file is used by
687 other programs of this software too.
688
689 @end table
690
691
692 @c *******************************************
693 @c ***************            ****************
694 @c ***************  EXAMPLES  ****************
695 @c ***************            ****************
696 @c *******************************************
697 @mansect examples
698 @node GPGSM Examples
699 @section Examples
700
701 @example
702 $ gpgsm -er goo@@bar.net <plaintext >ciphertext
703 @end example
704
705
706 @c man end
707
708
709 @c *******************************************
710 @c ***************              **************
711 @c ***************  UNATTENDED  **************
712 @c ***************              **************
713 @c *******************************************
714 @node Unattended Usage
715 @section Unattended Usage
716
717 @command{gpgsm} is often used as a backend engine by other software.  To help
718 with this a machine interface has been defined to have an unambiguous
719 way to do this.  This is most likely used with the @code{--server} command
720 but may also be used in the standard operation mode by using the
721 @code{--status-fd} option.
722
723 @menu
724 * Automated signature checking::  Automated signature checking.
725 @end menu
726
727 @node Automated signature checking,,,Unattended Usage
728 @section Automated signature checking
729
730 It is very important to understand the semantics used with signature
731 verification.  Checking a signature is not as simple as it may sound and
732 so the ooperation si a bit complicated.  In mosted cases it is required
733 to look at several status lines.  Here is a table of all cases a signed
734 message may have:
735
736 @table @asis
737 @item The signature is valid
738 This does mean that the signature has been successfully verified, the
739 certificates are all sane.  However there are two subcases with
740 important information:  One of the certificates may have expired or a
741 signature of a message itself as expired.  It is a sound practise to
742 consider such a signature still as valid but additional information
743 should be displayed.  Depending on the subcase @command{gpgsm} will issue
744 these status codes:
745   @table @asis 
746   @item signature valid and nothing did expire
747   @code{GOODSIG}, @code{VALIDSIG}, @code{TRUST_FULLY}
748   @item signature valid but at least one certificate has expired
749   @code{EXPKEYSIG}, @code{VALIDSIG}, @code{TRUST_FULLY}
750   @item signature valid but expired
751   @code{EXPSIG}, @code{VALIDSIG}, @code{TRUST_FULLY}
752   Note, that this case is currently not implemented.
753   @end table
754
755 @item The signature is invalid
756 This means that the signature verification failed (this is an indication
757 of af a transfer error, a programm error or tampering with the message).
758 @command{gpgsm} issues one of these status codes sequences:
759   @table @code
760   @item  @code{BADSIG}
761   @item  @code{GOODSIG}, @code{VALIDSIG} @code{TRUST_NEVER}
762   @end table
763
764 @item Error verifying a signature
765 For some reason the signature could not be verified, i.e. it can't be
766 decided whether the signature is valid or invalid.  A common reason for
767 this is a missing certificate.
768
769 @end table
770
771
772 @c *******************************************
773 @c ***************           *****************
774 @c ***************  ASSSUAN  *****************
775 @c ***************           *****************
776 @c *******************************************
777 @mansect assuan
778 @node GPGSM Protocol
779 @section The Protocol the Server Mode Uses.
780
781 Description of the protocol used to access @command{GPGSM}.
782 @command{GPGSM} does implement the Assuan protocol and in addition
783 provides a regular command line interface which exhibits a full client
784 to this protocol (but uses internal linking).  To start
785 @command{gpgsm} as a server the command line the option
786 @code{--server} must be used.  Additional options are provided to
787 select the communication method (i.e. the name of the socket).
788
789 We assume that the connection has already been established; see the
790 Assuan manual for details.
791
792 @menu
793 * GPGSM ENCRYPT::         Encrypting a message.
794 * GPGSM DECRYPT::         Decrypting a message.
795 * GPGSM SIGN::            Signing a message.
796 * GPGSM VERIFY::          Verifying a message.
797 * GPGSM GENKEY::          Generating a key.
798 * GPGSM LISTKEYS::        List available keys.
799 * GPGSM EXPORT::          Export certificates.
800 * GPGSM IMPORT::          Import certificates.
801 * GPGSM DELETE::          Delete certificates.
802 @end menu
803
804
805 @node GPGSM ENCRYPT
806 @subsection Encrypting a Message
807
808 Before encrytion can be done the recipient must be set using the
809 command:
810
811 @example
812   RECIPIENT @var{userID}
813 @end example
814
815 Set the recipient for the encryption.  @var{userID} should be the
816 internal representation of the key; the server may accept any other way
817 of specification.  If this is a valid and trusted recipient the server
818 does respond with OK, otherwise the return is an ERR with the reason why
819 the recipient can't be used, the encryption will then not be done for
820 this recipient.  If the policy is not to encrypt at all if not all
821 recipients are valid, the client has to take care of this.  All
822 @code{RECIPIENT} commands are cumulative until a @code{RESET} or an
823 successful @code{ENCRYPT} command.
824
825 @example
826   INPUT FD=@var{n} [--armor|--base64|--binary]
827 @end example
828
829 Set the file descriptor for the message to be encrypted to @var{n}.
830 Obviously the pipe must be open at that point, the server establishes
831 its own end.  If the server returns an error the client should consider
832 this session failed.
833
834 The @code{--armor} option may be used to advice the server that the
835 input data is in @acronym{PEM} format, @code{--base64} advices that a
836 raw base-64 encoding is used, @code{--binary} advices of raw binary
837 input (@acronym{BER}).  If none of these options is used, the server
838 tries to figure out the used encoding, but this may not always be
839 correct.
840
841 @example
842   OUTPUT FD=@var{n} [--armor|--base64]
843 @end example
844
845 Set the file descriptor to be used for the output (i.e. the encrypted
846 message). Obviously the pipe must be open at that point, the server
847 establishes its own end.  If the server returns an error he client
848 should consider this session failed.
849
850 The option armor encodes the output in @acronym{PEM} format, the
851 @code{--base64} option applies just a base 64 encoding.  No option
852 creates binary output (@acronym{BER}).
853   
854 The actual encryption is done using the command
855
856 @example
857   ENCRYPT 
858 @end example
859
860 It takes the plaintext from the @code{INPUT} command, writes to the
861 ciphertext to the file descriptor set with the @code{OUTPUT} command,
862 take the recipients from all the recipients set so far.  If this command
863 fails the clients should try to delete all output currently done or
864 otherwise mark it as invalid.  @command{GPGSM} does ensure that there won't be any
865 security problem with leftover data on the output in this case.
866
867 This command should in general not fail, as all necessary checks have
868 been done while setting the recipients.  The input and output pipes are
869 closed.
870
871
872 @node GPGSM DECRYPT
873 @subsection Decrypting a message
874
875 Input and output FDs are set the same way as in encryption, but
876 @code{INPUT} refers to the ciphertext and output to the plaintext. There
877 is no need to set recipients.  @command{GPGSM} automatically strips any
878 @acronym{S/MIME} headers from the input, so it is valid to pass an
879 entire MIME part to the INPUT pipe.
880
881 The encryption is done by using the command
882
883 @example
884   DECRYPT
885 @end example
886
887 It performs the decrypt operation after doing some check on the internal
888 state. (e.g. that all needed data has been set).  Because it utilizes
889 the GPG-Agent for the session key decryption, there is no need to ask
890 the client for a protecting passphrase - GpgAgent takes care of this by
891 requesting this from the user.
892
893
894 @node GPGSM SIGN
895 @subsection Signing a Message
896
897 Signing is usually done with these commands:
898
899 @example
900   INPUT FD=@var{n} [--armor|--base64|--binary]
901 @end example
902
903 This tells @command{GPGSM} to read the data to sign from file descriptor @var{n}.
904
905 @example
906   OUTPUT FD=@var{m} [--armor|--base64]
907 @end example
908
909 Write the output to file descriptor @var{m}.  If a detached signature is
910 requested, only the signature is written.
911
912 @example
913   SIGN [--detached] 
914 @end example
915
916 Sign the data set with the INPUT command and write it to the sink set by
917 OUTPUT.  With @code{--detached}, a detached signature is created
918 (surprise).
919
920 The key used for signining is the default one or the one specified in
921 the configuration file.  To get finer control over the keys, it is
922 possible to use the command
923
924 @example
925   SIGNER @var{userID}
926 @end example
927
928 to the signer's key.  @var{userID} should be the
929 internal representation of the key; the server may accept any other way
930 of specification.  If this is a valid and trusted recipient the server
931 does respond with OK, otherwise the return is an ERR with the reason why
932 the key can't be used, the signature will then not be created using
933 this key.  If the policy is not to sign at all if not all
934 keys are valid, the client has to take care of this.  All
935 @code{SIGNER} commands are cumulative until a @code{RESET} is done.
936 Note that a @code{SIGN} does not reset this list of signers which is in
937 contrats to the @code{RECIPIENT} command.
938
939
940 @node GPGSM VERIFY
941 @subsection Verifying a Message
942
943 To verify a mesage the command:
944
945 @example
946   VERIFY
947 @end example
948
949 is used. It does a verify operation on the message send to the input FD.
950 The result is written out using status lines.  If an output FD was
951 given, the signed text will be written to that.  If the signature is a
952 detached one, the server will inquire about the signed material and the
953 client must provide it.
954
955 @node GPGSM GENKEY
956 @subsection Generating a Key
957
958 This is used to generate a new keypair, store the secret part in the
959 @acronym{PSE} and the public key in the key database.  We will probably
960 add optional commands to allow the client to select whether a hardware
961 token is used to store the key.  Configuration options to
962 @command{GPGSM} can be used to restrict the use of this command.
963
964 @example
965   GENKEY 
966 @end example
967
968 @command{GPGSM} checks whether this command is allowed and then does an
969 INQUIRY to get the key parameters, the client should then send the
970 key parameters in the native format:
971
972 @example
973     S: INQUIRE KEY_PARAM native
974     C: D foo:fgfgfg
975     C: D bar
976     C: END
977 @end example    
978
979 Please note that the server may send Status info lines while reading the
980 data lines from the client.  After this the key generation takes place
981 and the server eventually does send an ERR or OK response.  Status lines
982 may be issued as a progress indicator.
983
984
985 @node GPGSM LISTKEYS
986 @subsection List available keys
987
988 To list the keys in the internal database or using an external key
989 provider, the command:
990
991 @example
992   LISTKEYS  @var{pattern}
993 @end example
994
995 is used.  To allow multiple patterns (which are ORed during the search)
996 quoting is required: Spaces are to be translated into "+" or into "%20";
997 in turn this requires that the usual escape quoting rules are done.
998
999 @example
1000   LISTSECRETKEYS @var{pattern}
1001 @end example
1002
1003 Lists only the keys where a secret key is available.
1004
1005 The list commands  commands are affected by the option
1006
1007 @example
1008   OPTION list-mode=@var{mode}
1009 @end example
1010
1011 where mode may be:
1012 @table @code
1013 @item 0 
1014 Use default (which is usually the same as 1).
1015 @item 1
1016 List only the internal keys.
1017 @item 2
1018 List only the external keys.
1019 @item 3
1020 List internal and external keys.
1021 @end table
1022
1023 Note that options are valid for the entire session.
1024     
1025
1026 @node GPGSM EXPORT
1027 @subsection Export certificates
1028
1029 To export certificate from the internal key database the command:
1030
1031 @example
1032   EXPORT @var{pattern}
1033 @end example
1034
1035 is used.  To allow multiple patterns (which are ORed) quoting is
1036 required: Spaces are to be translated into "+" or into "%20"; in turn
1037 this requires that the usual escape quoting rules are done.
1038
1039 The format of the output depends on what was set with the OUTPUT
1040 command.  When using @acronym{PEM} encoding a few informational lines
1041 are prepended.
1042
1043
1044 @node GPGSM IMPORT
1045 @subsection Import certificates
1046
1047 To import certificates into the internal key database, the command
1048
1049 @example
1050   IMPORT
1051 @end example
1052
1053 is used.  The data is expected on the file descriptor set with the
1054 @code{INPUT} command.  Certain checks are performend on the
1055 certificate.  Note that the code will also handle PKCS\#12 files and
1056 import private keys; a helper program is used for that.
1057
1058
1059 @node GPGSM DELETE
1060 @subsection Delete certificates
1061
1062 To delete certificate the command
1063
1064 @example
1065   DELKEYS @var{pattern}
1066 @end example
1067
1068 is used.  To allow multiple patterns (which are ORed) quoting is
1069 required: Spaces are to be translated into "+" or into "%20"; in turn
1070 this requires that the usual escape quoting rules are done.
1071
1072 The certificates must be specified unambiguously otherwise an error is
1073 returned.
1074