Fixed a build bug (straw letter in sm/import.c) and updated the documentation.
[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 @end table
309
310 @node CMS Options
311 @subsection How to change how the CMS is created.
312
313 @table @gnupgtabopt
314 @item --include-certs @var{n}
315 Using @var{n} of -2 includes all certificate except for the root cert,
316 -1 includes all certs, 0 does not include any certs, 1 includes only
317 the signers cert (this is the default) and all other positive
318 values include up to @var{n} certificates starting with the signer cert.
319   
320 @end table
321
322
323
324 @node Esoteric Options
325 @subsection Doing things one usually don't want todo.
326
327
328 @table @gnupgtabopt
329
330 @item --faked-system-time @var{epoch}
331 @opindex faked-system-time
332 This option is only useful for testing; it sets the system time back or
333 forth to @var{epoch} which is the number of seconds elapsed since the year
334 1970.
335
336 @item --debug @var{flags}
337 @opindex debug
338 This option is only useful for debugging and the behaviour may change at
339 any time without notice.  FLAGS are bit encoded and may be given in
340 usual C-Syntax. The currently defined bits are:
341    @table @code
342    @item 0  (1)
343    X.509 or OpenPGP protocol related data
344    @item 1  (2)  
345    values of big number integers 
346    @item 2  (4)
347    low level crypto operations
348    @item 5  (32)
349    memory allocation
350    @item 6  (64)
351    caching
352    @item 7  (128)
353    show memory statistics.
354    @item 9  (512)
355    write hashed data to files named @code{dbgmd-000*}
356    @item 10 (1024)
357    trace Assuan protocol
358    @item 12 (4096)
359    bypass all certificate validation
360    @end table
361
362 @item --debug-all
363 @opindex debug-all
364 Same as @code{--debug=0xffffffff}
365
366 @item --debug-no-chain-validation
367 @opindex debug-no-chain-validation
368 This is actually not a debugging option but only useful as such.  It
369 lets gpgsm bypass all certificate chain validation checks.
370
371 @end table
372
373 All the long options may also be given in the configuration file after
374 stripping off the two leading dashes.
375
376
377
378 @c 
379 @c  Examples
380 @c
381 @node GPGSM Examples
382 @section Examples
383
384 @c man begin EXAMPLES
385
386 @example
387 $ gpgsm -er goo@@bar.net <plaintext >ciphertext
388 @end example
389
390 @c man end
391
392
393
394 @c ---------------------------------
395 @c    The machine interface
396 @c --------------------------------
397 @node Unattended Usage
398 @section Unattended Usage
399
400 @sc{gpgsm} is often used as a backend engine by other software.  To help
401 with this a machine interface has been defined to have an unambiguous
402 way to do this.  This is most likely used with the @code{--server} command
403 but may also be used in the standard operation mode by using the
404 @code{--status-fd} option.
405
406 @menu
407 * Automated signature checking::  Automated signature checking.
408 @end menu
409
410 @node Automated signature checking,,,Unattended Usage
411 @section Automated signature checking
412
413 It is very important to understand the semantics used with signature
414 verification.  Checking a signature is not as simple as it may sound and
415 so the ooperation si a bit complicated.  In mosted cases it is required
416 to look at several status lines.  Here is a table of all cases a signed
417 message may have:
418
419 @table @asis
420 @item The signature is valid
421 This does mean that the signature has been successfully verified, the
422 certificates are all sane.  However there are two subcases with
423 important information:  One of the certificates may have expired or a
424 signature of a message itself as expired.  It is a sound practise to
425 consider such a signature still as valid but additional information
426 should be displayed.  Depending on the subcase @sc{gpgsm} will issue
427 these status codes:
428   @table @asis 
429   @item signature valid and nothing did expire
430   @code{GOODSIG}, @code{VALIDSIG}, @code{TRUST_FULLY}
431   @item signature valid but at least one certificate has expired
432   @code{EXPKEYSIG}, @code{VALIDSIG}, @code{TRUST_FULLY}
433   @item signature valid but expired
434   @code{EXPSIG}, @code{VALIDSIG}, @code{TRUST_FULLY}
435   Note, that this case is currently not implemented.
436   @end table
437
438 @item The signature is invalid
439 This means that the signature verification failed (this is an indication
440 of af a transfer error, a programm error or tampering with the message).
441 @sc{gpgsm} issues one of these status codes sequences:
442   @table @code
443   @item  @code{BADSIG}
444   @item  @code{GOODSIG}, @code{VALIDSIG} @code{TRUST_NEVER}
445   @end table
446
447 @item Error verifying a signature
448 For some reason the signature could not be verified, i.e. it can't be
449 decided whether the signature is valid or invalid.  A common reason for
450 this is a missing certificate.
451
452 @end table
453
454
455 @c 
456 @c  Assuan Protocol
457 @c
458 @node GPGSM Protocol
459 @section The Protocol the Server Mode Uses.
460
461 Description of the protocol used to access GPGSM.  GPGSM does implement
462 the Assuan protocol and in addition provides a regular command line
463 interface which exhibits a full client to this protocol (but uses
464 internal linking).  To start gpgsm as a server the commandline "gpgsm
465 --server" must be used.  Additional options are provided to select the
466 communication method (i.e. the name of the socket).
467
468 We assume that the connection has already been established; see the
469 Assuan manual for details.
470
471 @menu
472 * GPGSM ENCRYPT::         Encrypting a message.
473 * GPGSM DECRYPT::         Decrypting a message.
474 * GPGSM SIGN::            Signing a message.
475 * GPGSM VERIFY::          Verifying a message.
476 * GPGSM GENKEY::          Generating a key.
477 * GPGSM LISTKEYS::        List available keys.
478 * GPGSM EXPORT::          Export certificates.
479 * GPGSM IMPORT::          Import certificates.
480 * GPGSM DELETE::          Delete certificates.
481 @end menu
482
483
484 @node GPGSM ENCRYPT
485 @subsection Encrypting a Message
486
487 Before encrytion can be done the recipient must be set using the
488 command:
489
490 @example
491   RECIPIENT @var{userID}
492 @end example
493
494 Set the recipient for the encryption.  @var{userID} should be the
495 internal representation of the key; the server may accept any other way
496 of specification.  If this is a valid and trusted recipient the server
497 does respond with OK, otherwise the return is an ERR with the reason why
498 the recipient can't be used, the encryption will then not be done for
499 this recipient.  If the policy is not to encrypt at all if not all
500 recipients are valid, the client has to take care of this.  All
501 @code{RECIPIENT} commands are cumulative until a @code{RESET} or an
502 successful @code{ENCRYPT} command.
503
504 @example
505   INPUT FD=@var{n} [--armor|--base64|--binary]
506 @end example
507
508 Set the file descriptor for the message to be encrypted to @var{n}.
509 Obviously the pipe must be open at that point, the server establishes
510 its own end.  If the server returns an error the client should consider
511 this session failed.
512
513 The @code{--armor} option may be used to advice the server that the
514 input data is in @acronym{PEM} format, @code{--base64} advices that a
515 raw base-64 encoding is used, @code{--binary} advices of raw binary
516 input (@acronym{BER}).  If none of these options is used, the server
517 tries to figure out the used encoding, but this may not always be
518 correct.
519
520 @example
521   OUTPUT FD=@var{n} [--armor|--base64]
522 @end example
523
524 Set the file descriptor to be used for the output (i.e. the encrypted
525 message). Obviously the pipe must be open at that point, the server
526 establishes its own end.  If the server returns an error he client
527 should consider this session failed.
528
529 The option armor encodes the output in @acronym{PEM} format, the
530 @code{--base64} option applies just a base 64 encoding.  No option
531 creates binary output (@acronym{BER}).
532   
533 The actual encryption is done using the command
534
535 @example
536   ENCRYPT 
537 @end example
538
539 It takes the plaintext from the @code{INPUT} command, writes to the
540 ciphertext to the file descriptor set with the @code{OUTPUT} command,
541 take the recipients from all the recipients set so far.  If this command
542 fails the clients should try to delete all output currently done or
543 otherwise mark it as invalid.  GPGSM does ensure that there won't be any
544 security problem with leftover data on the output in this case.
545
546 This command should in general not fail, as all necessary checks have
547 been done while setting the recipients.  The input and output pipes are
548 closed.
549
550
551 @node GPGSM DECRYPT
552 @subsection Decrypting a message
553
554 Input and output FDs are set the same way as in encryption, but
555 @code{INPUT} refers to the ciphertext and output to the plaintext. There
556 is no need to set recipients.  GPGSM automatically strips any
557 @acronym{S/MIME} headers from the input, so it is valid to pass an
558 entire MIME part to the INPUT pipe.
559
560 The encryption is done by using the command
561
562 @example
563   DECRYPT
564 @end example
565
566 It performs the decrypt operation after doing some check on the internal
567 state. (e.g. that all needed data has been set).  Because it utilizes
568 the GPG-Agent for the session key decryption, there is no need to ask
569 the client for a protecting passphrase - GpgAgent takes care of this by
570 requesting this from the user.
571
572
573 @node GPGSM SIGN
574 @subsection Signing a Message
575
576 Signing is usually done with these commands:
577
578 @example
579   INPUT FD=@var{n} [--armor|--base64|--binary]
580 @end example
581
582 This tells GPGSM to read the data to sign from file descriptor @var{n}.
583
584 @example
585   OUTPUT FD=@var{m} [--armor|--base64]
586 @end example
587
588 Write the output to file descriptor @var{m}.  If a detached signature is
589 requested, only the signature is written.
590
591 @example
592   SIGN [--detached] 
593 @end example
594
595 Sign the data set with the INPUT command and write it to the sink set by
596 OUTPUT.  With @code{--detached}, a detached signature is created
597 (surprise).
598
599 The key used for signining is the default one or the one specified in
600 the configuration file.  To get finer control over the keys, it is
601 possible to use the command
602
603 @example
604   SIGNER @var{userID}
605 @end example
606
607 to the signer's key.  @var{userID} should be the
608 internal representation of the key; the server may accept any other way
609 of specification.  If this is a valid and trusted recipient the server
610 does respond with OK, otherwise the return is an ERR with the reason why
611 the key can't be used, the signature will then not be created using
612 this key.  If the policy is not to sign at all if not all
613 keys are valid, the client has to take care of this.  All
614 @code{SIGNER} commands are cumulative until a @code{RESET} is done.
615 Note that a @code{SIGN} does not reset this list of signers which is in
616 contrats to the @code{RECIPIENT} command.
617
618
619 @node GPGSM VERIFY
620 @subsection Verifying a Message
621
622 To verify a mesage the command:
623
624 @example
625   VERIFY
626 @end example
627
628 is used. It does a verify operation on the message send to the input FD.
629 The result is written out using status lines.  If an output FD was
630 given, the signed text will be written to that.  If the signature is a
631 detached one, the server will inquire about the signed material and the
632 client must provide it.
633
634 @node GPGSM GENKEY
635 @subsection Generating a Key
636
637 This is used to generate a new keypair, store the secret part in the
638 @acronym{PSE} and the public key in the key database.  We will probably
639 add optional commands to allow the client to select whether a hardware
640 token is used to store the key.  Configuration options to GPGSM can be
641 used to restrict the use of this command.
642
643 @example
644   GENKEY 
645 @end example
646
647 GPGSM checks whether this command is allowed and then does an
648 INQUIRY to get the key parameters, the client should then send the
649 key parameters in the native format:
650
651 @example
652     S: INQUIRE KEY_PARAM native
653     C: D foo:fgfgfg
654     C: D bar
655     C: END
656 @end example    
657
658 Please note that the server may send Status info lines while reading the
659 data lines from the client.  After this the key generation takes place
660 and the server eventually does send an ERR or OK response.  Status lines
661 may be issued as a progress indicator.
662
663
664 @node GPGSM LISTKEYS
665 @subsection List available keys
666
667 To list the keys in the internal database or using an external key
668 provider, the command:
669
670 @example
671   LISTKEYS  @var{pattern}
672 @end example
673
674 is used.  To allow multiple patterns (which are ORed during the search)
675 quoting is required: Spaces are to be translated into "+" or into "%20";
676 in turn this requires that the usual escape quoting rules are done.
677
678 @example
679   LISTSECRETKEYS @var{pattern}
680 @end example
681
682 Lists only the keys where a secret key is available.
683
684 The list commands  commands are affected by the option
685
686 @example
687   OPTION list-mode=@var{mode}
688 @end example
689
690 where mode may be:
691 @table @code
692 @item 0 
693 Use default (which is usually the same as 1).
694 @item 1
695 List only the internal keys.
696 @item 2
697 List only the external keys.
698 @item 3
699 List internal and external keys.
700 @end table
701
702 Note that options are valid for the entire session.
703     
704
705 @node GPGSM EXPORT
706 @subsection Export certificates
707
708 To export certificate from the internal key database the command:
709
710 @example
711   EXPORT @var{pattern}
712 @end example
713
714 is used.  To allow multiple patterns (which are ORed) quoting is
715 required: Spaces are to be translated into "+" or into "%20"; in turn
716 this requires that the usual escape quoting rules are done.
717
718 The format of the output depends on what was set with the OUTPUT
719 command.  When using @acronym{PEM} encoding a few informational lines
720 are prepended.
721
722
723 @node GPGSM IMPORT
724 @subsection Import certificates
725
726 To import certificates into the internal key database, the command
727
728 @example
729   IMPORT
730 @end example
731
732 is used.  The data is expected on the file descriptor set with the
733 @code{INPUT} command.  Certain checks are performend on the certificate.
734
735 @node GPGSM DELETE
736 @subsection Delete certificates
737
738 To delete certificate the command
739
740 @example
741   DELKEYS @var{pattern}
742 @end example
743
744 is used.  To allow multiple patterns (which are ORed) quoting is
745 required: Spaces are to be translated into "+" or into "%20"; in turn
746 this requires that the usual escape quoting rules are done.
747
748 The certificates must be specified unambiguously otherwise an error is
749 returned.
750