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