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