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