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