Described new options
[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 @sc{gpgsm} is a tool similar to @sc{gpg} to provide digital encryption
14 and signing servicesd on X.509 certificates and the CMS protocoll.  It
15 is mainly used as a backend for S/MIME mail processing.  @sc{gpgsm}
16 includes a full features certificate management and complies with all
17 rules defined for the German Sphinx project.
18
19 @c man end
20
21 @xref{Option Index}, for an index to GPGSM's commands and options.
22
23 @menu
24 * GPGSM Commands::        List of all commands.
25 * GPGSM Options::         List of all options.
26 * GPGSM Examples::        Some usage examples.
27
28 Developer information:
29 * Unattended Usage::      Using @sc{gpgsm} from other programs.
30 * GPGSM Protocol::        The protocol the server mode uses.
31 @end menu
32
33 @c man begin COMMANDS
34
35 @node GPGSM Commands
36 @section Commands
37
38 Commands are not distinguished from options execpt for the fact that
39 only one one command is allowed.
40
41 @menu
42 * General Commands::        Commands not specific to the functionality.
43 * Operational Commands::    Commands to select the type of operation.
44 * Certificate Management::  How to manage certificates.
45 @end menu
46
47 @node General Commands
48 @subsection Commands not specific to the function
49
50 @table @gnupgtabopt
51 @item --version
52 @opindex version
53 Print the program version and licensing information.  Not that you can
54 abbreviate this command.
55
56 @item --help, -h
57 @opindex help
58 Print a usage message summarizing the most usefule command-line options.
59 Not that you can abbreviate this command.
60
61 @item --dump-options
62 @opindex dump-options
63 Print a list of all available options and commands.  Not that you can
64 abbreviate this command.
65 @end table
66
67
68
69 @node Operational Commands
70 @subsection Commands to select the type of operation
71
72 @table @gnupgtabopt
73 @item --encrypt
74 @opindex encrypt
75 Perform an encryption.
76
77 @item --decrypt
78 @opindex decrypt
79 Perform a decryption; the type of input is automatically detmerined.  It
80 may either be in binary form or PEM encoded; automatic determination of
81 base-64 encoding is not done.
82
83 @item --sign
84 @opindex sign
85 Create a digital signature.  The key used is either the fist one found
86 in the keybox or thise set with the -u option
87
88 @item --verify
89 @opindex verify
90 Check a signature file for validity.  Depending on the arguments a
91 detached signatrue may also be checked.
92  
93 @item --server
94 @opindex server
95 Run in server mode and wait for commands on the @code{stdin}.
96
97 @item --call-dirmngr @var{command} [@var{args}]
98 @opindex call-dirmngr
99 Behave as a Dirmngr client issuing the request @var{command} with the
100 optional list of @var{args}.  The output of the Dirmngr is printed
101 stdout.  Please note that file names given as arguments should have an
102 absulte file name (i.e. commencing with @code{/} because they are
103 passed verbatim to the Dirmngr and the working directory of the
104 Dirmngr might not be the same as the one of this client.  Currently it
105 is not possible to pass data via stdin to the Dirmngr.  @var{command}
106 should not contain spaces.
107
108 This is command is required for certain maintaining tasks of the dirmngr
109 where a dirmngr must be able to call back to gpgsm.  See the Dirmngr
110 manual for details.
111
112 @item --call-protect-tool @var{arguments}
113 @opindex call-protect-tool
114 Certain maintenance operations are done by an external program call
115 @command{gpg-protect-tool}; this is usually not installed in a directory
116 listed in the PATH variable.  This command provides a simple wrapper to
117 access this tool.  @var{arguments} are passed verbatim to this command;
118 use @samp{--help} to get a list of supported operations. 
119
120
121 @end table
122
123
124 @node Certificate Management
125 @subsection How to manage the certificate and keys
126
127 @table @gnupgtabopt
128 @item --gen-key
129 @opindex gen-key
130 Generate a new key and a certificate request.
131
132 @item --list-keys
133 @opindex list-keys
134 List all available certificates stored in the local key database.
135
136 @item --list-secret-keys
137 @opindex list-secret-keys
138 List all available keys whenre a secret key is available.
139
140 @item --list-external-keys @var{pattern}
141 @opindex list-keys
142 List certificates matching @var{pattern} using an external server.  This
143 utilies the @code{dirmngr} service.  
144
145 @item --delete-keys @var{pattern}
146 @opindex delete-keys
147 Delete the keys matching @var{pattern}.
148
149 @item --export [@var{pattern}]
150 @opindex export
151 Export all certificates stored in the Keybox or those specified by the
152 optional @var{pattern}.  When using along with the @code{--armor} option
153 a few informational lines are prepended before each block.
154
155 @item --learn-card
156 @opindex learn-card
157 Read information about the private keys from the smartcard and import
158 the certificates from there.  This command utilizes the @sc{gpg-agent}
159 and in turn the @sc{scdaemon}.
160
161 @item --passwd @var{user_id}
162 @opindex passwd
163 Change the passphrase of the private key belonging to the certificate
164 specified as @var{user_id}.  Note, that changing the passphrase/PIN of a
165 smartcard is not yet supported.
166
167 @end table
168
169
170 @node GPGSM Options
171 @section Option Summary
172
173 GPGSM comes features a bunch ofoptions to control the exact behaviour
174 and to change the default configuration.
175
176 @menu 
177 * Configuration Options::   How to change the configuration.
178 * Certificate Options::     Certificate related options.
179 * Input and Output::        Input and Output.
180 * CMS Options::             How to change how the CMS is created.
181 * Esoteric Options::        Doing things one usually don't want to do.
182 @end menu
183
184 @c man begin OPTIONS
185
186 @node Configuration Options
187 @subsection How to change the configuration
188
189 These options are used to change the configuraton and are usually found
190 in the option file.
191
192 @table @gnupgtabopt
193
194 @item --options @var{file}
195 @opindex options
196 Reads configuration from @var{file} instead of from the default
197 per-user configuration file.  The default configuration file is named
198 @file{gpgsm.conf} and expected in the @file{.gnupg} directory directly
199 below the home directory of the user.
200
201 @item -v
202 @item --verbose
203 @opindex v
204 @opindex verbose
205 Outputs additional information while running.
206 You can increase the verbosity by giving several
207 verbose commands to @sc{gpgsm}, such as @samp{-vv}.
208
209 @item --policy-file @var{filename}
210 @opindex policy-file
211 Change the default name of the policy file to @var{filename}.
212
213 @item --agent-program @var{file}
214 @opindex agent-program
215 Specify an agent program to be used for secret key operations.  The
216 default value is the @file{/usr/local/bin/gpg-agent}.  This is only used
217 as a fallback when the envrionment variable @code{GPG_AGENT_INFO} is not
218 set or a running agent can't be connected.
219   
220 @item --dirmngr-program @var{file}
221 @opindex dirmnr-program
222 Specify a dirmngr program to be used for @acronym{CRL} checks.  The
223 default value is @file{/usr/sbin/dirmngr}.  This is only used as a
224 fallback when the environment variable @code{DIRMNGR_INFO} is not set or
225 a running dirmngr can't be connected.
226
227 @item --no-secmem-warning
228 @opindex no-secmem-warning
229 Don't print a warning when the so called "secure memory" can't be used.
230
231
232
233 @end table
234
235
236 @node Certificate Options
237 @subsection Certificate related options
238
239 @table @gnupgtabopt
240
241 @item  --enable-policy-checks
242 @itemx --disable-policy-checks
243 @opindex enable-policy-checks
244 @opindex disable-policy-checks
245 By default policy checks are enabled.  These options may be used to
246 change it.
247
248 @item  --enable-crl-checks
249 @itemx --disable-crl-checks
250 @opindex enable-crl-checks
251 @opindex disable-crl-checks
252 By default the @acronym{CRL} checks are enabled and the DirMngr is used
253 to check for revoked certificates.  The disable option is most useful
254 with an off-line network connection to suppress this check.
255
256 @item  --enable-ocsp
257 @itemx --disable-ocsp
258 @opindex enable-ocsp
259 @opindex disable-ocsp
260 Be default @acronym{OCSP} checks are disabled.  The enable opton may
261 be used to enable OCSP checks via Dirmngr.  If @acronym{CRL} checks
262 are also enabled, CRLs willbe used as a fallback if for some reason an
263 OCSP request won't succeed.
264
265 @end table
266
267 @node Input and Output
268 @subsection Input and Output
269
270 @table @gnupgtabopt
271 @item --armor
272 @itemx -a
273 @opindex armor
274 @opindex -a
275 Create PEM encoded output.  Default is binary output. 
276
277 @item --base64 
278 @opindex base64
279 Create Base-64 encoded output; i.e. PEM without the header lines.
280
281 @item --assume-armor
282 @opindex assume-armor
283 Assume the input data is PEM encoded.  Default is to autodetect the
284 encoding but this is may fail.
285
286 @item --assume-base64
287 @opindex assume-base64
288 Assume the input data is plain base-64 encoded.
289
290 @item --assume-binary
291 @opindex assume-binary
292 Assume the input data is binary encoded.
293
294 @item --local-user @var{user_id}
295 @item -u @var{user_id}
296 @opindex local-user
297 @opindex -u
298 Set the user(s) to be used for signing.  The default is the first
299 secret key found in the database.
300
301 @item --with-key-data
302 @opindex with-key-data
303 Displays extra information with the @code{--list-keys} commands.  Especially
304 a line tagged @code{grp} is printed which tells you the keygrip of a
305 key.  This string is for example used as the file name of the
306 secret key.
307
308 @item --with-validation
309 @opindex with-validation
310 When doing a key listing, do a full validation check for each key and
311 print the result.  This is usually a slow operation because it
312 requires a CRL lookup and other operations.
313
314 @item --with-md5-fingerprint
315 For standard key listings, also print the MD5 fingerprint of the
316 certificate.
317
318 @end table
319
320 @node CMS Options
321 @subsection How to change how the CMS is created.
322
323 @table @gnupgtabopt
324 @item --include-certs @var{n}
325 Using @var{n} of -2 includes all certificate except for the root cert,
326 -1 includes all certs, 0 does not include any certs, 1 includes only
327 the signers cert (this is the default) and all other positive
328 values include up to @var{n} certificates starting with the signer cert.
329   
330 @end table
331
332
333
334 @node Esoteric Options
335 @subsection Doing things one usually don't want todo.
336
337
338 @table @gnupgtabopt
339
340 @item --faked-system-time @var{epoch}
341 @opindex faked-system-time
342 This option is only useful for testing; it sets the system time back or
343 forth to @var{epoch} which is the number of seconds elapsed since the year
344 1970.
345
346 @item --debug-level @var{level}
347 @opindex debug-level
348 Select the debug level for investigating problems. @var{level} may be
349 one of:
350
351    @table @code
352    @item none
353    no debugging at all.
354    @item basic  
355    some basic debug messages
356    @item advanced
357    more verbose debug messages
358    @item expert
359    even more detailed messages
360    @item guru
361    all of the debug messages you can get
362    @end table
363
364 How these messages are mapped to the actual debugging flags is not
365 specified and may change with newer releaes of this program. They are
366 however carefully selected to best aid in debugging.
367
368 @item --debug @var{flags}
369 @opindex debug
370 This option is only useful for debugging and the behaviour may change
371 at any time without notice; using @code{--debug-levels} is the
372 preferred method to select the debug verbosity.  FLAGS are bit encoded
373 and may be given in usual C-Syntax. The currently defined bits are:
374
375    @table @code
376    @item 0  (1)
377    X.509 or OpenPGP protocol related data
378    @item 1  (2)  
379    values of big number integers 
380    @item 2  (4)
381    low level crypto operations
382    @item 5  (32)
383    memory allocation
384    @item 6  (64)
385    caching
386    @item 7  (128)
387    show memory statistics.
388    @item 9  (512)
389    write hashed data to files named @code{dbgmd-000*}
390    @item 10 (1024)
391    trace Assuan protocol
392    @end table
393
394 Note, that all flags set using this option may get overriden by
395 @code{--debug-level}.
396
397 @item --debug-all
398 @opindex debug-all
399 Same as @code{--debug=0xffffffff}
400
401 @item --debug-no-chain-validation
402 @opindex debug-no-chain-validation
403 This is actually not a debugging option but only useful as such.  It
404 lets gpgsm bypass all certificate chain validation checks.
405
406 @end table
407
408 All the long options may also be given in the configuration file after
409 stripping off the two leading dashes.
410
411
412
413 @c 
414 @c  Examples
415 @c
416 @node GPGSM Examples
417 @section Examples
418
419 @c man begin EXAMPLES
420
421 @example
422 $ gpgsm -er goo@@bar.net <plaintext >ciphertext
423 @end example
424
425 @c man end
426
427
428
429 @c ---------------------------------
430 @c    The machine interface
431 @c --------------------------------
432 @node Unattended Usage
433 @section Unattended Usage
434
435 @sc{gpgsm} is often used as a backend engine by other software.  To help
436 with this a machine interface has been defined to have an unambiguous
437 way to do this.  This is most likely used with the @code{--server} command
438 but may also be used in the standard operation mode by using the
439 @code{--status-fd} option.
440
441 @menu
442 * Automated signature checking::  Automated signature checking.
443 @end menu
444
445 @node Automated signature checking,,,Unattended Usage
446 @section Automated signature checking
447
448 It is very important to understand the semantics used with signature
449 verification.  Checking a signature is not as simple as it may sound and
450 so the ooperation si a bit complicated.  In mosted cases it is required
451 to look at several status lines.  Here is a table of all cases a signed
452 message may have:
453
454 @table @asis
455 @item The signature is valid
456 This does mean that the signature has been successfully verified, the
457 certificates are all sane.  However there are two subcases with
458 important information:  One of the certificates may have expired or a
459 signature of a message itself as expired.  It is a sound practise to
460 consider such a signature still as valid but additional information
461 should be displayed.  Depending on the subcase @sc{gpgsm} will issue
462 these status codes:
463   @table @asis 
464   @item signature valid and nothing did expire
465   @code{GOODSIG}, @code{VALIDSIG}, @code{TRUST_FULLY}
466   @item signature valid but at least one certificate has expired
467   @code{EXPKEYSIG}, @code{VALIDSIG}, @code{TRUST_FULLY}
468   @item signature valid but expired
469   @code{EXPSIG}, @code{VALIDSIG}, @code{TRUST_FULLY}
470   Note, that this case is currently not implemented.
471   @end table
472
473 @item The signature is invalid
474 This means that the signature verification failed (this is an indication
475 of af a transfer error, a programm error or tampering with the message).
476 @sc{gpgsm} issues one of these status codes sequences:
477   @table @code
478   @item  @code{BADSIG}
479   @item  @code{GOODSIG}, @code{VALIDSIG} @code{TRUST_NEVER}
480   @end table
481
482 @item Error verifying a signature
483 For some reason the signature could not be verified, i.e. it can't be
484 decided whether the signature is valid or invalid.  A common reason for
485 this is a missing certificate.
486
487 @end table
488
489
490 @c 
491 @c  Assuan Protocol
492 @c
493 @node GPGSM Protocol
494 @section The Protocol the Server Mode Uses.
495
496 Description of the protocol used to access GPGSM.  GPGSM does implement
497 the Assuan protocol and in addition provides a regular command line
498 interface which exhibits a full client to this protocol (but uses
499 internal linking).  To start gpgsm as a server the commandline "gpgsm
500 --server" must be used.  Additional options are provided to select the
501 communication method (i.e. the name of the socket).
502
503 We assume that the connection has already been established; see the
504 Assuan manual for details.
505
506 @menu
507 * GPGSM ENCRYPT::         Encrypting a message.
508 * GPGSM DECRYPT::         Decrypting a message.
509 * GPGSM SIGN::            Signing a message.
510 * GPGSM VERIFY::          Verifying a message.
511 * GPGSM GENKEY::          Generating a key.
512 * GPGSM LISTKEYS::        List available keys.
513 * GPGSM EXPORT::          Export certificates.
514 * GPGSM IMPORT::          Import certificates.
515 * GPGSM DELETE::          Delete certificates.
516 @end menu
517
518
519 @node GPGSM ENCRYPT
520 @subsection Encrypting a Message
521
522 Before encrytion can be done the recipient must be set using the
523 command:
524
525 @example
526   RECIPIENT @var{userID}
527 @end example
528
529 Set the recipient for the encryption.  @var{userID} should be the
530 internal representation of the key; the server may accept any other way
531 of specification.  If this is a valid and trusted recipient the server
532 does respond with OK, otherwise the return is an ERR with the reason why
533 the recipient can't be used, the encryption will then not be done for
534 this recipient.  If the policy is not to encrypt at all if not all
535 recipients are valid, the client has to take care of this.  All
536 @code{RECIPIENT} commands are cumulative until a @code{RESET} or an
537 successful @code{ENCRYPT} command.
538
539 @example
540   INPUT FD=@var{n} [--armor|--base64|--binary]
541 @end example
542
543 Set the file descriptor for the message to be encrypted to @var{n}.
544 Obviously the pipe must be open at that point, the server establishes
545 its own end.  If the server returns an error the client should consider
546 this session failed.
547
548 The @code{--armor} option may be used to advice the server that the
549 input data is in @acronym{PEM} format, @code{--base64} advices that a
550 raw base-64 encoding is used, @code{--binary} advices of raw binary
551 input (@acronym{BER}).  If none of these options is used, the server
552 tries to figure out the used encoding, but this may not always be
553 correct.
554
555 @example
556   OUTPUT FD=@var{n} [--armor|--base64]
557 @end example
558
559 Set the file descriptor to be used for the output (i.e. the encrypted
560 message). Obviously the pipe must be open at that point, the server
561 establishes its own end.  If the server returns an error he client
562 should consider this session failed.
563
564 The option armor encodes the output in @acronym{PEM} format, the
565 @code{--base64} option applies just a base 64 encoding.  No option
566 creates binary output (@acronym{BER}).
567   
568 The actual encryption is done using the command
569
570 @example
571   ENCRYPT 
572 @end example
573
574 It takes the plaintext from the @code{INPUT} command, writes to the
575 ciphertext to the file descriptor set with the @code{OUTPUT} command,
576 take the recipients from all the recipients set so far.  If this command
577 fails the clients should try to delete all output currently done or
578 otherwise mark it as invalid.  GPGSM does ensure that there won't be any
579 security problem with leftover data on the output in this case.
580
581 This command should in general not fail, as all necessary checks have
582 been done while setting the recipients.  The input and output pipes are
583 closed.
584
585
586 @node GPGSM DECRYPT
587 @subsection Decrypting a message
588
589 Input and output FDs are set the same way as in encryption, but
590 @code{INPUT} refers to the ciphertext and output to the plaintext. There
591 is no need to set recipients.  GPGSM automatically strips any
592 @acronym{S/MIME} headers from the input, so it is valid to pass an
593 entire MIME part to the INPUT pipe.
594
595 The encryption is done by using the command
596
597 @example
598   DECRYPT
599 @end example
600
601 It performs the decrypt operation after doing some check on the internal
602 state. (e.g. that all needed data has been set).  Because it utilizes
603 the GPG-Agent for the session key decryption, there is no need to ask
604 the client for a protecting passphrase - GpgAgent takes care of this by
605 requesting this from the user.
606
607
608 @node GPGSM SIGN
609 @subsection Signing a Message
610
611 Signing is usually done with these commands:
612
613 @example
614   INPUT FD=@var{n} [--armor|--base64|--binary]
615 @end example
616
617 This tells GPGSM to read the data to sign from file descriptor @var{n}.
618
619 @example
620   OUTPUT FD=@var{m} [--armor|--base64]
621 @end example
622
623 Write the output to file descriptor @var{m}.  If a detached signature is
624 requested, only the signature is written.
625
626 @example
627   SIGN [--detached] 
628 @end example
629
630 Sign the data set with the INPUT command and write it to the sink set by
631 OUTPUT.  With @code{--detached}, a detached signature is created
632 (surprise).
633
634 The key used for signining is the default one or the one specified in
635 the configuration file.  To get finer control over the keys, it is
636 possible to use the command
637
638 @example
639   SIGNER @var{userID}
640 @end example
641
642 to the signer's key.  @var{userID} should be the
643 internal representation of the key; the server may accept any other way
644 of specification.  If this is a valid and trusted recipient the server
645 does respond with OK, otherwise the return is an ERR with the reason why
646 the key can't be used, the signature will then not be created using
647 this key.  If the policy is not to sign at all if not all
648 keys are valid, the client has to take care of this.  All
649 @code{SIGNER} commands are cumulative until a @code{RESET} is done.
650 Note that a @code{SIGN} does not reset this list of signers which is in
651 contrats to the @code{RECIPIENT} command.
652
653
654 @node GPGSM VERIFY
655 @subsection Verifying a Message
656
657 To verify a mesage the command:
658
659 @example
660   VERIFY
661 @end example
662
663 is used. It does a verify operation on the message send to the input FD.
664 The result is written out using status lines.  If an output FD was
665 given, the signed text will be written to that.  If the signature is a
666 detached one, the server will inquire about the signed material and the
667 client must provide it.
668
669 @node GPGSM GENKEY
670 @subsection Generating a Key
671
672 This is used to generate a new keypair, store the secret part in the
673 @acronym{PSE} and the public key in the key database.  We will probably
674 add optional commands to allow the client to select whether a hardware
675 token is used to store the key.  Configuration options to GPGSM can be
676 used to restrict the use of this command.
677
678 @example
679   GENKEY 
680 @end example
681
682 GPGSM checks whether this command is allowed and then does an
683 INQUIRY to get the key parameters, the client should then send the
684 key parameters in the native format:
685
686 @example
687     S: INQUIRE KEY_PARAM native
688     C: D foo:fgfgfg
689     C: D bar
690     C: END
691 @end example    
692
693 Please note that the server may send Status info lines while reading the
694 data lines from the client.  After this the key generation takes place
695 and the server eventually does send an ERR or OK response.  Status lines
696 may be issued as a progress indicator.
697
698
699 @node GPGSM LISTKEYS
700 @subsection List available keys
701
702 To list the keys in the internal database or using an external key
703 provider, the command:
704
705 @example
706   LISTKEYS  @var{pattern}
707 @end example
708
709 is used.  To allow multiple patterns (which are ORed during the search)
710 quoting is required: Spaces are to be translated into "+" or into "%20";
711 in turn this requires that the usual escape quoting rules are done.
712
713 @example
714   LISTSECRETKEYS @var{pattern}
715 @end example
716
717 Lists only the keys where a secret key is available.
718
719 The list commands  commands are affected by the option
720
721 @example
722   OPTION list-mode=@var{mode}
723 @end example
724
725 where mode may be:
726 @table @code
727 @item 0 
728 Use default (which is usually the same as 1).
729 @item 1
730 List only the internal keys.
731 @item 2
732 List only the external keys.
733 @item 3
734 List internal and external keys.
735 @end table
736
737 Note that options are valid for the entire session.
738     
739
740 @node GPGSM EXPORT
741 @subsection Export certificates
742
743 To export certificate from the internal key database the command:
744
745 @example
746   EXPORT @var{pattern}
747 @end example
748
749 is used.  To allow multiple patterns (which are ORed) quoting is
750 required: Spaces are to be translated into "+" or into "%20"; in turn
751 this requires that the usual escape quoting rules are done.
752
753 The format of the output depends on what was set with the OUTPUT
754 command.  When using @acronym{PEM} encoding a few informational lines
755 are prepended.
756
757
758 @node GPGSM IMPORT
759 @subsection Import certificates
760
761 To import certificates into the internal key database, the command
762
763 @example
764   IMPORT
765 @end example
766
767 is used.  The data is expected on the file descriptor set with the
768 @code{INPUT} command.  Certain checks are performend on the
769 certificate.  Note that the code will also handle PKCS\#12 files and
770 import private keys; a helper program is used for that.
771
772
773 @node GPGSM DELETE
774 @subsection Delete certificates
775
776 To delete certificate the command
777
778 @example
779   DELKEYS @var{pattern}
780 @end example
781
782 is used.  To allow multiple patterns (which are ORed) quoting is
783 required: Spaces are to be translated into "+" or into "%20"; in turn
784 this requires that the usual escape quoting rules are done.
785
786 The certificates must be specified unambiguously otherwise an error is
787 returned.
788