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