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