doc: Don't install gpg-zip.1.
[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 @include defs.inc
6
7 @node Invoking GPGSM
8 @chapter Invoking GPGSM
9 @cindex GPGSM command options
10 @cindex command options
11 @cindex options, GPGSM command
12
13 @manpage gpgsm.1
14 @ifset manverb
15 .B gpgsm
16 \- CMS encryption and signing tool
17 @end ifset
18
19 @mansect synopsis
20 @ifset manverb
21 .B  gpgsm
22 .RB [ \-\-homedir
23 .IR dir ]
24 .RB [ \-\-options
25 .IR file ]
26 .RI [ options ]
27 .I command
28 .RI [ args ]
29 @end ifset
30
31
32 @mansect description
33 @command{gpgsm} is a tool similar to @command{gpg} to provide digital
34 encryption and signing services on X.509 certificates and the CMS
35 protocol.  It is mainly used as a backend for S/MIME mail processing.
36 @command{gpgsm} includes a full featured certificate management and
37 complies with all rules defined for the German Sphinx project.
38
39 @manpause
40 @xref{Option Index}, for an index to @command{GPGSM}'s commands and options.
41 @mancont
42
43 @menu
44 * GPGSM Commands::        List of all commands.
45 * GPGSM Options::         List of all options.
46 * GPGSM Configuration::   Configuration files.
47 * GPGSM Examples::        Some usage examples.
48
49 Developer information:
50 * Unattended Usage::      Using @command{gpgsm} from other programs.
51 * GPGSM Protocol::        The protocol the server mode uses.
52 @end menu
53
54 @c *******************************************
55 @c ***************            ****************
56 @c ***************  COMMANDS  ****************
57 @c ***************            ****************
58 @c *******************************************
59 @mansect commands
60 @node GPGSM Commands
61 @section Commands
62
63 Commands are not distinguished from options except for the fact that
64 only one command is allowed.
65
66 @menu
67 * General GPGSM Commands::        Commands not specific to the functionality.
68 * Operational GPGSM Commands::    Commands to select the type of operation.
69 * Certificate Management::        How to manage certificates.
70 @end menu
71
72
73 @c *******************************************
74 @c **********  GENERAL COMMANDS  *************
75 @c *******************************************
76 @node General GPGSM Commands
77 @subsection Commands not specific to the function
78
79 @table @gnupgtabopt
80 @item --version
81 @opindex version
82 Print the program version and licensing information.  Note that you
83 cannot abbreviate this command.
84
85 @item --help, -h
86 @opindex help
87 Print a usage message summarizing the most useful command-line options.
88 Note that you cannot abbreviate this command.
89
90 @item --warranty
91 @opindex warranty
92 Print warranty information.  Note that you cannot abbreviate this
93 command.
94
95 @item --dump-options
96 @opindex dump-options
97 Print a list of all available options and commands.  Note that you cannot
98 abbreviate this command.
99 @end table
100
101
102 @c *******************************************
103 @c ********  OPERATIONAL COMMANDS  ***********
104 @c *******************************************
105 @node Operational GPGSM Commands
106 @subsection Commands to select the type of operation
107
108 @table @gnupgtabopt
109 @item --encrypt
110 @opindex encrypt
111 Perform an encryption.  The keys the data is encrypted too must be set
112 using the option @option{--recipient}.
113
114 @item --decrypt
115 @opindex decrypt
116 Perform a decryption; the type of input is automatically determined.  It
117 may either be in binary form or PEM encoded; automatic determination of
118 base-64 encoding is not done.
119
120 @item --sign
121 @opindex sign
122 Create a digital signature.  The key used is either the fist one found
123 in the keybox or those set with the @option{--local-user} option.
124
125 @item --verify
126 @opindex verify
127 Check a signature file for validity.  Depending on the arguments a
128 detached signature may also be checked.
129
130 @item --server
131 @opindex server
132 Run in server mode and wait for commands on the @code{stdin}.
133
134 @item --call-dirmngr @var{command} [@var{args}]
135 @opindex call-dirmngr
136 Behave as a Dirmngr client issuing the request @var{command} with the
137 optional list of @var{args}.  The output of the Dirmngr is printed
138 stdout.  Please note that file names given as arguments should have an
139 absolute file name (i.e. commencing with @code{/} because they are
140 passed verbatim to the Dirmngr and the working directory of the
141 Dirmngr might not be the same as the one of this client.  Currently it
142 is not possible to pass data via stdin to the Dirmngr.  @var{command}
143 should not contain spaces.
144
145 This is command is required for certain maintaining tasks of the dirmngr
146 where a dirmngr must be able to call back to @command{gpgsm}.  See the Dirmngr
147 manual for details.
148
149 @item --call-protect-tool @var{arguments}
150 @opindex call-protect-tool
151 Certain maintenance operations are done by an external program call
152 @command{gpg-protect-tool}; this is usually not installed in a directory
153 listed in the PATH variable.  This command provides a simple wrapper to
154 access this tool.  @var{arguments} are passed verbatim to this command;
155 use @samp{--help} to get a list of supported operations.
156
157
158 @end table
159
160
161 @c *******************************************
162 @c *******  CERTIFICATE MANAGEMENT  **********
163 @c *******************************************
164 @node Certificate Management
165 @subsection How to manage the certificates and keys
166
167 @table @gnupgtabopt
168 @item --gen-key
169 @opindex gen-key
170 This command allows the creation of a certificate signing request or a
171 self-signed certificate.  It is commonly used along with the
172 @option{--output} option to save the created CSR or certificate into a
173 file.  If used with the @option{--batch} a parameter file is used to
174 create the CSR or certificate and it is further possible to create
175 non-self-signed certificates.
176
177 @item --list-keys
178 @itemx -k
179 @opindex list-keys
180 List all available certificates stored in the local key database.
181 Note that the displayed data might be reformatted for better human
182 readability and illegal characters are replaced by safe substitutes.
183
184 @item --list-secret-keys
185 @itemx -K
186 @opindex list-secret-keys
187 List all available certificates for which a corresponding a secret key
188 is available.
189
190 @item --list-external-keys @var{pattern}
191 @opindex list-keys
192 List certificates matching @var{pattern} using an external server.  This
193 utilizes the @code{dirmngr} service.
194
195 @item --list-chain
196 @opindex list-chain
197 Same as @option{--list-keys} but also prints all keys making up the chain.
198
199
200 @item --dump-cert
201 @itemx --dump-keys
202 @opindex dump-cert
203 @opindex dump-keys
204 List all available certificates stored in the local key database using a
205 format useful mainly for debugging.
206
207 @item --dump-chain
208 @opindex dump-chain
209 Same as @option{--dump-keys} but also prints all keys making up the chain.
210
211 @item --dump-secret-keys
212 @opindex dump-secret-keys
213 List all available certificates for which a corresponding a secret key
214 is available using a format useful mainly for debugging.
215
216 @item --dump-external-keys @var{pattern}
217 @opindex dump-external-keys
218 List certificates matching @var{pattern} using an external server.
219 This utilizes the @code{dirmngr} service.  It uses a format useful
220 mainly for debugging.
221
222 @item --keydb-clear-some-cert-flags
223 @opindex keydb-clear-some-cert-flags
224 This is a debugging aid to reset certain flags in the key database
225 which are used to cache certain certificate stati.  It is especially
226 useful if a bad CRL or a weird running OCSP responder did accidentally
227 revoke certificate.  There is no security issue with this command
228 because @command{gpgsm} always make sure that the validity of a certificate is
229 checked right before it is used.
230
231 @item --delete-keys @var{pattern}
232 @opindex delete-keys
233 Delete the keys matching @var{pattern}.  Note that there is no command
234 to delete the secret part of the key directly.  In case you need to do
235 this, you should run the command @code{gpgsm --dump-secret-keys KEYID}
236 before you delete the key, copy the string of hex-digits in the
237 ``keygrip'' line and delete the file consisting of these hex-digits
238 and the suffix @code{.key} from the @file{private-keys-v1.d} directory
239 below our GnuPG home directory (usually @file{~/.gnupg}).
240
241 @item --export [@var{pattern}]
242 @opindex export
243 Export all certificates stored in the Keybox or those specified by the
244 optional @var{pattern}. Those pattern consist of a list of user ids
245 (@pxref{how-to-specify-a-user-id}).  When used along with the
246 @option{--armor} option a few informational lines are prepended before
247 each block.  There is one limitation: As there is no commonly agreed
248 upon way to pack more than one certificate into an ASN.1 structure,
249 the binary export (i.e. without using @option{armor}) works only for
250 the export of one certificate.  Thus it is required to specify a
251 @var{pattern} which yields exactly one certificate.  Ephemeral
252 certificate are only exported if all @var{pattern} are given as
253 fingerprints or keygrips.
254
255 @item --export-secret-key-p12 @var{key-id}
256 @opindex export-secret-key-p12
257 Export the private key and the certificate identified by @var{key-id} in
258 a PKCS#12 format. When used with the @code{--armor} option a few
259 informational lines are prepended to the output.  Note, that the PKCS#12
260 format is not very secure and this command is only provided if there is
261 no other way to exchange the private key. (@pxref{option --p12-charset})
262
263 @item --export-secret-key-p8 @var{key-id}
264 @itemx --export-secret-key-raw @var{key-id}
265 @opindex export-secret-key-p8
266 @opindex export-secret-key-raw
267 Export the private key of the certificate identified by @var{key-id}
268 with any encryption stripped.  The @code{...-raw} command exports in
269 PKCS#1 format; the @code{...-p8} command exports in PKCS#8 format.
270 When used with the @code{--armor} option a few informational lines are
271 prepended to the output.  These commands are useful to prepare a key
272 for use on a TLS server.
273
274 @item --import [@var{files}]
275 @opindex import
276 Import the certificates from the PEM or binary encoded files as well as
277 from signed-only messages.  This command may also be used to import a
278 secret key from a PKCS#12 file.
279
280 @item --learn-card
281 @opindex learn-card
282 Read information about the private keys from the smartcard and import
283 the certificates from there.  This command utilizes the @command{gpg-agent}
284 and in turn the @command{scdaemon}.
285
286 @item --passwd @var{user_id}
287 @opindex passwd
288 Change the passphrase of the private key belonging to the certificate
289 specified as @var{user_id}.  Note, that changing the passphrase/PIN of a
290 smartcard is not yet supported.
291
292 @end table
293
294
295 @c *******************************************
296 @c ***************            ****************
297 @c ***************  OPTIONS   ****************
298 @c ***************            ****************
299 @c *******************************************
300 @mansect options
301 @node GPGSM Options
302 @section Option Summary
303
304 @command{GPGSM} features a bunch of options to control the exact behaviour
305 and to change the default configuration.
306
307 @menu
308 * Configuration Options::   How to change the configuration.
309 * Certificate Options::     Certificate related options.
310 * Input and Output::        Input and Output.
311 * CMS Options::             How to change how the CMS is created.
312 * Esoteric Options::        Doing things one usually do not want to do.
313 @end menu
314
315
316 @c *******************************************
317 @c ********  CONFIGURATION OPTIONS  **********
318 @c *******************************************
319 @node Configuration Options
320 @subsection How to change the configuration
321
322 These options are used to change the configuration and are usually found
323 in the option file.
324
325 @table @gnupgtabopt
326
327 @anchor{gpgsm-option --options}
328 @item --options @var{file}
329 @opindex options
330 Reads configuration from @var{file} instead of from the default
331 per-user configuration file.  The default configuration file is named
332 @file{gpgsm.conf} and expected in the @file{.gnupg} directory directly
333 below the home directory of the user.
334
335 @include opt-homedir.texi
336
337
338 @item -v
339 @item --verbose
340 @opindex v
341 @opindex verbose
342 Outputs additional information while running.
343 You can increase the verbosity by giving several
344 verbose commands to @command{gpgsm}, such as @samp{-vv}.
345
346 @item --policy-file @var{filename}
347 @opindex policy-file
348 Change the default name of the policy file to @var{filename}.
349
350 @item --agent-program @var{file}
351 @opindex agent-program
352 Specify an agent program to be used for secret key operations.  The
353 default value is determined by running the command @command{gpgconf}.
354 Note that the pipe symbol (@code{|}) is used for a regression test
355 suite hack and may thus not be used in the file name.
356
357 @item --dirmngr-program @var{file}
358 @opindex dirmngr-program
359 Specify a dirmngr program to be used for @acronym{CRL} checks.  The
360 default value is @file{@value{BINDIR}/dirmngr}.  This is only used as a
361 fallback when the environment variable @code{DIRMNGR_INFO} is not set or
362 a running dirmngr cannot be connected.
363
364 @item --prefer-system-dirmngr
365 @opindex prefer-system-dirmngr
366 If a system wide @command{dirmngr} is running in daemon mode, first try
367 to connect to this one.  Fallback to a pipe based server if this does
368 not work.  Under Windows this option is ignored because the system dirmngr is
369 always used.
370
371 @item --disable-dirmngr
372 Entirely disable the use of the Dirmngr.
373
374 @item --no-autostart
375 @opindex no-autostart
376 Do not start the gpg-agent or the dirmngr if it has not yet been
377 started and its service is required.  This option is mostly useful on
378 machines where the connection to gpg-agent has been redirected to
379 another machines.  If dirmngr is required on the remote machine, it
380 may be started manually using @command{gpgconf --launch dirmngr}.
381
382 @item --no-secmem-warning
383 @opindex no-secmem-warning
384 Do not print a warning when the so called "secure memory" cannot be used.
385
386 @item --log-file @var{file}
387 @opindex log-file
388 When running in server mode, append all logging output to @var{file}.
389
390 @end table
391
392
393 @c *******************************************
394 @c ********  CERTIFICATE OPTIONS  ************
395 @c *******************************************
396 @node Certificate Options
397 @subsection Certificate related options
398
399 @table @gnupgtabopt
400
401 @item  --enable-policy-checks
402 @itemx --disable-policy-checks
403 @opindex enable-policy-checks
404 @opindex disable-policy-checks
405 By default policy checks are enabled.  These options may be used to
406 change it.
407
408 @item  --enable-crl-checks
409 @itemx --disable-crl-checks
410 @opindex enable-crl-checks
411 @opindex disable-crl-checks
412 By default the @acronym{CRL} checks are enabled and the DirMngr is used
413 to check for revoked certificates.  The disable option is most useful
414 with an off-line network connection to suppress this check.
415
416 @item  --enable-trusted-cert-crl-check
417 @itemx --disable-trusted-cert-crl-check
418 @opindex enable-trusted-cert-crl-check
419 @opindex disable-trusted-cert-crl-check
420 By default the @acronym{CRL} for trusted root certificates are checked
421 like for any other certificates.  This allows a CA to revoke its own
422 certificates voluntary without the need of putting all ever issued
423 certificates into a CRL.  The disable option may be used to switch this
424 extra check off.  Due to the caching done by the Dirmngr, there will not be
425 any noticeable performance gain.  Note, that this also disables possible
426 OCSP checks for trusted root certificates.  A more specific way of
427 disabling this check is by adding the ``relax'' keyword to the root CA
428 line of the @file{trustlist.txt}
429
430
431 @item --force-crl-refresh
432 @opindex force-crl-refresh
433 Tell the dirmngr to reload the CRL for each request.  For better
434 performance, the dirmngr will actually optimize this by suppressing
435 the loading for short time intervals (e.g. 30 minutes). This option
436 is useful to make sure that a fresh CRL is available for certificates
437 hold in the keybox.  The suggested way of doing this is by using it
438 along with the option @option{--with-validation} for a key listing
439 command.  This option should not be used in a configuration file.
440
441 @item  --enable-ocsp
442 @itemx --disable-ocsp
443 @opindex enable-ocsp
444 @opindex disable-ocsp
445 By default @acronym{OCSP} checks are disabled.  The enable option may
446 be used to enable OCSP checks via Dirmngr.  If @acronym{CRL} checks
447 are also enabled, CRLs will be used as a fallback if for some reason an
448 OCSP request will not succeed.  Note, that you have to allow OCSP
449 requests in Dirmngr's configuration too (option
450 @option{--allow-ocsp}) and configure Dirmngr properly.  If you do not do
451 so you will get the error code @samp{Not supported}.
452
453 @item --auto-issuer-key-retrieve
454 @opindex auto-issuer-key-retrieve
455 If a required certificate is missing while validating the chain of
456 certificates, try to load that certificate from an external location.
457 This usually means that Dirmngr is employed to search for the
458 certificate.  Note that this option makes a "web bug" like behavior
459 possible.  LDAP server operators can see which keys you request, so by
460 sending you a message signed by a brand new key (which you naturally
461 will not have on your local keybox), the operator can tell both your IP
462 address and the time when you verified the signature.
463
464
465 @anchor{gpgsm-option --validation-model}
466 @item --validation-model @var{name}
467 @opindex validation-model
468 This option changes the default validation model.  The only possible
469 values are "shell" (which is the default), "chain" which forces the
470 use of the chain model and "steed" for a new simplified model.  The
471 chain model is also used if an option in the @file{trustlist.txt} or
472 an attribute of the certificate requests it.  However the standard
473 model (shell) is in that case always tried first.
474
475 @item --ignore-cert-extension @var{oid}
476 @opindex ignore-cert-extension
477 Add @var{oid} to the list of ignored certificate extensions.  The
478 @var{oid} is expected to be in dotted decimal form, like
479 @code{2.5.29.3}.  This option may be used more than once.  Critical
480 flagged certificate extensions matching one of the OIDs in the list
481 are treated as if they are actually handled and thus the certificate
482 will not be rejected due to an unknown critical extension.  Use this
483 option with care because extensions are usually flagged as critical
484 for a reason.
485
486 @end table
487
488 @c *******************************************
489 @c ***********  INPUT AND OUTPUT  ************
490 @c *******************************************
491 @node Input and Output
492 @subsection Input and Output
493
494 @table @gnupgtabopt
495 @item --armor
496 @itemx -a
497 @opindex armor
498 Create PEM encoded output.  Default is binary output.
499
500 @item --base64
501 @opindex base64
502 Create Base-64 encoded output; i.e. PEM without the header lines.
503
504 @item --assume-armor
505 @opindex assume-armor
506 Assume the input data is PEM encoded.  Default is to autodetect the
507 encoding but this is may fail.
508
509 @item --assume-base64
510 @opindex assume-base64
511 Assume the input data is plain base-64 encoded.
512
513 @item --assume-binary
514 @opindex assume-binary
515 Assume the input data is binary encoded.
516
517 @anchor{option --p12-charset}
518 @item --p12-charset @var{name}
519 @opindex p12-charset
520 @command{gpgsm} uses the UTF-8 encoding when encoding passphrases for
521 PKCS#12 files.  This option may be used to force the passphrase to be
522 encoded in the specified encoding @var{name}.  This is useful if the
523 application used to import the key uses a different encoding and thus
524 will not be able to import a file generated by @command{gpgsm}.  Commonly
525 used values for @var{name} are @code{Latin1} and @code{CP850}.  Note
526 that @command{gpgsm} itself automagically imports any file with a
527 passphrase encoded to the most commonly used encodings.
528
529
530 @item --default-key @var{user_id}
531 @opindex default-key
532 Use @var{user_id} as the standard key for signing.  This key is used if
533 no other key has been defined as a signing key.  Note, that the first
534 @option{--local-users} option also sets this key if it has not yet been
535 set; however @option{--default-key} always overrides this.
536
537
538 @item --local-user @var{user_id}
539 @item -u @var{user_id}
540 @opindex local-user
541 Set the user(s) to be used for signing.  The default is the first
542 secret key found in the database.
543
544
545 @item --recipient @var{name}
546 @itemx -r
547 @opindex recipient
548 Encrypt to the user id @var{name}.  There are several ways a user id
549 may be given (@pxref{how-to-specify-a-user-id}).
550
551
552 @item --output @var{file}
553 @itemx -o @var{file}
554 @opindex output
555 Write output to @var{file}.  The default is to write it to stdout.
556
557
558 @anchor{gpgsm-option --with-key-data}
559 @item --with-key-data
560 @opindex with-key-data
561 Displays extra information with the @code{--list-keys} commands.  Especially
562 a line tagged @code{grp} is printed which tells you the keygrip of a
563 key.  This string is for example used as the file name of the
564 secret key.
565
566 @anchor{gpgsm-option --with-validation}
567 @item --with-validation
568 @opindex with-validation
569 When doing a key listing, do a full validation check for each key and
570 print the result.  This is usually a slow operation because it
571 requires a CRL lookup and other operations.
572
573 When used along with --import, a validation of the certificate to
574 import is done and only imported if it succeeds the test.  Note that
575 this does not affect an already available certificate in the DB.
576 This option is therefore useful to simply verify a certificate.
577
578
579 @item --with-md5-fingerprint
580 For standard key listings, also print the MD5 fingerprint of the
581 certificate.
582
583 @item --with-keygrip
584 Include the keygrip in standard key listings.  Note that the keygrip is
585 always listed in --with-colons mode.
586
587 @item --with-secret
588 @opindex with-secret
589 Include info about the presence of a secret key in public key listings
590 done with @code{--with-colons}.
591
592 @end table
593
594 @c *******************************************
595 @c *************  CMS OPTIONS  ***************
596 @c *******************************************
597 @node CMS Options
598 @subsection How to change how the CMS is created.
599
600 @table @gnupgtabopt
601 @item --include-certs @var{n}
602 @opindex include-certs
603 Using @var{n} of -2 includes all certificate except for the root cert,
604 -1 includes all certs, 0 does not include any certs, 1 includes only the
605 signers cert and all other positive values include up to @var{n}
606 certificates starting with the signer cert.  The default is -2.
607
608 @item --cipher-algo @var{oid}
609 @opindex cipher-algo
610 Use the cipher algorithm with the ASN.1 object identifier @var{oid} for
611 encryption.  For convenience the strings @code{3DES}, @code{AES} and
612 @code{AES256} may be used instead of their OIDs.  The default is
613 @code{AES} (2.16.840.1.101.3.4.1.2).
614
615 @item --digest-algo @code{name}
616 Use @code{name} as the message digest algorithm.  Usually this
617 algorithm is deduced from the respective signing certificate.  This
618 option forces the use of the given algorithm and may lead to severe
619 interoperability problems.
620
621 @end table
622
623
624
625 @c *******************************************
626 @c ********  ESOTERIC OPTIONS  ***************
627 @c *******************************************
628 @node Esoteric Options
629 @subsection Doing things one usually do not want to do.
630
631
632 @table @gnupgtabopt
633
634 @item --extra-digest-algo @var{name}
635 @opindex extra-digest-algo
636 Sometimes signatures are broken in that they announce a different digest
637 algorithm than actually used.  @command{gpgsm} uses a one-pass data
638 processing model and thus needs to rely on the announced digest
639 algorithms to properly hash the data.  As a workaround this option may
640 be used to tell gpg to also hash the data using the algorithm
641 @var{name}; this slows processing down a little bit but allows to verify
642 such broken signatures.  If @command{gpgsm} prints an error like
643 ``digest algo 8 has not been enabled'' you may want to try this option,
644 with @samp{SHA256} for @var{name}.
645
646
647 @item --faked-system-time @var{epoch}
648 @opindex faked-system-time
649 This option is only useful for testing; it sets the system time back or
650 forth to @var{epoch} which is the number of seconds elapsed since the year
651 1970.  Alternatively @var{epoch} may be given as a full ISO time string
652 (e.g. "20070924T154812").
653
654 @item --with-ephemeral-keys
655 @opindex with-ephemeral-keys
656 Include ephemeral flagged keys in the output of key listings.  Note
657 that they are included anyway if the key specification for a listing
658 is given as fingerprint or keygrip.
659
660 @item --debug-level @var{level}
661 @opindex debug-level
662 Select the debug level for investigating problems. @var{level} may be
663 a numeric value or by a keyword:
664
665 @table @code
666 @item none
667 No debugging at all.  A value of less than 1 may be used instead of
668 the keyword.
669 @item basic
670 Some basic debug messages.  A value between 1 and 2 may be used
671 instead of the keyword.
672 @item advanced
673 More verbose debug messages.  A value between 3 and 5 may be used
674 instead of the keyword.
675 @item expert
676 Even more detailed messages.  A value between 6 and 8 may be used
677 instead of the keyword.
678 @item guru
679 All of the debug messages you can get. A value greater than 8 may be
680 used instead of the keyword.  The creation of hash tracing files is
681 only enabled if the keyword is used.
682 @end table
683
684 How these messages are mapped to the actual debugging flags is not
685 specified and may change with newer releases of this program. They are
686 however carefully selected to best aid in debugging.
687
688 @item --debug @var{flags}
689 @opindex debug
690 This option is only useful for debugging and the behaviour may change
691 at any time without notice; using @code{--debug-levels} is the
692 preferred method to select the debug verbosity.  FLAGS are bit encoded
693 and may be given in usual C-Syntax. The currently defined bits are:
694
695 @table @code
696 @item 0  (1)
697 X.509 or OpenPGP protocol related data
698 @item 1  (2)
699 values of big number integers
700 @item 2  (4)
701 low level crypto operations
702 @item 5  (32)
703 memory allocation
704 @item 6  (64)
705 caching
706 @item 7  (128)
707 show memory statistics.
708 @item 9  (512)
709 write hashed data to files named @code{dbgmd-000*}
710 @item 10 (1024)
711 trace Assuan protocol
712 @end table
713
714 Note, that all flags set using this option may get overridden by
715 @code{--debug-level}.
716
717 @item --debug-all
718 @opindex debug-all
719 Same as @code{--debug=0xffffffff}
720
721 @item --debug-allow-core-dump
722 @opindex debug-allow-core-dump
723 Usually @command{gpgsm} tries to avoid dumping core by well written code and by
724 disabling core dumps for security reasons.  However, bugs are pretty
725 durable beasts and to squash them it is sometimes useful to have a core
726 dump.  This option enables core dumps unless the Bad Thing happened
727 before the option parsing.
728
729 @item --debug-no-chain-validation
730 @opindex debug-no-chain-validation
731 This is actually not a debugging option but only useful as such.  It
732 lets @command{gpgsm} bypass all certificate chain validation checks.
733
734 @item --debug-ignore-expiration
735 @opindex debug-ignore-expiration
736 This is actually not a debugging option but only useful as such.  It
737 lets @command{gpgsm} ignore all notAfter dates, this is used by the regression
738 tests.
739
740 @item --fixed-passphrase @var{string}
741 @opindex fixed-passphrase
742 Supply the passphrase @var{string} to the gpg-protect-tool.  This
743 option is only useful for the regression tests included with this
744 package and may be revised or removed at any time without notice.
745
746 @item --no-common-certs-import
747 @opindex no-common-certs-import
748 Suppress the import of common certificates on keybox creation.
749
750 @end table
751
752 All the long options may also be given in the configuration file after
753 stripping off the two leading dashes.
754
755 @c *******************************************
756 @c ***************            ****************
757 @c ***************  USER ID   ****************
758 @c ***************            ****************
759 @c *******************************************
760 @mansect how to specify a user id
761 @ifset isman
762 @include specify-user-id.texi
763 @end ifset
764
765 @c *******************************************
766 @c ***************            ****************
767 @c ***************   FILES    ****************
768 @c ***************            ****************
769 @c *******************************************
770 @mansect files
771 @node GPGSM Configuration
772 @section Configuration files
773
774 There are a few configuration files to control certain aspects of
775 @command{gpgsm}'s operation. Unless noted, they are expected in the
776 current home directory (@pxref{option --homedir}).
777
778 @table @file
779
780 @item gpgsm.conf
781 @cindex gpgsm.conf
782 This is the standard configuration file read by @command{gpgsm} on
783 startup.  It may contain any valid long option; the leading two dashes
784 may not be entered and the option may not be abbreviated.  This default
785 name may be changed on the command line (@pxref{gpgsm-option --options}).
786 You should backup this file.
787
788
789 @item policies.txt
790 @cindex policies.txt
791 This is a list of allowed CA policies.  This file should list the
792 object identifiers of the policies line by line.  Empty lines and
793 lines starting with a hash mark are ignored.  Policies missing in this
794 file and not marked as critical in the certificate will print only a
795 warning; certificates with policies marked as critical and not listed
796 in this file will fail the signature verification.  You should backup
797 this file.
798
799 For example, to allow only the policy 2.289.9.9, the file should look
800 like this:
801
802 @c man:.RS
803 @example
804 # Allowed policies
805 2.289.9.9
806 @end example
807 @c man:.RE
808
809 @item qualified.txt
810 @cindex qualified.txt
811 This is the list of root certificates used for qualified certificates.
812 They are defined as certificates capable of creating legally binding
813 signatures in the same way as handwritten signatures are.  Comments
814 start with a hash mark and empty lines are ignored.  Lines do have a
815 length limit but this is not a serious limitation as the format of the
816 entries is fixed and checked by gpgsm: A non-comment line starts with
817 optional whitespace, followed by exactly 40 hex character, white space
818 and a lowercased 2 letter country code.  Additional data delimited with
819 by a white space is current ignored but might late be used for other
820 purposes.
821
822 Note that even if a certificate is listed in this file, this does not
823 mean that the certificate is trusted; in general the certificates listed
824 in this file need to be listed also in @file{trustlist.txt}.
825
826 This is a global file an installed in the data directory
827 (e.g. @file{@value{DATADIR}/qualified.txt}).  GnuPG installs a suitable
828 file with root certificates as used in Germany.  As new Root-CA
829 certificates may be issued over time, these entries may need to be
830 updated; new distributions of this software should come with an updated
831 list but it is still the responsibility of the Administrator to check
832 that this list is correct.
833
834 Everytime @command{gpgsm} uses a certificate for signing or verification
835 this file will be consulted to check whether the certificate under
836 question has ultimately been issued by one of these CAs.  If this is the
837 case the user will be informed that the verified signature represents a
838 legally binding (``qualified'') signature.  When creating a signature
839 using such a certificate an extra prompt will be issued to let the user
840 confirm that such a legally binding signature shall really be created.
841
842 Because this software has not yet been approved for use with such
843 certificates, appropriate notices will be shown to indicate this fact.
844
845 @item help.txt
846 @cindex help.txt
847 This is plain text file with a few help entries used with
848 @command{pinentry} as well as a large list of help items for
849 @command{gpg} and @command{gpgsm}.  The standard file has English help
850 texts; to install localized versions use filenames like @file{help.LL.txt}
851 with LL denoting the locale.  GnuPG comes with a set of predefined help
852 files in the data directory (e.g. @file{@value{DATADIR}/gnupg/help.de.txt})
853 and allows overriding of any help item by help files stored in the
854 system configuration directory (e.g. @file{@value{SYSCONFDIR}/help.de.txt}).
855 For a reference of the help file's syntax, please see the installed
856 @file{help.txt} file.
857
858
859 @item com-certs.pem
860 @cindex com-certs.pem
861 This file is a collection of common certificates used to populated a
862 newly created @file{pubring.kbx}.  An administrator may replace this
863 file with a custom one.  The format is a concatenation of PEM encoded
864 X.509 certificates.  This global file is installed in the data directory
865 (e.g. @file{@value{DATADIR}/com-certs.pem}).
866
867 @end table
868
869 @c man:.RE
870 Note that on larger installations, it is useful to put predefined files
871 into the directory @file{/etc/skel/.gnupg/} so that newly created users
872 start up with a working configuration.  For existing users a small
873 helper script is provided to create these files (@pxref{addgnupghome}).
874
875 For internal purposes gpgsm creates and maintains a few other files;
876 they all live in in the current home directory (@pxref{option
877 --homedir}).  Only @command{gpgsm} may modify these files.
878
879
880 @table @file
881 @item pubring.kbx
882 @cindex pubring.kbx
883 This a database file storing the certificates as well as meta
884 information.  For debugging purposes the tool @command{kbxutil} may be
885 used to show the internal structure of this file.  You should backup
886 this file.
887
888 @item random_seed
889 @cindex random_seed
890 This content of this file is used to maintain the internal state of the
891 random number generator across invocations.  The same file is used by
892 other programs of this software too.
893
894 @item S.gpg-agent
895 @cindex S.gpg-agent
896 If this file exists
897 @command{gpgsm} will first try to connect to this socket for
898 accessing @command{gpg-agent} before starting a new @command{gpg-agent}
899 instance.  Under Windows this socket (which in reality be a plain file
900 describing a regular TCP listening port) is the standard way of
901 connecting the @command{gpg-agent}.
902
903 @end table
904
905
906 @c *******************************************
907 @c ***************            ****************
908 @c ***************  EXAMPLES  ****************
909 @c ***************            ****************
910 @c *******************************************
911 @mansect examples
912 @node GPGSM Examples
913 @section Examples
914
915 @example
916 $ gpgsm -er goo@@bar.net <plaintext >ciphertext
917 @end example
918
919
920 @c *******************************************
921 @c ***************              **************
922 @c ***************  UNATTENDED  **************
923 @c ***************              **************
924 @c *******************************************
925 @manpause
926 @node Unattended Usage
927 @section Unattended Usage
928
929 @command{gpgsm} is often used as a backend engine by other software.  To help
930 with this a machine interface has been defined to have an unambiguous
931 way to do this.  This is most likely used with the @code{--server} command
932 but may also be used in the standard operation mode by using the
933 @code{--status-fd} option.
934
935 @menu
936 * Automated signature checking::  Automated signature checking.
937 * CSR and certificate creation::  CSR and certificate creation.
938 @end menu
939
940 @node Automated signature checking
941 @subsection Automated signature checking
942
943 It is very important to understand the semantics used with signature
944 verification.  Checking a signature is not as simple as it may sound and
945 so the operation is a bit complicated.  In most cases it is required
946 to look at several status lines.  Here is a table of all cases a signed
947 message may have:
948
949 @table @asis
950 @item The signature is valid
951 This does mean that the signature has been successfully verified, the
952 certificates are all sane.  However there are two subcases with
953 important information:  One of the certificates may have expired or a
954 signature of a message itself as expired.  It is a sound practise to
955 consider such a signature still as valid but additional information
956 should be displayed.  Depending on the subcase @command{gpgsm} will issue
957 these status codes:
958   @table @asis
959   @item signature valid and nothing did expire
960   @code{GOODSIG}, @code{VALIDSIG}, @code{TRUST_FULLY}
961   @item signature valid but at least one certificate has expired
962   @code{EXPKEYSIG}, @code{VALIDSIG}, @code{TRUST_FULLY}
963   @item signature valid but expired
964   @code{EXPSIG}, @code{VALIDSIG}, @code{TRUST_FULLY}
965   Note, that this case is currently not implemented.
966   @end table
967
968 @item The signature is invalid
969 This means that the signature verification failed (this is an indication
970 of af a transfer error, a program error or tampering with the message).
971 @command{gpgsm} issues one of these status codes sequences:
972   @table @code
973   @item  @code{BADSIG}
974   @item  @code{GOODSIG}, @code{VALIDSIG} @code{TRUST_NEVER}
975   @end table
976
977 @item Error verifying a signature
978 For some reason the signature could not be verified, i.e. it cannot be
979 decided whether the signature is valid or invalid.  A common reason for
980 this is a missing certificate.
981
982 @end table
983
984 @node CSR and certificate creation
985 @subsection CSR and certificate creation
986
987 The command @option{--gen-key} may be used along with the option
988 @option{--batch} to either create a certificate signing request (CSR)
989 or an X.509 certificate.  This is controlled by a parameter file; the
990 format of this file is as follows:
991
992 @itemize @bullet
993 @item Text only, line length is limited to about 1000 characters.
994 @item UTF-8 encoding must be used to specify non-ASCII characters.
995 @item Empty lines are ignored.
996 @item Leading and trailing while space is ignored.
997 @item A hash sign as the first non white space character indicates
998 a comment line.
999 @item Control statements are indicated by a leading percent sign, the
1000 arguments are separated by white space from the keyword.
1001 @item Parameters are specified by a keyword, followed by a colon.  Arguments
1002 are separated by white space.
1003 @item The first parameter must be @samp{Key-Type}, control statements
1004 may be placed anywhere.
1005 @item
1006 The order of the parameters does not matter except for @samp{Key-Type}
1007 which must be the first parameter.  The parameters are only used for
1008 the generated CSR/certificate; parameters from previous sets are not
1009 used.  Some syntactically checks may be performed.
1010 @item
1011 Key generation takes place when either the end of the parameter file
1012 is reached, the next @samp{Key-Type} parameter is encountered or at the
1013 control statement @samp{%commit} is encountered.
1014 @end itemize
1015
1016 @noindent
1017 Control statements:
1018
1019 @table @asis
1020
1021 @item %echo @var{text}
1022 Print @var{text} as diagnostic.
1023
1024 @item %dry-run
1025 Suppress actual key generation (useful for syntax checking).
1026
1027 @item %commit
1028 Perform the key generation.  Note that an implicit commit is done at
1029 the next @asis{Key-Type} parameter.
1030
1031 @c  %certfile <filename>
1032 @c      [Not yet implemented!]
1033 @c      Do not write the certificate to the keyDB but to <filename>.
1034 @c      This must be given before the first
1035 @c      commit to take place, duplicate specification of the same filename
1036 @c      is ignored, the last filename before a commit is used.
1037 @c      The filename is used until a new filename is used (at commit points)
1038 @c      and all keys are written to that file.  If a new filename is given,
1039 @c      this file is created (and overwrites an existing one).
1040 @c      Both control statements must be given.
1041 @end table
1042
1043 @noindent
1044 General Parameters:
1045
1046 @table @asis
1047
1048 @item Key-Type: @var{algo}
1049 Starts a new parameter block by giving the type of the primary
1050 key. The algorithm must be capable of signing.  This is a required
1051 parameter.  The only supported value for @var{algo} is @samp{rsa}.
1052
1053 @item Key-Length: @var{nbits}
1054 The requested length of a generated key in bits.  Defaults to 2048.
1055
1056 @item Key-Grip: @var{hexstring}
1057 This is optional and used to generate a CSR or certificatet for an
1058 already existing key.  Key-Length will be ignored when given.
1059
1060 @item Key-Usage: @var{usage-list}
1061 Space or comma delimited list of key usage, allowed values are
1062 @samp{encrypt}, @samp{sign} and @samp{cert}.  This is used to generate
1063 the keyUsage extension.  Please make sure that the algorithm is
1064 capable of this usage.  Default is to allow encrypt and sign.
1065
1066 @item Name-DN: @var{subject-name}
1067 This is the Distinguished Name (DN) of the subject in RFC-2253 format.
1068
1069 @item Name-Email: @var{string}
1070 This is an email address for the altSubjectName.  This parameter is
1071 optional but may occur several times to add several email addresses to
1072 a certificate.
1073
1074 @item Name-DNS: @var{string}
1075 The is an DNS name for the altSubjectName.  This parameter is optional
1076 but may occur several times to add several DNS names to a certificate.
1077
1078 @item Name-URI: @var{string}
1079 This is an URI for the altSubjectName.  This parameter is optional but
1080 may occur several times to add several URIs to a certificate.
1081 @end table
1082
1083 @noindent
1084 Additional parameters used to create a certificate (in contrast to a
1085 certificate signing request):
1086
1087 @table @asis
1088
1089 @item Serial: @var{sn}
1090 If this parameter is given an X.509 certificate will be generated.
1091 @var{sn} is expected to be a hex string representing an unsigned
1092 integer of arbitary length.  The special value @samp{random} can be
1093 used to create a 64 bit random serial number.
1094
1095 @item Issuer-DN: @var{issuer-name}
1096 This is the DN name of the issuer in rfc2253 format.  If it is not set
1097 it will default to the subject DN and a special GnuPG extension will
1098 be included in the certificate to mark it as a standalone certificate.
1099
1100 @item Creation-Date: @var{iso-date}
1101 @itemx Not-Before: @var{iso-date}
1102 Set the notBefore date of the certificate.  Either a date like
1103 @samp{1986-04-26} or @samp{1986-04-26 12:00} or a standard ISO
1104 timestamp like @samp{19860426T042640} may be used.  The time is
1105 considered to be UTC.  If it is not given the current date is used.
1106
1107 @item Expire-Date: @var{iso-date}
1108 @itemx Not-After: @var{iso-date}
1109 Set the notAfter date of the certificate.  Either a date like
1110 @samp{2063-04-05} or @samp{2063-04-05 17:00} or a standard ISO
1111 timestamp like @samp{20630405T170000} may be used.  The time is
1112 considered to be UTC.  If it is not given a default value in the not
1113 too far future is used.
1114
1115 @item Signing-Key: @var{keygrip}
1116 This gives the keygrip of the key used to sign the certificate.  If it
1117 is not given a self-signed certificate will be created.  For
1118 compatibility with future versions, it is suggested to prefix the
1119 keygrip with a @samp{&}.
1120
1121 @item Hash-Algo: @var{hash-algo}
1122 Use @var{hash-algo} for this CSR or certificate.  The supported hash
1123 algorithms are: @samp{sha1}, @samp{sha256}, @samp{sha384} and
1124 @samp{sha512}; they may also be specified with uppercase letters.  The
1125 default is @samp{sha256}.
1126
1127 @end table
1128
1129 @c *******************************************
1130 @c ***************           *****************
1131 @c ***************  ASSSUAN  *****************
1132 @c ***************           *****************
1133 @c *******************************************
1134 @node GPGSM Protocol
1135 @section The Protocol the Server Mode Uses.
1136
1137 Description of the protocol used to access @command{GPGSM}.
1138 @command{GPGSM} does implement the Assuan protocol and in addition
1139 provides a regular command line interface which exhibits a full client
1140 to this protocol (but uses internal linking).  To start
1141 @command{gpgsm} as a server the command line the option
1142 @code{--server} must be used.  Additional options are provided to
1143 select the communication method (i.e. the name of the socket).
1144
1145 We assume that the connection has already been established; see the
1146 Assuan manual for details.
1147
1148 @menu
1149 * GPGSM ENCRYPT::         Encrypting a message.
1150 * GPGSM DECRYPT::         Decrypting a message.
1151 * GPGSM SIGN::            Signing a message.
1152 * GPGSM VERIFY::          Verifying a message.
1153 * GPGSM GENKEY::          Generating a key.
1154 * GPGSM LISTKEYS::        List available keys.
1155 * GPGSM EXPORT::          Export certificates.
1156 * GPGSM IMPORT::          Import certificates.
1157 * GPGSM DELETE::          Delete certificates.
1158 * GPGSM GETAUDITLOG::     Retrieve an audit log.
1159 * GPGSM GETINFO::         Information about the process
1160 * GPGSM OPTION::          Session options.
1161 @end menu
1162
1163
1164 @node GPGSM ENCRYPT
1165 @subsection Encrypting a Message
1166
1167 Before encryption can be done the recipient must be set using the
1168 command:
1169
1170 @example
1171   RECIPIENT @var{userID}
1172 @end example
1173
1174 Set the recipient for the encryption.  @var{userID} should be the
1175 internal representation of the key; the server may accept any other way
1176 of specification.  If this is a valid and trusted recipient the server
1177 does respond with OK, otherwise the return is an ERR with the reason why
1178 the recipient cannot be used, the encryption will then not be done for
1179 this recipient.  If the policy is not to encrypt at all if not all
1180 recipients are valid, the client has to take care of this.  All
1181 @code{RECIPIENT} commands are cumulative until a @code{RESET} or an
1182 successful @code{ENCRYPT} command.
1183
1184 @example
1185   INPUT FD[=@var{n}] [--armor|--base64|--binary]
1186 @end example
1187
1188 Set the file descriptor for the message to be encrypted to @var{n}.
1189 Obviously the pipe must be open at that point, the server establishes
1190 its own end.  If the server returns an error the client should consider
1191 this session failed.  If @var{n} is not given, this commands uses the
1192 last file descriptor passed to the application.
1193 @xref{fun-assuan_sendfd, ,the assuan_sendfd function,assuan,the Libassuan
1194 manual}, on how to do descriptor passing.
1195
1196 The @code{--armor} option may be used to advice the server that the
1197 input data is in @acronym{PEM} format, @code{--base64} advices that a
1198 raw base-64 encoding is used, @code{--binary} advices of raw binary
1199 input (@acronym{BER}).  If none of these options is used, the server
1200 tries to figure out the used encoding, but this may not always be
1201 correct.
1202
1203 @example
1204   OUTPUT FD[=@var{n}] [--armor|--base64]
1205 @end example
1206
1207 Set the file descriptor to be used for the output (i.e. the encrypted
1208 message). Obviously the pipe must be open at that point, the server
1209 establishes its own end.  If the server returns an error he client
1210 should consider this session failed.
1211
1212 The option armor encodes the output in @acronym{PEM} format, the
1213 @code{--base64} option applies just a base 64 encoding.  No option
1214 creates binary output (@acronym{BER}).
1215
1216 The actual encryption is done using the command
1217
1218 @example
1219   ENCRYPT
1220 @end example
1221
1222 It takes the plaintext from the @code{INPUT} command, writes to the
1223 ciphertext to the file descriptor set with the @code{OUTPUT} command,
1224 take the recipients from all the recipients set so far.  If this command
1225 fails the clients should try to delete all output currently done or
1226 otherwise mark it as invalid.  @command{GPGSM} does ensure that there
1227 will not be any
1228 security problem with leftover data on the output in this case.
1229
1230 This command should in general not fail, as all necessary checks have
1231 been done while setting the recipients.  The input and output pipes are
1232 closed.
1233
1234
1235 @node GPGSM DECRYPT
1236 @subsection Decrypting a message
1237
1238 Input and output FDs are set the same way as in encryption, but
1239 @code{INPUT} refers to the ciphertext and output to the plaintext. There
1240 is no need to set recipients.  @command{GPGSM} automatically strips any
1241 @acronym{S/MIME} headers from the input, so it is valid to pass an
1242 entire MIME part to the INPUT pipe.
1243
1244 The encryption is done by using the command
1245
1246 @example
1247   DECRYPT
1248 @end example
1249
1250 It performs the decrypt operation after doing some check on the internal
1251 state. (e.g. that all needed data has been set).  Because it utilizes
1252 the GPG-Agent for the session key decryption, there is no need to ask
1253 the client for a protecting passphrase - GpgAgent takes care of this by
1254 requesting this from the user.
1255
1256
1257 @node GPGSM SIGN
1258 @subsection Signing a Message
1259
1260 Signing is usually done with these commands:
1261
1262 @example
1263   INPUT FD[=@var{n}] [--armor|--base64|--binary]
1264 @end example
1265
1266 This tells @command{GPGSM} to read the data to sign from file descriptor @var{n}.
1267
1268 @example
1269   OUTPUT FD[=@var{m}] [--armor|--base64]
1270 @end example
1271
1272 Write the output to file descriptor @var{m}.  If a detached signature is
1273 requested, only the signature is written.
1274
1275 @example
1276   SIGN [--detached]
1277 @end example
1278
1279 Sign the data set with the INPUT command and write it to the sink set by
1280 OUTPUT.  With @code{--detached}, a detached signature is created
1281 (surprise).
1282
1283 The key used for signing is the default one or the one specified in
1284 the configuration file.  To get finer control over the keys, it is
1285 possible to use the command
1286
1287 @example
1288   SIGNER @var{userID}
1289 @end example
1290
1291 to the signer's key.  @var{userID} should be the
1292 internal representation of the key; the server may accept any other way
1293 of specification.  If this is a valid and trusted recipient the server
1294 does respond with OK, otherwise the return is an ERR with the reason why
1295 the key cannot be used, the signature will then not be created using
1296 this key.  If the policy is not to sign at all if not all
1297 keys are valid, the client has to take care of this.  All
1298 @code{SIGNER} commands are cumulative until a @code{RESET} is done.
1299 Note that a @code{SIGN} does not reset this list of signers which is in
1300 contrats to the @code{RECIPIENT} command.
1301
1302
1303 @node GPGSM VERIFY
1304 @subsection Verifying a Message
1305
1306 To verify a mesage the command:
1307
1308 @example
1309   VERIFY
1310 @end example
1311
1312 is used. It does a verify operation on the message send to the input FD.
1313 The result is written out using status lines.  If an output FD was
1314 given, the signed text will be written to that.  If the signature is a
1315 detached one, the server will inquire about the signed material and the
1316 client must provide it.
1317
1318 @node GPGSM GENKEY
1319 @subsection Generating a Key
1320
1321 This is used to generate a new keypair, store the secret part in the
1322 @acronym{PSE} and the public key in the key database.  We will probably
1323 add optional commands to allow the client to select whether a hardware
1324 token is used to store the key.  Configuration options to
1325 @command{GPGSM} can be used to restrict the use of this command.
1326
1327 @example
1328   GENKEY
1329 @end example
1330
1331 @command{GPGSM} checks whether this command is allowed and then does an
1332 INQUIRY to get the key parameters, the client should then send the
1333 key parameters in the native format:
1334
1335 @example
1336     S: INQUIRE KEY_PARAM native
1337     C: D foo:fgfgfg
1338     C: D bar
1339     C: END
1340 @end example
1341
1342 Please note that the server may send Status info lines while reading the
1343 data lines from the client.  After this the key generation takes place
1344 and the server eventually does send an ERR or OK response.  Status lines
1345 may be issued as a progress indicator.
1346
1347
1348 @node GPGSM LISTKEYS
1349 @subsection List available keys
1350 @anchor{gpgsm-cmd listkeys}
1351
1352 To list the keys in the internal database or using an external key
1353 provider, the command:
1354
1355 @example
1356   LISTKEYS  @var{pattern}
1357 @end example
1358
1359 is used.  To allow multiple patterns (which are ORed during the search)
1360 quoting is required: Spaces are to be translated into "+" or into "%20";
1361 in turn this requires that the usual escape quoting rules are done.
1362
1363 @example
1364   LISTSECRETKEYS @var{pattern}
1365 @end example
1366
1367 Lists only the keys where a secret key is available.
1368
1369 The list commands  commands are affected by the option
1370
1371 @example
1372   OPTION list-mode=@var{mode}
1373 @end example
1374
1375 where mode may be:
1376 @table @code
1377 @item 0
1378 Use default (which is usually the same as 1).
1379 @item 1
1380 List only the internal keys.
1381 @item 2
1382 List only the external keys.
1383 @item 3
1384 List internal and external keys.
1385 @end table
1386
1387 Note that options are valid for the entire session.
1388
1389
1390 @node GPGSM EXPORT
1391 @subsection Export certificates
1392
1393 To export certificate from the internal key database the command:
1394
1395 @example
1396   EXPORT [--data [--armor] [--base64]] [--] @var{pattern}
1397 @end example
1398
1399 is used.  To allow multiple patterns (which are ORed) quoting is
1400 required: Spaces are to be translated into "+" or into "%20"; in turn
1401 this requires that the usual escape quoting rules are done.
1402
1403 If the @option{--data} option has not been given, the format of the
1404 output depends on what was set with the OUTPUT command.  When using
1405 @acronym{PEM} encoding a few informational lines are prepended.
1406
1407 If the @option{--data} has been given, a target set via OUTPUT is
1408 ignored and the data is returned inline using standard
1409 @code{D}-lines. This avoids the need for an extra file descriptor.  In
1410 this case the options @option{--armor} and @option{--base64} may be used
1411 in the same way as with the OUTPUT command.
1412
1413
1414 @node GPGSM IMPORT
1415 @subsection Import certificates
1416
1417 To import certificates into the internal key database, the command
1418
1419 @example
1420   IMPORT [--re-import]
1421 @end example
1422
1423 is used.  The data is expected on the file descriptor set with the
1424 @code{INPUT} command.  Certain checks are performed on the
1425 certificate.  Note that the code will also handle PKCS#12 files and
1426 import private keys; a helper program is used for that.
1427
1428 With the option @option{--re-import} the input data is expected to a be
1429 a linefeed separated list of fingerprints.  The command will re-import
1430 the corresponding certificates; that is they are made permanent by
1431 removing their ephemeral flag.
1432
1433
1434 @node GPGSM DELETE
1435 @subsection Delete certificates
1436
1437 To delete a certificate the command
1438
1439 @example
1440   DELKEYS @var{pattern}
1441 @end example
1442
1443 is used.  To allow multiple patterns (which are ORed) quoting is
1444 required: Spaces are to be translated into "+" or into "%20"; in turn
1445 this requires that the usual escape quoting rules are done.
1446
1447 The certificates must be specified unambiguously otherwise an error is
1448 returned.
1449
1450 @node GPGSM GETAUDITLOG
1451 @subsection Retrieve an audit log.
1452 @anchor{gpgsm-cmd getauditlog}
1453
1454 This command is used to retrieve an audit log.
1455
1456 @example
1457 GETAUDITLOG [--data] [--html]
1458 @end example
1459
1460 If @option{--data} is used, the audit log is send using D-lines
1461 instead of being sent to the file descriptor given by an OUTPUT
1462 command.  If @option{--html} is used, the output is formated as an
1463 XHTML block. This is designed to be incorporated into a HTML
1464 document.
1465
1466
1467 @node GPGSM GETINFO
1468 @subsection  Return information about the process
1469
1470 This is a multipurpose function to return a variety of information.
1471
1472 @example
1473 GETINFO @var{what}
1474 @end example
1475
1476 The value of @var{what} specifies the kind of information returned:
1477 @table @code
1478 @item version
1479 Return the version of the program.
1480 @item pid
1481 Return the process id of the process.
1482 @item agent-check
1483 Return OK if the agent is running.
1484 @item cmd_has_option @var{cmd} @var{opt}
1485 Return OK if the command @var{cmd} implements the option @var{opt}.
1486 The leading two dashes usually used with @var{opt} shall not be given.
1487 @item offline
1488 Return OK if the connection is in offline mode.  This may be either
1489 due to a @code{OPTION offline=1} or due to @command{gpgsm} being
1490 started with option @option{--disable-dirmngr}.
1491 @end table
1492
1493 @node GPGSM OPTION
1494 @subsection  Session options.
1495
1496 The standard Assuan option handler supports these options.
1497
1498 @example
1499 OPTION @var{name}[=@var{value}]
1500 @end example
1501
1502 These @var{name}s are recognized:
1503
1504 @table @code
1505
1506 @item putenv
1507 Change the session's environment to be passed via gpg-agent to
1508 Pinentry.  @var{value} is a string of the form
1509 @code{<KEY>[=[<STRING>]]}.  If only @code{<KEY>} is given the
1510 environment variable @code{<KEY>} is removed from the session
1511 environment, if @code{<KEY>=} is given that environment variable is
1512 set to the empty string, and if @code{<STRING>} is given it is set to
1513 that string.
1514
1515 @item display
1516 Set the session environment variable @code{DISPLAY} is set to @var{value}.
1517 @item ttyname
1518 Set the session environment variable @code{GPG_TTY} is set to @var{value}.
1519 @item ttytype
1520 Set the session environment variable @code{TERM} is set to @var{value}.
1521 @item lc-ctype
1522 Set the session environment variable @code{LC_CTYPE} is set to @var{value}.
1523 @item lc-messages
1524 Set the session environment variable @code{LC_MESSAGES} is set to @var{value}.
1525 @item xauthority
1526 Set the session environment variable @code{XAUTHORITY} is set to @var{value}.
1527 @item pinentry-user-data
1528 Set the session environment variable @code{PINENTRY_USER_DATA} is set
1529 to @var{value}.
1530
1531 @item include-certs
1532 This option overrides the command line option
1533 @option{--include-certs}.  A @var{value} of -2 includes all
1534 certificates except for the root certificate, -1 includes all
1535 certicates, 0 does not include any certicates, 1 includes only the
1536 signers certicate and all other positive values include up to
1537 @var{value} certificates starting with the signer cert.
1538
1539 @item list-mode
1540 @xref{gpgsm-cmd listkeys}.
1541
1542 @item list-to-output
1543 If @var{value} is true the output of the list commands
1544 (@pxref{gpgsm-cmd listkeys}) is written to the file descriptor set
1545 with the last OUTPUT command.  If @var{value} is false the output is
1546 written via data lines; this is the default.
1547
1548 @item with-validation
1549 If @var{value} is true for each listed certificate the validation
1550 status is printed.  This may result in the download of a CRL or the
1551 user being asked about the trustworthiness of a root certificate.  The
1552 default is given by a command line option (@pxref{gpgsm-option
1553 --with-validation}).
1554
1555
1556 @item with-secret
1557 If @var{value} is true certificates with a corresponding private key
1558 are marked by the list commands.
1559
1560 @item validation-model
1561 This option overrides the command line option
1562 @option{validation-model} for the session.
1563 (@pxref{gpgsm-option --validation-model}.)
1564
1565 @item with-key-data
1566 This option globally enables the command line option
1567 @option{--with-key-data}.  (@pxref{gpgsm-option --with-key-data}.)
1568
1569 @item enable-audit-log
1570 If @var{value} is true data to write an audit log is gathered.
1571 (@pxref{gpgsm-cmd getauditlog}.)
1572
1573 @item allow-pinentry-notify
1574 If this option is used notifications about the launch of a Pinentry
1575 are passed back to the client.
1576
1577 @item with-ephemeral-keys
1578 If @var{value} is true ephemeral certificates are included in the
1579 output of the list commands.
1580
1581 @item no-encrypt-to
1582 If this option is used all keys set by the command line option
1583 @option{--encrypt-to} are ignored.
1584
1585 @item offline
1586 If @var{value} is true or @var{value} is not given all network access
1587 is disabled for this session.  This is the same as the command line
1588 option @option{--disable-dirmngr}.
1589
1590 @end table
1591
1592 @mansect see also
1593 @ifset isman
1594 @command{gpg2}(1),
1595 @command{gpg-agent}(1)
1596 @end ifset
1597 @include see-also-note.texi