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