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