Fixed bug 842 (segv in gpgconf)
[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 opton 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
417 @item --validation-model @var{name}
418 @opindex validation-model
419 This option changes the default validation model.  The only possible
420 values are "shell" (which is the default) and "chain" which forces the
421 use of the chain model.  The chain model is also used if an option in
422 the @file{trustlist.txt} or an attribute of the certificate requests it.
423 However the standard model (shell) is in that case always tried first.
424
425
426
427 @end table
428
429 @c *******************************************
430 @c ***********  INPUT AND OUTPUT  ************
431 @c *******************************************
432 @node Input and Output
433 @subsection Input and Output
434
435 @table @gnupgtabopt
436 @item --armor
437 @itemx -a
438 @opindex armor
439 @opindex -a
440 Create PEM encoded output.  Default is binary output. 
441
442 @item --base64 
443 @opindex base64
444 Create Base-64 encoded output; i.e. PEM without the header lines.
445
446 @item --assume-armor
447 @opindex assume-armor
448 Assume the input data is PEM encoded.  Default is to autodetect the
449 encoding but this is may fail.
450
451 @item --assume-base64
452 @opindex assume-base64
453 Assume the input data is plain base-64 encoded.
454
455 @item --assume-binary
456 @opindex assume-binary
457 Assume the input data is binary encoded.
458
459 @anchor{option --p12-charset}
460 @item --p12-charset @var{name}
461 @opindex p12-charset
462 @command{gpgsm} uses the UTF-8 encoding when encoding passphrases for
463 PKCS#12 files.  This option may be used to force the passphrase to be
464 encoded in the specified encoding @var{name}.  This is useful if the
465 application used to import the key uses a different encoding and thus
466 won't be able to import a file generated by @command{gpgsm}.  Commonly
467 used values for @var{name} are @code{Latin1} and @code{CP850}.  Note
468 that @command{gpgsm} itself automagically imports any file with a
469 passphrase encoded to the most commonly used encodings.
470
471
472 @item --default-key @var{user_id}
473 @opindex default-key
474 Use @var{user_id} as the standard key for signing.  This key is used if
475 no other key has been defined as a signing key.  Note, that the first
476 @option{--local-users} option also sets this key if it has not yet been
477 set; however @option{--default-key} always overrides this.
478
479
480 @item --local-user @var{user_id}
481 @item -u @var{user_id}
482 @opindex local-user
483 @opindex -u
484 Set the user(s) to be used for signing.  The default is the first
485 secret key found in the database.
486
487
488 @item --recipient @var{name}
489 @itemx -r
490 @opindex recipient
491 Encrypt to the user id @var{name}.  There are several ways a user id
492 may be given (@pxref{how-to-specify-a-user-id}).
493
494
495 @item --output @var{file}
496 @itemx -o @var{file}
497 @opindex output
498 Write output to @var{file}.  The default is to write it to stdout.
499
500
501 @item --with-key-data
502 @opindex with-key-data
503 Displays extra information with the @code{--list-keys} commands.  Especially
504 a line tagged @code{grp} is printed which tells you the keygrip of a
505 key.  This string is for example used as the file name of the
506 secret key.
507
508 @item --with-validation
509 @opindex with-validation
510 When doing a key listing, do a full validation check for each key and
511 print the result.  This is usually a slow operation because it
512 requires a CRL lookup and other operations. 
513
514 When used along with --import, a validation of the certificate to
515 import is done and only imported if it succeeds the test.  Note that
516 this does not affect an already available cwertificate in the DB.
517 This option is therefore useful to simply verify a certificate.
518
519
520 @item --with-md5-fingerprint
521 For standard key listings, also print the MD5 fingerprint of the
522 certificate.
523
524 @end table
525
526 @c *******************************************
527 @c *************  CMS OPTIONS  ***************
528 @c *******************************************
529 @node CMS Options
530 @subsection How to change how the CMS is created.
531
532 @table @gnupgtabopt
533 @item --include-certs @var{n}
534 @opindex include-certs
535 Using @var{n} of -2 includes all certificate except for the root cert,
536 -1 includes all certs, 0 does not include any certs, 1 includes only
537 the signers cert (this is the default) and all other positive
538 values include up to @var{n} certificates starting with the signer cert.
539
540
541 @item --cipher-algo @var{oid}
542 @opindex cipher-algo
543 Use the cipher algorithm with the ASN.1 object identifier @var{oid} for
544 encryption.  For convenience the strings @code{3DES}, @code{AES} and
545 @code{AES256} may be used instead of their OIDs.  The default is
546 @code{3DES} (1.2.840.113549.3.7).
547   
548 @end table
549
550
551
552 @c *******************************************
553 @c ********  ESOTERIC OPTIONS  ***************
554 @c *******************************************
555 @node Esoteric Options
556 @subsection Doing things one usually don't want to do.
557
558
559 @table @gnupgtabopt
560
561 @item --faked-system-time @var{epoch}
562 @opindex faked-system-time
563 This option is only useful for testing; it sets the system time back or
564 forth to @var{epoch} which is the number of seconds elapsed since the year
565 1970.  Alternativly @var{epoch} may be given as a full ISO time string
566 (e.g. "20070924T154812").
567
568 @item --with-ephemeral-keys
569 @opindex with-ephemeral-keys
570 Include ephemeral flagged keys in the output of key listings.
571
572 @item --debug-level @var{level}
573 @opindex debug-level
574 Select the debug level for investigating problems. @var{level} may be
575 one of:
576
577 @table @code
578 @item none
579 no debugging at all.
580 @item basic  
581 some basic debug messages
582 @item advanced
583 more verbose debug messages
584 @item expert
585 even more detailed messages
586 @item guru
587 all of the debug messages you can get
588 @end table
589
590 How these messages are mapped to the actual debugging flags is not
591 specified and may change with newer releaes of this program. They are
592 however carefully selected to best aid in debugging.
593
594 @item --debug @var{flags}
595 @opindex debug
596 This option is only useful for debugging and the behaviour may change
597 at any time without notice; using @code{--debug-levels} is the
598 preferred method to select the debug verbosity.  FLAGS are bit encoded
599 and may be given in usual C-Syntax. The currently defined bits are:
600
601 @table @code
602 @item 0  (1)
603 X.509 or OpenPGP protocol related data
604 @item 1  (2)  
605 values of big number integers 
606 @item 2  (4)
607 low level crypto operations
608 @item 5  (32)
609 memory allocation
610 @item 6  (64)
611 caching
612 @item 7  (128)
613 show memory statistics.
614 @item 9  (512)
615 write hashed data to files named @code{dbgmd-000*}
616 @item 10 (1024)
617 trace Assuan protocol
618 @end table
619
620 Note, that all flags set using this option may get overriden by
621 @code{--debug-level}.
622
623 @item --debug-all
624 @opindex debug-all
625 Same as @code{--debug=0xffffffff}
626
627 @item --debug-allow-core-dump
628 @opindex debug-allow-core-dump
629 Usually @command{gpgsm} tries to avoid dumping core by well written code and by
630 disabling core dumps for security reasons.  However, bugs are pretty
631 durable beasts and to squash them it is sometimes useful to have a core
632 dump.  This option enables core dumps unless the Bad Thing happened
633 before the option parsing.
634
635 @item --debug-no-chain-validation
636 @opindex debug-no-chain-validation
637 This is actually not a debugging option but only useful as such.  It
638 lets @command{gpgsm} bypass all certificate chain validation checks.
639
640 @item --debug-ignore-expiration
641 @opindex debug-ignore-expiration
642 This is actually not a debugging option but only useful as such.  It
643 lets @command{gpgsm} ignore all notAfter dates, this is used by the regresssion
644 tests.
645
646 @item --fixed-passphrase @var{string}
647 @opindex fixed-passphrase
648 Supply the passphrase @var{string} to the gpg-protect-tool.  This
649 option is only useful for the regression tests included with this
650 package and may be revised or removed at any time without notice.
651
652 @end table
653
654 All the long options may also be given in the configuration file after
655 stripping off the two leading dashes.
656
657 @c *******************************************
658 @c ***************            ****************
659 @c ***************  USER ID   ****************
660 @c ***************            ****************
661 @c *******************************************
662 @mansect how to specify a user id
663 @ifset isman
664 @include specify-user-id.texi
665 @end ifset
666
667 @c *******************************************
668 @c ***************            ****************
669 @c ***************   FILES    ****************
670 @c ***************            ****************
671 @c *******************************************
672 @mansect files
673 @node GPGSM Configuration
674 @section Configuration files
675
676 There are a few configuration files to control certain aspects of
677 @command{gpgsm}'s operation. Unless noted, they are expected in the
678 current home directory (@pxref{option --homedir}).
679
680 @table @file
681
682 @item gpgsm.conf
683 @cindex gpgsm.conf
684 This is the standard configuration file read by @command{gpgsm} on
685 startup.  It may contain any valid long option; the leading two dashes
686 may not be entered and the option may not be abbreviated.  This default
687 name may be changed on the command line (@pxref{option
688   --options}).
689
690 @item policies.txt
691 @cindex policies.txt
692 This is a list of allowed CA policies.  This file should list the
693 object identifiers of the policies line by line.  Empty lines and
694 lines starting with a hash mark are ignored.  Policies missing in this
695 file and not marked as critical in the certificate will print only a
696 warning; certificates with policies marked as critical and not listed
697 in this file will fail the signature verification.
698
699 For example, to allow only the policy 2.289.9.9, the file should look
700 like this:
701
702 @c man:.RS
703 @example
704 # Allowed policies
705 2.289.9.9  
706 @end example
707 @c man:.RE
708
709 @item qualified.txt
710 @cindex qualified.txt
711 This is the list of root certificates used for qualified certificates.
712 They are defined as certificates capable of creating legally binding
713 signatures in the same way as handwritten signatures are.  Comments
714 start with a hash mark and empty lines are ignored.  Lines do have a
715 length limit but this is not a serious limitation as the format of the
716 entries is fixed and checked by gpgsm: A non-comment line starts with
717 optional white spaces, followed by exactly 40 hex character, white space
718 and a lowercased 2 letter country code.  Additional data delimited with
719 by a white space is current ignored but might late be used for other
720 purposes.
721
722 Note that even if a certificate is listed in this file, this does not
723 mean that thecertificate is trusted; in general the certificates listed
724 in this file need to be listed also in @file{trustlist.txt}.
725
726 This is a global file an installed in the data directory
727 (e.g. @file{/usr/share/gnupg/qualified.txt}).  GnuPG installs a suitable
728 file with root certificates as used in Germany.  As new Root-CA
729 certificates may be issued over time, these entries may need to be
730 updated; new distributions of this software should come with an updated
731 list but it is still the responsibility of the Administrator to check
732 that this list is correct.
733
734 Everytime @command{gpgsm} uses a certificate for signing or verification
735 this file will be consulted to check whether the certificate under
736 question has ultimately been issued by one of these CAs.  If this is the
737 case the user will be informed that the verified signature represents a
738 legally binding (``qualified'') signature.  When creating a signature
739 using such a certificate an extra prompt will be issued to let the user
740 confirm that such a legally binding signature shall really be created.
741
742 Because this software has not yet been approved for use with such
743 certificates, appropriate notices will be shown to indicate this fact.
744
745 @end table
746
747 @c man:.RE
748 Note that on larger installations, it is useful to put predefined files
749 into the directory @file{/etc/skel/.gnupg/} so that newly created users
750 start up with a working configuration.  For existing users the a small
751 helper script is provided to create these files (@pxref{addgnupghome}).
752
753 For internal purposes gpgsm creates and maintaines a few other files;
754 They all live in in the current home directory (@pxref{option
755 --homedir}).  Only @command{gpgsm} may modify these files.
756
757
758 @table @file
759 @item pubring.kbx
760 @cindex pubring.kbx
761 This a database file storing the certificates as well as meta
762 information.  For debugging purposes the tool @command{kbxutil} may be
763 used to show the internal structure of this file.
764       
765 @item random_seed
766 @cindex random_seed
767 This content of this file is used to maintain the internal state of the
768 random number generator accross invocations.  The same file is used by
769 other programs of this software too.
770
771 @item S.gpg-agent
772 @cindex S.gpg-agent
773 If this file exists and the environment variable @env{GPG_AGENT_INFO} is
774 not set, @command{gpgsm} will first try to connect to this socket for
775 accessing @command{gpg-agent} before starting a new @command{gpg-agent}
776 instance.  Under Windows this socket (which in reality be a plain file
777 describing a regular TCP litening port) is the standard way of
778 connecting the @command{gpg-agent}.
779
780 @end table
781
782
783 @c *******************************************
784 @c ***************            ****************
785 @c ***************  EXAMPLES  ****************
786 @c ***************            ****************
787 @c *******************************************
788 @mansect examples
789 @node GPGSM Examples
790 @section Examples
791
792 @example
793 $ gpgsm -er goo@@bar.net <plaintext >ciphertext
794 @end example
795
796
797 @c man end
798
799
800 @c *******************************************
801 @c ***************              **************
802 @c ***************  UNATTENDED  **************
803 @c ***************              **************
804 @c *******************************************
805 @node Unattended Usage
806 @section Unattended Usage
807
808 @command{gpgsm} is often used as a backend engine by other software.  To help
809 with this a machine interface has been defined to have an unambiguous
810 way to do this.  This is most likely used with the @code{--server} command
811 but may also be used in the standard operation mode by using the
812 @code{--status-fd} option.
813
814 @menu
815 * Automated signature checking::  Automated signature checking.
816 @end menu
817
818 @node Automated signature checking,,,Unattended Usage
819 @section Automated signature checking
820
821 It is very important to understand the semantics used with signature
822 verification.  Checking a signature is not as simple as it may sound and
823 so the ooperation si a bit complicated.  In mosted cases it is required
824 to look at several status lines.  Here is a table of all cases a signed
825 message may have:
826
827 @table @asis
828 @item The signature is valid
829 This does mean that the signature has been successfully verified, the
830 certificates are all sane.  However there are two subcases with
831 important information:  One of the certificates may have expired or a
832 signature of a message itself as expired.  It is a sound practise to
833 consider such a signature still as valid but additional information
834 should be displayed.  Depending on the subcase @command{gpgsm} will issue
835 these status codes:
836   @table @asis 
837   @item signature valid and nothing did expire
838   @code{GOODSIG}, @code{VALIDSIG}, @code{TRUST_FULLY}
839   @item signature valid but at least one certificate has expired
840   @code{EXPKEYSIG}, @code{VALIDSIG}, @code{TRUST_FULLY}
841   @item signature valid but expired
842   @code{EXPSIG}, @code{VALIDSIG}, @code{TRUST_FULLY}
843   Note, that this case is currently not implemented.
844   @end table
845
846 @item The signature is invalid
847 This means that the signature verification failed (this is an indication
848 of af a transfer error, a programm error or tampering with the message).
849 @command{gpgsm} issues one of these status codes sequences:
850   @table @code
851   @item  @code{BADSIG}
852   @item  @code{GOODSIG}, @code{VALIDSIG} @code{TRUST_NEVER}
853   @end table
854
855 @item Error verifying a signature
856 For some reason the signature could not be verified, i.e. it can't be
857 decided whether the signature is valid or invalid.  A common reason for
858 this is a missing certificate.
859
860 @end table
861
862
863 @c *******************************************
864 @c ***************           *****************
865 @c ***************  ASSSUAN  *****************
866 @c ***************           *****************
867 @c *******************************************
868 @manpause
869 @node GPGSM Protocol
870 @section The Protocol the Server Mode Uses.
871
872 Description of the protocol used to access @command{GPGSM}.
873 @command{GPGSM} does implement the Assuan protocol and in addition
874 provides a regular command line interface which exhibits a full client
875 to this protocol (but uses internal linking).  To start
876 @command{gpgsm} as a server the command line the option
877 @code{--server} must be used.  Additional options are provided to
878 select the communication method (i.e. the name of the socket).
879
880 We assume that the connection has already been established; see the
881 Assuan manual for details.
882
883 @menu
884 * GPGSM ENCRYPT::         Encrypting a message.
885 * GPGSM DECRYPT::         Decrypting a message.
886 * GPGSM SIGN::            Signing a message.
887 * GPGSM VERIFY::          Verifying a message.
888 * GPGSM GENKEY::          Generating a key.
889 * GPGSM LISTKEYS::        List available keys.
890 * GPGSM EXPORT::          Export certificates.
891 * GPGSM IMPORT::          Import certificates.
892 * GPGSM DELETE::          Delete certificates.
893 @end menu
894
895
896 @node GPGSM ENCRYPT
897 @subsection Encrypting a Message
898
899 Before encrytion can be done the recipient must be set using the
900 command:
901
902 @example
903   RECIPIENT @var{userID}
904 @end example
905
906 Set the recipient for the encryption.  @var{userID} should be the
907 internal representation of the key; the server may accept any other way
908 of specification.  If this is a valid and trusted recipient the server
909 does respond with OK, otherwise the return is an ERR with the reason why
910 the recipient can't be used, the encryption will then not be done for
911 this recipient.  If the policy is not to encrypt at all if not all
912 recipients are valid, the client has to take care of this.  All
913 @code{RECIPIENT} commands are cumulative until a @code{RESET} or an
914 successful @code{ENCRYPT} command.
915
916 @example
917   INPUT FD[=@var{n}] [--armor|--base64|--binary]
918 @end example
919
920 Set the file descriptor for the message to be encrypted to @var{n}.
921 Obviously the pipe must be open at that point, the server establishes
922 its own end.  If the server returns an error the client should consider
923 this session failed.  If @var{n} is not given, this commands uses the
924 last file descriptor passed to the application.
925 @xref{fun-assuan_sendfd, ,the assuan_sendfd function,assuan,the Libassuan
926 manual}, on how to do descriptor passing.
927
928 The @code{--armor} option may be used to advice the server that the
929 input data is in @acronym{PEM} format, @code{--base64} advices that a
930 raw base-64 encoding is used, @code{--binary} advices of raw binary
931 input (@acronym{BER}).  If none of these options is used, the server
932 tries to figure out the used encoding, but this may not always be
933 correct.
934
935 @example
936   OUTPUT FD[=@var{n}] [--armor|--base64]
937 @end example
938
939 Set the file descriptor to be used for the output (i.e. the encrypted
940 message). Obviously the pipe must be open at that point, the server
941 establishes its own end.  If the server returns an error he client
942 should consider this session failed.
943
944 The option armor encodes the output in @acronym{PEM} format, the
945 @code{--base64} option applies just a base 64 encoding.  No option
946 creates binary output (@acronym{BER}).
947   
948 The actual encryption is done using the command
949
950 @example
951   ENCRYPT 
952 @end example
953
954 It takes the plaintext from the @code{INPUT} command, writes to the
955 ciphertext to the file descriptor set with the @code{OUTPUT} command,
956 take the recipients from all the recipients set so far.  If this command
957 fails the clients should try to delete all output currently done or
958 otherwise mark it as invalid.  @command{GPGSM} does ensure that there won't be any
959 security problem with leftover data on the output in this case.
960
961 This command should in general not fail, as all necessary checks have
962 been done while setting the recipients.  The input and output pipes are
963 closed.
964
965
966 @node GPGSM DECRYPT
967 @subsection Decrypting a message
968
969 Input and output FDs are set the same way as in encryption, but
970 @code{INPUT} refers to the ciphertext and output to the plaintext. There
971 is no need to set recipients.  @command{GPGSM} automatically strips any
972 @acronym{S/MIME} headers from the input, so it is valid to pass an
973 entire MIME part to the INPUT pipe.
974
975 The encryption is done by using the command
976
977 @example
978   DECRYPT
979 @end example
980
981 It performs the decrypt operation after doing some check on the internal
982 state. (e.g. that all needed data has been set).  Because it utilizes
983 the GPG-Agent for the session key decryption, there is no need to ask
984 the client for a protecting passphrase - GpgAgent takes care of this by
985 requesting this from the user.
986
987
988 @node GPGSM SIGN
989 @subsection Signing a Message
990
991 Signing is usually done with these commands:
992
993 @example
994   INPUT FD[=@var{n}] [--armor|--base64|--binary]
995 @end example
996
997 This tells @command{GPGSM} to read the data to sign from file descriptor @var{n}.
998
999 @example
1000   OUTPUT FD[=@var{m}] [--armor|--base64]
1001 @end example
1002
1003 Write the output to file descriptor @var{m}.  If a detached signature is
1004 requested, only the signature is written.
1005
1006 @example
1007   SIGN [--detached] 
1008 @end example
1009
1010 Sign the data set with the INPUT command and write it to the sink set by
1011 OUTPUT.  With @code{--detached}, a detached signature is created
1012 (surprise).
1013
1014 The key used for signining is the default one or the one specified in
1015 the configuration file.  To get finer control over the keys, it is
1016 possible to use the command
1017
1018 @example
1019   SIGNER @var{userID}
1020 @end example
1021
1022 to the signer's key.  @var{userID} should be the
1023 internal representation of the key; the server may accept any other way
1024 of specification.  If this is a valid and trusted recipient the server
1025 does respond with OK, otherwise the return is an ERR with the reason why
1026 the key can't be used, the signature will then not be created using
1027 this key.  If the policy is not to sign at all if not all
1028 keys are valid, the client has to take care of this.  All
1029 @code{SIGNER} commands are cumulative until a @code{RESET} is done.
1030 Note that a @code{SIGN} does not reset this list of signers which is in
1031 contrats to the @code{RECIPIENT} command.
1032
1033
1034 @node GPGSM VERIFY
1035 @subsection Verifying a Message
1036
1037 To verify a mesage the command:
1038
1039 @example
1040   VERIFY
1041 @end example
1042
1043 is used. It does a verify operation on the message send to the input FD.
1044 The result is written out using status lines.  If an output FD was
1045 given, the signed text will be written to that.  If the signature is a
1046 detached one, the server will inquire about the signed material and the
1047 client must provide it.
1048
1049 @node GPGSM GENKEY
1050 @subsection Generating a Key
1051
1052 This is used to generate a new keypair, store the secret part in the
1053 @acronym{PSE} and the public key in the key database.  We will probably
1054 add optional commands to allow the client to select whether a hardware
1055 token is used to store the key.  Configuration options to
1056 @command{GPGSM} can be used to restrict the use of this command.
1057
1058 @example
1059   GENKEY 
1060 @end example
1061
1062 @command{GPGSM} checks whether this command is allowed and then does an
1063 INQUIRY to get the key parameters, the client should then send the
1064 key parameters in the native format:
1065
1066 @example
1067     S: INQUIRE KEY_PARAM native
1068     C: D foo:fgfgfg
1069     C: D bar
1070     C: END
1071 @end example    
1072
1073 Please note that the server may send Status info lines while reading the
1074 data lines from the client.  After this the key generation takes place
1075 and the server eventually does send an ERR or OK response.  Status lines
1076 may be issued as a progress indicator.
1077
1078
1079 @node GPGSM LISTKEYS
1080 @subsection List available keys
1081
1082 To list the keys in the internal database or using an external key
1083 provider, the command:
1084
1085 @example
1086   LISTKEYS  @var{pattern}
1087 @end example
1088
1089 is used.  To allow multiple patterns (which are ORed during the search)
1090 quoting is required: Spaces are to be translated into "+" or into "%20";
1091 in turn this requires that the usual escape quoting rules are done.
1092
1093 @example
1094   LISTSECRETKEYS @var{pattern}
1095 @end example
1096
1097 Lists only the keys where a secret key is available.
1098
1099 The list commands  commands are affected by the option
1100
1101 @example
1102   OPTION list-mode=@var{mode}
1103 @end example
1104
1105 where mode may be:
1106 @table @code
1107 @item 0 
1108 Use default (which is usually the same as 1).
1109 @item 1
1110 List only the internal keys.
1111 @item 2
1112 List only the external keys.
1113 @item 3
1114 List internal and external keys.
1115 @end table
1116
1117 Note that options are valid for the entire session.
1118     
1119
1120 @node GPGSM EXPORT
1121 @subsection Export certificates
1122
1123 To export certificate from the internal key database the command:
1124
1125 @example
1126   EXPORT [--data [--armor] [--base64]] [--] @var{pattern}
1127 @end example
1128
1129 is used.  To allow multiple patterns (which are ORed) quoting is
1130 required: Spaces are to be translated into "+" or into "%20"; in turn
1131 this requires that the usual escape quoting rules are done.
1132
1133 If the @option{--data} option has not been given, the format of the
1134 output depends on what was set with the OUTPUT command.  When using
1135 @acronym{PEM} encoding a few informational lines are prepended.
1136
1137 If the @option{--data} has been given, a target set via OUTPUT is
1138 ignored and the data is returned inline using standard
1139 @code{D}-lines. This avoids the need for an extra file descriptor.  In
1140 this case the options @option{--armor} and @option{--base64} may be used
1141 in the same way as with the OUTPUT command.
1142
1143
1144 @node GPGSM IMPORT
1145 @subsection Import certificates
1146
1147 To import certificates into the internal key database, the command
1148
1149 @example
1150   IMPORT
1151 @end example
1152
1153 is used.  The data is expected on the file descriptor set with the
1154 @code{INPUT} command.  Certain checks are performend on the
1155 certificate.  Note that the code will also handle PKCS\#12 files and
1156 import private keys; a helper program is used for that.
1157
1158
1159 @node GPGSM DELETE
1160 @subsection Delete certificates
1161
1162 To delete certificate the command
1163
1164 @example
1165   DELKEYS @var{pattern}
1166 @end example
1167
1168 is used.  To allow multiple patterns (which are ORed) quoting is
1169 required: Spaces are to be translated into "+" or into "%20"; in turn
1170 this requires that the usual escape quoting rules are done.
1171
1172 The certificates must be specified unambiguously otherwise an error is
1173 returned.
1174
1175
1176 @mansect see also
1177 @ifset isman
1178 @command{gpg2}(1), 
1179 @command{gpg-agent}(1)
1180 @end ifset
1181 @include see-also-note.texi