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