Exporting secret keys via gpg-agent is now basically supported.
[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 @end table
558
559 @c *******************************************
560 @c *************  CMS OPTIONS  ***************
561 @c *******************************************
562 @node CMS Options
563 @subsection How to change how the CMS is created.
564
565 @table @gnupgtabopt
566 @item --include-certs @var{n}
567 @opindex include-certs
568 Using @var{n} of -2 includes all certificate except for the root cert,
569 -1 includes all certs, 0 does not include any certs, 1 includes only the
570 signers cert and all other positive values include up to @var{n}
571 certificates starting with the signer cert.  The default is -2.
572
573 @item --cipher-algo @var{oid}
574 @opindex cipher-algo
575 Use the cipher algorithm with the ASN.1 object identifier @var{oid} for
576 encryption.  For convenience the strings @code{3DES}, @code{AES} and
577 @code{AES256} may be used instead of their OIDs.  The default is
578 @code{3DES} (1.2.840.113549.3.7).
579   
580 @item --digest-algo @code{name}
581 Use @code{name} as the message digest algorithm.  Usually this
582 algorithm is deduced from the respective signing certificate.  This
583 option forces the use of the given algorithm and may lead to severe
584 interoperability problems.
585
586 @end table
587
588
589
590 @c *******************************************
591 @c ********  ESOTERIC OPTIONS  ***************
592 @c *******************************************
593 @node Esoteric Options
594 @subsection Doing things one usually don't want to do.
595
596
597 @table @gnupgtabopt
598
599 @item --extra-digest-algo @var{name}
600 @opindex extra-digest-algo
601 Sometimes signatures are broken in that they announce a different digest
602 algorithm than actually used.  @command{gpgsm} uses a one-pass data
603 processing model and thus needs to rely on the announced digest
604 algorithms to properly hash the data.  As a workaround this option may
605 be used to tell gpg to also hash the data using the algorithm
606 @var{name}; this slows processing down a little bit but allows to verify
607 such broken signatures.  If @command{gpgsm} prints an error like
608 ``digest algo 8 has not been enabled'' you may want to try this option,
609 with @samp{SHA256} for @var{name}.
610
611
612 @item --faked-system-time @var{epoch}
613 @opindex faked-system-time
614 This option is only useful for testing; it sets the system time back or
615 forth to @var{epoch} which is the number of seconds elapsed since the year
616 1970.  Alternatively @var{epoch} may be given as a full ISO time string
617 (e.g. "20070924T154812").
618
619 @item --with-ephemeral-keys
620 @opindex with-ephemeral-keys
621 Include ephemeral flagged keys in the output of key listings.  Note
622 that they are included anyway if the key specification for a listing
623 is given as fingerprint or keygrip.
624
625 @item --debug-level @var{level}
626 @opindex debug-level
627 Select the debug level for investigating problems. @var{level} may be
628 a numeric value or by a keyword:
629
630 @table @code
631 @item none
632 No debugging at all.  A value of less than 1 may be used instead of
633 the keyword.
634 @item basic  
635 Some basic debug messages.  A value between 1 and 2 may be used
636 instead of the keyword.
637 @item advanced
638 More verbose debug messages.  A value between 3 and 5 may be used
639 instead of the keyword.
640 @item expert
641 Even more detailed messages.  A value between 6 and 8 may be used
642 instead of the keyword.
643 @item guru
644 All of the debug messages you can get. A value greater than 8 may be
645 used instead of the keyword.  The creation of hash tracing files is
646 only enabled if the keyword is used.
647 @end table
648
649 How these messages are mapped to the actual debugging flags is not
650 specified and may change with newer releases of this program. They are
651 however carefully selected to best aid in debugging.
652
653 @item --debug @var{flags}
654 @opindex debug
655 This option is only useful for debugging and the behaviour may change
656 at any time without notice; using @code{--debug-levels} is the
657 preferred method to select the debug verbosity.  FLAGS are bit encoded
658 and may be given in usual C-Syntax. The currently defined bits are:
659
660 @table @code
661 @item 0  (1)
662 X.509 or OpenPGP protocol related data
663 @item 1  (2)  
664 values of big number integers 
665 @item 2  (4)
666 low level crypto operations
667 @item 5  (32)
668 memory allocation
669 @item 6  (64)
670 caching
671 @item 7  (128)
672 show memory statistics.
673 @item 9  (512)
674 write hashed data to files named @code{dbgmd-000*}
675 @item 10 (1024)
676 trace Assuan protocol
677 @end table
678
679 Note, that all flags set using this option may get overridden by
680 @code{--debug-level}.
681
682 @item --debug-all
683 @opindex debug-all
684 Same as @code{--debug=0xffffffff}
685
686 @item --debug-allow-core-dump
687 @opindex debug-allow-core-dump
688 Usually @command{gpgsm} tries to avoid dumping core by well written code and by
689 disabling core dumps for security reasons.  However, bugs are pretty
690 durable beasts and to squash them it is sometimes useful to have a core
691 dump.  This option enables core dumps unless the Bad Thing happened
692 before the option parsing.
693
694 @item --debug-no-chain-validation
695 @opindex debug-no-chain-validation
696 This is actually not a debugging option but only useful as such.  It
697 lets @command{gpgsm} bypass all certificate chain validation checks.
698
699 @item --debug-ignore-expiration
700 @opindex debug-ignore-expiration
701 This is actually not a debugging option but only useful as such.  It
702 lets @command{gpgsm} ignore all notAfter dates, this is used by the regression
703 tests.
704
705 @item --fixed-passphrase @var{string}
706 @opindex fixed-passphrase
707 Supply the passphrase @var{string} to the gpg-protect-tool.  This
708 option is only useful for the regression tests included with this
709 package and may be revised or removed at any time without notice.
710
711 @item --no-common-certs-import
712 @opindex no-common-certs-import
713 Suppress the import of common certificates on keybox creation.
714
715 @end table
716
717 All the long options may also be given in the configuration file after
718 stripping off the two leading dashes.
719
720 @c *******************************************
721 @c ***************            ****************
722 @c ***************  USER ID   ****************
723 @c ***************            ****************
724 @c *******************************************
725 @mansect how to specify a user id
726 @ifset isman
727 @include specify-user-id.texi
728 @end ifset
729
730 @c *******************************************
731 @c ***************            ****************
732 @c ***************   FILES    ****************
733 @c ***************            ****************
734 @c *******************************************
735 @mansect files
736 @node GPGSM Configuration
737 @section Configuration files
738
739 There are a few configuration files to control certain aspects of
740 @command{gpgsm}'s operation. Unless noted, they are expected in the
741 current home directory (@pxref{option --homedir}).
742
743 @table @file
744
745 @item gpgsm.conf
746 @cindex gpgsm.conf
747 This is the standard configuration file read by @command{gpgsm} on
748 startup.  It may contain any valid long option; the leading two dashes
749 may not be entered and the option may not be abbreviated.  This default
750 name may be changed on the command line (@pxref{option
751   --options}).  You should backup this file.
752
753
754 @item policies.txt
755 @cindex policies.txt
756 This is a list of allowed CA policies.  This file should list the
757 object identifiers of the policies line by line.  Empty lines and
758 lines starting with a hash mark are ignored.  Policies missing in this
759 file and not marked as critical in the certificate will print only a
760 warning; certificates with policies marked as critical and not listed
761 in this file will fail the signature verification.  You should backup
762 this file.
763
764 For example, to allow only the policy 2.289.9.9, the file should look
765 like this:
766
767 @c man:.RS
768 @example
769 # Allowed policies
770 2.289.9.9  
771 @end example
772 @c man:.RE
773
774 @item qualified.txt
775 @cindex qualified.txt
776 This is the list of root certificates used for qualified certificates.
777 They are defined as certificates capable of creating legally binding
778 signatures in the same way as handwritten signatures are.  Comments
779 start with a hash mark and empty lines are ignored.  Lines do have a
780 length limit but this is not a serious limitation as the format of the
781 entries is fixed and checked by gpgsm: A non-comment line starts with
782 optional whitespace, followed by exactly 40 hex character, white space
783 and a lowercased 2 letter country code.  Additional data delimited with
784 by a white space is current ignored but might late be used for other
785 purposes.
786
787 Note that even if a certificate is listed in this file, this does not
788 mean that the certificate is trusted; in general the certificates listed
789 in this file need to be listed also in @file{trustlist.txt}.
790
791 This is a global file an installed in the data directory
792 (e.g. @file{/usr/share/gnupg/qualified.txt}).  GnuPG installs a suitable
793 file with root certificates as used in Germany.  As new Root-CA
794 certificates may be issued over time, these entries may need to be
795 updated; new distributions of this software should come with an updated
796 list but it is still the responsibility of the Administrator to check
797 that this list is correct.
798
799 Everytime @command{gpgsm} uses a certificate for signing or verification
800 this file will be consulted to check whether the certificate under
801 question has ultimately been issued by one of these CAs.  If this is the
802 case the user will be informed that the verified signature represents a
803 legally binding (``qualified'') signature.  When creating a signature
804 using such a certificate an extra prompt will be issued to let the user
805 confirm that such a legally binding signature shall really be created.
806
807 Because this software has not yet been approved for use with such
808 certificates, appropriate notices will be shown to indicate this fact.
809
810 @item help.txt
811 @cindex help.txt
812 This is plain text file with a few help entries used with 
813 @command{pinentry} as well as a large list of help items for
814 @command{gpg} and @command{gpgsm}.  The standard file has English help
815 texts; to install localized versions use filenames like @file{help.LL.txt}
816 with LL denoting the locale.  GnuPG comes with a set of predefined help
817 files in the data directory (e.g. @file{/usr/share/gnupg/help.de.txt})
818 and allows overriding of any help item by help files stored in the
819 system configuration directory (e.g. @file{/etc/gnupg/help.de.txt}).
820 For a reference of the help file's syntax, please see the installed
821 @file{help.txt} file.
822
823
824 @item com-certs.pem
825 @cindex com-certs.pem
826 This file is a collection of common certificates used to populated a
827 newly created @file{pubring.kbx}.  An administrator may replace this
828 file with a custom one.  The format is a concatenation of PEM encoded
829 X.509 certificates.  This global file is installed in the data directory
830 (e.g. @file{/usr/share/gnupg/qualified.txt}).
831
832 @end table
833
834 @c man:.RE
835 Note that on larger installations, it is useful to put predefined files
836 into the directory @file{/etc/skel/.gnupg/} so that newly created users
837 start up with a working configuration.  For existing users a small
838 helper script is provided to create these files (@pxref{addgnupghome}).
839
840 For internal purposes gpgsm creates and maintains a few other files;
841 they all live in in the current home directory (@pxref{option
842 --homedir}).  Only @command{gpgsm} may modify these files.
843
844
845 @table @file
846 @item pubring.kbx
847 @cindex pubring.kbx
848 This a database file storing the certificates as well as meta
849 information.  For debugging purposes the tool @command{kbxutil} may be
850 used to show the internal structure of this file.  You should backup
851 this file.
852
853 @item random_seed
854 @cindex random_seed
855 This content of this file is used to maintain the internal state of the
856 random number generator across invocations.  The same file is used by
857 other programs of this software too.
858
859 @item S.gpg-agent
860 @cindex S.gpg-agent
861 If this file exists and the environment variable @env{GPG_AGENT_INFO} is
862 not set, @command{gpgsm} will first try to connect to this socket for
863 accessing @command{gpg-agent} before starting a new @command{gpg-agent}
864 instance.  Under Windows this socket (which in reality be a plain file
865 describing a regular TCP listening port) is the standard way of
866 connecting the @command{gpg-agent}.
867
868 @end table
869
870
871 @c *******************************************
872 @c ***************            ****************
873 @c ***************  EXAMPLES  ****************
874 @c ***************            ****************
875 @c *******************************************
876 @mansect examples
877 @node GPGSM Examples
878 @section Examples
879
880 @example
881 $ gpgsm -er goo@@bar.net <plaintext >ciphertext
882 @end example
883
884
885 @c man end
886
887
888 @c *******************************************
889 @c ***************              **************
890 @c ***************  UNATTENDED  **************
891 @c ***************              **************
892 @c *******************************************
893 @node Unattended Usage
894 @section Unattended Usage
895
896 @command{gpgsm} is often used as a backend engine by other software.  To help
897 with this a machine interface has been defined to have an unambiguous
898 way to do this.  This is most likely used with the @code{--server} command
899 but may also be used in the standard operation mode by using the
900 @code{--status-fd} option.
901
902 @menu
903 * Automated signature checking::  Automated signature checking.
904 @end menu
905
906 @node Automated signature checking,,,Unattended Usage
907 @section Automated signature checking
908
909 It is very important to understand the semantics used with signature
910 verification.  Checking a signature is not as simple as it may sound and
911 so the operation is a bit complicated.  In most cases it is required
912 to look at several status lines.  Here is a table of all cases a signed
913 message may have:
914
915 @table @asis
916 @item The signature is valid
917 This does mean that the signature has been successfully verified, the
918 certificates are all sane.  However there are two subcases with
919 important information:  One of the certificates may have expired or a
920 signature of a message itself as expired.  It is a sound practise to
921 consider such a signature still as valid but additional information
922 should be displayed.  Depending on the subcase @command{gpgsm} will issue
923 these status codes:
924   @table @asis 
925   @item signature valid and nothing did expire
926   @code{GOODSIG}, @code{VALIDSIG}, @code{TRUST_FULLY}
927   @item signature valid but at least one certificate has expired
928   @code{EXPKEYSIG}, @code{VALIDSIG}, @code{TRUST_FULLY}
929   @item signature valid but expired
930   @code{EXPSIG}, @code{VALIDSIG}, @code{TRUST_FULLY}
931   Note, that this case is currently not implemented.
932   @end table
933
934 @item The signature is invalid
935 This means that the signature verification failed (this is an indication
936 of af a transfer error, a program error or tampering with the message).
937 @command{gpgsm} issues one of these status codes sequences:
938   @table @code
939   @item  @code{BADSIG}
940   @item  @code{GOODSIG}, @code{VALIDSIG} @code{TRUST_NEVER}
941   @end table
942
943 @item Error verifying a signature
944 For some reason the signature could not be verified, i.e. it can't be
945 decided whether the signature is valid or invalid.  A common reason for
946 this is a missing certificate.
947
948 @end table
949
950
951 @c *******************************************
952 @c ***************           *****************
953 @c ***************  ASSSUAN  *****************
954 @c ***************           *****************
955 @c *******************************************
956 @manpause
957 @node GPGSM Protocol
958 @section The Protocol the Server Mode Uses.
959
960 Description of the protocol used to access @command{GPGSM}.
961 @command{GPGSM} does implement the Assuan protocol and in addition
962 provides a regular command line interface which exhibits a full client
963 to this protocol (but uses internal linking).  To start
964 @command{gpgsm} as a server the command line the option
965 @code{--server} must be used.  Additional options are provided to
966 select the communication method (i.e. the name of the socket).
967
968 We assume that the connection has already been established; see the
969 Assuan manual for details.
970
971 @menu
972 * GPGSM ENCRYPT::         Encrypting a message.
973 * GPGSM DECRYPT::         Decrypting a message.
974 * GPGSM SIGN::            Signing a message.
975 * GPGSM VERIFY::          Verifying a message.
976 * GPGSM GENKEY::          Generating a key.
977 * GPGSM LISTKEYS::        List available keys.
978 * GPGSM EXPORT::          Export certificates.
979 * GPGSM IMPORT::          Import certificates.
980 * GPGSM DELETE::          Delete certificates.
981 * GPGSM GETINFO::         Information about the process
982 @end menu
983
984
985 @node GPGSM ENCRYPT
986 @subsection Encrypting a Message
987
988 Before encryption can be done the recipient must be set using the
989 command:
990
991 @example
992   RECIPIENT @var{userID}
993 @end example
994
995 Set the recipient for the encryption.  @var{userID} should be the
996 internal representation of the key; the server may accept any other way
997 of specification.  If this is a valid and trusted recipient the server
998 does respond with OK, otherwise the return is an ERR with the reason why
999 the recipient can't be used, the encryption will then not be done for
1000 this recipient.  If the policy is not to encrypt at all if not all
1001 recipients are valid, the client has to take care of this.  All
1002 @code{RECIPIENT} commands are cumulative until a @code{RESET} or an
1003 successful @code{ENCRYPT} command.
1004
1005 @example
1006   INPUT FD[=@var{n}] [--armor|--base64|--binary]
1007 @end example
1008
1009 Set the file descriptor for the message to be encrypted to @var{n}.
1010 Obviously the pipe must be open at that point, the server establishes
1011 its own end.  If the server returns an error the client should consider
1012 this session failed.  If @var{n} is not given, this commands uses the
1013 last file descriptor passed to the application.
1014 @xref{fun-assuan_sendfd, ,the assuan_sendfd function,assuan,the Libassuan
1015 manual}, on how to do descriptor passing.
1016
1017 The @code{--armor} option may be used to advice the server that the
1018 input data is in @acronym{PEM} format, @code{--base64} advices that a
1019 raw base-64 encoding is used, @code{--binary} advices of raw binary
1020 input (@acronym{BER}).  If none of these options is used, the server
1021 tries to figure out the used encoding, but this may not always be
1022 correct.
1023
1024 @example
1025   OUTPUT FD[=@var{n}] [--armor|--base64]
1026 @end example
1027
1028 Set the file descriptor to be used for the output (i.e. the encrypted
1029 message). Obviously the pipe must be open at that point, the server
1030 establishes its own end.  If the server returns an error he client
1031 should consider this session failed.
1032
1033 The option armor encodes the output in @acronym{PEM} format, the
1034 @code{--base64} option applies just a base 64 encoding.  No option
1035 creates binary output (@acronym{BER}).
1036   
1037 The actual encryption is done using the command
1038
1039 @example
1040   ENCRYPT 
1041 @end example
1042
1043 It takes the plaintext from the @code{INPUT} command, writes to the
1044 ciphertext to the file descriptor set with the @code{OUTPUT} command,
1045 take the recipients from all the recipients set so far.  If this command
1046 fails the clients should try to delete all output currently done or
1047 otherwise mark it as invalid.  @command{GPGSM} does ensure that there won't be any
1048 security problem with leftover data on the output in this case.
1049
1050 This command should in general not fail, as all necessary checks have
1051 been done while setting the recipients.  The input and output pipes are
1052 closed.
1053
1054
1055 @node GPGSM DECRYPT
1056 @subsection Decrypting a message
1057
1058 Input and output FDs are set the same way as in encryption, but
1059 @code{INPUT} refers to the ciphertext and output to the plaintext. There
1060 is no need to set recipients.  @command{GPGSM} automatically strips any
1061 @acronym{S/MIME} headers from the input, so it is valid to pass an
1062 entire MIME part to the INPUT pipe.
1063
1064 The encryption is done by using the command
1065
1066 @example
1067   DECRYPT
1068 @end example
1069
1070 It performs the decrypt operation after doing some check on the internal
1071 state. (e.g. that all needed data has been set).  Because it utilizes
1072 the GPG-Agent for the session key decryption, there is no need to ask
1073 the client for a protecting passphrase - GpgAgent takes care of this by
1074 requesting this from the user.
1075
1076
1077 @node GPGSM SIGN
1078 @subsection Signing a Message
1079
1080 Signing is usually done with these commands:
1081
1082 @example
1083   INPUT FD[=@var{n}] [--armor|--base64|--binary]
1084 @end example
1085
1086 This tells @command{GPGSM} to read the data to sign from file descriptor @var{n}.
1087
1088 @example
1089   OUTPUT FD[=@var{m}] [--armor|--base64]
1090 @end example
1091
1092 Write the output to file descriptor @var{m}.  If a detached signature is
1093 requested, only the signature is written.
1094
1095 @example
1096   SIGN [--detached] 
1097 @end example
1098
1099 Sign the data set with the INPUT command and write it to the sink set by
1100 OUTPUT.  With @code{--detached}, a detached signature is created
1101 (surprise).
1102
1103 The key used for signing is the default one or the one specified in
1104 the configuration file.  To get finer control over the keys, it is
1105 possible to use the command
1106
1107 @example
1108   SIGNER @var{userID}
1109 @end example
1110
1111 to the signer's key.  @var{userID} should be the
1112 internal representation of the key; the server may accept any other way
1113 of specification.  If this is a valid and trusted recipient the server
1114 does respond with OK, otherwise the return is an ERR with the reason why
1115 the key can't be used, the signature will then not be created using
1116 this key.  If the policy is not to sign at all if not all
1117 keys are valid, the client has to take care of this.  All
1118 @code{SIGNER} commands are cumulative until a @code{RESET} is done.
1119 Note that a @code{SIGN} does not reset this list of signers which is in
1120 contrats to the @code{RECIPIENT} command.
1121
1122
1123 @node GPGSM VERIFY
1124 @subsection Verifying a Message
1125
1126 To verify a mesage the command:
1127
1128 @example
1129   VERIFY
1130 @end example
1131
1132 is used. It does a verify operation on the message send to the input FD.
1133 The result is written out using status lines.  If an output FD was
1134 given, the signed text will be written to that.  If the signature is a
1135 detached one, the server will inquire about the signed material and the
1136 client must provide it.
1137
1138 @node GPGSM GENKEY
1139 @subsection Generating a Key
1140
1141 This is used to generate a new keypair, store the secret part in the
1142 @acronym{PSE} and the public key in the key database.  We will probably
1143 add optional commands to allow the client to select whether a hardware
1144 token is used to store the key.  Configuration options to
1145 @command{GPGSM} can be used to restrict the use of this command.
1146
1147 @example
1148   GENKEY 
1149 @end example
1150
1151 @command{GPGSM} checks whether this command is allowed and then does an
1152 INQUIRY to get the key parameters, the client should then send the
1153 key parameters in the native format:
1154
1155 @example
1156     S: INQUIRE KEY_PARAM native
1157     C: D foo:fgfgfg
1158     C: D bar
1159     C: END
1160 @end example    
1161
1162 Please note that the server may send Status info lines while reading the
1163 data lines from the client.  After this the key generation takes place
1164 and the server eventually does send an ERR or OK response.  Status lines
1165 may be issued as a progress indicator.
1166
1167
1168 @node GPGSM LISTKEYS
1169 @subsection List available keys
1170
1171 To list the keys in the internal database or using an external key
1172 provider, the command:
1173
1174 @example
1175   LISTKEYS  @var{pattern}
1176 @end example
1177
1178 is used.  To allow multiple patterns (which are ORed during the search)
1179 quoting is required: Spaces are to be translated into "+" or into "%20";
1180 in turn this requires that the usual escape quoting rules are done.
1181
1182 @example
1183   LISTSECRETKEYS @var{pattern}
1184 @end example
1185
1186 Lists only the keys where a secret key is available.
1187
1188 The list commands  commands are affected by the option
1189
1190 @example
1191   OPTION list-mode=@var{mode}
1192 @end example
1193
1194 where mode may be:
1195 @table @code
1196 @item 0 
1197 Use default (which is usually the same as 1).
1198 @item 1
1199 List only the internal keys.
1200 @item 2
1201 List only the external keys.
1202 @item 3
1203 List internal and external keys.
1204 @end table
1205
1206 Note that options are valid for the entire session.
1207     
1208
1209 @node GPGSM EXPORT
1210 @subsection Export certificates
1211
1212 To export certificate from the internal key database the command:
1213
1214 @example
1215   EXPORT [--data [--armor] [--base64]] [--] @var{pattern}
1216 @end example
1217
1218 is used.  To allow multiple patterns (which are ORed) quoting is
1219 required: Spaces are to be translated into "+" or into "%20"; in turn
1220 this requires that the usual escape quoting rules are done.
1221
1222 If the @option{--data} option has not been given, the format of the
1223 output depends on what was set with the OUTPUT command.  When using
1224 @acronym{PEM} encoding a few informational lines are prepended.
1225
1226 If the @option{--data} has been given, a target set via OUTPUT is
1227 ignored and the data is returned inline using standard
1228 @code{D}-lines. This avoids the need for an extra file descriptor.  In
1229 this case the options @option{--armor} and @option{--base64} may be used
1230 in the same way as with the OUTPUT command.
1231
1232
1233 @node GPGSM IMPORT
1234 @subsection Import certificates
1235
1236 To import certificates into the internal key database, the command
1237
1238 @example
1239   IMPORT [--re-import]
1240 @end example
1241
1242 is used.  The data is expected on the file descriptor set with the
1243 @code{INPUT} command.  Certain checks are performed on the
1244 certificate.  Note that the code will also handle PKCS#12 files and
1245 import private keys; a helper program is used for that.
1246
1247 With the option @option{--re-import} the input data is expected to a be
1248 a linefeed separated list of fingerprints.  The command will re-import
1249 the corresponding certificates; that is they are made permanent by
1250 removing their ephemeral flag.
1251
1252
1253 @node GPGSM DELETE
1254 @subsection Delete certificates
1255
1256 To delete a certificate the command
1257
1258 @example
1259   DELKEYS @var{pattern}
1260 @end example
1261
1262 is used.  To allow multiple patterns (which are ORed) quoting is
1263 required: Spaces are to be translated into "+" or into "%20"; in turn
1264 this requires that the usual escape quoting rules are done.
1265
1266 The certificates must be specified unambiguously otherwise an error is
1267 returned.
1268
1269 @node GPGSM GETINFO
1270 @subsection  Return information about the process
1271
1272 This is a multipurpose function to return a variety of information.
1273
1274 @example
1275 GETINFO @var{what}
1276 @end example
1277
1278 The value of @var{what} specifies the kind of information returned:
1279 @table @code
1280 @item version
1281 Return the version of the program.
1282 @item pid
1283 Return the process id of the process.
1284 @item agent-check
1285 Return success if the agent is running.
1286 @item cmd_has_option @var{cmd} @var{opt}
1287 Return success if the command @var{cmd} implements the option @var{opt}.
1288 The leading two dashes usually used with @var{opt} shall not be given.
1289 @end table
1290
1291 @mansect see also
1292 @ifset isman
1293 @command{gpg2}(1), 
1294 @command{gpg-agent}(1)
1295 @end ifset
1296 @include see-also-note.texi