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