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