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