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