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