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