doc: Do not used fixed file names in the manuals.
[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 @item --validation-model @var{name}
466 @opindex validation-model
467 This option changes the default validation model.  The only possible
468 values are "shell" (which is the default), "chain" which forces the
469 use of the chain model and "steed" for a new simplified model.  The
470 chain model is also used if an option in the @file{trustlist.txt} or
471 an attribute of the certificate requests it.  However the standard
472 model (shell) is in that case always tried first.
473
474 @item --ignore-cert-extension @var{oid}
475 @opindex ignore-cert-extension
476 Add @var{oid} to the list of ignored certificate extensions.  The
477 @var{oid} is expected to be in dotted decimal form, like
478 @code{2.5.29.3}.  This option may be used more than once.  Critical
479 flagged certificate extensions matching one of the OIDs in the list
480 are treated as if they are actually handled and thus the certificate
481 will not be rejected due to an unknown critical extension.  Use this
482 option with care because extensions are usually flagged as critical
483 for a reason.
484
485 @end table
486
487 @c *******************************************
488 @c ***********  INPUT AND OUTPUT  ************
489 @c *******************************************
490 @node Input and Output
491 @subsection Input and Output
492
493 @table @gnupgtabopt
494 @item --armor
495 @itemx -a
496 @opindex armor
497 Create PEM encoded output.  Default is binary output.
498
499 @item --base64
500 @opindex base64
501 Create Base-64 encoded output; i.e. PEM without the header lines.
502
503 @item --assume-armor
504 @opindex assume-armor
505 Assume the input data is PEM encoded.  Default is to autodetect the
506 encoding but this is may fail.
507
508 @item --assume-base64
509 @opindex assume-base64
510 Assume the input data is plain base-64 encoded.
511
512 @item --assume-binary
513 @opindex assume-binary
514 Assume the input data is binary encoded.
515
516 @anchor{option --p12-charset}
517 @item --p12-charset @var{name}
518 @opindex p12-charset
519 @command{gpgsm} uses the UTF-8 encoding when encoding passphrases for
520 PKCS#12 files.  This option may be used to force the passphrase to be
521 encoded in the specified encoding @var{name}.  This is useful if the
522 application used to import the key uses a different encoding and thus
523 will not be able to import a file generated by @command{gpgsm}.  Commonly
524 used values for @var{name} are @code{Latin1} and @code{CP850}.  Note
525 that @command{gpgsm} itself automagically imports any file with a
526 passphrase encoded to the most commonly used encodings.
527
528
529 @item --default-key @var{user_id}
530 @opindex default-key
531 Use @var{user_id} as the standard key for signing.  This key is used if
532 no other key has been defined as a signing key.  Note, that the first
533 @option{--local-users} option also sets this key if it has not yet been
534 set; however @option{--default-key} always overrides this.
535
536
537 @item --local-user @var{user_id}
538 @item -u @var{user_id}
539 @opindex local-user
540 Set the user(s) to be used for signing.  The default is the first
541 secret key found in the database.
542
543
544 @item --recipient @var{name}
545 @itemx -r
546 @opindex recipient
547 Encrypt to the user id @var{name}.  There are several ways a user id
548 may be given (@pxref{how-to-specify-a-user-id}).
549
550
551 @item --output @var{file}
552 @itemx -o @var{file}
553 @opindex output
554 Write output to @var{file}.  The default is to write it to stdout.
555
556
557 @item --with-key-data
558 @opindex with-key-data
559 Displays extra information with the @code{--list-keys} commands.  Especially
560 a line tagged @code{grp} is printed which tells you the keygrip of a
561 key.  This string is for example used as the file name of the
562 secret key.
563
564 @item --with-validation
565 @opindex with-validation
566 When doing a key listing, do a full validation check for each key and
567 print the result.  This is usually a slow operation because it
568 requires a CRL lookup and other operations.
569
570 When used along with --import, a validation of the certificate to
571 import is done and only imported if it succeeds the test.  Note that
572 this does not affect an already available certificate in the DB.
573 This option is therefore useful to simply verify a certificate.
574
575
576 @item --with-md5-fingerprint
577 For standard key listings, also print the MD5 fingerprint of the
578 certificate.
579
580 @item --with-keygrip
581 Include the keygrip in standard key listings.  Note that the keygrip is
582 always listed in --with-colons mode.
583
584 @item --with-secret
585 @opindex with-secret
586 Include info about the presence of a secret key in public key listings
587 done with @code{--with-colons}.
588
589 @end table
590
591 @c *******************************************
592 @c *************  CMS OPTIONS  ***************
593 @c *******************************************
594 @node CMS Options
595 @subsection How to change how the CMS is created.
596
597 @table @gnupgtabopt
598 @item --include-certs @var{n}
599 @opindex include-certs
600 Using @var{n} of -2 includes all certificate except for the root cert,
601 -1 includes all certs, 0 does not include any certs, 1 includes only the
602 signers cert and all other positive values include up to @var{n}
603 certificates starting with the signer cert.  The default is -2.
604
605 @item --cipher-algo @var{oid}
606 @opindex cipher-algo
607 Use the cipher algorithm with the ASN.1 object identifier @var{oid} for
608 encryption.  For convenience the strings @code{3DES}, @code{AES} and
609 @code{AES256} may be used instead of their OIDs.  The default is
610 @code{AES} (2.16.840.1.101.3.4.1.2).
611
612 @item --digest-algo @code{name}
613 Use @code{name} as the message digest algorithm.  Usually this
614 algorithm is deduced from the respective signing certificate.  This
615 option forces the use of the given algorithm and may lead to severe
616 interoperability problems.
617
618 @end table
619
620
621
622 @c *******************************************
623 @c ********  ESOTERIC OPTIONS  ***************
624 @c *******************************************
625 @node Esoteric Options
626 @subsection Doing things one usually do not want to do.
627
628
629 @table @gnupgtabopt
630
631 @item --extra-digest-algo @var{name}
632 @opindex extra-digest-algo
633 Sometimes signatures are broken in that they announce a different digest
634 algorithm than actually used.  @command{gpgsm} uses a one-pass data
635 processing model and thus needs to rely on the announced digest
636 algorithms to properly hash the data.  As a workaround this option may
637 be used to tell gpg to also hash the data using the algorithm
638 @var{name}; this slows processing down a little bit but allows to verify
639 such broken signatures.  If @command{gpgsm} prints an error like
640 ``digest algo 8 has not been enabled'' you may want to try this option,
641 with @samp{SHA256} for @var{name}.
642
643
644 @item --faked-system-time @var{epoch}
645 @opindex faked-system-time
646 This option is only useful for testing; it sets the system time back or
647 forth to @var{epoch} which is the number of seconds elapsed since the year
648 1970.  Alternatively @var{epoch} may be given as a full ISO time string
649 (e.g. "20070924T154812").
650
651 @item --with-ephemeral-keys
652 @opindex with-ephemeral-keys
653 Include ephemeral flagged keys in the output of key listings.  Note
654 that they are included anyway if the key specification for a listing
655 is given as fingerprint or keygrip.
656
657 @item --debug-level @var{level}
658 @opindex debug-level
659 Select the debug level for investigating problems. @var{level} may be
660 a numeric value or by a keyword:
661
662 @table @code
663 @item none
664 No debugging at all.  A value of less than 1 may be used instead of
665 the keyword.
666 @item basic
667 Some basic debug messages.  A value between 1 and 2 may be used
668 instead of the keyword.
669 @item advanced
670 More verbose debug messages.  A value between 3 and 5 may be used
671 instead of the keyword.
672 @item expert
673 Even more detailed messages.  A value between 6 and 8 may be used
674 instead of the keyword.
675 @item guru
676 All of the debug messages you can get. A value greater than 8 may be
677 used instead of the keyword.  The creation of hash tracing files is
678 only enabled if the keyword is used.
679 @end table
680
681 How these messages are mapped to the actual debugging flags is not
682 specified and may change with newer releases of this program. They are
683 however carefully selected to best aid in debugging.
684
685 @item --debug @var{flags}
686 @opindex debug
687 This option is only useful for debugging and the behaviour may change
688 at any time without notice; using @code{--debug-levels} is the
689 preferred method to select the debug verbosity.  FLAGS are bit encoded
690 and may be given in usual C-Syntax. The currently defined bits are:
691
692 @table @code
693 @item 0  (1)
694 X.509 or OpenPGP protocol related data
695 @item 1  (2)
696 values of big number integers
697 @item 2  (4)
698 low level crypto operations
699 @item 5  (32)
700 memory allocation
701 @item 6  (64)
702 caching
703 @item 7  (128)
704 show memory statistics.
705 @item 9  (512)
706 write hashed data to files named @code{dbgmd-000*}
707 @item 10 (1024)
708 trace Assuan protocol
709 @end table
710
711 Note, that all flags set using this option may get overridden by
712 @code{--debug-level}.
713
714 @item --debug-all
715 @opindex debug-all
716 Same as @code{--debug=0xffffffff}
717
718 @item --debug-allow-core-dump
719 @opindex debug-allow-core-dump
720 Usually @command{gpgsm} tries to avoid dumping core by well written code and by
721 disabling core dumps for security reasons.  However, bugs are pretty
722 durable beasts and to squash them it is sometimes useful to have a core
723 dump.  This option enables core dumps unless the Bad Thing happened
724 before the option parsing.
725
726 @item --debug-no-chain-validation
727 @opindex debug-no-chain-validation
728 This is actually not a debugging option but only useful as such.  It
729 lets @command{gpgsm} bypass all certificate chain validation checks.
730
731 @item --debug-ignore-expiration
732 @opindex debug-ignore-expiration
733 This is actually not a debugging option but only useful as such.  It
734 lets @command{gpgsm} ignore all notAfter dates, this is used by the regression
735 tests.
736
737 @item --fixed-passphrase @var{string}
738 @opindex fixed-passphrase
739 Supply the passphrase @var{string} to the gpg-protect-tool.  This
740 option is only useful for the regression tests included with this
741 package and may be revised or removed at any time without notice.
742
743 @item --no-common-certs-import
744 @opindex no-common-certs-import
745 Suppress the import of common certificates on keybox creation.
746
747 @end table
748
749 All the long options may also be given in the configuration file after
750 stripping off the two leading dashes.
751
752 @c *******************************************
753 @c ***************            ****************
754 @c ***************  USER ID   ****************
755 @c ***************            ****************
756 @c *******************************************
757 @mansect how to specify a user id
758 @ifset isman
759 @include specify-user-id.texi
760 @end ifset
761
762 @c *******************************************
763 @c ***************            ****************
764 @c ***************   FILES    ****************
765 @c ***************            ****************
766 @c *******************************************
767 @mansect files
768 @node GPGSM Configuration
769 @section Configuration files
770
771 There are a few configuration files to control certain aspects of
772 @command{gpgsm}'s operation. Unless noted, they are expected in the
773 current home directory (@pxref{option --homedir}).
774
775 @table @file
776
777 @item gpgsm.conf
778 @cindex gpgsm.conf
779 This is the standard configuration file read by @command{gpgsm} on
780 startup.  It may contain any valid long option; the leading two dashes
781 may not be entered and the option may not be abbreviated.  This default
782 name may be changed on the command line (@pxref{gpgsm-option --options}).
783 You should backup this file.
784
785
786 @item policies.txt
787 @cindex policies.txt
788 This is a list of allowed CA policies.  This file should list the
789 object identifiers of the policies line by line.  Empty lines and
790 lines starting with a hash mark are ignored.  Policies missing in this
791 file and not marked as critical in the certificate will print only a
792 warning; certificates with policies marked as critical and not listed
793 in this file will fail the signature verification.  You should backup
794 this file.
795
796 For example, to allow only the policy 2.289.9.9, the file should look
797 like this:
798
799 @c man:.RS
800 @example
801 # Allowed policies
802 2.289.9.9
803 @end example
804 @c man:.RE
805
806 @item qualified.txt
807 @cindex qualified.txt
808 This is the list of root certificates used for qualified certificates.
809 They are defined as certificates capable of creating legally binding
810 signatures in the same way as handwritten signatures are.  Comments
811 start with a hash mark and empty lines are ignored.  Lines do have a
812 length limit but this is not a serious limitation as the format of the
813 entries is fixed and checked by gpgsm: A non-comment line starts with
814 optional whitespace, followed by exactly 40 hex character, white space
815 and a lowercased 2 letter country code.  Additional data delimited with
816 by a white space is current ignored but might late be used for other
817 purposes.
818
819 Note that even if a certificate is listed in this file, this does not
820 mean that the certificate is trusted; in general the certificates listed
821 in this file need to be listed also in @file{trustlist.txt}.
822
823 This is a global file an installed in the data directory
824 (e.g. @file{@value{DATADIR}/qualified.txt}).  GnuPG installs a suitable
825 file with root certificates as used in Germany.  As new Root-CA
826 certificates may be issued over time, these entries may need to be
827 updated; new distributions of this software should come with an updated
828 list but it is still the responsibility of the Administrator to check
829 that this list is correct.
830
831 Everytime @command{gpgsm} uses a certificate for signing or verification
832 this file will be consulted to check whether the certificate under
833 question has ultimately been issued by one of these CAs.  If this is the
834 case the user will be informed that the verified signature represents a
835 legally binding (``qualified'') signature.  When creating a signature
836 using such a certificate an extra prompt will be issued to let the user
837 confirm that such a legally binding signature shall really be created.
838
839 Because this software has not yet been approved for use with such
840 certificates, appropriate notices will be shown to indicate this fact.
841
842 @item help.txt
843 @cindex help.txt
844 This is plain text file with a few help entries used with
845 @command{pinentry} as well as a large list of help items for
846 @command{gpg} and @command{gpgsm}.  The standard file has English help
847 texts; to install localized versions use filenames like @file{help.LL.txt}
848 with LL denoting the locale.  GnuPG comes with a set of predefined help
849 files in the data directory (e.g. @file{@value{DATADIR}/gnupg/help.de.txt})
850 and allows overriding of any help item by help files stored in the
851 system configuration directory (e.g. @file{@value{SYSCONFDIR}/help.de.txt}).
852 For a reference of the help file's syntax, please see the installed
853 @file{help.txt} file.
854
855
856 @item com-certs.pem
857 @cindex com-certs.pem
858 This file is a collection of common certificates used to populated a
859 newly created @file{pubring.kbx}.  An administrator may replace this
860 file with a custom one.  The format is a concatenation of PEM encoded
861 X.509 certificates.  This global file is installed in the data directory
862 (e.g. @file{@value{DATADIR}/com-certs.pem}).
863
864 @end table
865
866 @c man:.RE
867 Note that on larger installations, it is useful to put predefined files
868 into the directory @file{/etc/skel/.gnupg/} so that newly created users
869 start up with a working configuration.  For existing users a small
870 helper script is provided to create these files (@pxref{addgnupghome}).
871
872 For internal purposes gpgsm creates and maintains a few other files;
873 they all live in in the current home directory (@pxref{option
874 --homedir}).  Only @command{gpgsm} may modify these files.
875
876
877 @table @file
878 @item pubring.kbx
879 @cindex pubring.kbx
880 This a database file storing the certificates as well as meta
881 information.  For debugging purposes the tool @command{kbxutil} may be
882 used to show the internal structure of this file.  You should backup
883 this file.
884
885 @item random_seed
886 @cindex random_seed
887 This content of this file is used to maintain the internal state of the
888 random number generator across invocations.  The same file is used by
889 other programs of this software too.
890
891 @item S.gpg-agent
892 @cindex S.gpg-agent
893 If this file exists
894 @command{gpgsm} will first try to connect to this socket for
895 accessing @command{gpg-agent} before starting a new @command{gpg-agent}
896 instance.  Under Windows this socket (which in reality be a plain file
897 describing a regular TCP listening port) is the standard way of
898 connecting the @command{gpg-agent}.
899
900 @end table
901
902
903 @c *******************************************
904 @c ***************            ****************
905 @c ***************  EXAMPLES  ****************
906 @c ***************            ****************
907 @c *******************************************
908 @mansect examples
909 @node GPGSM Examples
910 @section Examples
911
912 @example
913 $ gpgsm -er goo@@bar.net <plaintext >ciphertext
914 @end example
915
916
917 @c *******************************************
918 @c ***************              **************
919 @c ***************  UNATTENDED  **************
920 @c ***************              **************
921 @c *******************************************
922 @manpause
923 @node Unattended Usage
924 @section Unattended Usage
925
926 @command{gpgsm} is often used as a backend engine by other software.  To help
927 with this a machine interface has been defined to have an unambiguous
928 way to do this.  This is most likely used with the @code{--server} command
929 but may also be used in the standard operation mode by using the
930 @code{--status-fd} option.
931
932 @menu
933 * Automated signature checking::  Automated signature checking.
934 * CSR and certificate creation::  CSR and certificate creation.
935 @end menu
936
937 @node Automated signature checking
938 @subsection Automated signature checking
939
940 It is very important to understand the semantics used with signature
941 verification.  Checking a signature is not as simple as it may sound and
942 so the operation is a bit complicated.  In most cases it is required
943 to look at several status lines.  Here is a table of all cases a signed
944 message may have:
945
946 @table @asis
947 @item The signature is valid
948 This does mean that the signature has been successfully verified, the
949 certificates are all sane.  However there are two subcases with
950 important information:  One of the certificates may have expired or a
951 signature of a message itself as expired.  It is a sound practise to
952 consider such a signature still as valid but additional information
953 should be displayed.  Depending on the subcase @command{gpgsm} will issue
954 these status codes:
955   @table @asis
956   @item signature valid and nothing did expire
957   @code{GOODSIG}, @code{VALIDSIG}, @code{TRUST_FULLY}
958   @item signature valid but at least one certificate has expired
959   @code{EXPKEYSIG}, @code{VALIDSIG}, @code{TRUST_FULLY}
960   @item signature valid but expired
961   @code{EXPSIG}, @code{VALIDSIG}, @code{TRUST_FULLY}
962   Note, that this case is currently not implemented.
963   @end table
964
965 @item The signature is invalid
966 This means that the signature verification failed (this is an indication
967 of af a transfer error, a program error or tampering with the message).
968 @command{gpgsm} issues one of these status codes sequences:
969   @table @code
970   @item  @code{BADSIG}
971   @item  @code{GOODSIG}, @code{VALIDSIG} @code{TRUST_NEVER}
972   @end table
973
974 @item Error verifying a signature
975 For some reason the signature could not be verified, i.e. it cannot be
976 decided whether the signature is valid or invalid.  A common reason for
977 this is a missing certificate.
978
979 @end table
980
981 @node CSR and certificate creation
982 @subsection CSR and certificate creation
983
984 The command @option{--gen-key} may be used along with the option
985 @option{--batch} to either create a certificate signing request (CSR)
986 or an X.509 certificate.  This is controlled by a parameter file; the
987 format of this file is as follows:
988
989 @itemize @bullet
990 @item Text only, line length is limited to about 1000 characters.
991 @item UTF-8 encoding must be used to specify non-ASCII characters.
992 @item Empty lines are ignored.
993 @item Leading and trailing while space is ignored.
994 @item A hash sign as the first non white space character indicates
995 a comment line.
996 @item Control statements are indicated by a leading percent sign, the
997 arguments are separated by white space from the keyword.
998 @item Parameters are specified by a keyword, followed by a colon.  Arguments
999 are separated by white space.
1000 @item The first parameter must be @samp{Key-Type}, control statements
1001 may be placed anywhere.
1002 @item
1003 The order of the parameters does not matter except for @samp{Key-Type}
1004 which must be the first parameter.  The parameters are only used for
1005 the generated CSR/certificate; parameters from previous sets are not
1006 used.  Some syntactically checks may be performed.
1007 @item
1008 Key generation takes place when either the end of the parameter file
1009 is reached, the next @samp{Key-Type} parameter is encountered or at the
1010 control statement @samp{%commit} is encountered.
1011 @end itemize
1012
1013 @noindent
1014 Control statements:
1015
1016 @table @asis
1017
1018 @item %echo @var{text}
1019 Print @var{text} as diagnostic.
1020
1021 @item %dry-run
1022 Suppress actual key generation (useful for syntax checking).
1023
1024 @item %commit
1025 Perform the key generation.  Note that an implicit commit is done at
1026 the next @asis{Key-Type} parameter.
1027
1028 @c  %certfile <filename>
1029 @c      [Not yet implemented!]
1030 @c      Do not write the certificate to the keyDB but to <filename>.
1031 @c      This must be given before the first
1032 @c      commit to take place, duplicate specification of the same filename
1033 @c      is ignored, the last filename before a commit is used.
1034 @c      The filename is used until a new filename is used (at commit points)
1035 @c      and all keys are written to that file.  If a new filename is given,
1036 @c      this file is created (and overwrites an existing one).
1037 @c      Both control statements must be given.
1038 @end table
1039
1040 @noindent
1041 General Parameters:
1042
1043 @table @asis
1044
1045 @item Key-Type: @var{algo}
1046 Starts a new parameter block by giving the type of the primary
1047 key. The algorithm must be capable of signing.  This is a required
1048 parameter.  The only supported value for @var{algo} is @samp{rsa}.
1049
1050 @item Key-Length: @var{nbits}
1051 The requested length of a generated key in bits.  Defaults to 2048.
1052
1053 @item Key-Grip: @var{hexstring}
1054 This is optional and used to generate a CSR or certificatet for an
1055 already existing key.  Key-Length will be ignored when given.
1056
1057 @item Key-Usage: @var{usage-list}
1058 Space or comma delimited list of key usage, allowed values are
1059 @samp{encrypt}, @samp{sign} and @samp{cert}.  This is used to generate
1060 the keyUsage extension.  Please make sure that the algorithm is
1061 capable of this usage.  Default is to allow encrypt and sign.
1062
1063 @item Name-DN: @var{subject-name}
1064 This is the Distinguished Name (DN) of the subject in RFC-2253 format.
1065
1066 @item Name-Email: @var{string}
1067 This is an email address for the altSubjectName.  This parameter is
1068 optional but may occur several times to add several email addresses to
1069 a certificate.
1070
1071 @item Name-DNS: @var{string}
1072 The is an DNS name for the altSubjectName.  This parameter is optional
1073 but may occur several times to add several DNS names to a certificate.
1074
1075 @item Name-URI: @var{string}
1076 This is an URI for the altSubjectName.  This parameter is optional but
1077 may occur several times to add several URIs to a certificate.
1078 @end table
1079
1080 @noindent
1081 Additional parameters used to create a certificate (in contrast to a
1082 certificate signing request):
1083
1084 @table @asis
1085
1086 @item Serial: @var{sn}
1087 If this parameter is given an X.509 certificate will be generated.
1088 @var{sn} is expected to be a hex string representing an unsigned
1089 integer of arbitary length.  The special value @samp{random} can be
1090 used to create a 64 bit random serial number.
1091
1092 @item Issuer-DN: @var{issuer-name}
1093 This is the DN name of the issuer in rfc2253 format.  If it is not set
1094 it will default to the subject DN and a special GnuPG extension will
1095 be included in the certificate to mark it as a standalone certificate.
1096
1097 @item Creation-Date: @var{iso-date}
1098 @itemx Not-Before: @var{iso-date}
1099 Set the notBefore date of the certificate.  Either a date like
1100 @samp{1986-04-26} or @samp{1986-04-26 12:00} or a standard ISO
1101 timestamp like @samp{19860426T042640} may be used.  The time is
1102 considered to be UTC.  If it is not given the current date is used.
1103
1104 @item Expire-Date: @var{iso-date}
1105 @itemx Not-After: @var{iso-date}
1106 Set the notAfter date of the certificate.  Either a date like
1107 @samp{2063-04-05} or @samp{2063-04-05 17:00} or a standard ISO
1108 timestamp like @samp{20630405T170000} may be used.  The time is
1109 considered to be UTC.  If it is not given a default value in the not
1110 too far future is used.
1111
1112 @item Signing-Key: @var{keygrip}
1113 This gives the keygrip of the key used to sign the certificate.  If it
1114 is not given a self-signed certificate will be created.  For
1115 compatibility with future versions, it is suggested to prefix the
1116 keygrip with a @samp{&}.
1117
1118 @item Hash-Algo: @var{hash-algo}
1119 Use @var{hash-algo} for this CSR or certificate.  The supported hash
1120 algorithms are: @samp{sha1}, @samp{sha256}, @samp{sha384} and
1121 @samp{sha512}; they may also be specified with uppercase letters.  The
1122 default is @samp{sha256}.
1123
1124 @end table
1125
1126 @c *******************************************
1127 @c ***************           *****************
1128 @c ***************  ASSSUAN  *****************
1129 @c ***************           *****************
1130 @c *******************************************
1131 @node GPGSM Protocol
1132 @section The Protocol the Server Mode Uses.
1133
1134 Description of the protocol used to access @command{GPGSM}.
1135 @command{GPGSM} does implement the Assuan protocol and in addition
1136 provides a regular command line interface which exhibits a full client
1137 to this protocol (but uses internal linking).  To start
1138 @command{gpgsm} as a server the command line the option
1139 @code{--server} must be used.  Additional options are provided to
1140 select the communication method (i.e. the name of the socket).
1141
1142 We assume that the connection has already been established; see the
1143 Assuan manual for details.
1144
1145 @menu
1146 * GPGSM ENCRYPT::         Encrypting a message.
1147 * GPGSM DECRYPT::         Decrypting a message.
1148 * GPGSM SIGN::            Signing a message.
1149 * GPGSM VERIFY::          Verifying a message.
1150 * GPGSM GENKEY::          Generating a key.
1151 * GPGSM LISTKEYS::        List available keys.
1152 * GPGSM EXPORT::          Export certificates.
1153 * GPGSM IMPORT::          Import certificates.
1154 * GPGSM DELETE::          Delete certificates.
1155 * GPGSM GETINFO::         Information about the process
1156 @end menu
1157
1158
1159 @node GPGSM ENCRYPT
1160 @subsection Encrypting a Message
1161
1162 Before encryption can be done the recipient must be set using the
1163 command:
1164
1165 @example
1166   RECIPIENT @var{userID}
1167 @end example
1168
1169 Set the recipient for the encryption.  @var{userID} should be the
1170 internal representation of the key; the server may accept any other way
1171 of specification.  If this is a valid and trusted recipient the server
1172 does respond with OK, otherwise the return is an ERR with the reason why
1173 the recipient cannot be used, the encryption will then not be done for
1174 this recipient.  If the policy is not to encrypt at all if not all
1175 recipients are valid, the client has to take care of this.  All
1176 @code{RECIPIENT} commands are cumulative until a @code{RESET} or an
1177 successful @code{ENCRYPT} command.
1178
1179 @example
1180   INPUT FD[=@var{n}] [--armor|--base64|--binary]
1181 @end example
1182
1183 Set the file descriptor for the message to be encrypted to @var{n}.
1184 Obviously the pipe must be open at that point, the server establishes
1185 its own end.  If the server returns an error the client should consider
1186 this session failed.  If @var{n} is not given, this commands uses the
1187 last file descriptor passed to the application.
1188 @xref{fun-assuan_sendfd, ,the assuan_sendfd function,assuan,the Libassuan
1189 manual}, on how to do descriptor passing.
1190
1191 The @code{--armor} option may be used to advice the server that the
1192 input data is in @acronym{PEM} format, @code{--base64} advices that a
1193 raw base-64 encoding is used, @code{--binary} advices of raw binary
1194 input (@acronym{BER}).  If none of these options is used, the server
1195 tries to figure out the used encoding, but this may not always be
1196 correct.
1197
1198 @example
1199   OUTPUT FD[=@var{n}] [--armor|--base64]
1200 @end example
1201
1202 Set the file descriptor to be used for the output (i.e. the encrypted
1203 message). Obviously the pipe must be open at that point, the server
1204 establishes its own end.  If the server returns an error he client
1205 should consider this session failed.
1206
1207 The option armor encodes the output in @acronym{PEM} format, the
1208 @code{--base64} option applies just a base 64 encoding.  No option
1209 creates binary output (@acronym{BER}).
1210
1211 The actual encryption is done using the command
1212
1213 @example
1214   ENCRYPT
1215 @end example
1216
1217 It takes the plaintext from the @code{INPUT} command, writes to the
1218 ciphertext to the file descriptor set with the @code{OUTPUT} command,
1219 take the recipients from all the recipients set so far.  If this command
1220 fails the clients should try to delete all output currently done or
1221 otherwise mark it as invalid.  @command{GPGSM} does ensure that there
1222 will not be any
1223 security problem with leftover data on the output in this case.
1224
1225 This command should in general not fail, as all necessary checks have
1226 been done while setting the recipients.  The input and output pipes are
1227 closed.
1228
1229
1230 @node GPGSM DECRYPT
1231 @subsection Decrypting a message
1232
1233 Input and output FDs are set the same way as in encryption, but
1234 @code{INPUT} refers to the ciphertext and output to the plaintext. There
1235 is no need to set recipients.  @command{GPGSM} automatically strips any
1236 @acronym{S/MIME} headers from the input, so it is valid to pass an
1237 entire MIME part to the INPUT pipe.
1238
1239 The encryption is done by using the command
1240
1241 @example
1242   DECRYPT
1243 @end example
1244
1245 It performs the decrypt operation after doing some check on the internal
1246 state. (e.g. that all needed data has been set).  Because it utilizes
1247 the GPG-Agent for the session key decryption, there is no need to ask
1248 the client for a protecting passphrase - GpgAgent takes care of this by
1249 requesting this from the user.
1250
1251
1252 @node GPGSM SIGN
1253 @subsection Signing a Message
1254
1255 Signing is usually done with these commands:
1256
1257 @example
1258   INPUT FD[=@var{n}] [--armor|--base64|--binary]
1259 @end example
1260
1261 This tells @command{GPGSM} to read the data to sign from file descriptor @var{n}.
1262
1263 @example
1264   OUTPUT FD[=@var{m}] [--armor|--base64]
1265 @end example
1266
1267 Write the output to file descriptor @var{m}.  If a detached signature is
1268 requested, only the signature is written.
1269
1270 @example
1271   SIGN [--detached]
1272 @end example
1273
1274 Sign the data set with the INPUT command and write it to the sink set by
1275 OUTPUT.  With @code{--detached}, a detached signature is created
1276 (surprise).
1277
1278 The key used for signing is the default one or the one specified in
1279 the configuration file.  To get finer control over the keys, it is
1280 possible to use the command
1281
1282 @example
1283   SIGNER @var{userID}
1284 @end example
1285
1286 to the signer's key.  @var{userID} should be the
1287 internal representation of the key; the server may accept any other way
1288 of specification.  If this is a valid and trusted recipient the server
1289 does respond with OK, otherwise the return is an ERR with the reason why
1290 the key cannot be used, the signature will then not be created using
1291 this key.  If the policy is not to sign at all if not all
1292 keys are valid, the client has to take care of this.  All
1293 @code{SIGNER} commands are cumulative until a @code{RESET} is done.
1294 Note that a @code{SIGN} does not reset this list of signers which is in
1295 contrats to the @code{RECIPIENT} command.
1296
1297
1298 @node GPGSM VERIFY
1299 @subsection Verifying a Message
1300
1301 To verify a mesage the command:
1302
1303 @example
1304   VERIFY
1305 @end example
1306
1307 is used. It does a verify operation on the message send to the input FD.
1308 The result is written out using status lines.  If an output FD was
1309 given, the signed text will be written to that.  If the signature is a
1310 detached one, the server will inquire about the signed material and the
1311 client must provide it.
1312
1313 @node GPGSM GENKEY
1314 @subsection Generating a Key
1315
1316 This is used to generate a new keypair, store the secret part in the
1317 @acronym{PSE} and the public key in the key database.  We will probably
1318 add optional commands to allow the client to select whether a hardware
1319 token is used to store the key.  Configuration options to
1320 @command{GPGSM} can be used to restrict the use of this command.
1321
1322 @example
1323   GENKEY
1324 @end example
1325
1326 @command{GPGSM} checks whether this command is allowed and then does an
1327 INQUIRY to get the key parameters, the client should then send the
1328 key parameters in the native format:
1329
1330 @example
1331     S: INQUIRE KEY_PARAM native
1332     C: D foo:fgfgfg
1333     C: D bar
1334     C: END
1335 @end example
1336
1337 Please note that the server may send Status info lines while reading the
1338 data lines from the client.  After this the key generation takes place
1339 and the server eventually does send an ERR or OK response.  Status lines
1340 may be issued as a progress indicator.
1341
1342
1343 @node GPGSM LISTKEYS
1344 @subsection List available keys
1345
1346 To list the keys in the internal database or using an external key
1347 provider, the command:
1348
1349 @example
1350   LISTKEYS  @var{pattern}
1351 @end example
1352
1353 is used.  To allow multiple patterns (which are ORed during the search)
1354 quoting is required: Spaces are to be translated into "+" or into "%20";
1355 in turn this requires that the usual escape quoting rules are done.
1356
1357 @example
1358   LISTSECRETKEYS @var{pattern}
1359 @end example
1360
1361 Lists only the keys where a secret key is available.
1362
1363 The list commands  commands are affected by the option
1364
1365 @example
1366   OPTION list-mode=@var{mode}
1367 @end example
1368
1369 where mode may be:
1370 @table @code
1371 @item 0
1372 Use default (which is usually the same as 1).
1373 @item 1
1374 List only the internal keys.
1375 @item 2
1376 List only the external keys.
1377 @item 3
1378 List internal and external keys.
1379 @end table
1380
1381 Note that options are valid for the entire session.
1382
1383
1384 @node GPGSM EXPORT
1385 @subsection Export certificates
1386
1387 To export certificate from the internal key database the command:
1388
1389 @example
1390   EXPORT [--data [--armor] [--base64]] [--] @var{pattern}
1391 @end example
1392
1393 is used.  To allow multiple patterns (which are ORed) quoting is
1394 required: Spaces are to be translated into "+" or into "%20"; in turn
1395 this requires that the usual escape quoting rules are done.
1396
1397 If the @option{--data} option has not been given, the format of the
1398 output depends on what was set with the OUTPUT command.  When using
1399 @acronym{PEM} encoding a few informational lines are prepended.
1400
1401 If the @option{--data} has been given, a target set via OUTPUT is
1402 ignored and the data is returned inline using standard
1403 @code{D}-lines. This avoids the need for an extra file descriptor.  In
1404 this case the options @option{--armor} and @option{--base64} may be used
1405 in the same way as with the OUTPUT command.
1406
1407
1408 @node GPGSM IMPORT
1409 @subsection Import certificates
1410
1411 To import certificates into the internal key database, the command
1412
1413 @example
1414   IMPORT [--re-import]
1415 @end example
1416
1417 is used.  The data is expected on the file descriptor set with the
1418 @code{INPUT} command.  Certain checks are performed on the
1419 certificate.  Note that the code will also handle PKCS#12 files and
1420 import private keys; a helper program is used for that.
1421
1422 With the option @option{--re-import} the input data is expected to a be
1423 a linefeed separated list of fingerprints.  The command will re-import
1424 the corresponding certificates; that is they are made permanent by
1425 removing their ephemeral flag.
1426
1427
1428 @node GPGSM DELETE
1429 @subsection Delete certificates
1430
1431 To delete a certificate the command
1432
1433 @example
1434   DELKEYS @var{pattern}
1435 @end example
1436
1437 is used.  To allow multiple patterns (which are ORed) quoting is
1438 required: Spaces are to be translated into "+" or into "%20"; in turn
1439 this requires that the usual escape quoting rules are done.
1440
1441 The certificates must be specified unambiguously otherwise an error is
1442 returned.
1443
1444 @node GPGSM GETINFO
1445 @subsection  Return information about the process
1446
1447 This is a multipurpose function to return a variety of information.
1448
1449 @example
1450 GETINFO @var{what}
1451 @end example
1452
1453 The value of @var{what} specifies the kind of information returned:
1454 @table @code
1455 @item version
1456 Return the version of the program.
1457 @item pid
1458 Return the process id of the process.
1459 @item agent-check
1460 Return success if the agent is running.
1461 @item cmd_has_option @var{cmd} @var{opt}
1462 Return success if the command @var{cmd} implements the option @var{opt}.
1463 The leading two dashes usually used with @var{opt} shall not be given.
1464 @end table
1465
1466 @mansect see also
1467 @ifset isman
1468 @command{gpg2}(1),
1469 @command{gpg-agent}(1)
1470 @end ifset
1471 @include see-also-note.texi