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