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