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