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