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