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