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