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