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