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