1 This is gnupg.info, produced by makeinfo version 6.5 from gnupg.texi.
3 This is the 'The GNU Privacy Guard Manual' (version 2.2.32-beta2,
6 (C) 2002, 2004, 2005, 2006, 2007, 2010 Free Software Foundation, Inc.
7 (C) 2013, 2014, 2015 Werner Koch.
8 (C) 2015, 2016, 2017 g10 Code GmbH.
10 Permission is granted to copy, distribute and/or modify this
11 document under the terms of the GNU General Public License as
12 published by the Free Software Foundation; either version 3 of the
13 License, or (at your option) any later version. The text of the
14 license can be found in the section entitled "Copying".
15 INFO-DIR-SECTION GNU Utilities
17 * gpg2: (gnupg). OpenPGP encryption and signing tool.
18 * gpgsm: (gnupg). S/MIME encryption and signing tool.
19 * gpg-agent: (gnupg). The secret key daemon.
20 * dirmngr: (gnupg). X.509 CRL and OCSP server.
21 * dirmngr-client: (gnupg). X.509 CRL and OCSP client.
25 File: gnupg.info, Node: Top, Next: Installation, Up: (dir)
27 Using the GNU Privacy Guard
28 ***************************
30 This is the 'The GNU Privacy Guard Manual' (version 2.2.32-beta2,
33 (C) 2002, 2004, 2005, 2006, 2007, 2010 Free Software Foundation, Inc.
34 (C) 2013, 2014, 2015 Werner Koch.
35 (C) 2015, 2016, 2017 g10 Code GmbH.
37 Permission is granted to copy, distribute and/or modify this
38 document under the terms of the GNU General Public License as
39 published by the Free Software Foundation; either version 3 of the
40 License, or (at your option) any later version. The text of the
41 license can be found in the section entitled "Copying".
43 This manual documents how to use the GNU Privacy Guard system as well
44 as the administration and the architecture.
48 * Installation:: A short installation guide.
50 * Invoking GPG-AGENT:: How to launch the secret key daemon.
51 * Invoking DIRMNGR:: How to launch the CRL and OCSP daemon.
52 * Invoking GPG:: Using the OpenPGP protocol.
53 * Invoking GPGSM:: Using the S/MIME protocol.
54 * Invoking SCDAEMON:: How to handle Smartcards.
55 * Specify a User ID:: How to Specify a User Id.
56 * Trust Values:: How GnuPG displays trust values.
58 * Helper Tools:: Description of small helper tools
59 * Web Key Service:: Tools for the Web Key Service
61 * Howtos:: How to do certain things.
62 * System Notes:: Notes pertaining to certain OSes.
63 * Debugging:: How to solve problems
65 * Copying:: GNU General Public License says
66 how you can copy and share GnuPG
67 * Contributors:: People who have contributed to GnuPG.
69 * Glossary:: Short description of terms used.
70 * Option Index:: Index to command line options.
71 * Environment Index:: Index to environment variables and files.
72 * Index:: Index of concepts and symbol names.
75 File: gnupg.info, Node: Installation, Next: Invoking GPG-AGENT, Prev: Top, Up: Top
77 1 A short installation guide
78 ****************************
80 Unfortunately the installation guide has not been finished in time.
81 Instead of delaying the release of GnuPG 2.0 even further, I decided to
82 release without that guide. The chapter on gpg-agent and gpgsm do
83 include brief information on how to set up the whole thing. Please
84 watch the GnuPG website for updates of the documentation. In the
85 meantime you may search the GnuPG mailing list archives or ask on the
86 gnupg-users mailing list for advise on how to solve problems or how to
87 get that whole thing up and running.
89 ** Building the software
91 Building the software is described in the file 'INSTALL'. Given that
92 you are already reading this documentation we can only give some extra
95 To comply with the rules on GNU systems you should have build time
96 configured 'gnupg' using:
98 ./configure --sysconfdir=/etc --localstatedir=/var
100 This is to make sure that system wide configuration files are
101 searched in the directory '/etc' and variable data below '/var'; the
102 default would be to also install them below '/usr/local' where the
103 binaries get installed. If you selected to use the '--prefix=/' you
104 obviously don't need those option as they are the default then.
106 ** Notes on setting a root CA key to trusted
108 X.509 is based on a hierarchical key infrastructure. At the root of
109 the tree a trusted anchor (root certificate) is required. There are
110 usually no other means of verifying whether this root certificate is
111 trustworthy than looking it up in a list. GnuPG uses a file
112 ('trustlist.txt') to keep track of all root certificates it knows about.
113 There are 3 ways to get certificates into this list:
115 * Use the list which comes with GnuPG. However this list only
116 contains a few root certificates. Most installations will need
119 * Let 'gpgsm' ask you whether you want to insert a new root
120 certificate. This feature is enabled by default; you may disable
121 it using the option 'no-allow-mark-trusted' into 'gpg-agent.conf'.
123 * Manually maintain the list of trusted root certificates. For a
124 multi user installation this can be done once for all users on a
125 machine. Specific changes on a per-user base are also possible.
128 File: gnupg.info, Node: Invoking GPG-AGENT, Next: Invoking DIRMNGR, Prev: Installation, Up: Top
133 'gpg-agent' is a daemon to manage secret (private) keys independently
134 from any protocol. It is used as a backend for 'gpg' and 'gpgsm' as
135 well as for a couple of other utilities.
137 The agent is automatically started on demand by 'gpg', 'gpgsm',
138 'gpgconf', or 'gpg-connect-agent'. Thus there is no reason to start it
139 manually. In case you want to use the included Secure Shell Agent you
140 may start the agent using:
142 gpg-connect-agent /bye
144 If you want to manually terminate the currently-running agent, you can
147 gpgconf --kill gpg-agent
149 You should always add the following lines to your '.bashrc' or whatever
150 initialization file is used for all shell invocations:
155 It is important that this environment variable always reflects the
156 output of the 'tty' command. For W32 systems this option is not
159 Please make sure that a proper pinentry program has been installed
160 under the default filename (which is system dependent) or use the option
161 'pinentry-program' to specify the full name of that program. It is
162 often useful to install a symbolic link from the actual used pinentry
163 (e.g. '/usr/local/bin/pinentry-gtk') to the expected one (e.g.
164 '/usr/local/bin/pinentry').
166 *Note Option Index::, for an index to 'GPG-AGENT''s commands and
171 * Agent Commands:: List of all commands.
172 * Agent Options:: List of all options.
173 * Agent Configuration:: Configuration files.
174 * Agent Signals:: Use of some signals.
175 * Agent Examples:: Some usage examples.
176 * Agent Protocol:: The protocol the agent uses.
179 File: gnupg.info, Node: Agent Commands, Next: Agent Options, Up: Invoking GPG-AGENT
184 Commands are not distinguished from options except for the fact that
185 only one command is allowed.
188 Print the program version and licensing information. Note that you
189 cannot abbreviate this command.
193 Print a usage message summarizing the most useful command-line
194 options. Note that you cannot abbreviate this command.
197 Print a list of all available options and commands. Note that you
198 cannot abbreviate this command.
201 Run in server mode and wait for commands on the 'stdin'. The
202 default mode is to create a socket and listen for commands there.
204 '--daemon [COMMAND LINE]'
205 Start the gpg-agent as a daemon; that is, detach it from the
206 console and run it in the background.
208 As an alternative you may create a new process as a child of
209 gpg-agent: 'gpg-agent --daemon /bin/sh'. This way you get a new
210 shell with the environment setup properly; after you exit from this
211 shell, gpg-agent terminates within a few seconds.
214 Run in the foreground, sending logs by default to stderr, and
215 listening on provided file descriptors, which must already be bound
216 to listening sockets. This command is useful when running under
217 systemd or other similar process supervision schemes. This option
218 is not supported on Windows.
220 In -supervised mode, different file descriptors can be provided for
221 use as different socket types (e.g. ssh, extra) as long as they
222 are identified in the environment variable 'LISTEN_FDNAMES' (see
223 sd_listen_fds(3) on some Linux distributions for more information
227 File: gnupg.info, Node: Agent Options, Next: Agent Configuration, Prev: Agent Commands, Up: Invoking GPG-AGENT
232 Options may either be used on the command line or, after stripping off
233 the two leading dashes, in the configuration file.
236 Reads configuration from FILE instead of from the default per-user
237 configuration file. The default configuration file is named
238 'gpg-agent.conf' and expected in the '.gnupg' directory directly
239 below the home directory of the user. This option is ignored if
240 used in an options file.
243 Set the name of the home directory to DIR. If this option is not
244 used, the home directory defaults to '~/.gnupg'. It is only
245 recognized when given on the command line. It also overrides any
246 home directory stated through the environment variable 'GNUPGHOME'
247 or (on Windows systems) by means of the Registry entry
248 HKCU\SOFTWARE\GNU\GNUPG:HOMEDIR.
250 On Windows systems it is possible to install GnuPG as a portable
251 application. In this case only this command line option is
252 considered, all other ways to set a home directory are ignored.
254 To install GnuPG as a portable application under Windows, create an
255 empty file named 'gpgconf.ctl' in the same directory as the tool
256 'gpgconf.exe'. The root of the installation is then that
257 directory; or, if 'gpgconf.exe' has been installed directly below a
258 directory named 'bin', its parent directory. You also need to make
259 sure that the following directories exist and are writable:
260 'ROOT/home' for the GnuPG home and 'ROOT/usr/local/var/cache/gnupg'
261 for internal cache files.
265 Outputs additional information while running. You can increase the
266 verbosity by giving several verbose commands to 'gpg-agent', such
271 Try to be as quiet as possible.
274 Don't invoke a pinentry or do any other thing requiring human
277 '--faked-system-time EPOCH'
278 This option is only useful for testing; it sets the system time
279 back or forth to EPOCH which is the number of seconds elapsed since
282 '--debug-level LEVEL'
283 Select the debug level for investigating problems. LEVEL may be a
284 numeric value or a keyword:
287 No debugging at all. A value of less than 1 may be used
288 instead of the keyword.
290 Some basic debug messages. A value between 1 and 2 may be
291 used instead of the keyword.
293 More verbose debug messages. A value between 3 and 5 may be
294 used instead of the keyword.
296 Even more detailed messages. A value between 6 and 8 may be
297 used instead of the keyword.
299 All of the debug messages you can get. A value greater than 8
300 may be used instead of the keyword. The creation of hash
301 tracing files is only enabled if the keyword is used.
303 How these messages are mapped to the actual debugging flags is not
304 specified and may change with newer releases of this program. They
305 are however carefully selected to best aid in debugging.
308 This option is only useful for debugging and the behavior may
309 change at any time without notice. FLAGS are bit encoded and may
310 be given in usual C-Syntax. The currently defined bits are:
313 X.509 or OpenPGP protocol related data
315 values of big number integers
317 low level crypto operations
323 show memory statistics
325 write hashed data to files named 'dbgmd-000*'
327 trace Assuan protocol
329 bypass all certificate validation
332 Same as '--debug=0xffffffff'
335 When running in server mode, wait N seconds before entering the
336 actual processing loop and print the pid. This gives time to
339 '--debug-quick-random'
340 This option inhibits the use of the very secure random quality
341 level (Libgcrypt’s 'GCRY_VERY_STRONG_RANDOM') and degrades all
342 request down to standard random quality. It is only used for
343 testing and should not be used for any production quality keys.
344 This option is only effective when given on the command line.
346 On GNU/Linux, another way to quickly generate insecure keys is to
347 use 'rngd' to fill the kernel's entropy pool with lower quality
348 random data. 'rngd' is typically provided by the 'rng-tools'
349 package. It can be run as follows: 'sudo rngd -f -r /dev/urandom'.
352 This option enables extra debug information pertaining to the
353 Pinentry. As of now it is only useful when used along with
357 Don't detach the process from the console. This is mainly useful
364 Format the info output in daemon mode for use with the standard
365 Bourne shell or the C-shell respectively. The default is to guess
366 it based on the environment variable 'SHELL' which is correct in
371 Tell the pinentry to grab the keyboard and mouse. This option
372 should be used on X-Servers to avoid X-sniffing attacks. Any use
373 of the option '--grab' overrides an used option '--no-grab'. The
374 default is '--no-grab'.
377 Append all logging output to FILE. This is very helpful in seeing
378 what the agent actually does. Use 'socket://' to log to socket.
379 If neither a log file nor a log file descriptor has been set on a
380 Windows platform, the Registry entry
381 'HKCU\Software\GNU\GnuPG:DefaultLogFile', if set, is used to
382 specify the logging output.
384 '--no-allow-mark-trusted'
385 Do not allow clients to mark keys as trusted, i.e. put them into
386 the 'trustlist.txt' file. This makes it harder for users to
387 inadvertently accept Root-CA keys.
389 '--allow-preset-passphrase'
390 This option allows the use of 'gpg-preset-passphrase' to seed the
391 internal cache of 'gpg-agent' with passphrases.
393 '--no-allow-loopback-pinentry'
394 '--allow-loopback-pinentry'
395 Disallow or allow clients to use the loopback pinentry features;
396 see the option 'pinentry-mode' for details. Allow is the default.
398 The '--force' option of the Assuan command 'DELETE_KEY' is also
399 controlled by this option: The option is ignored if a loopback
400 pinentry is disallowed.
402 '--no-allow-external-cache'
403 Tell Pinentry not to enable features which use an external cache
406 Some desktop environments prefer to unlock all credentials with one
407 master password and may have installed a Pinentry which employs an
408 additional external cache to implement such a policy. By using
409 this option the Pinentry is advised not to make use of such a cache
410 and instead always ask the user for the requested passphrase.
412 '--allow-emacs-pinentry'
413 Tell Pinentry to allow features to divert the passphrase entry to a
414 running Emacs instance. How this is exactly handled depends on the
415 version of the used Pinentry.
417 '--ignore-cache-for-signing'
418 This option will let 'gpg-agent' bypass the passphrase cache for
419 all signing operation. Note that there is also a per-session
420 option to control this behavior but this command line option takes
423 '--default-cache-ttl N'
424 Set the time a cache entry is valid to N seconds. The default is
425 600 seconds. Each time a cache entry is accessed, the entry's
426 timer is reset. To set an entry's maximum lifetime, use
427 'max-cache-ttl'. Note that a cached passphrase may not be evicted
428 immediately from memory if no client requests a cache operation.
429 This is due to an internal housekeeping function which is only run
432 '--default-cache-ttl-ssh N'
433 Set the time a cache entry used for SSH keys is valid to N seconds.
434 The default is 1800 seconds. Each time a cache entry is accessed,
435 the entry's timer is reset. To set an entry's maximum lifetime,
436 use 'max-cache-ttl-ssh'.
439 Set the maximum time a cache entry is valid to N seconds. After
440 this time a cache entry will be expired even if it has been
441 accessed recently or has been set using 'gpg-preset-passphrase'.
442 The default is 2 hours (7200 seconds).
444 '--max-cache-ttl-ssh N'
445 Set the maximum time a cache entry used for SSH keys is valid to N
446 seconds. After this time a cache entry will be expired even if it
447 has been accessed recently or has been set using
448 'gpg-preset-passphrase'. The default is 2 hours (7200 seconds).
450 '--enforce-passphrase-constraints'
451 Enforce the passphrase constraints by not allowing the user to
452 bypass them using the "Take it anyway" button.
454 '--min-passphrase-len N'
455 Set the minimal length of a passphrase. When entering a new
456 passphrase shorter than this value a warning will be displayed.
459 '--min-passphrase-nonalpha N'
460 Set the minimal number of digits or special characters required in
461 a passphrase. When entering a new passphrase with less than this
462 number of digits or special characters a warning will be displayed.
465 '--check-passphrase-pattern FILE'
466 '--check-sym-passphrase-pattern FILE'
467 Check the passphrase against the pattern given in FILE. When
468 entering a new passphrase matching one of these pattern a warning
469 will be displayed. If FILE does not contain any slashes and does
470 not start with "~/" it is searched in the system configuration
471 directory ('/etc/gnupg'). The default is not to use any pattern
472 file. The second version of this option is only used when creating
473 a new symmetric key to allow the use of different patterns for such
476 Security note: It is known that checking a passphrase against a
477 list of pattern or even against a complete dictionary is not very
478 effective to enforce good passphrases. Users will soon figure up
479 ways to bypass such a policy. A better policy is to educate users
480 on good security behavior and optionally to run a passphrase
481 cracker regularly on all users passphrases to catch the very simple
484 '--max-passphrase-days N'
485 Ask the user to change the passphrase if N days have passed since
486 the last change. With '--enforce-passphrase-constraints' set the
487 user may not bypass this check.
489 '--enable-passphrase-history'
490 This option does nothing yet.
492 '--pinentry-invisible-char CHAR'
493 This option asks the Pinentry to use CHAR for displaying hidden
494 characters. CHAR must be one character UTF-8 string. A Pinentry
495 may or may not honor this request.
497 '--pinentry-timeout N'
498 This option asks the Pinentry to timeout after N seconds with no
499 user input. The default value of 0 does not ask the pinentry to
500 timeout, however a Pinentry may use its own default timeout value
501 in this case. A Pinentry may or may not honor this request.
503 '--pinentry-formatted-passphrase'
504 This option asks the Pinentry to enable passphrase formatting when
505 asking the user for a new passphrase and masking of the passphrase
508 If passphrase formatting is enabled, then all non-breaking space
509 characters are stripped from the entered passphrase. Passphrase
510 formatting is mostly useful in combination with passphrases
511 generated with the GENPIN feature of some Pinentries. Note that
512 such a generated passphrase, if not modified by the user, skips all
513 passphrase constraints checking because such constraints would
514 actually weaken the generated passphrase.
516 '--pinentry-program FILENAME'
517 Use program FILENAME as the PIN entry. The default is installation
518 dependent. With the default configuration the name of the default
519 pinentry is 'pinentry'; if that file does not exist but a
520 'pinentry-basic' exist the latter is used.
522 On a Windows platform the default is to use the first existing
523 program from this list: 'bin\pinentry.exe',
524 '..\Gpg4win\bin\pinentry.exe', '..\Gpg4win\pinentry.exe',
525 '..\GNU\GnuPG\pinentry.exe', '..\GNU\bin\pinentry.exe',
526 'bin\pinentry-basic.exe' where the file names are relative to the
527 GnuPG installation directory.
529 '--pinentry-touch-file FILENAME'
530 By default the filename of the socket gpg-agent is listening for
531 requests is passed to Pinentry, so that it can touch that file
532 before exiting (it does this only in curses mode). This option
533 changes the file passed to Pinentry to FILENAME. The special name
534 '/dev/null' may be used to completely disable this feature. Note
535 that Pinentry will not create that file, it will only change the
536 modification and access time.
538 '--scdaemon-program FILENAME'
539 Use program FILENAME as the Smartcard daemon. The default is
540 installation dependent and can be shown with the 'gpgconf' command.
543 Do not make use of the scdaemon tool. This option has the effect
544 of disabling the ability to do smartcard operations. Note, that
545 enabling this option at runtime does not kill an already forked
548 '--disable-check-own-socket'
549 'gpg-agent' employs a periodic self-test to detect a stolen socket.
550 This usually means a second instance of 'gpg-agent' has taken over
551 the socket and 'gpg-agent' will then terminate itself. This option
552 may be used to disable this self-test for debugging purposes.
554 '--use-standard-socket'
555 '--no-use-standard-socket'
556 '--use-standard-socket-p'
557 Since GnuPG 2.1 the standard socket is always used. These options
558 have no more effect. The command 'gpg-agent
559 --use-standard-socket-p' will thus always return success.
565 '--lc-messages STRING'
566 '--xauthority STRING'
567 These options are used with the server mode to pass localization
572 Ignore requests to change the current 'tty' or X window system's
573 'DISPLAY' variable respectively. This is useful to lock the
574 pinentry to pop up at the 'tty' or display you started the agent.
577 Set the size of the queue for pending connections. The default is
580 '--extra-socket NAME'
581 The extra socket is created by default, you may use this option to
582 change the name of the socket. To disable the creation of the
583 socket use "none" or "/dev/null" for NAME.
585 Also listen on native gpg-agent connections on the given socket.
586 The intended use for this extra socket is to setup a Unix domain
587 socket forwarding from a remote machine to this socket on the local
588 machine. A 'gpg' running on the remote machine may then connect to
589 the local gpg-agent and use its private keys. This enables
590 decrypting or signing data on a remote machine without exposing the
591 private keys to the remote machine.
593 '--enable-extended-key-format'
594 '--disable-extended-key-format'
595 Since version 2.2.22 keys are created in the extended private key
596 format by default. Changing the passphrase of a key will also
597 convert the key to that new format. This key format is supported
598 since GnuPG version 2.1.12 and thus there should be no need to
599 disable it. Anyway, the disable option still allows to revert to
600 the old behavior for new keys; be aware that keys are never
601 migrated back to the old format. If the enable option has been
602 used the disable option won't have an effect. The advantage of the
603 extended private key format is that it is text based and can carry
604 additional meta data. In extended key format the OCB mode is used
607 '--enable-ssh-support'
608 '--enable-putty-support'
610 The OpenSSH Agent protocol is always enabled, but 'gpg-agent' will
611 only set the 'SSH_AUTH_SOCK' variable if this flag is given.
613 In this mode of operation, the agent does not only implement the
614 gpg-agent protocol, but also the agent protocol used by OpenSSH
615 (through a separate socket). Consequently, it should be possible
616 to use the gpg-agent as a drop-in replacement for the well known
619 SSH Keys, which are to be used through the agent, need to be added
620 to the gpg-agent initially through the ssh-add utility. When a key
621 is added, ssh-add will ask for the password of the provided key
622 file and send the unprotected key material to the agent; this
623 causes the gpg-agent to ask for a passphrase, which is to be used
624 for encrypting the newly received key and storing it in a gpg-agent
627 Once a key has been added to the gpg-agent this way, the gpg-agent
628 will be ready to use the key.
630 Note: in case the gpg-agent receives a signature request, the user
631 might need to be prompted for a passphrase, which is necessary for
632 decrypting the stored key. Since the ssh-agent protocol does not
633 contain a mechanism for telling the agent on which display/terminal
634 it is running, gpg-agent's ssh-support will use the TTY or X
635 display where gpg-agent has been started. To switch this display
636 to the current one, the following command may be used:
638 gpg-connect-agent updatestartuptty /bye
640 Although all GnuPG components try to start the gpg-agent as needed,
641 this is not possible for the ssh support because ssh does not know
642 about it. Thus if no GnuPG tool which accesses the agent has been
643 run, there is no guarantee that ssh is able to use gpg-agent for
644 authentication. To fix this you may start gpg-agent if needed
645 using this simple command:
647 gpg-connect-agent /bye
649 Adding the '--verbose' shows the progress of starting the agent.
651 The '--enable-putty-support' is only available under Windows and
652 allows the use of gpg-agent with the ssh implementation 'putty'.
653 This is similar to the regular ssh-agent support but makes use of
654 Windows message queue as required by 'putty'.
656 '--ssh-fingerprint-digest'
658 Select the digest algorithm used to compute ssh fingerprints that
659 are communicated to the user, e.g. in pinentry dialogs. OpenSSH
660 has transitioned from using MD5 to the more secure SHA256.
662 '--auto-expand-secmem N'
663 Allow Libgcrypt to expand its secure memory area as required. The
664 optional value N is a non-negative integer with a suggested size in
665 bytes of each additionally allocated secure memory area. The value
666 is rounded up to the next 32 KiB; usual C style prefixes are
667 allowed. For an heavy loaded gpg-agent with many concurrent
668 connection this option avoids sign or decrypt errors due to out of
669 secure memory error returns.
671 '--s2k-calibration MILLISECONDS'
672 Change the default calibration time to MILLISECONDS. The given
673 value is capped at 60 seconds; a value of 0 resets to the
674 compiled-in default. This option is re-read on a SIGHUP (or
675 'gpgconf --reload gpg-agent') and the S2K count is then
679 Specify the iteration count used to protect the passphrase. This
680 option can be used to override the auto-calibration done by
681 default. The auto-calibration computes a count which requires by
682 default 100ms to mangle a given passphrase. See also
685 To view the actually used iteration count and the milliseconds
686 required for an S2K operation use:
688 gpg-connect-agent 'GETINFO s2k_count' /bye
689 gpg-connect-agent 'GETINFO s2k_time' /bye
691 To view the auto-calibrated count use:
693 gpg-connect-agent 'GETINFO s2k_count_cal' /bye
696 File: gnupg.info, Node: Agent Configuration, Next: Agent Signals, Prev: Agent Options, Up: Invoking GPG-AGENT
701 There are a few configuration files needed for the operation of the
702 agent. By default they may all be found in the current home directory
703 (*note option --homedir::).
706 This is the standard configuration file read by 'gpg-agent' on
707 startup. It may contain any valid long option; the leading two
708 dashes may not be entered and the option may not be abbreviated.
709 This file is also read after a 'SIGHUP' however only a few options
710 will actually have an effect. This default name may be changed on
711 the command line (*note option --options::). You should backup
715 This is the list of trusted keys. You should backup this file.
717 Comment lines, indicated by a leading hash mark, as well as empty
718 lines are ignored. To mark a key as trusted you need to enter its
719 fingerprint followed by a space and a capital letter 'S'. Colons
720 may optionally be used to separate the bytes of a fingerprint; this
721 enables cutting and pasting the fingerprint from a key listing
722 output. If the line is prefixed with a '!' the key is explicitly
723 marked as not trusted.
725 Here is an example where two keys are marked as ultimately trusted
726 and one as not trusted:
728 # CN=Wurzel ZS 3,O=Intevation GmbH,C=DE
729 A6935DD34EF3087973C706FC311AA2CCF733765B S
731 # CN=PCA-1-Verwaltung-02/O=PKI-1-Verwaltung/C=DE
732 DC:BD:69:25:48:BD:BB:7E:31:6E:BB:80:D3:00:80:35:D4:F8:A6:CD S
734 # CN=Root-CA/O=Schlapphuete/L=Pullach/C=DE
735 !14:56:98:D3:FE:9C:CA:5A:31:6E:BC:81:D3:11:4E:00:90:A3:44:C2 S
737 Before entering a key into this file, you need to ensure its
738 authenticity. How to do this depends on your organisation; your
739 administrator might have already entered those keys which are
740 deemed trustworthy enough into this file. Places where to look for
741 the fingerprint of a root certificate are letters received from the
742 CA or the website of the CA (after making 100% sure that this is
743 indeed the website of that CA). You may want to consider
744 disallowing interactive updates of this file by using the *note
745 option --no-allow-mark-trusted::. It might even be advisable to
746 change the permissions to read-only so that this file can't be
747 changed inadvertently.
749 As a special feature a line 'include-default' will include a global
750 list of trusted certificates (e.g. '/etc/gnupg/trustlist.txt').
751 This global list is also used if the local list is not available.
753 It is possible to add further flags after the 'S' for use by the
757 Relax checking of some root certificate requirements. As of
758 now this flag allows the use of root certificates with a
759 missing basicConstraints attribute (despite that it is a MUST
760 for CA certificates) and disables CRL checking for the root
764 If validation of a certificate finally issued by a CA with
765 this flag set fails, try again using the chain validation
769 This file is used when support for the secure shell agent protocol
770 has been enabled (*note option --enable-ssh-support::). Only keys
771 present in this file are used in the SSH protocol. You should
774 The 'ssh-add' tool may be used to add new entries to this file; you
775 may also add them manually. Comment lines, indicated by a leading
776 hash mark, as well as empty lines are ignored. An entry starts
777 with optional whitespace, followed by the keygrip of the key given
778 as 40 hex digits, optionally followed by the caching TTL in seconds
779 and another optional field for arbitrary flags. A non-zero TTL
780 overrides the global default as set by '--default-cache-ttl-ssh'.
782 The only flag support is 'confirm'. If this flag is found for a
783 key, each use of the key will pop up a pinentry to confirm the use
784 of that key. The flag is automatically set if a new key was loaded
785 into 'gpg-agent' using the option '-c' of the 'ssh-add' command.
787 The keygrip may be prefixed with a '!' to disable an entry.
789 The following example lists exactly one key. Note that keys
790 available through a OpenPGP smartcard in the active smartcard
791 reader are implicitly added to this list; i.e. there is no need to
794 # Key added on: 2011-07-20 20:38:46
795 # Fingerprint: 5e:8d:c4:ad:e7:af:6e:27:8a:d6:13:e4:79:ad:0b:81
796 34B62F25E277CF13D3C6BCEBFD3F85D08F0A864B 0 confirm
800 This is the directory where gpg-agent stores the private keys.
801 Each key is stored in a file with the name made up of the keygrip
802 and the suffix 'key'. You should backup all files in this
803 directory and take great care to keep this backup closed away.
805 Note that on larger installations, it is useful to put predefined
806 files into the directory '/etc/skel/.gnupg' so that newly created users
807 start up with a working configuration. For existing users the a small
808 helper script is provided to create these files (*note addgnupghome::).
811 File: gnupg.info, Node: Agent Signals, Next: Agent Examples, Prev: Agent Configuration, Up: Invoking GPG-AGENT
813 2.4 Use of some signals
814 =======================
816 A running 'gpg-agent' may be controlled by signals, i.e. using the
817 'kill' command to send a signal to the process.
819 Here is a list of supported signals:
822 This signal flushes all cached passphrases and if the program has
823 been started with a configuration file, the configuration file is
824 read again. Only certain options are honored: 'quiet', 'verbose',
825 'debug', 'debug-all', 'debug-level', 'debug-pinentry', 'no-grab',
826 'pinentry-program', 'pinentry-invisible-char', 'default-cache-ttl',
827 'max-cache-ttl', 'ignore-cache-for-signing', 's2k-count',
828 'no-allow-external-cache', 'allow-emacs-pinentry',
829 'no-allow-mark-trusted', 'disable-scdaemon', and
830 'disable-check-own-socket'. 'scdaemon-program' is also supported
831 but due to the current implementation, which calls the scdaemon
832 only once, it is not of much use unless you manually kill the
836 Shuts down the process but waits until all current requests are
837 fulfilled. If the process has received 3 of these signals and
838 requests are still pending, a shutdown is forced.
841 Shuts down the process immediately.
844 Dump internal information to the log file.
847 This signal is used for internal purposes.
850 File: gnupg.info, Node: Agent Examples, Next: Agent Protocol, Prev: Agent Signals, Up: Invoking GPG-AGENT
855 It is important to set the environment variable 'GPG_TTY' in your login
856 shell, for example in the '~/.bashrc' init script:
858 export GPG_TTY=$(tty)
860 If you enabled the Ssh Agent Support, you also need to tell ssh about
861 it by adding this to your init script:
864 if [ "${gnupg_SSH_AUTH_SOCK_by:-0}" -ne $$ ]; then
865 export SSH_AUTH_SOCK="$(gpgconf --list-dirs agent-ssh-socket)"
869 File: gnupg.info, Node: Agent Protocol, Prev: Agent Examples, Up: Invoking GPG-AGENT
871 2.6 Agent's Assuan Protocol
872 ===========================
874 Note: this section does only document the protocol, which is used by
875 GnuPG components; it does not deal with the ssh-agent protocol. To see
876 the full specification of each command, use
878 gpg-connect-agent 'help COMMAND' /bye
880 or just 'help' to list all available commands.
882 The 'gpg-agent' daemon is started on demand by the GnuPG components.
884 To identify a key we use a thing called keygrip which is the SHA-1
885 hash of an canonical encoded S-Expression of the public key as used in
886 Libgcrypt. For the purpose of this interface the keygrip is given as a
887 hex string. The advantage of using this and not the hash of a
888 certificate is that it will be possible to use the same keypair for
889 different protocols, thereby saving space on the token used to keep the
892 The 'gpg-agent' may send status messages during a command or when
893 returning from a command to inform a client about the progress or result
894 of an operation. For example, the INQUIRE_MAXLEN status message may be
895 sent during a server inquire to inform the client of the maximum usable
896 length of the inquired data (which should not be exceeded).
900 * Agent PKDECRYPT:: Decrypting a session key
901 * Agent PKSIGN:: Signing a Hash
902 * Agent GENKEY:: Generating a Key
903 * Agent IMPORT:: Importing a Secret Key
904 * Agent EXPORT:: Exporting a Secret Key
905 * Agent ISTRUSTED:: Importing a Root Certificate
906 * Agent GET_PASSPHRASE:: Ask for a passphrase
907 * Agent CLEAR_PASSPHRASE:: Expire a cached passphrase
908 * Agent PRESET_PASSPHRASE:: Set a passphrase for a keygrip
909 * Agent GET_CONFIRMATION:: Ask for confirmation
910 * Agent HAVEKEY:: Check whether a key is available
911 * Agent LEARN:: Register a smartcard
912 * Agent PASSWD:: Change a Passphrase
913 * Agent UPDATESTARTUPTTY:: Change the Standard Display
914 * Agent GETEVENTCOUNTER:: Get the Event Counters
915 * Agent GETINFO:: Return information about the process
916 * Agent OPTION:: Set options for the session
919 File: gnupg.info, Node: Agent PKDECRYPT, Next: Agent PKSIGN, Up: Agent Protocol
921 2.6.1 Decrypting a session key
922 ------------------------------
924 The client asks the server to decrypt a session key. The encrypted
925 session key should have all information needed to select the appropriate
926 secret key or to delegate it to a smartcard.
930 Tell the server about the key to be used for decryption. If this is
931 not used, 'gpg-agent' may try to figure out the key by trying to decrypt
932 the message with each key available.
936 The agent checks whether this command is allowed and then does an
937 INQUIRY to get the ciphertext the client should then send the cipher
940 S: INQUIRE CIPHERTEXT
945 Please note that the server may send status info lines while reading
946 the data lines from the client. The data send is a SPKI like S-Exp with
951 (<param_name1> <mpi>)
953 (<param_namen> <mpi>)))
955 Where algo is a string with the name of the algorithm; see the
956 libgcrypt documentation for a list of valid algorithms. The number and
957 names of the parameters depend on the algorithm. The agent does return
958 an error if there is an inconsistency.
960 If the decryption was successful the decrypted data is returned by
963 Here is an example session:
965 S: INQUIRE CIPHERTEXT
966 C: D (enc-val elg (a 349324324)
967 C: D (b 3F444677CA)))
969 S: # session key follows
971 S: D (value 1234567890ABCDEF0)
972 S: OK decryption successful
974 The “PADDING” status line is only send if gpg-agent can tell what
975 kind of padding is used. As of now only the value 0 is used to indicate
976 that the padding has been removed.
979 File: gnupg.info, Node: Agent PKSIGN, Next: Agent GENKEY, Prev: Agent PKDECRYPT, Up: Agent Protocol
984 The client asks the agent to sign a given hash value. A default key
985 will be chosen if no key has been set. To set a key a client first
990 This can be used multiple times to create multiple signature, the
991 list of keys is reset with the next PKSIGN command or a RESET. The
992 server tests whether the key is a valid key to sign something and
995 SETHASH --hash=<name>|<algo> <hexstring>
997 The client can use this command to tell the server about the data
998 <hexstring> (which usually is a hash) to be signed. <algo> is the
999 decimal encoded hash algorithm number as used by Libgcrypt. Either
1000 <algo> or -hash=<name> must be given. Valid names for <name> are:
1003 The SHA-1 hash algorithm
1005 The SHA-256 hash algorithm
1007 The RIPE-MD160 hash algorithm
1009 The old and broken MD5 hash algorithm
1011 A combined hash algorithm as used by the TLS protocol.
1013 The actual signing is done using
1017 Options are not yet defined, but may later be used to choose among
1018 different algorithms. The agent does then some checks, asks for the
1019 passphrase and as a result the server returns the signature as an SPKI
1020 like S-expression in "D" lines:
1024 (<param_name1> <mpi>)
1026 (<param_namen> <mpi>)))
1028 The operation is affected by the option
1030 OPTION use-cache-for-signing=0|1
1032 The default of '1' uses the cache. Setting this option to '0' will
1033 lead 'gpg-agent' to ignore the passphrase cache. Note, that there is
1034 also a global command line option for 'gpg-agent' to globally disable
1037 Here is an example session:
1043 S: # I did ask the user whether he really wants to sign
1044 S: # I did ask the user for the passphrase
1046 C: D ABCDEF012345678901234
1048 S: # signature follows
1049 S: D (sig-val rsa (s 45435453654612121212))
1053 File: gnupg.info, Node: Agent GENKEY, Next: Agent IMPORT, Prev: Agent PKSIGN, Up: Agent Protocol
1055 2.6.3 Generating a Key
1056 ----------------------
1058 This is used to create a new keypair and store the secret key inside the
1059 active PSE -- which is in most cases a Soft-PSE. A not-yet-defined
1060 option allows choosing the storage location. To get the secret key out
1061 of the PSE, a special export tool has to be used.
1063 GENKEY [--no-protection] [--preset] [<cache_nonce>]
1065 Invokes the key generation process and the server will then inquire
1066 on the generation parameters, like:
1069 C: D (genkey (rsa (nbits 1024)))
1072 The format of the key parameters which depends on the algorithm is of
1077 (parameter_name_1 ....)
1079 (parameter_name_n ....)))
1081 If everything succeeds, the server returns the *public key* in a SPKI
1082 like S-Expression like this:
1089 Here is an example session:
1092 C: D (genkey (rsa (nbits 1024)))
1095 S: D (rsa (n 326487324683264) (e 10001)))
1098 The '--no-protection' option may be used to prevent prompting for a
1099 passphrase to protect the secret key while leaving the secret key
1100 unprotected. The '--preset' option may be used to add the passphrase to
1101 the cache using the default cache parameters.
1103 The '--inq-passwd' option may be used to create the key with a
1104 supplied passphrase. When used the agent does an inquiry with the
1105 keyword 'NEWPASSWD' to retrieve that passphrase. This option takes
1106 precedence over '--no-protection'; however if the client sends a empty
1107 (zero-length) passphrase, this is identical to '--no-protection'.
1110 File: gnupg.info, Node: Agent IMPORT, Next: Agent EXPORT, Prev: Agent GENKEY, Up: Agent Protocol
1112 2.6.4 Importing a Secret Key
1113 ----------------------------
1115 This operation is not yet supported by GpgAgent. Specialized tools are
1116 to be used for this.
1118 There is no actual need because we can expect that secret keys
1119 created by a 3rd party are stored on a smartcard. If we have generated
1120 the key ourselves, we do not need to import it.
1123 File: gnupg.info, Node: Agent EXPORT, Next: Agent ISTRUSTED, Prev: Agent IMPORT, Up: Agent Protocol
1125 2.6.5 Export a Secret Key
1126 -------------------------
1130 Should be done by an extra tool.
1133 File: gnupg.info, Node: Agent ISTRUSTED, Next: Agent GET_PASSPHRASE, Prev: Agent EXPORT, Up: Agent Protocol
1135 2.6.6 Importing a Root Certificate
1136 ----------------------------------
1138 Actually we do not import a Root Cert but provide a way to validate any
1139 piece of data by storing its Hash along with a description and an
1140 identifier in the PSE. Here is the interface description:
1142 ISTRUSTED <fingerprint>
1144 Check whether the OpenPGP primary key or the X.509 certificate with
1145 the given fingerprint is an ultimately trusted key or a trusted Root CA
1146 certificate. The fingerprint should be given as a hexstring (without
1147 any blanks or colons or whatever in between) and may be left padded with
1148 00 in case of an MD5 fingerprint. GPGAgent will answer with:
1152 The key is in the table of trusted keys.
1154 ERR 304 (Not Trusted)
1156 The key is not in this table.
1158 Gpg needs the entire list of trusted keys to maintain the web of
1159 trust; the following command is therefore quite helpful:
1163 GpgAgent returns a list of trusted keys line by line:
1165 S: D 000000001234454556565656677878AF2F1ECCFF P
1166 S: D 340387563485634856435645634856438576457A P
1167 S: D FEDC6532453745367FD83474357495743757435D S
1170 The first item on a line is the hexified fingerprint where MD5
1171 fingerprints are '00' padded to the left and the second item is a flag
1172 to indicate the type of key (so that gpg is able to only take care of
1173 PGP keys). P = OpenPGP, S = S/MIME. A client should ignore the rest of
1174 the line, so that we can extend the format in the future.
1176 Finally a client should be able to mark a key as trusted:
1178 MARKTRUSTED FINGERPRINT "P"|"S"
1180 The server will then pop up a window to ask the user whether she
1181 really trusts this key. For this it will probably ask for a text to be
1182 displayed like this:
1184 S: INQUIRE TRUSTDESC
1185 C: D Do you trust the key with the fingerprint @FPR@
1186 C: D bla fasel blurb.
1190 Known sequences with the pattern @foo@ are replaced according to this
1194 Format the fingerprint according to gpg rules for a v3 keys.
1196 Format the fingerprint according to gpg rules for a v4 keys.
1198 Choose an appropriate format to format the fingerprint.
1200 Replaced by a single '@'.
1203 File: gnupg.info, Node: Agent GET_PASSPHRASE, Next: Agent CLEAR_PASSPHRASE, Prev: Agent ISTRUSTED, Up: Agent Protocol
1205 2.6.7 Ask for a passphrase
1206 --------------------------
1208 This function is usually used to ask for a passphrase to be used for
1209 symmetric encryption, but may also be used by programs which need
1210 special handling of passphrases. This command uses a syntax which helps
1211 clients to use the agent with minimum effort.
1213 GET_PASSPHRASE [--data] [--check] [--no-ask] [--repeat[=N]] \
1214 [--qualitybar] CACHE_ID \
1215 [ERROR_MESSAGE PROMPT DESCRIPTION]
1217 CACHE_ID is expected to be a string used to identify a cached
1218 passphrase. Use a 'X' to bypass the cache. With no other arguments the
1219 agent returns a cached passphrase or an error. By convention either the
1220 hexified fingerprint of the key shall be used for CACHE_ID or an
1221 arbitrary string prefixed with the name of the calling application and a
1222 colon: Like 'gpg:somestring'.
1224 ERROR_MESSAGE is either a single 'X' for no error message or a string
1225 to be shown as an error message like (e.g. "invalid passphrase").
1226 Blanks must be percent escaped or replaced by '+''.
1228 PROMPT is either a single 'X' for a default prompt or the text to be
1229 shown as the prompt. Blanks must be percent escaped or replaced by '+'.
1231 DESCRIPTION is a text shown above the entry field. Blanks must be
1232 percent escaped or replaced by '+'.
1234 The agent either returns with an error or with a OK followed by the
1235 hex encoded passphrase. Note that the length of the strings is
1236 implicitly limited by the maximum length of a command. If the option
1237 '--data' is used, the passphrase is not returned on the OK line but by
1238 regular data lines; this is the preferred method.
1240 If the option '--check' is used, the standard passphrase constraints
1241 checks are applied. A check is not done if the passphrase has been
1244 If the option '--no-ask' is used and the passphrase is not in the
1245 cache the user will not be asked to enter a passphrase but the error
1246 code 'GPG_ERR_NO_DATA' is returned.
1248 If the option '--qualitybar' is used and a minimum passphrase length
1249 has been configured, a visual indication of the entered passphrase
1252 CLEAR_PASSPHRASE CACHE_ID
1254 may be used to invalidate the cache entry for a passphrase. The
1255 function returns with OK even when there is no cached passphrase.
1258 File: gnupg.info, Node: Agent CLEAR_PASSPHRASE, Next: Agent PRESET_PASSPHRASE, Prev: Agent GET_PASSPHRASE, Up: Agent Protocol
1260 2.6.8 Remove a cached passphrase
1261 --------------------------------
1263 Use this command to remove a cached passphrase.
1265 CLEAR_PASSPHRASE [--mode=normal] <cache_id>
1267 The '--mode=normal' option can be used to clear a CACHE_ID that was
1271 File: gnupg.info, Node: Agent PRESET_PASSPHRASE, Next: Agent GET_CONFIRMATION, Prev: Agent CLEAR_PASSPHRASE, Up: Agent Protocol
1273 2.6.9 Set a passphrase for a keygrip
1274 ------------------------------------
1276 This command adds a passphrase to the cache for the specified KEYGRIP.
1278 PRESET_PASSPHRASE [--inquire] <string_or_keygrip> <timeout> [<hexstring>]
1280 The passphrase is a hexadecimal string when specified. When not
1281 specified, the passphrase will be retrieved from the pinentry module
1282 unless the '--inquire' option was specified in which case the passphrase
1283 will be retrieved from the client.
1285 The TIMEOUT parameter keeps the passphrase cached for the specified
1286 number of seconds. A value of '-1' means infinite while '0' means the
1287 default (currently only a timeout of -1 is allowed, which means to never
1291 File: gnupg.info, Node: Agent GET_CONFIRMATION, Next: Agent HAVEKEY, Prev: Agent PRESET_PASSPHRASE, Up: Agent Protocol
1293 2.6.10 Ask for confirmation
1294 ---------------------------
1296 This command may be used to ask for a simple confirmation by presenting
1297 a text and 2 buttons: Okay and Cancel.
1299 GET_CONFIRMATION DESCRIPTION
1301 DESCRIPTIONis displayed along with a Okay and Cancel button. Blanks
1302 must be percent escaped or replaced by '+'. A 'X' may be used to
1303 display confirmation dialog with a default text.
1305 The agent either returns with an error or with a OK. Note, that the
1306 length of DESCRIPTION is implicitly limited by the maximum length of a
1310 File: gnupg.info, Node: Agent HAVEKEY, Next: Agent LEARN, Prev: Agent GET_CONFIRMATION, Up: Agent Protocol
1312 2.6.11 Check whether a key is available
1313 ---------------------------------------
1315 This can be used to see whether a secret key is available. It does not
1316 return any information on whether the key is somehow protected.
1320 The agent answers either with OK or 'No_Secret_Key' (208). The
1321 caller may want to check for other error codes as well. More than one
1322 keygrip may be given. In this case the command returns success if at
1323 least one of the keygrips corresponds to an available secret key.
1326 File: gnupg.info, Node: Agent LEARN, Next: Agent PASSWD, Prev: Agent HAVEKEY, Up: Agent Protocol
1328 2.6.12 Register a smartcard
1329 ---------------------------
1333 This command is used to register a smartcard. With the '--send'
1334 option given the certificates are sent back.
1337 File: gnupg.info, Node: Agent PASSWD, Next: Agent UPDATESTARTUPTTY, Prev: Agent LEARN, Up: Agent Protocol
1339 2.6.13 Change a Passphrase
1340 --------------------------
1342 PASSWD [--cache-nonce=<c>] [--passwd-nonce=<s>] [--preset] KEYGRIP
1344 This command is used to interactively change the passphrase of the
1345 key identified by the hex string KEYGRIP. The '--preset' option may be
1346 used to add the new passphrase to the cache using the default cache
1350 File: gnupg.info, Node: Agent UPDATESTARTUPTTY, Next: Agent GETEVENTCOUNTER, Prev: Agent PASSWD, Up: Agent Protocol
1352 2.6.14 Change the standard display
1353 ----------------------------------
1357 Set the startup TTY and X-DISPLAY variables to the values of this
1358 session. This command is useful to direct future pinentry invocations
1359 to another screen. It is only required because there is no way in the
1360 ssh-agent protocol to convey this information.
1363 File: gnupg.info, Node: Agent GETEVENTCOUNTER, Next: Agent GETINFO, Prev: Agent UPDATESTARTUPTTY, Up: Agent Protocol
1365 2.6.15 Get the Event Counters
1366 -----------------------------
1370 This function return one status line with the current values of the
1371 event counters. The event counters are useful to avoid polling by
1372 delaying a poll until something has changed. The values are decimal
1373 numbers in the range '0' to 'UINT_MAX' and wrapping around to 0. The
1374 actual values should not be relied upon; they shall only be used to
1377 The currently defined counters are:
1379 Incremented with any change of any of the other counters.
1381 Incremented for added or removed private keys.
1383 Incremented for changes of the card readers stati.
1386 File: gnupg.info, Node: Agent GETINFO, Next: Agent OPTION, Prev: Agent GETEVENTCOUNTER, Up: Agent Protocol
1388 2.6.16 Return information about the process
1389 -------------------------------------------
1391 This is a multipurpose function to return a variety of information.
1395 The value of WHAT specifies the kind of information returned:
1397 Return the version of the program.
1399 Return the process id of the process.
1401 Return the name of the socket used to connect the agent.
1403 Return the name of the socket used for SSH connections. If SSH
1404 support has not been enabled the error 'GPG_ERR_NO_DATA' will be
1408 File: gnupg.info, Node: Agent OPTION, Prev: Agent GETINFO, Up: Agent Protocol
1410 2.6.17 Set options for the session
1411 ----------------------------------
1413 Here is a list of session options which are not yet described with other
1414 commands. The general syntax for an Assuan option is:
1421 This may be used to tell gpg-agent of which gpg-agent version the
1422 client is aware of. gpg-agent uses this information to enable
1423 features which might break older clients.
1426 Change the session's environment to be used for the Pinentry.
1432 Set envvar NAME to the empty string
1434 Set envvar NAME to the string VALUE.
1436 'use-cache-for-signing'
1437 See Assuan command 'PKSIGN'.
1439 'allow-pinentry-notify'
1440 This does not need any value. It is used to enable the
1441 PINENTRY_LAUNCHED inquiry.
1444 This option is used to change the operation mode of the pinentry.
1445 The following values are defined:
1448 This is the default mode which pops up a pinentry as needed.
1451 Instead of popping up a pinentry, return the error code
1455 Instead of popping up a pinentry, return the error code
1456 'GPG_ERR_NO_PIN_ENTRY'.
1459 Use a loopback pinentry. This fakes a pinentry by using
1460 inquiries back to the caller to ask for a passphrase. This
1461 option may only be set if the agent has been configured for
1462 that. To disable this feature use *note option
1463 --no-allow-loopback-pinentry::.
1465 'cache-ttl-opt-preset'
1466 This option sets the cache TTL for new entries created by GENKEY
1467 and PASSWD commands when using the '--preset' option. It is not
1468 used a default value is used.
1471 Instead of using the standard S2K count (which is computed on the
1472 fly), the given S2K count is used for new keys or when changing the
1473 passphrase of a key. Values below 65536 are considered to be 0.
1474 This option is valid for the entire session or until reset to 0.
1475 This option is useful if the key is later used on boxes which are
1476 either much slower or faster than the actual box.
1478 'pretend-request-origin'
1479 This option switches the connection into a restricted mode which
1480 handles all further commands in the same way as they would be
1481 handled when originating from the extra or browser socket. Note
1482 that this option is not available in the restricted mode. Valid
1483 values for this option are:
1487 This is a NOP and leaves the connection in the standard way.
1490 Pretend to come from a remote origin in the same way as
1491 connections from the '--extra-socket'.
1494 Pretend to come from a local web browser in the same way as
1495 connections from the '--browser-socket'.
1498 File: gnupg.info, Node: Invoking DIRMNGR, Next: Invoking GPG, Prev: Invoking GPG-AGENT, Up: Top
1503 Since version 2.1 of GnuPG, 'dirmngr' takes care of accessing the
1504 OpenPGP keyservers. As with previous versions it is also used as a
1505 server for managing and downloading certificate revocation lists (CRLs)
1506 for X.509 certificates, downloading X.509 certificates, and providing
1507 access to OCSP providers. Dirmngr is invoked internally by 'gpg',
1508 'gpgsm', or via the 'gpg-connect-agent' tool.
1510 *Note Option Index::,for an index to 'DIRMNGR''s commands and options.
1514 * Dirmngr Commands:: List of all commands.
1515 * Dirmngr Options:: List of all options.
1516 * Dirmngr Configuration:: Configuration files.
1517 * Dirmngr Signals:: Use of signals.
1518 * Dirmngr Examples:: Some usage examples.
1519 * Dirmngr Protocol:: The protocol dirmngr uses.
1522 File: gnupg.info, Node: Dirmngr Commands, Next: Dirmngr Options, Up: Invoking DIRMNGR
1527 Commands are not distinguished from options except for the fact that
1528 only one command is allowed.
1531 Print the program version and licensing information. Note that you
1532 cannot abbreviate this command.
1535 Print a usage message summarizing the most useful command-line
1536 options. Note that you cannot abbreviate this command.
1539 Print a list of all available options and commands. Note that you
1540 cannot abbreviate this command.
1543 Run in server mode and wait for commands on the 'stdin'. The
1544 default mode is to create a socket and listen for commands there.
1545 This is only used for testing.
1548 Run in background daemon mode and listen for commands on a socket.
1549 This is the way 'dirmngr' is started on demand by the other GnuPG
1550 components. To force starting 'dirmngr' it is in general best to
1551 use 'gpgconf --launch dirmngr'.
1554 Run in the foreground, sending logs to stderr, and listening on
1555 file descriptor 3, which must already be bound to a listening
1556 socket. This is useful when running under systemd or other similar
1557 process supervision schemes. This option is not supported on
1561 List the contents of the CRL cache on 'stdout'. This is probably
1562 only useful for debugging purposes.
1565 This command requires a filename as additional argument, and it
1566 will make Dirmngr try to import the CRL in FILE into it's cache.
1567 Note, that this is only possible if Dirmngr is able to retrieve the
1568 CA's certificate directly by its own means. In general it is
1569 better to use 'gpgsm''s '--call-dirmngr loadcrl filename' command
1570 so that 'gpgsm' can help dirmngr.
1573 This command requires an URL as additional argument, and it will
1574 make dirmngr try to retrieve and import the CRL from that URL into
1575 it's cache. This is mainly useful for debugging purposes. The
1576 'dirmngr-client' provides the same feature for a running dirmngr.
1579 This commands shuts down an running instance of Dirmngr. This
1580 command has currently no effect.
1583 This command removes all CRLs from Dirmngr's cache. Client
1584 requests will thus trigger reading of fresh CRLs.
1587 File: gnupg.info, Node: Dirmngr Options, Next: Dirmngr Configuration, Prev: Dirmngr Commands, Up: Invoking DIRMNGR
1592 Note that all long options with the exception of '--options' and
1593 '--homedir' may also be given in the configuration file after stripping
1594 off the two leading dashes.
1597 Reads configuration from FILE instead of from the default per-user
1598 configuration file. The default configuration file is named
1599 'dirmngr.conf' and expected in the home directory.
1602 Set the name of the home directory to DIR. This option is only
1603 effective when used on the command line. The default is the
1604 directory named '.gnupg' directly below the home directory of the
1605 user unless the environment variable 'GNUPGHOME' has been set in
1606 which case its value will be used. Many kinds of data are stored
1607 within this directory.
1611 Outputs additional information while running. You can increase the
1612 verbosity by giving several verbose commands to DIRMNGR, such as
1616 Append all logging output to FILE. This is very helpful in seeing
1617 what the agent actually does. Use 'socket://' to log to socket.
1619 '--debug-level LEVEL'
1620 Select the debug level for investigating problems. LEVEL may be a
1621 numeric value or by a keyword:
1624 No debugging at all. A value of less than 1 may be used
1625 instead of the keyword.
1627 Some basic debug messages. A value between 1 and 2 may be
1628 used instead of the keyword.
1630 More verbose debug messages. A value between 3 and 5 may be
1631 used instead of the keyword.
1633 Even more detailed messages. A value between 6 and 8 may be
1634 used instead of the keyword.
1636 All of the debug messages you can get. A value greater than 8
1637 may be used instead of the keyword. The creation of hash
1638 tracing files is only enabled if the keyword is used.
1640 How these messages are mapped to the actual debugging flags is not
1641 specified and may change with newer releases of this program. They
1642 are however carefully selected to best aid in debugging.
1645 Set debugging flags. This option is only useful for debugging and
1646 its behavior may change with a new release. All flags are or-ed
1647 and may be given in C syntax (e.g. 0x0042) or as a comma separated
1648 list of flag names. To get a list of all supported flags the
1649 single word "help" can be used.
1652 Same as '--debug=0xffffffff'
1655 Enable debugging of the TLS layer at LEVEL. The details of the
1656 debug level depend on the used TLS library and are not set in
1660 When running in server mode, wait N seconds before entering the
1661 actual processing loop and print the pid. This gives time to
1664 '--disable-check-own-socket'
1665 On some platforms 'dirmngr' is able to detect the removal of its
1666 socket file and shutdown itself. This option disable this
1667 self-test for debugging purposes.
1673 Format the info output in daemon mode for use with the standard
1674 Bourne shell respective the C-shell. The default is to guess it
1675 based on the environment variable 'SHELL' which is in almost all
1679 Enabling this option forces loading of expired CRLs; this is only
1680 useful for debugging.
1684 The option '--use-tor' switches Dirmngr and thus GnuPG into "Tor
1685 mode" to route all network access via Tor (an anonymity network).
1686 Certain other features are disabled in this mode. The effect of
1687 '--use-tor' cannot be overridden by any other command or even by
1688 reloading dirmngr. The use of '--no-use-tor' disables the use of
1689 Tor. The default is to use Tor if it is available on startup or
1690 after reloading dirmngr. The test on the available of Tor is done
1691 by trying to connects to a SOCKS proxy at either port 9050 or
1692 9150); if another type of proxy is listening on one of these ports,
1693 you should use '--no-use-tor'.
1695 '--standard-resolver'
1696 This option forces the use of the system's standard DNS resolver
1697 code. This is mainly used for debugging. Note that on Windows a
1698 standard resolver is not used and all DNS access will return the
1699 error "Not Implemented" if this option is used. Using this
1700 together with enabled Tor mode returns the error "Not Enabled".
1702 '--recursive-resolver'
1703 When possible use a recursive resolver instead of a stub resolver.
1705 '--resolver-timeout N'
1706 Set the timeout for the DNS resolver to N seconds. The default are
1709 '--connect-timeout N'
1710 '--connect-quick-timeout N'
1711 Set the timeout for HTTP and generic TCP connection attempts to N
1712 seconds. The value set with the quick variant is used when the
1713 -quick option has been given to certain Assuan commands. The quick
1714 value is capped at the value of the regular connect timeout. The
1715 default values are 15 and 2 seconds. Note that the timeout values
1716 are for each connection attempt; the connection code will attempt
1717 to connect all addresses listed for a server.
1719 '--listen-backlog N'
1720 Set the size of the queue for pending connections. The default is
1723 '--allow-version-check'
1724 Allow Dirmngr to connect to 'https://versions.gnupg.org' to get the
1725 list of current software versions. If this option is enabled the
1726 list is retrieved in case the local copy does not exist or is older
1727 than 5 to 7 days. See the option '--query-swdb' of the command
1728 'gpgconf' for more details. Note, that regardless of this option a
1729 version check can always be triggered using this command:
1731 gpg-connect-agent --dirmngr 'loadswdb --force' /bye
1734 Use NAME as your keyserver. This is the server that 'gpg'
1735 communicates with to receive keys, send keys, and search for keys.
1736 The format of the NAME is a URI: 'scheme:[//]keyservername[:port]'
1737 The scheme is the type of keyserver: "hkp" for the HTTP (or
1738 compatible) keyservers, "ldap" for the LDAP keyservers, or "mailto"
1739 for the Graff email keyserver. Note that your particular
1740 installation of GnuPG may have other keyserver types available as
1741 well. Keyserver schemes are case-insensitive. After the keyserver
1742 name, optional keyserver configuration options may be provided.
1743 These are the same as the '--keyserver-options' of 'gpg', but apply
1744 only to this particular keyserver.
1746 Most keyservers synchronize with each other, so there is generally
1747 no need to send keys to more than one server. Somes keyservers use
1748 round robin DNS to give a different keyserver each time you use it.
1750 If exactly two keyservers are configured and only one is a Tor
1751 hidden service (.onion), Dirmngr selects the keyserver to use
1752 depending on whether Tor is locally running or not. The check for
1753 a running Tor is done for each new connection.
1755 If no keyserver is explicitly configured, dirmngr will use the
1756 built-in default of 'https://keyserver.ubuntu.com'.
1758 Windows users with a keyserver running on their Active Directory
1759 may use the short form 'ldap:///' for NAME to access this
1762 For accessing anonymous LDAP keyservers NAME is in general just a
1763 'ldaps://ldap.example.com'. A BaseDN parameter should never be
1764 specified. If authentication is required things are more
1765 complicated and two methods are available:
1767 The modern method (since version 2.2.28) is to use the very same
1768 syntax as used with the option '--ldapserver'. Please see over
1769 there for details; here is an example:
1771 keyserver ldap:ldap.example.com::uid=USERNAME,ou=GnuPG Users,
1772 dc=example,dc=com:PASSWORD::starttls
1774 The other method is to use a full URL for NAME; for example:
1776 keyserver ldaps://ldap.example.com/????bindname=uid=USERNAME
1777 %2Cou=GnuPG%20Users%2Cdc=example%2Cdc=com,password=PASSWORD
1779 Put this all on one line without any spaces and keep the '%2C' as
1780 given. Replace USERNAME, PASSWORD, and the 'dc' parts according to
1781 the instructions received from your LDAP administrator. Note that
1782 only simple authentication (i.e. cleartext passwords) is supported
1783 and thus using ldaps is strongly suggested (since 2.2.28 "ldaps"
1784 defaults to port 389 and uses STARTTLS). On Windows authentication
1785 via AD can be requested by adding 'gpgNtds=1' after the fourth
1786 question mark instead of the bindname and password parameter.
1788 '--nameserver IPADDR'
1789 In "Tor mode" Dirmngr uses a public resolver via Tor to resolve DNS
1790 names. If the default public resolver, which is '8.8.8.8', shall
1791 not be used a different one can be given using this option. Note
1792 that a numerical IP address must be given (IPv6 or IPv4) and that
1793 no error checking is done for IPADDR.
1797 Disable the use of all IPv4 or IPv6 addresses.
1800 Entirely disables the use of LDAP.
1803 Entirely disables the use of HTTP.
1806 When looking for the location of a CRL, the to be tested
1807 certificate usually contains so called "CRL Distribution Point"
1808 (DP) entries which are URLs describing the way to access the CRL.
1809 The first found DP entry is used. With this option all entries
1810 using the HTTP scheme are ignored when looking for a suitable DP.
1813 This is similar to '--ignore-http-dp' but ignores entries using the
1814 LDAP scheme. Both options may be combined resulting in ignoring
1817 '--ignore-ocsp-service-url'
1818 Ignore all OCSP URLs contained in the certificate. The effect is
1819 to force the use of the default responder.
1821 '--honor-http-proxy'
1822 If the environment variable 'http_proxy' has been set, use its
1823 value to access HTTP servers.
1825 '--http-proxy HOST[:PORT]'
1826 Use HOST and PORT to access HTTP servers. The use of this option
1827 overrides the environment variable 'http_proxy' regardless whether
1828 '--honor-http-proxy' has been set.
1830 '--ldap-proxy HOST[:PORT]'
1831 Use HOST and PORT to connect to LDAP servers. If PORT is omitted,
1832 port 389 (standard LDAP port) is used. This overrides any
1833 specified host and port part in a LDAP URL and will also be used if
1834 host and port have been omitted from the URL.
1837 Never use anything else but the LDAP "proxy" as configured with
1838 '--ldap-proxy'. Usually 'dirmngr' tries to use other configured
1839 LDAP server if the connection using the "proxy" failed.
1841 '--ldapserverlist-file FILE'
1842 Read the list of LDAP servers to consult for CRLs and X.509
1843 certificates from file instead of the default per-user ldap server
1844 list file. The default value for FILE is
1845 'dirmngr_ldapservers.conf'.
1847 This server list file contains one LDAP server per line in the
1850 HOSTNAME:PORT:USERNAME:PASSWORD:BASE_DN:FLAGS
1852 Lines starting with a '#' are comments.
1854 Note that as usual all strings entered are expected to be UTF-8
1855 encoded. Obviously this will lead to problems if the password has
1856 originally been encoded as Latin-1. There is no other solution
1857 here than to put such a password in the binary encoding into the
1858 file (i.e. non-ascii characters won't show up readable).(1)
1861 This is an alternative way to specify LDAP servers for CRL and
1862 X.509 certificate retrieval. If this option is used the servers
1863 configured in 'dirmngr_ldapservers.conf' (or the file given by
1864 '--ldapserverlist-file') are cleared. Note that
1865 'dirmngr_ldapservers.conf' is not read again by a reload signal.
1866 However, '--ldapserver' options are read again.
1868 SPEC is either a proper LDAP URL or a colon delimited list of the
1871 HOSTNAME:PORT:USERNAME:PASSWORD:BASE_DN:FLAGS:
1873 with an optional prefix of 'ldap:' (but without the two slashes
1874 which would turn this into a proper LDAP URL). FLAGS is a list of
1875 one or more comma delimited keywords:
1877 The default: Do not use a TLS secured connection at all; the
1878 default port is 389.
1880 Use STARTTLS to secure the connection; the default port is
1883 Tunnel LDAP through a TLS connection; the default port is 636.
1885 On Windows authenticate the LDAP connection using the Active
1886 Directory with the current user.
1888 Note that in an URL style specification the scheme 'ldaps://'
1889 refers to STARTTLS and _not_ to LDAP-over-TLS.
1891 '--ldaptimeout SECS'
1892 Specify the number of seconds to wait for an LDAP query before
1893 timing out. The default are 15 seconds. 0 will never timeout.
1896 This option makes dirmngr add any servers it discovers when
1897 validating certificates against CRLs to the internal list of
1898 servers to consult for certificates and CRLs.
1900 This option is useful when trying to validate a certificate that
1901 has a CRL distribution point that points to a server that is not
1902 already listed in the ldapserverlist. Dirmngr will always go to
1903 this server and try to download the CRL, but chances are high that
1904 the certificate used to sign the CRL is located on the same server.
1905 So if dirmngr doesn't add that new server to list, it will often
1906 not be able to verify the signature of the CRL unless the
1907 '--add-servers' option is used.
1909 Note: The current version of dirmngr has this option disabled by
1913 This option enables OCSP support if requested by the client.
1915 OCSP requests are rejected by default because they may violate the
1916 privacy of the user; for example it is possible to track the time
1917 when a user is reading a mail.
1919 '--ocsp-responder URL'
1920 Use URL as the default OCSP Responder if the certificate does not
1921 contain information about an assigned responder. Note, that
1922 '--ocsp-signer' must also be set to a valid certificate.
1924 '--ocsp-signer FPR|FILE'
1925 Use the certificate with the fingerprint FPR to check the responses
1926 of the default OCSP Responder. Alternatively a filename can be
1927 given in which case the response is expected to be signed by one of
1928 the certificates described in that file. Any argument which
1929 contains a slash, dot or tilde is considered a filename. Usual
1930 filename expansion takes place: A tilde at the start followed by a
1931 slash is replaced by the content of 'HOME', no slash at start
1932 describes a relative filename which will be searched at the home
1933 directory. To make sure that the FILE is searched in the home
1934 directory, either prepend the name with "./" or use a name which
1937 If a response has been signed by a certificate described by these
1938 fingerprints no further check upon the validity of this certificate
1941 The format of the FILE is a list of SHA-1 fingerprint, one per line
1942 with optional colons between the bytes. Empty lines and lines
1943 prefix with a hash mark are ignored.
1945 '--ocsp-max-clock-skew N'
1946 The number of seconds a skew between the OCSP responder and them
1947 local clock is accepted. Default is 600 (10 minutes).
1949 '--ocsp-max-period N'
1950 Seconds a response is at maximum considered valid after the time
1951 given in the thisUpdate field. Default is 7776000 (90 days).
1953 '--ocsp-current-period N'
1954 The number of seconds an OCSP response is considered valid after
1955 the time given in the NEXT_UPDATE datum. Default is 10800 (3
1959 Do not return more that N items in one query. The default is 10.
1961 '--ignore-cert-extension OID'
1962 Add OID to the list of ignored certificate extensions. The OID is
1963 expected to be in dotted decimal form, like '2.5.29.3'. This
1964 option may be used more than once. Critical flagged certificate
1965 extensions matching one of the OIDs in the list are treated as if
1966 they are actually handled and thus the certificate won't be
1967 rejected due to an unknown critical extension. Use this option
1968 with care because extensions are usually flagged as critical for a
1971 '--ignore-cert FPR|FILE'
1972 Entirely ignore certificates with the fingerprint FPR. As an
1973 alternative to the fingerprint a filename can be given in which
1974 case all certificates described in that file are ignored. Any
1975 argument which contains a slash, dot or tilde is considered a
1976 filename. Usual filename expansion takes place: A tilde at the
1977 start followed by a slash is replaced by the content of 'HOME', no
1978 slash at start describes a relative filename which will be searched
1979 at the home directory. To make sure that the FILE is searched in
1980 the home directory, either prepend the name with "./" or use a name
1981 which contains a dot. The format of such a file is a list of SHA-1
1982 fingerprint, one per line with optional colons between the bytes.
1983 Empty lines and lines prefixed with a hash mark are ignored.
1985 This option is useful as a quick workaround to exclude certain
1986 certificates from the system store.
1989 Use the root certificates in FILE for verification of the TLS
1990 certificates used with 'hkps' (keyserver access over TLS). If the
1991 file is in PEM format a suffix of '.pem' is expected for FILE.
1992 This option may be given multiple times to add more root
1993 certificates. Tilde expansion is supported.
1995 If no 'hkp-cacert' directive is present, dirmngr will use the
1998 ---------- Footnotes ----------
2000 (1) The 'gpgconf' tool might be helpful for frontends as it enables
2001 editing this configuration file using percent-escaped strings.
2004 File: gnupg.info, Node: Dirmngr Configuration, Next: Dirmngr Signals, Prev: Dirmngr Options, Up: Invoking DIRMNGR
2009 Dirmngr makes use of several directories when running in daemon mode:
2010 There are a few configuration files whih control the operation of
2011 dirmngr. By default they may all be found in the current home directory
2012 (*note option --homedir::).
2015 This is the standard configuration file read by 'dirmngr' on
2016 startup. It may contain any valid long option; the leading two
2017 dashes may not be entered and the option may not be abbreviated.
2018 This file is also read after a 'SIGHUP' however not all options
2019 will actually have an effect. This default name may be changed on
2020 the command line (*note option --options::). You should backup
2023 '/etc/gnupg/trusted-certs'
2024 This directory should be filled with certificates of Root CAs you
2025 are trusting in checking the CRLs and signing OCSP Responses.
2027 Usually these are the same certificates you use with the
2028 applications making use of dirmngr. It is expected that each of
2029 these certificate files contain exactly one DER encoded certificate
2030 in a file with the suffix '.crt' or '.der'. 'dirmngr' reads those
2031 certificates on startup and when given a SIGHUP. Certificates which
2032 are not readable or do not make up a proper X.509 certificate are
2033 ignored; see the log file for details.
2035 Applications using dirmngr (e.g. gpgsm) can request these
2036 certificates to complete a trust chain in the same way as with the
2037 extra-certs directory (see below).
2039 Note that for OCSP responses the certificate specified using the
2040 option '--ocsp-signer' is always considered valid to sign OCSP
2043 '/etc/gnupg/extra-certs'
2044 This directory may contain extra certificates which are preloaded
2045 into the internal cache on startup. Applications using dirmngr
2046 (e.g. gpgsm) can request cached certificates to complete a trust
2047 chain. This is convenient in cases you have a couple intermediate
2048 CA certificates or certificates usually used to sign OCSP
2049 responses. These certificates are first tried before going out to
2050 the net to look for them. These certificates must also be DER
2051 encoded and suffixed with '.crt' or '.der'.
2054 This directory is used to store cached CRLs. The 'crls.d' part
2055 will be created by dirmngr if it does not exists but you need to
2056 make sure that the upper directory exists.
2058 To be able to see what's going on you should create the configure
2059 file '~/gnupg/dirmngr.conf' with at least one line:
2061 log-file ~/dirmngr.log
2063 To be able to perform OCSP requests you probably want to add the
2068 To make sure that new options are read and that after the
2069 installation of a new GnuPG versions the installed dirmngr is running,
2070 you may want to kill an existing dirmngr first:
2072 gpgconf --kill dirmngr
2074 You may check the log file to see whether all desired root
2075 certificates have been loaded correctly.
2078 File: gnupg.info, Node: Dirmngr Signals, Next: Dirmngr Examples, Prev: Dirmngr Configuration, Up: Invoking DIRMNGR
2083 A running 'dirmngr' may be controlled by signals, i.e. using the 'kill'
2084 command to send a signal to the process.
2086 Here is a list of supported signals:
2089 This signal flushes all internally cached CRLs as well as any
2090 cached certificates. Then the certificate cache is reinitialized
2091 as on startup. Options are re-read from the configuration file.
2092 Instead of sending this signal it is better to use
2093 gpgconf --reload dirmngr
2096 Shuts down the process but waits until all current requests are
2097 fulfilled. If the process has received 3 of these signals and
2098 requests are still pending, a shutdown is forced. You may also use
2099 gpgconf --kill dirmngr
2100 instead of this signal
2103 Shuts down the process immediately.
2106 This prints some caching statistics to the log file.
2109 File: gnupg.info, Node: Dirmngr Examples, Next: Dirmngr Protocol, Prev: Dirmngr Signals, Up: Invoking DIRMNGR
2114 Here is an example on how to show dirmngr's internal table of OpenPGP
2115 keyserver addresses. The output is intended for debugging purposes and
2116 not part of a defined API.
2118 gpg-connect-agent --dirmngr 'keyserver --hosttable' /bye
2120 To inhibit the use of a particular host you have noticed in one of
2121 the keyserver pools, you may use
2123 gpg-connect-agent --dirmngr 'keyserver --dead pgpkeys.bnd.de' /bye
2125 The description of the 'keyserver' command can be printed using
2127 gpg-connect-agent --dirmngr 'help keyserver' /bye
2130 File: gnupg.info, Node: Dirmngr Protocol, Prev: Dirmngr Examples, Up: Invoking DIRMNGR
2132 3.6 Dirmngr's Assuan Protocol
2133 =============================
2135 Assuan is the IPC protocol used to access dirmngr. This is a
2136 description of the commands implemented by dirmngr.
2140 * Dirmngr LOOKUP:: Look up a certificate via LDAP
2141 * Dirmngr ISVALID:: Validate a certificate using a CRL or OCSP.
2142 * Dirmngr CHECKCRL:: Validate a certificate using a CRL.
2143 * Dirmngr CHECKOCSP:: Validate a certificate using OCSP.
2144 * Dirmngr CACHECERT:: Put a certificate into the internal cache.
2145 * Dirmngr VALIDATE:: Validate a certificate for debugging.
2148 File: gnupg.info, Node: Dirmngr LOOKUP, Next: Dirmngr ISVALID, Up: Dirmngr Protocol
2150 3.6.1 Return the certificate(s) found
2151 -------------------------------------
2153 Lookup certificate. To allow multiple patterns (which are ORed) quoting
2154 is required: Spaces are to be translated into "+" or into "%20";
2155 obviously this requires that the usual escape quoting rules are applied.
2156 The server responds with:
2158 S: D <DER encoded certificate>
2160 S: D <second DER encoded certificate>
2164 In this example 2 certificates are returned. The server may return
2165 any number of certificates; OK will also be returned when no
2166 certificates were found. The dirmngr might return a status line
2170 To indicate that the output was truncated to N items due to a
2171 limitation of the server or by an arbitrary set limit.
2173 The option '--url' may be used if instead of a search pattern a
2174 complete URL to the certificate is known:
2176 C: LOOKUP --url CN%3DWerner%20Koch,o%3DIntevation%20GmbH,c%3DDE?userCertificate
2178 If the option '--cache-only' is given, no external lookup is done so
2179 that only certificates from the cache are returned.
2181 With the option '--single', the first and only the first match will
2182 be returned. Unless option '--cache-only' is also used, no local lookup
2183 will be done in this case.
2186 File: gnupg.info, Node: Dirmngr ISVALID, Next: Dirmngr CHECKCRL, Prev: Dirmngr LOOKUP, Up: Dirmngr Protocol
2188 3.6.2 Validate a certificate using a CRL or OCSP
2189 ------------------------------------------------
2191 ISVALID [--only-ocsp] [--force-default-responder] CERTID|CERTFPR
2193 Check whether the certificate described by the CERTID has been
2194 revoked. Due to caching, the Dirmngr is able to answer immediately in
2197 The CERTID is a hex encoded string consisting of two parts, delimited
2198 by a single dot. The first part is the SHA-1 hash of the issuer name
2199 and the second part the serial number.
2201 Alternatively the certificate's SHA-1 fingerprint CERTFPR may be
2202 given in which case an OCSP request is done before consulting the CRL.
2203 If the option '--only-ocsp' is given, no fallback to a CRL check will be
2204 used. If the option '--force-default-responder' is given, only the
2205 default OCSP responder will be used and any other methods of obtaining
2206 an OCSP responder URL won't be used.
2208 Common return values are:
2210 'GPG_ERR_NO_ERROR (0)'
2211 This is the positive answer: The certificate is not revoked and we
2212 have an up-to-date revocation list for that certificate. If OCSP
2213 was used the responder confirmed that the certificate has not been
2216 'GPG_ERR_CERT_REVOKED'
2217 This is the negative answer: The certificate has been revoked.
2218 Either it is in a CRL and that list is up to date or an OCSP
2219 responder informed us that it has been revoked.
2221 'GPG_ERR_NO_CRL_KNOWN'
2222 No CRL is known for this certificate or the CRL is not valid or out
2226 The OCSP responder returned an "unknown" status. This means that
2227 it is not aware of the certificate's status.
2229 'GPG_ERR_NOT_SUPPORTED'
2230 This is commonly seen if OCSP support has not been enabled in the
2233 If DirMngr has not enough information about the given certificate
2234 (which is the case for not yet cached certificates), it will inquire the
2237 S: INQUIRE SENDCERT <CertID>
2238 C: D <DER encoded certificate>
2241 A client should be aware that DirMngr may ask for more than one
2244 If Dirmngr has a certificate but the signature of the certificate
2245 could not been validated because the root certificate is not known to
2246 dirmngr as trusted, it may ask back to see whether the client trusts
2247 this the root certificate:
2249 S: INQUIRE ISTRUSTED <CertHexfpr>
2253 Only this answer will let Dirmngr consider the certificate as valid.
2256 File: gnupg.info, Node: Dirmngr CHECKCRL, Next: Dirmngr CHECKOCSP, Prev: Dirmngr ISVALID, Up: Dirmngr Protocol
2258 3.6.3 Validate a certificate using a CRL
2259 ----------------------------------------
2261 Check whether the certificate with FINGERPRINT (SHA-1 hash of the entire
2262 X.509 certificate blob) is valid or not by consulting the CRL
2263 responsible for this certificate. If the fingerprint has not been given
2264 or the certificate is not known, the function inquires the certificate
2267 S: INQUIRE TARGETCERT
2268 C: D <DER encoded certificate>
2271 Thus the caller is expected to return the certificate for the request
2272 (which should match FINGERPRINT) as a binary blob. Processing then
2273 takes place without further interaction; in particular dirmngr tries to
2274 locate other required certificate by its own mechanism which includes a
2275 local certificate store as well as a list of trusted root certificates.
2277 The return code is 0 for success; i.e. the certificate has not been
2278 revoked or one of the usual error codes from libgpg-error.
2281 File: gnupg.info, Node: Dirmngr CHECKOCSP, Next: Dirmngr CACHECERT, Prev: Dirmngr CHECKCRL, Up: Dirmngr Protocol
2283 3.6.4 Validate a certificate using OCSP
2284 ---------------------------------------
2286 CHECKOCSP [--force-default-responder] [FINGERPRINT]
2288 Check whether the certificate with FINGERPRINT (the SHA-1 hash of the
2289 entire X.509 certificate blob) is valid by consulting the appropriate
2290 OCSP responder. If the fingerprint has not been given or the
2291 certificate is not known by Dirmngr, the function inquires the
2294 S: INQUIRE TARGETCERT
2295 C: D <DER encoded certificate>
2298 Thus the caller is expected to return the certificate for the request
2299 (which should match FINGERPRINT) as a binary blob. Processing then
2300 takes place without further interaction; in particular dirmngr tries to
2301 locate other required certificates by its own mechanism which includes a
2302 local certificate store as well as a list of trusted root certificates.
2304 If the option '--force-default-responder' is given, only the default
2305 OCSP responder is used. This option is the per-command variant of the
2306 global option '--ignore-ocsp-service-url'.
2308 The return code is 0 for success; i.e. the certificate has not been
2309 revoked or one of the usual error codes from libgpg-error.
2312 File: gnupg.info, Node: Dirmngr CACHECERT, Next: Dirmngr VALIDATE, Prev: Dirmngr CHECKOCSP, Up: Dirmngr Protocol
2314 3.6.5 Put a certificate into the internal cache
2315 -----------------------------------------------
2317 Put a certificate into the internal cache. This command might be useful
2318 if a client knows in advance certificates required for a test and wants
2319 to make sure they get added to the internal cache. It is also helpful
2320 for debugging. To get the actual certificate, this command immediately
2323 S: INQUIRE TARGETCERT
2324 C: D <DER encoded certificate>
2327 Thus the caller is expected to return the certificate for the request
2330 The return code is 0 for success; i.e. the certificate has not been
2331 successfully cached or one of the usual error codes from libgpg-error.
2334 File: gnupg.info, Node: Dirmngr VALIDATE, Prev: Dirmngr CACHECERT, Up: Dirmngr Protocol
2336 3.6.6 Validate a certificate for debugging
2337 ------------------------------------------
2339 Validate a certificate using the certificate validation function used
2340 internally by dirmngr. This command is only useful for debugging. To
2341 get the actual certificate, this command immediately inquires it using
2343 S: INQUIRE TARGETCERT
2344 C: D <DER encoded certificate>
2347 Thus the caller is expected to return the certificate for the request
2351 File: gnupg.info, Node: Invoking GPG, Next: Invoking GPGSM, Prev: Invoking DIRMNGR, Up: Top
2356 'gpg' is the OpenPGP part of the GNU Privacy Guard (GnuPG). It is a tool
2357 to provide digital encryption and signing services using the OpenPGP
2358 standard. 'gpg' features complete key management and all the bells and
2359 whistles you would expect from a full OpenPGP implementation.
2361 There are two main versions of GnuPG: GnuPG 1.x and GnuPG 2.x. GnuPG
2362 2.x supports modern encryption algorithms and thus should be preferred
2363 over GnuPG 1.x. You only need to use GnuPG 1.x if your platform doesn't
2364 support GnuPG 2.x, or you need support for some features that GnuPG 2.x
2365 has deprecated, e.g., decrypting data created with PGP-2 keys.
2367 If you are looking for version 1 of GnuPG, you may find that version
2368 installed under the name 'gpg1'.
2370 *Note Option Index::, for an index to 'gpg''s commands and options.
2374 * GPG Commands:: List of all commands.
2375 * GPG Options:: List of all options.
2376 * GPG Configuration:: Configuration files.
2377 * GPG Examples:: Some usage examples.
2379 Developer information:
2380 * Unattended Usage of GPG:: Using 'gpg' from other programs.
2383 File: gnupg.info, Node: GPG Commands, Next: GPG Options, Up: Invoking GPG
2388 Commands are not distinguished from options except for the fact that
2389 only one command is allowed. Generally speaking, irrelevant options are
2390 silently ignored, and may not be checked for correctness.
2392 'gpg' may be run with no commands. In this case it will print a
2393 warning perform a reasonable action depending on the type of file it is
2394 given as input (an encrypted message is decrypted, a signature is
2395 verified, a file containing keys is listed, etc.).
2397 If you run into any problems, please add the option '--verbose' to
2398 the invocation to see more diagnostics.
2402 * General GPG Commands:: Commands not specific to the functionality.
2403 * Operational GPG Commands:: Commands to select the type of operation.
2404 * OpenPGP Key Management:: How to manage your keys.
2407 File: gnupg.info, Node: General GPG Commands, Next: Operational GPG Commands, Up: GPG Commands
2409 4.1.1 Commands not specific to the function
2410 -------------------------------------------
2413 Print the program version and licensing information. Note that you
2414 cannot abbreviate this command.
2418 Print a usage message summarizing the most useful command-line
2419 options. Note that you cannot arbitrarily abbreviate this command
2420 (though you can use its short form '-h').
2423 Print warranty information.
2426 Print a list of all available options and commands. Note that you
2427 cannot abbreviate this command.
2430 File: gnupg.info, Node: Operational GPG Commands, Next: OpenPGP Key Management, Prev: General GPG Commands, Up: GPG Commands
2432 4.1.2 Commands to select the type of operation
2433 ----------------------------------------------
2437 Sign a message. This command may be combined with '--encrypt' (to
2438 sign and encrypt a message), '--symmetric' (to sign and
2439 symmetrically encrypt a message), or both '--encrypt' and
2440 '--symmetric' (to sign and encrypt a message that can be decrypted
2441 using a secret key or a passphrase). The signing key is chosen by
2442 default or can be set explicitly using the '--local-user' and
2443 '--default-key' options.
2447 Make a cleartext signature. The content in a cleartext signature
2448 is readable without any special software. OpenPGP software is only
2449 needed to verify the signature. cleartext signatures may modify
2450 end-of-line whitespace for platform independence and are not
2451 intended to be reversible. The signing key is chosen by default or
2452 can be set explicitly using the '--local-user' and '--default-key'
2457 Make a detached signature.
2461 Encrypt data to one or more public keys. This command may be
2462 combined with '--sign' (to sign and encrypt a message),
2463 '--symmetric' (to encrypt a message that can be decrypted using a
2464 secret key or a passphrase), or '--sign' and '--symmetric' together
2465 (for a signed message that can be decrypted using a secret key or a
2466 passphrase). '--recipient' and related options specify which
2467 public keys to use for encryption.
2471 Encrypt with a symmetric cipher using a passphrase. The default
2472 symmetric cipher used is AES-128, but may be chosen with the
2473 '--cipher-algo' option. This command may be combined with '--sign'
2474 (for a signed and symmetrically encrypted message), '--encrypt'
2475 (for a message that may be decrypted via a secret key or a
2476 passphrase), or '--sign' and '--encrypt' together (for a signed
2477 message that may be decrypted via a secret key or a passphrase).
2478 'gpg' caches the passphrase used for symmetric encryption so that a
2479 decrypt operation may not require that the user needs to enter the
2480 passphrase. The option '--no-symkey-cache' can be used to disable
2484 Store only (make a simple literal data packet).
2488 Decrypt the file given on the command line (or STDIN if no file is
2489 specified) and write it to STDOUT (or the file specified with
2490 '--output'). If the decrypted file is signed, the signature is
2491 also verified. This command differs from the default operation, as
2492 it never writes to the filename which is included in the file and
2493 it rejects files that don't begin with an encrypted message.
2496 Assume that the first argument is a signed file and verify it
2497 without generating any output. With no arguments, the signature
2498 packet is read from STDIN. If only one argument is given, the
2499 specified file is expected to include a complete signature.
2501 With more than one argument, the first argument should specify a
2502 file with a detached signature and the remaining files should
2503 contain the signed data. To read the signed data from STDIN, use
2504 '-' as the second filename. For security reasons, a detached
2505 signature will not read the signed material from STDIN if not
2506 explicitly specified.
2508 Note: If the option '--batch' is not used, 'gpg' may assume that a
2509 single argument is a file with a detached signature, and it will
2510 try to find a matching data file by stripping certain suffixes.
2511 Using this historical feature to verify a detached signature is
2512 strongly discouraged; you should always specify the data file
2515 Note: When verifying a cleartext signature, 'gpg' verifies only
2516 what makes up the cleartext signed data and not any extra data
2517 outside of the cleartext signature or the header lines directly
2518 following the dash marker line. The option '--output' may be used
2519 to write out the actual signed data, but there are other pitfalls
2520 with this format as well. It is suggested to avoid cleartext
2521 signatures in favor of detached signatures.
2523 Note: Sometimes the use of the 'gpgv' tool is easier than using the
2524 full-fledged 'gpg' with this option. 'gpgv' is designed to compare
2525 signed data against a list of trusted keys and returns with success
2526 only for a good signature. It has its own manual page.
2529 This modifies certain other commands to accept multiple files for
2530 processing on the command line or read from STDIN with each
2531 filename on a separate line. This allows for many files to be
2532 processed at once. '--multifile' may currently be used along with
2533 '--verify', '--encrypt', and '--decrypt'. Note that '--multifile
2534 --verify' may not be used with detached signatures.
2537 Identical to '--multifile --verify'.
2540 Identical to '--multifile --encrypt'.
2543 Identical to '--multifile --decrypt'.
2547 '--list-public-keys'
2548 List the specified keys. If no keys are specified, then all keys
2549 from the configured public keyrings are listed.
2551 Never use the output of this command in scripts or other programs.
2552 The output is intended only for humans and its format is likely to
2553 change. The '--with-colons' option emits the output in a stable,
2554 machine-parseable format, which is intended for use by scripts and
2557 '--list-secret-keys'
2559 List the specified secret keys. If no keys are specified, then all
2560 known secret keys are listed. A '#' after the initial tags 'sec'
2561 or 'ssb' means that the secret key or subkey is currently not
2562 usable. We also say that this key has been taken offline (for
2563 example, a primary key can be taken offline by exporting the key
2564 using the command '--export-secret-subkeys'). A '>' after these
2565 tags indicate that the key is stored on a smartcard. See also
2568 '--check-signatures'
2570 Same as '--list-keys', but the key signatures are verified and
2571 listed too. Note that for performance reasons the revocation
2572 status of a signing key is not shown. This command has the same
2573 effect as using '--list-keys' with '--with-sig-check'.
2575 The status of the verification is indicated by a flag directly
2576 following the "sig" tag (and thus before the flags described below.
2577 A "!" indicates that the signature has been successfully verified,
2578 a "-" denotes a bad signature and a "%" is used if an error
2579 occurred while checking the signature (e.g. a non supported
2580 algorithm). Signatures where the public key is not available are
2581 not listed; to see their keyids the command '--list-sigs' can be
2584 For each signature listed, there are several flags in between the
2585 signature status flag and keyid. These flags give additional
2586 information about each key signature. From left to right, they are
2587 the numbers 1-3 for certificate check level (see
2588 '--ask-cert-level'), "L" for a local or non-exportable signature
2589 (see '--lsign-key'), "R" for a nonRevocable signature (see the
2590 '--edit-key' command "nrsign"), "P" for a signature that contains a
2591 policy URL (see '--cert-policy-url'), "N" for a signature that
2592 contains a notation (see '--cert-notation'), "X" for an eXpired
2593 signature (see '--ask-cert-expire'), and the numbers 1-9 or "T" for
2594 10 and above to indicate trust signature levels (see the
2595 '--edit-key' command "tsign").
2598 '--locate-external-keys'
2599 Locate the keys given as arguments. This command basically uses
2600 the same algorithm as used when locating keys for encryption and
2601 may thus be used to see what keys 'gpg' might use. In particular
2602 external methods as defined by '--auto-key-locate' are used to
2603 locate a key if the arguments comain valid mail addresses. Only
2604 public keys are listed.
2606 The variant '--locate-external-keys' does not consider a locally
2607 existing key and can thus be used to force the refresh of a key via
2608 the defined external methods. If a fingerprint is given and and
2609 the methods defined by -auto-key-locate define LDAP servers, the
2610 key is fetched from these resources; defined non-LDAP keyservers
2614 This commands takes OpenPGP keys as input and prints information
2615 about them in the same way the command '--list-keys' does for
2616 locally stored key. In addition the list options
2617 'show-unusable-uids', 'show-unusable-subkeys', 'show-notations' and
2618 'show-policy-urls' are also enabled. As usual for automated
2619 processing, this command should be combined with the option
2623 List all keys (or the specified ones) along with their
2624 fingerprints. This is the same output as '--list-keys' but with
2625 the additional output of a line with the fingerprint. May also be
2626 combined with '--check-signatures'. If this command is given
2627 twice, the fingerprints of all secondary keys are listed too. This
2628 command also forces pretty printing of fingerprints if the keyid
2629 format has been set to "none".
2632 List only the sequence of packets. This command is only useful for
2633 debugging. When used with option '--verbose' the actual MPI values
2634 are dumped and not only their lengths. Note that the output of
2635 this command may change with new releases.
2639 Present a menu to work with a smartcard. The subcommand "help"
2640 provides an overview on available commands. For a detailed
2641 description, please see the Card HOWTO at
2642 https://gnupg.org/documentation/howtos.html#GnuPG-cardHOWTO .
2645 Show the content of the smart card.
2648 Present a menu to allow changing the PIN of a smartcard. This
2649 functionality is also available as the subcommand "passwd" with the
2650 '--edit-card' command.
2652 '--delete-keys NAME'
2653 Remove key from the public keyring. In batch mode either '--yes'
2654 is required or the key must be specified by fingerprint. This is a
2655 safeguard against accidental deletion of multiple keys. If the
2656 exclamation mark syntax is used with the fingerprint of a subkey
2657 only that subkey is deleted; if the exclamation mark is used with
2658 the fingerprint of the primary key the entire public key is
2661 '--delete-secret-keys NAME'
2662 Remove key from the secret keyring. In batch mode the key must be
2663 specified by fingerprint. The option '--yes' can be used to advise
2664 gpg-agent not to request a confirmation. This extra pre-caution is
2665 done because 'gpg' can't be sure that the secret key (as controlled
2666 by gpg-agent) is only used for the given OpenPGP public key. If
2667 the exclamation mark syntax is used with the fingerprint of a
2668 subkey only the secret part of that subkey is deleted; if the
2669 exclamation mark is used with the fingerprint of the primary key
2670 only the secret part of the primary key is deleted.
2672 '--delete-secret-and-public-key NAME'
2673 Same as '--delete-key', but if a secret key exists, it will be
2674 removed first. In batch mode the key must be specified by
2675 fingerprint. The option '--yes' can be used to advise gpg-agent
2676 not to request a confirmation.
2679 Either export all keys from all keyrings (default keyring and those
2680 registered via option '--keyring'), or if at least one name is
2681 given, those of the given name. The exported keys are written to
2682 STDOUT or to the file given with option '--output'. Use together
2683 with '--armor' to mail those keys.
2685 '--send-keys KEYIDS'
2686 Similar to '--export' but sends the keys to a keyserver.
2687 Fingerprints may be used instead of key IDs. Don't send your
2688 complete keyring to a keyserver -- select only those keys which are
2689 new or changed by you. If no KEYIDS are given, 'gpg' does nothing.
2691 Take care: Keyservers are by design write only systems and thus it
2692 is not possible to ever delete keys once they have been send to a
2695 '--export-secret-keys'
2696 '--export-secret-subkeys'
2697 Same as '--export', but exports the secret keys instead. The
2698 exported keys are written to STDOUT or to the file given with
2699 option '--output'. This command is often used along with the
2700 option '--armor' to allow for easy printing of the key for paper
2701 backup; however the external tool 'paperkey' does a better job of
2702 creating backups on paper. Note that exporting a secret key can be
2703 a security risk if the exported keys are sent over an insecure
2706 The second form of the command has the special property to render
2707 the secret part of the primary key useless; this is a GNU extension
2708 to OpenPGP and other implementations can not be expected to
2709 successfully import such a key. Its intended use is in generating
2710 a full key with an additional signing subkey on a dedicated
2711 machine. This command then exports the key without the primary key
2712 to the main machine.
2714 GnuPG may ask you to enter the passphrase for the key. This is
2715 required, because the internal protection method of the secret key
2716 is different from the one specified by the OpenPGP protocol.
2719 This command is used to export a key in the OpenSSH public key
2720 format. It requires the specification of one key by the usual
2721 means and exports the latest valid subkey which has an
2722 authentication capability to STDOUT or to the file given with
2723 option '--output'. That output can directly be added to ssh's
2724 'authorized_key' file.
2726 By specifying the key to export using a key ID or a fingerprint
2727 suffixed with an exclamation mark (!), a specific subkey or the
2728 primary key can be exported. This does not even require that the
2729 key has the authentication capability flag set.
2733 Import/merge keys. This adds the given keys to the keyring. The
2734 fast version is currently just a synonym.
2736 There are a few other options which control how this command works.
2737 Most notable here is the '--import-options merge-only' option which
2738 does not insert new keys but does only the merging of new
2739 signatures, user-IDs and subkeys.
2741 '--receive-keys KEYIDS'
2742 '--recv-keys KEYIDS'
2743 Import the keys with the given KEYIDS from a keyserver.
2746 Request updates from a keyserver for keys that already exist on the
2747 local keyring. This is useful for updating a key with the latest
2748 signatures, user IDs, etc. Calling this with no arguments will
2749 refresh the entire keyring.
2751 '--search-keys NAMES'
2752 Search the keyserver for the given NAMES. Multiple names given
2753 here will be joined together to create the search string for the
2754 keyserver. Note that keyservers search for NAMES in a different
2755 and simpler way than gpg does. The best choice is to use a mail
2756 address. Due to data privacy reasons keyservers may even not even
2757 allow searching by user id or mail address and thus may only return
2758 results when being used with the '--recv-key' command to search by
2759 key fingerprint or keyid.
2762 Retrieve keys located at the specified URIS. Note that different
2763 installations of GnuPG may support different protocols (HTTP, FTP,
2764 LDAP, etc.). When using HTTPS the system provided root
2765 certificates are used by this command.
2768 Do trust database maintenance. This command iterates over all keys
2769 and builds the Web of Trust. This is an interactive command
2770 because it may have to ask for the "ownertrust" values for keys.
2771 The user has to give an estimation of how far she trusts the owner
2772 of the displayed key to correctly certify (sign) other keys. GnuPG
2773 only asks for the ownertrust value if it has not yet been assigned
2774 to a key. Using the '--edit-key' menu, the assigned value can be
2775 changed at any time.
2778 Do trust database maintenance without user interaction. From time
2779 to time the trust database must be updated so that expired keys or
2780 signatures and the resulting changes in the Web of Trust can be
2781 tracked. Normally, GnuPG will calculate when this is required and
2782 do it automatically unless '--no-auto-check-trustdb' is set. This
2783 command can be used to force a trust database check at any time.
2784 The processing is identical to that of '--update-trustdb' but it
2785 skips keys with a not yet defined "ownertrust".
2787 For use with cron jobs, this command can be used together with
2788 '--batch' in which case the trust database check is done only if a
2789 check is needed. To force a run even in batch mode add the option
2792 '--export-ownertrust'
2793 Send the ownertrust values to STDOUT. This is useful for backup
2794 purposes as these values are the only ones which can't be
2795 re-created from a corrupted trustdb. Example:
2796 gpg --export-ownertrust > otrust.txt
2798 '--import-ownertrust'
2799 Update the trustdb with the ownertrust values stored in 'files' (or
2800 STDIN if not given); existing values will be overwritten. In case
2801 of a severely damaged trustdb and if you have a recent backup of
2802 the ownertrust values (e.g. in the file 'otrust.txt'), you may
2803 re-create the trustdb using these commands:
2806 gpg --import-ownertrust < otrust.txt
2808 '--rebuild-keydb-caches'
2809 When updating from version 1.0.6 to 1.0.7 this command should be
2810 used to create signature caches in the keyring. It might be handy
2811 in other situations too.
2815 Print message digest of algorithm ALGO for all given files or
2816 STDIN. With the second form (or a deprecated "*" for ALGO) digests
2817 for all available algorithms are printed.
2819 '--gen-random 0|1|2 COUNT'
2820 Emit COUNT random bytes of the given quality level 0, 1 or 2. If
2821 COUNT is not given or zero, an endless sequence of random bytes
2822 will be emitted. If used with '--armor' the output will be base64
2823 encoded. PLEASE, don't use this command unless you know what you
2824 are doing; it may remove precious entropy from the system!
2826 '--gen-prime MODE BITS'
2827 Use the source, Luke :-). The output format is subject to change
2832 Pack or unpack an arbitrary input into/from an OpenPGP ASCII armor.
2833 This is a GnuPG extension to OpenPGP and in general not very
2836 '--tofu-policy {auto|good|unknown|bad|ask} KEYS'
2837 Set the TOFU policy for all the bindings associated with the
2838 specified KEYS. For more information about the meaning of the
2839 policies, *note trust-model-tofu::. The KEYS may be specified
2840 either by their fingerprint (preferred) or their keyid.
2843 File: gnupg.info, Node: OpenPGP Key Management, Prev: Operational GPG Commands, Up: GPG Commands
2845 4.1.3 How to manage your keys
2846 -----------------------------
2848 This section explains the main commands for key management.
2850 '--quick-generate-key USER-ID [ALGO [USAGE [EXPIRE]]]'
2852 This is a simple command to generate a standard key with one user
2853 id. In contrast to '--generate-key' the key is generated directly
2854 without the need to answer a bunch of prompts. Unless the option
2855 '--yes' is given, the key creation will be canceled if the given
2856 user id already exists in the keyring.
2858 If invoked directly on the console without any special options an
2859 answer to a "Continue?" style confirmation prompt is required. In
2860 case the user id already exists in the keyring a second prompt to
2861 force the creation of the key will show up.
2863 If ALGO or USAGE are given, only the primary key is created and no
2864 prompts are shown. To specify an expiration date but still create
2865 a primary and subkey use "default" or "future-default" for ALGO and
2866 "default" for USAGE. For a description of these optional arguments
2867 see the command '--quick-add-key'. The USAGE accepts also the
2868 value "cert" which can be used to create a certification only
2869 primary key; the default is to a create certification and signing
2872 The EXPIRE argument can be used to specify an expiration date for
2873 the key. Several formats are supported; commonly the ISO formats
2874 "YYYY-MM-DD" or "YYYYMMDDThhmmss" are used. To make the key expire
2875 in N seconds, N days, N weeks, N months, or N years use
2876 "seconds=N", "Nd", "Nw", "Nm", or "Ny" respectively. Not
2877 specifying a value, or using "-" results in a key expiring in a
2878 reasonable default interval. The values "never", "none" can be
2879 used for no expiration date.
2881 If this command is used with '--batch', '--pinentry-mode' has been
2882 set to 'loopback', and one of the passphrase options
2883 ('--passphrase', '--passphrase-fd', or '--passphrase-file') is
2884 used, the supplied passphrase is used for the new key and the agent
2885 does not ask for it. To create a key without any protection
2886 '--passphrase ''' may be used.
2888 To create an OpenPGP key from the keys available on the currently
2889 inserted smartcard, the special string "card" can be used for ALGO.
2890 If the card features an encryption and a signing key, gpg will
2891 figure them out and creates an OpenPGP key consisting of the usual
2892 primary key and one subkey. This works only with certain
2893 smartcards. Note that the interactive '--full-gen-key' command
2894 allows to do the same but with greater flexibility in the selection
2895 of the smartcard keys.
2897 Note that it is possible to create a primary key and a subkey using
2898 non-default algorithms by using "default" and changing the default
2899 parameters using the option '--default-new-key-algo'.
2901 '--quick-set-expire FPR EXPIRE [*|SUBFPRS]'
2902 With two arguments given, directly set the expiration time of the
2903 primary key identified by FPR to EXPIRE. To remove the expiration
2904 time '0' can be used. With three arguments and the third given as
2905 an asterisk, the expiration time of all non-revoked and not yet
2906 expired subkeys are set to EXPIRE. With more than two arguments
2907 and a list of fingerprints given for SUBFPRS, all non-revoked
2908 subkeys matching these fingerprints are set to EXPIRE.
2910 '--quick-add-key FPR [ALGO [USAGE [EXPIRE]]]'
2911 Directly add a subkey to the key identified by the fingerprint FPR.
2912 Without the optional arguments an encryption subkey is added. If
2913 any of the arguments are given a more specific subkey is added.
2915 ALGO may be any of the supported algorithms or curve names given in
2916 the format as used by key listings. To use the default algorithm
2917 the string "default" or "-" can be used. Supported algorithms are
2918 "rsa", "dsa", "elg", "ed25519", "cv25519", and other ECC curves.
2919 For example the string "rsa" adds an RSA key with the default key
2920 length; a string "rsa4096" requests that the key length is 4096
2921 bits. The string "future-default" is an alias for the algorithm
2922 which will likely be used as default algorithm in future versions
2923 of gpg. To list the supported ECC curves the command 'gpg
2924 --with-colons --list-config curve' can be used.
2926 Depending on the given ALGO the subkey may either be an encryption
2927 subkey or a signing subkey. If an algorithm is capable of signing
2928 and encryption and such a subkey is desired, a USAGE string must be
2929 given. This string is either "default" or "-" to keep the default
2930 or a comma delimited list (or space delimited list) of keywords:
2931 "sign" for a signing subkey, "auth" for an authentication subkey,
2932 and "encr" for an encryption subkey ("encrypt" can be used as alias
2933 for "encr"). The valid combinations depend on the algorithm.
2935 The EXPIRE argument can be used to specify an expiration date for
2936 the key. Several formats are supported; commonly the ISO formats
2937 "YYYY-MM-DD" or "YYYYMMDDThhmmss" are used. To make the key expire
2938 in N seconds, N days, N weeks, N months, or N years use
2939 "seconds=N", "Nd", "Nw", "Nm", or "Ny" respectively. Not
2940 specifying a value, or using "-" results in a key expiring in a
2941 reasonable default interval. The values "never", "none" can be
2942 used for no expiration date.
2946 Generate a new key pair using the current default parameters. This
2947 is the standard command to create a new key. In addition to the
2948 key a revocation certificate is created and stored in the
2949 'openpgp-revocs.d' directory below the GnuPG home directory.
2951 '--full-generate-key'
2953 Generate a new key pair with dialogs for all options. This is an
2954 extended version of '--generate-key'.
2956 There is also a feature which allows you to create keys in batch
2957 mode. See the manual section "Unattended key generation" on how to
2960 '--generate-revocation NAME'
2962 Generate a revocation certificate for the complete key. To only
2963 revoke a subkey or a key signature, use the '--edit' command.
2965 This command merely creates the revocation certificate so that it
2966 can be used to revoke the key if that is ever needed. To actually
2967 revoke a key the created revocation certificate needs to be merged
2968 with the key to revoke. This is done by importing the revocation
2969 certificate using the '--import' command. Then the revoked key
2970 needs to be published, which is best done by sending the key to a
2971 keyserver (command '--send-key') and by exporting ('--export') it
2972 to a file which is then send to frequent communication partners.
2974 '--generate-designated-revocation NAME'
2975 '--desig-revoke NAME'
2976 Generate a designated revocation certificate for a key. This
2977 allows a user (with the permission of the keyholder) to revoke
2981 Present a menu which enables you to do most of the key management
2982 related tasks. It expects the specification of a key on the
2986 Toggle selection of user ID or photographic user ID with index
2987 N. Use '*' to select all and '0' to deselect all.
2990 Toggle selection of subkey with index N or key ID N. Use '*'
2991 to select all and '0' to deselect all.
2994 Make a signature on key of user 'name'. If the key is not yet
2995 signed by the default user (or the users given with '-u'), the
2996 program displays the information of the key again, together
2997 with its fingerprint and asks whether it should be signed.
2998 This question is repeated for all users specified with '-u'.
3001 Same as "sign" but the signature is marked as non-exportable
3002 and will therefore never be used by others. This may be used
3003 to make keys valid only in the local environment.
3006 Same as "sign" but the signature is marked as non-revocable
3007 and can therefore never be revoked.
3010 Make a trust signature. This is a signature that combines the
3011 notions of certification (like a regular signature), and trust
3012 (like the "trust" command). It is generally only useful in
3013 distinct communities or groups. For more information please
3014 read the sections "Trust Signature" and "Regular Expression"
3017 Note that "l" (for local / non-exportable), "nr" (for
3018 non-revocable, and "t" (for trust) may be freely mixed and prefixed
3019 to "sign" to create a signature of any type desired.
3021 If the option '--only-sign-text-ids' is specified, then any
3022 non-text based user ids (e.g., photo IDs) will not be selected for
3026 Delete a signature. Note that it is not possible to retract a
3027 signature, once it has been send to the public (i.e. to a
3028 keyserver). In that case you better use 'revsig'.
3031 Revoke a signature. For every signature which has been
3032 generated by one of the secret keys, GnuPG asks whether a
3033 revocation certificate should be generated.
3036 Check the signatures on all selected user IDs. With the extra
3037 option 'selfsig' only self-signatures are shown.
3040 Create an additional user ID.
3043 Create a photographic user ID. This will prompt for a JPEG
3044 file that will be embedded into the user ID. Note that a very
3045 large JPEG will make for a very large key. Also note that
3046 some programs will display your JPEG unchanged (GnuPG), and
3047 some programs will scale it to fit in a dialog box (PGP).
3050 Display the selected photographic user ID.
3053 Delete a user ID or photographic user ID. Note that it is not
3054 possible to retract a user id, once it has been send to the
3055 public (i.e. to a keyserver). In that case you better use
3059 Revoke a user ID or photographic user ID.
3062 Flag the current user id as the primary one, removes the
3063 primary user id flag from all other user ids and sets the
3064 timestamp of all affected self-signatures one second ahead.
3065 Note that setting a photo user ID as primary makes it primary
3066 over other photo user IDs, and setting a regular user ID as
3067 primary makes it primary over other regular user IDs.
3070 Set a preferred keyserver for the specified user ID(s). This
3071 allows other users to know where you prefer they get your key
3072 from. See '--keyserver-options honor-keyserver-url' for more
3073 on how this works. Setting a value of "none" removes an
3074 existing preferred keyserver.
3077 Set a name=value notation for the specified user ID(s). See
3078 '--cert-notation' for more on how this works. Setting a value
3079 of "none" removes all notations, setting a notation prefixed
3080 with a minus sign (-) removes that notation, and setting a
3081 notation name (without the =value) prefixed with a minus sign
3082 removes all notations with that name.
3085 List preferences from the selected user ID. This shows the
3086 actual preferences, without including any implied preferences.
3089 More verbose preferences listing for the selected user ID.
3090 This shows the preferences in effect by including the implied
3091 preferences of 3DES (cipher), SHA-1 (digest), and Uncompressed
3092 (compression) if they are not already included in the
3093 preference list. In addition, the preferred keyserver and
3094 signature notations (if any) are shown.
3097 Set the list of user ID preferences to STRING for all (or just
3098 the selected) user IDs. Calling setpref with no arguments
3099 sets the preference list to the default (either built-in or
3100 set via '--default-preference-list'), and calling setpref with
3101 "none" as the argument sets an empty preference list. Use
3102 'gpg --version' to get a list of available algorithms. Note
3103 that while you can change the preferences on an attribute user
3104 ID (aka "photo ID"), GnuPG does not select keys via attribute
3105 user IDs so these preferences will not be used by GnuPG.
3107 When setting preferences, you should list the algorithms in
3108 the order which you'd like to see them used by someone else
3109 when encrypting a message to your key. If you don't include
3110 3DES, it will be automatically added at the end. Note that
3111 there are many factors that go into choosing an algorithm (for
3112 example, your key may not be the only recipient), and so the
3113 remote OpenPGP application being used to send to you may or
3114 may not follow your exact chosen order for a given message.
3115 It will, however, only choose an algorithm that is present on
3116 the preference list of every recipient key. See also the
3117 INTEROPERABILITY WITH OTHER OPENPGP PROGRAMS section below.
3120 Add a subkey to this key.
3123 Generate a subkey on a card and add it to this key.
3126 Transfer the selected secret subkey (or the primary key if no
3127 subkey has been selected) to a smartcard. The secret key in
3128 the keyring will be replaced by a stub if the key could be
3129 stored successfully on the card and you use the save command
3130 later. Only certain key types may be transferred to the card.
3131 A sub menu allows you to select on what card to store the key.
3132 Note that it is not possible to get that key back from the
3133 card - if the card gets broken your secret key will be lost
3134 unless you have a backup somewhere.
3137 Restore the given FILE to a card. This command may be used to
3138 restore a backup key (as generated during card initialization)
3139 to a new card. In almost all cases this will be the
3140 encryption key. You should use this command only with the
3141 corresponding public key and make sure that the file given as
3142 argument is indeed the backup to restore. You should then
3143 select 2 to restore as encryption key. You will first be
3144 asked to enter the passphrase of the backup key and then for
3145 the Admin PIN of the card.
3148 Remove a subkey (secondary key). Note that it is not possible
3149 to retract a subkey, once it has been send to the public (i.e.
3150 to a keyserver). In that case you better use 'revkey'. Also
3151 note that this only deletes the public part of a key.
3157 Change the key or subkey expiration time. If a subkey is
3158 selected, the expiration time of this subkey will be changed.
3159 With no selection, the key expiration of the primary key is
3163 Change the owner trust value for the key. This updates the
3164 trust-db immediately and no save is required.
3168 Disable or enable an entire key. A disabled key can not
3169 normally be used for encryption.
3172 Add a designated revoker to the key. This takes one optional
3173 argument: "sensitive". If a designated revoker is marked as
3174 sensitive, it will not be exported by default (see
3178 Change the passphrase of the secret key.
3181 This is dummy command which exists only for backward
3185 Compact (by removing all signatures except the selfsig) any
3186 user ID that is no longer usable (e.g. revoked, or expired).
3187 Then, remove any signatures that are not usable by the trust
3188 calculations. Specifically, this removes any signature that
3189 does not validate, any signature that is superseded by a later
3190 signature, revoked signatures, and signatures issued by keys
3191 that are not present on the keyring.
3194 Make the key as small as possible. This removes all
3195 signatures from each user ID except for the most recent
3199 Change the usage flags (capabilities) of the primary key or of
3200 subkeys. These usage flags (e.g. Certify, Sign,
3201 Authenticate, Encrypt) are set during key creation. Sometimes
3202 it is useful to have the opportunity to change them (for
3203 example to add Authenticate) after they have been created.
3204 Please take care when doing this; the allowed usage flags
3205 depend on the key algorithm.
3208 Add cross-certification signatures to signing subkeys that may
3209 not currently have them. Cross-certification signatures
3210 protect against a subtle attack against signing subkeys. See
3211 '--require-cross-certification'. All new keys generated have
3212 this signature by default, so this command is only useful to
3213 bring older keys up to date.
3216 Save all changes to the keyring and quit.
3219 Quit the program without updating the keyring.
3221 The listing shows you the key with its secondary keys and all user
3222 IDs. The primary user ID is indicated by a dot, and selected keys
3223 or user IDs are indicated by an asterisk. The trust value is
3224 displayed with the primary key: "trust" is the assigned owner trust
3225 and "validity" is the calculated validity of the key. Validity
3226 values are also displayed for all user IDs. For possible values of
3227 trust, *note trust-values::.
3230 Signs a public key with your secret key. This is a shortcut
3231 version of the subcommand "sign" from '--edit'.
3234 Signs a public key with your secret key but marks it as
3235 non-exportable. This is a shortcut version of the subcommand
3236 "lsign" from '--edit-key'.
3238 '--quick-sign-key FPR [NAMES]'
3239 '--quick-lsign-key FPR [NAMES]'
3240 Directly sign a key from the passphrase without any further user
3241 interaction. The FPR must be the verified primary fingerprint of a
3242 key in the local keyring. If no NAMES are given, all useful user
3243 ids are signed; with given [NAMES] only useful user ids matching
3244 one of theses names are signed. By default, or if a name is
3245 prefixed with a '*', a case insensitive substring match is used.
3246 If a name is prefixed with a '=' a case sensitive exact match is
3249 The command '--quick-lsign-key' marks the signatures as
3250 non-exportable. If such a non-exportable signature already exists
3251 the '--quick-sign-key' turns it into a exportable signature. If
3252 you need to update an existing signature, for example to add or
3253 change notation data, you need to use the option
3256 This command uses reasonable defaults and thus does not provide the
3257 full flexibility of the "sign" subcommand from '--edit-key'. Its
3258 intended use is to help unattended key signing by utilizing a list
3259 of verified fingerprints.
3261 '--quick-add-uid USER-ID NEW-USER-ID'
3262 This command adds a new user id to an existing key. In contrast to
3263 the interactive sub-command 'adduid' of '--edit-key' the
3264 NEW-USER-ID is added verbatim with only leading and trailing white
3265 space removed, it is expected to be UTF-8 encoded, and no checks on
3266 its form are applied.
3268 '--quick-revoke-uid USER-ID USER-ID-TO-REVOKE'
3269 This command revokes a user ID on an existing key. It cannot be
3270 used to revoke the last user ID on key (some non-revoked user ID
3271 must remain), with revocation reason "User ID is no longer valid".
3272 If you want to specify a different revocation reason, or to supply
3273 supplementary revocation text, you should use the interactive
3274 sub-command 'revuid' of '--edit-key'.
3276 '--quick-revoke-sig FPR SIGNING-FPR [NAMES]'
3277 This command revokes the key signatures made by SIGNING-FPR from
3278 the key specified by the fingerprint FPR. With NAMES given only
3279 the signatures on user ids of the key matching any of the given
3280 names are affected (see '--quick-sign-key'). If a revocation
3281 already exists a notice is printed instead of creating a new
3282 revocation; no error is returned in this case. Note that key
3283 signature revocations may be superseded by a newer key signature
3284 and in turn again revoked.
3286 '--quick-set-primary-uid USER-ID PRIMARY-USER-ID'
3287 This command sets or updates the primary user ID flag on an
3288 existing key. USER-ID specifies the key and PRIMARY-USER-ID the
3289 user ID which shall be flagged as the primary user ID. The primary
3290 user ID flag is removed from all other user ids and the timestamp
3291 of all affected self-signatures is set one second ahead.
3293 '--change-passphrase USER-ID'
3295 Change the passphrase of the secret key belonging to the
3296 certificate specified as USER-ID. This is a shortcut for the
3297 sub-command 'passwd' of the edit key menu. When using together
3298 with the option '--dry-run' this will not actually change the
3299 passphrase but check that the current passphrase is correct.
3302 File: gnupg.info, Node: GPG Options, Next: GPG Configuration, Prev: GPG Commands, Up: Invoking GPG
3307 'gpg' features a bunch of options to control the exact behaviour and to
3308 change the default configuration.
3312 * GPG Configuration Options:: How to change the configuration.
3313 * GPG Key related Options:: Key related options.
3314 * GPG Input and Output:: Input and Output.
3315 * OpenPGP Options:: OpenPGP protocol specific options.
3316 * Compliance Options:: Compliance options.
3317 * GPG Esoteric Options:: Doing things one usually doesn't want to do.
3318 * Deprecated Options:: Deprecated options.
3320 Long options can be put in an options file (default
3321 "~/.gnupg/gpg.conf"). Short option names will not work - for example,
3322 "armor" is a valid option for the options file, while "a" is not. Do
3323 not write the 2 dashes, but simply the name of the option and any
3324 required arguments. Lines with a hash ('#') as the first
3325 non-white-space character are ignored. Commands may be put in this file
3326 too, but that is not generally useful as the command will execute
3327 automatically with every execution of gpg.
3329 Please remember that option parsing stops as soon as a non-option is
3330 encountered, you can explicitly stop parsing by using the special option
3334 File: gnupg.info, Node: GPG Configuration Options, Next: GPG Key related Options, Up: GPG Options
3336 4.2.1 How to change the configuration
3337 -------------------------------------
3339 These options are used to change the configuration and most of them are
3340 usually found in the option file.
3342 '--default-key NAME'
3343 Use NAME as the default key to sign with. If this option is not
3344 used, the default key is the first key found in the secret keyring.
3345 Note that '-u' or '--local-user' overrides this option. This
3346 option may be given multiple times. In this case, the last key for
3347 which a secret key is available is used. If there is no secret key
3348 available for any of the specified values, GnuPG will not emit an
3349 error message but continue as if this option wasn't given.
3351 '--default-recipient NAME'
3352 Use NAME as default recipient if option '--recipient' is not used
3353 and don't ask if this is a valid one. NAME must be non-empty.
3355 '--default-recipient-self'
3356 Use the default key as default recipient if option '--recipient' is
3357 not used and don't ask if this is a valid one. The default key is
3358 the first one from the secret keyring or the one set with
3361 '--no-default-recipient'
3362 Reset '--default-recipient' and '--default-recipient-self'. Should
3363 not be used in an option file.
3366 Give more information during processing. If used twice, the input
3367 data is listed in detail.
3370 Reset verbose level to 0. Should not be used in an option file.
3373 Try to be as quiet as possible. Should not be used in an option
3378 Use batch mode. Never ask, do not allow interactive commands.
3379 '--no-batch' disables this option. Note that even with a filename
3380 given on the command line, gpg might still need to read from STDIN
3381 (in particular if gpg figures that the input is a detached
3382 signature and no data file has been specified). Thus if you do not
3383 want to feed data via STDIN, you should connect STDIN to
3386 It is highly recommended to use this option along with the options
3387 '--status-fd' and '--with-colons' for any unattended use of 'gpg'.
3388 Should not be used in an option file.
3391 Make sure that the TTY (terminal) is never used for any output.
3392 This option is needed in some cases because GnuPG sometimes prints
3393 warnings to the TTY even if '--batch' is used.
3396 Assume "yes" on most questions. Should not be used in an option
3400 Assume "no" on most questions. Should not be used in an option
3403 '--list-options PARAMETERS'
3404 This is a space or comma delimited string that gives options used
3405 when listing keys and signatures (that is, '--list-keys',
3406 '--check-signatures', '--list-public-keys', '--list-secret-keys',
3407 and the '--edit-key' functions). Options can be prepended with a
3408 'no-' (after the two dashes) to give the opposite meaning. The
3412 Causes '--list-keys', '--check-signatures',
3413 '--list-public-keys', and '--list-secret-keys' to display any
3414 photo IDs attached to the key. Defaults to no. See also
3415 '--photo-viewer'. Does not work with '--with-colons': see
3416 '--attribute-fd' for the appropriate way to get photo data for
3417 scripts and other frontends.
3420 Show usage information for keys and subkeys in the standard
3421 key listing. This is a list of letters indicating the allowed
3422 usage for a key ('E'=encryption, 'S'=signing,
3423 'C'=certification, 'A'=authentication). Defaults to yes.
3426 Show policy URLs in the '--check-signatures' listings.
3432 Show all, IETF standard, or user-defined signature notations
3433 in the '--check-signatures' listings. Defaults to no.
3436 Show any preferred keyserver URL in the '--check-signatures'
3437 listings. Defaults to no.
3440 Display the calculated validity of user IDs during key
3441 listings. Defaults to yes.
3444 Show revoked and expired user IDs in key listings. Defaults
3447 show-unusable-subkeys
3448 Show revoked and expired subkeys in key listings. Defaults to
3452 Display the keyring name at the head of key listings to show
3453 which keyring a given key resides on. Defaults to no.
3456 Show signature expiration dates (if any) during
3457 '--check-signatures' listings. Defaults to no.
3460 Include signature subpackets in the key listing. This option
3461 can take an optional argument list of the subpackets to list.
3462 If no argument is passed, list all subpackets. Defaults to
3463 no. This option is only meaningful when using '--with-colons'
3464 along with '--check-signatures'.
3467 For each user-id which has a valid mail address print only the
3468 fingerprint followed by the mail address.
3470 '--verify-options PARAMETERS'
3471 This is a space or comma delimited string that gives options used
3472 when verifying signatures. Options can be prepended with a 'no-'
3473 to give the opposite meaning. The options are:
3476 Display any photo IDs present on the key that issued the
3477 signature. Defaults to no. See also '--photo-viewer'.
3480 Show policy URLs in the signature being verified. Defaults to
3486 Show all, IETF standard, or user-defined signature notations
3487 in the signature being verified. Defaults to IETF standard.
3490 Show any preferred keyserver URL in the signature being
3491 verified. Defaults to yes.
3494 Display the calculated validity of the user IDs on the key
3495 that issued the signature. Defaults to yes.
3498 Show revoked and expired user IDs during signature
3499 verification. Defaults to no.
3501 show-primary-uid-only
3502 Show only the primary user ID during signature verification.
3503 That is all the AKA lines as well as photo Ids are not shown
3504 with the signature verification status.
3507 Enable PKA lookups to verify sender addresses. Note that PKA
3508 is based on DNS, and so enabling this option may disclose
3509 information on when and what signatures are verified or to
3510 whom data is encrypted. This is similar to the "web bug"
3511 described for the '--auto-key-retrieve' option.
3514 Raise the trust in a signature to full if the signature passes
3515 PKA validation. This option is only meaningful if pka-lookups
3518 '--enable-large-rsa'
3519 '--disable-large-rsa'
3520 With -generate-key and -batch, enable the creation of RSA secret
3521 keys as large as 8192 bit. Note: 8192 bit is more than is
3522 generally recommended. These large keys don't significantly
3523 improve security, but they are more expensive to use, and their
3524 signatures and certifications are larger. This option is only
3525 available if the binary was build with large-secmem support.
3529 Enable hash truncation for all DSA keys even for old DSA Keys up to
3530 1024 bit. This is also the default with '--openpgp'. Note that
3531 older versions of GnuPG also required this flag to allow the
3532 generation of DSA larger than 1024 bit.
3534 '--photo-viewer STRING'
3535 This is the command line that should be run to view a photo ID.
3536 "%i" will be expanded to a filename containing the photo. "%I"
3537 does the same, except the file will not be deleted once the viewer
3538 exits. Other flags are "%k" for the key ID, "%K" for the long key
3539 ID, "%f" for the key fingerprint, "%t" for the extension of the
3540 image type (e.g. "jpg"), "%T" for the MIME type of the image (e.g.
3541 "image/jpeg"), "%v" for the single-character calculated validity of
3542 the image being viewed (e.g. "f"), "%V" for the calculated
3543 validity as a string (e.g. "full"), "%U" for a base32 encoded hash
3544 of the user ID, and "%%" for an actual percent sign. If neither %i
3545 or %I are present, then the photo will be supplied to the viewer on
3548 On Unix the default viewer is 'xloadimage -fork -quiet -title
3549 'KeyID 0x%k' STDIN' with a fallback to 'display -title 'KeyID 0x%k'
3550 %i' and finally to 'xdg-open %i'. On Windows '!ShellExecute 400
3551 %i' is used; here the command is a meta command to use that API
3552 call followed by a wait time in milliseconds which is used to give
3553 the viewer time to read the temporary image file before gpg deletes
3554 it again. Note that if your image viewer program is not secure,
3555 then executing it from gpg does not make it secure.
3557 '--exec-path STRING'
3558 Sets a list of directories to search for photo viewers If not
3559 provided photo viewers use the 'PATH' environment variable.
3562 Add FILE to the current list of keyrings. If FILE begins with a
3563 tilde and a slash, these are replaced by the $HOME directory. If
3564 the filename does not contain a slash, it is assumed to be in the
3565 GnuPG home directory ("~/.gnupg" unless '--homedir' or $GNUPGHOME
3568 Note that this adds a keyring to the current list. If the intent
3569 is to use the specified keyring alone, use '--keyring' along with
3570 '--no-default-keyring'.
3572 If the option '--no-keyring' has been used no keyrings will be used
3575 '--primary-keyring FILE'
3576 This is a varian of '--keyring' and designates FILE as the primary
3577 public keyring. This means that newly imported keys (via
3578 '--import' or keyserver '--recv-from') will go to this keyring.
3580 '--secret-keyring FILE'
3581 This is an obsolete option and ignored. All secret keys are stored
3582 in the 'private-keys-v1.d' directory below the GnuPG home
3585 '--trustdb-name FILE'
3586 Use FILE instead of the default trustdb. If FILE begins with a
3587 tilde and a slash, these are replaced by the $HOME directory. If
3588 the filename does not contain a slash, it is assumed to be in the
3589 GnuPG home directory ('~/.gnupg' if '--homedir' or $GNUPGHOME is
3593 Set the name of the home directory to DIR. If this option is not
3594 used, the home directory defaults to '~/.gnupg'. It is only
3595 recognized when given on the command line. It also overrides any
3596 home directory stated through the environment variable 'GNUPGHOME'
3597 or (on Windows systems) by means of the Registry entry
3598 HKCU\SOFTWARE\GNU\GNUPG:HOMEDIR.
3600 On Windows systems it is possible to install GnuPG as a portable
3601 application. In this case only this command line option is
3602 considered, all other ways to set a home directory are ignored.
3604 To install GnuPG as a portable application under Windows, create an
3605 empty file named 'gpgconf.ctl' in the same directory as the tool
3606 'gpgconf.exe'. The root of the installation is then that
3607 directory; or, if 'gpgconf.exe' has been installed directly below a
3608 directory named 'bin', its parent directory. You also need to make
3609 sure that the following directories exist and are writable:
3610 'ROOT/home' for the GnuPG home and 'ROOT/usr/local/var/cache/gnupg'
3611 for internal cache files.
3613 '--display-charset NAME'
3614 Set the name of the native character set. This is used to convert
3615 some informational strings like user IDs to the proper UTF-8
3616 encoding. Note that this has nothing to do with the character set
3617 of data to be encrypted or signed; GnuPG does not recode
3618 user-supplied data. If this option is not used, the default
3619 character set is determined from the current locale. A verbosity
3620 level of 3 shows the chosen set. This option should not be used on
3621 Windows. Valid values for NAME are:
3624 This is the Latin 1 set.
3630 This is currently an alias for the Latin 1 set.
3633 The usual Russian set (RFC-1489).
3636 Bypass all translations and assume that the OS uses native
3641 Assume that command line arguments are given as UTF-8 strings. The
3642 default ('--no-utf8-strings') is to assume that arguments are
3643 encoded in the character set as specified by '--display-charset'.
3644 These options affect all following arguments. Both options may be
3645 used multiple times. This option should not be used in an option
3648 This option has no effect on Windows. There the internal used
3649 UTF-8 encoding is translated for console input and output. The
3650 command line arguments are expected as Unicode and translated to
3651 UTF-8. Thus when calling this program from another, make sure to
3652 use the Unicode version of CreateProcess.
3655 Read options from FILE and do not try to read them from the default
3656 options file in the homedir (see '--homedir'). This option is
3657 ignored if used in an options file.
3660 Shortcut for '--options /dev/null'. This option is detected before
3661 an attempt to open an option file. Using this option will also
3662 prevent the creation of a '~/.gnupg' homedir.
3665 '--compress-level N'
3666 '--bzip2-compress-level N'
3667 Set compression level to N for the ZIP and ZLIB compression
3668 algorithms. The default is to use the default compression level of
3669 zlib (normally 6). '--bzip2-compress-level' sets the compression
3670 level for the BZIP2 compression algorithm (defaulting to 6 as
3671 well). This is a different option from '--compress-level' since
3672 BZIP2 uses a significant amount of memory for each additional
3673 compression level. '-z' sets both. A value of 0 for N disables
3676 '--bzip2-decompress-lowmem'
3677 Use a different decompression method for BZIP2 compressed files.
3678 This alternate method uses a bit more than half the memory, but
3679 also runs at half the speed. This is useful under extreme low
3680 memory circumstances when the file was originally compressed at a
3681 high '--bzip2-compress-level'.
3683 '--mangle-dos-filenames'
3684 '--no-mangle-dos-filenames'
3685 Older version of Windows cannot handle filenames with more than one
3686 dot. '--mangle-dos-filenames' causes GnuPG to replace (rather than
3687 add to) the extension of an output filename to avoid this problem.
3688 This option is off by default and has no effect on non-Windows
3692 '--no-ask-cert-level'
3693 When making a key signature, prompt for a certification level. If
3694 this option is not specified, the certification level used is set
3695 via '--default-cert-level'. See '--default-cert-level' for
3696 information on the specific levels and how they are used.
3697 '--no-ask-cert-level' disables this option. This option defaults
3700 '--default-cert-level N'
3701 The default to use for the check level when signing a key.
3703 0 means you make no particular claim as to how carefully you
3706 1 means you believe the key is owned by the person who claims to
3707 own it but you could not, or did not verify the key at all. This
3708 is useful for a "persona" verification, where you sign the key of a
3711 2 means you did casual verification of the key. For example, this
3712 could mean that you verified the key fingerprint and checked the
3713 user ID on the key against a photo ID.
3715 3 means you did extensive verification of the key. For example,
3716 this could mean that you verified the key fingerprint with the
3717 owner of the key in person, and that you checked, by means of a
3718 hard to forge document with a photo ID (such as a passport) that
3719 the name of the key owner matches the name in the user ID on the
3720 key, and finally that you verified (by exchange of email) that the
3721 email address on the key belongs to the key owner.
3723 Note that the examples given above for levels 2 and 3 are just
3724 that: examples. In the end, it is up to you to decide just what
3725 "casual" and "extensive" mean to you.
3727 This option defaults to 0 (no particular claim).
3730 When building the trust database, treat any signatures with a
3731 certification level below this as invalid. Defaults to 2, which
3732 disregards level 1 signatures. Note that level 0 "no particular
3733 claim" signatures are always accepted.
3735 '--trusted-key LONG KEY ID OR FINGERPRINT'
3736 Assume that the specified key (which should be given as
3737 fingerprint) is as trustworthy as one of your own secret keys.
3738 This option is useful if you don't want to keep your secret keys
3739 (or one of them) online but still want to be able to check the
3740 validity of a given recipient's or signator's key. If the given
3741 key is not locally available but an LDAP keyserver is configured
3742 the missing key is imported from that server.
3744 '--trust-model {pgp|classic|tofu|tofu+pgp|direct|always|auto}'
3745 Set what trust model GnuPG should follow. The models are:
3748 This is the Web of Trust combined with trust signatures as
3749 used in PGP 5.x and later. This is the default trust model
3750 when creating a new trust database.
3753 This is the standard Web of Trust as introduced by PGP 2.
3756 TOFU stands for Trust On First Use. In this trust model, the
3757 first time a key is seen, it is memorized. If later another
3758 key with a user id with the same email address is seen, both
3759 keys are marked as suspect. In that case, the next time
3760 either is used, a warning is displayed describing the
3761 conflict, why it might have occurred (either the user
3762 generated a new key and failed to cross sign the old and new
3763 keys, the key is forgery, or a man-in-the-middle attack is
3764 being attempted), and the user is prompted to manually confirm
3765 the validity of the key in question.
3767 Because a potential attacker is able to control the email
3768 address and thereby circumvent the conflict detection
3769 algorithm by using an email address that is similar in
3770 appearance to a trusted email address, whenever a message is
3771 verified, statistics about the number of messages signed with
3772 the key are shown. In this way, a user can easily identify
3773 attacks using fake keys for regular correspondents.
3775 When compared with the Web of Trust, TOFU offers significantly
3776 weaker security guarantees. In particular, TOFU only helps
3777 ensure consistency (that is, that the binding between a key
3778 and email address doesn't change). A major advantage of TOFU
3779 is that it requires little maintenance to use correctly. To
3780 use the web of trust properly, you need to actively sign keys
3781 and mark users as trusted introducers. This is a
3782 time-consuming process and anecdotal evidence suggests that
3783 even security-conscious users rarely take the time to do this
3784 thoroughly and instead rely on an ad-hoc TOFU process.
3786 In the TOFU model, policies are associated with bindings
3787 between keys and email addresses (which are extracted from
3788 user ids and normalized). There are five policies, which can
3789 be set manually using the '--tofu-policy' option. The default
3790 policy can be set using the '--tofu-default-policy' option.
3792 The TOFU policies are: 'auto', 'good', 'unknown', 'bad' and
3793 'ask'. The 'auto' policy is used by default (unless
3794 overridden by '--tofu-default-policy') and marks a binding as
3795 marginally trusted. The 'good', 'unknown' and 'bad' policies
3796 mark a binding as fully trusted, as having unknown trust or as
3797 having trust never, respectively. The 'unknown' policy is
3798 useful for just using TOFU to detect conflicts, but to never
3799 assign positive trust to a binding. The final policy, 'ask'
3800 prompts the user to indicate the binding's trust. If batch
3801 mode is enabled (or input is inappropriate in the context),
3802 then the user is not prompted and the 'undefined' trust level
3806 This trust model combines TOFU with the Web of Trust. This is
3807 done by computing the trust level for each model and then
3808 taking the maximum trust level where the trust levels are
3809 ordered as follows: 'unknown < undefined < marginal < fully <
3810 ultimate < expired < never'.
3812 By setting '--tofu-default-policy=unknown', this model can be
3813 used to implement the web of trust with TOFU's conflict
3814 detection algorithm, but without its assignment of positive
3815 trust values, which some security-conscious users don't like.
3818 Key validity is set directly by the user and not calculated
3819 via the Web of Trust. This model is solely based on the key
3820 and does not distinguish user IDs. Note that when changing to
3821 another trust model the trust values assigned to a key are
3822 transformed into ownertrust values, which also indicate how
3823 you trust the owner of the key to sign other keys.
3826 Skip key validation and assume that used keys are always fully
3827 valid. You generally won't use this unless you are using some
3828 external validation scheme. This option also suppresses the
3829 "[uncertain]" tag printed with signature checks when there is
3830 no evidence that the user ID is bound to the key. Note that
3831 this trust model still does not allow the use of expired,
3832 revoked, or disabled keys.
3835 Select the trust model depending on whatever the internal
3836 trust database says. This is the default model if such a
3837 database already exists. Note that a tofu trust model is not
3838 considered here and must be enabled explicitly.
3840 '--auto-key-locate MECHANISMS'
3841 '--no-auto-key-locate'
3842 GnuPG can automatically locate and retrieve keys as needed using
3843 this option. This happens when encrypting to an email address (in
3844 the "user@example.com" form), and there are no "user@example.com"
3845 keys on the local keyring. This option takes any number of the
3846 mechanisms listed below, in the order they are to be tried.
3847 Instead of listing the mechanisms as comma delimited arguments, the
3848 option may also be given several times to add more mechanism. The
3849 option '--no-auto-key-locate' or the mechanism "clear" resets the
3850 list. The default is "local,wkd".
3853 Locate a key using DNS CERT, as specified in RFC-4398.
3856 Locate a key using DNS PKA.
3859 Locate a key using DANE, as specified in
3860 draft-ietf-dane-openpgpkey-05.txt.
3863 Locate a key using the Web Key Directory protocol.
3866 Using DNS Service Discovery, check the domain in question for
3867 any LDAP keyservers to use. If this fails, attempt to locate
3868 the key using the PGP Universal method of checking
3869 'ldap://keys.(thedomain)'.
3872 Locate the key using the Active Directory (Windows only).
3873 This method also allows to search by fingerprint using the
3874 command '--locate-external-key'.
3877 Locate a key using a keyserver. This method also allows to
3878 search by fingerprint using the command
3879 '--locate-external-key' if any of the configured keyservers is
3883 In addition, a keyserver URL as used in the 'dirmngr'
3884 configuration may be used here to query that particular
3885 keyserver. This method also allows to search by fingerprint
3886 using the command '--locate-external-key' if the URL specifies
3890 Locate the key using the local keyrings. This mechanism
3891 allows the user to select the order a local key lookup is
3892 done. Thus using '--auto-key-locate local' is identical to
3893 '--no-auto-key-locate'.
3896 This flag disables the standard local key lookup, done before
3897 any of the mechanisms defined by the '--auto-key-locate' are
3898 tried. The position of this mechanism in the list does not
3899 matter. It is not required if 'local' is also used.
3902 Clear all defined mechanisms. This is useful to override
3903 mechanisms given in a config file. Note that a 'nodefault' in
3904 MECHANISMS will also be cleared unless it is given after the
3908 '--no-auto-key-import'
3909 This is an offline mechanism to get a missing key for signature
3910 verification and for later encryption to this key. If this option
3911 is enabled and a signature includes an embedded key, that key is
3912 used to verify the signature and on verification success that key
3913 is imported. The default is '--no-auto-key-import'.
3915 On the sender (signing) site the option '--include-key-block' needs
3916 to be used to put the public part of the signing key as “Key Block
3917 subpacket” into the signature.
3919 '--auto-key-retrieve'
3920 '--no-auto-key-retrieve'
3921 These options enable or disable the automatic retrieving of keys
3922 from a keyserver when verifying signatures made by keys that are
3923 not on the local keyring. The default is '--no-auto-key-retrieve'.
3925 The order of methods tried to lookup the key is:
3927 1. If the option '--auto-key-import' is set and the signatures
3928 includes an embedded key, that key is used to verify the signature
3929 and on verification success that key is imported.
3931 2. If a preferred keyserver is specified in the signature and the
3932 option 'honor-keyserver-url' is active (which is not the default),
3933 that keyserver is tried. Note that the creator of the signature
3934 uses the option '--sig-keyserver-url' to specify the preferred
3935 keyserver for data signatures.
3937 3. If the signature has the Signer's UID set (e.g. using
3938 '--sender' while creating the signature) a Web Key Directory (WKD)
3939 lookup is done. This is the default configuration but can be
3940 disabled by removing WKD from the auto-key-locate list or by using
3941 the option '--disable-signer-uid'.
3943 4. If the option 'honor-pka-record' is active, the legacy PKA
3946 5. If any keyserver is configured and the Issuer Fingerprint is
3947 part of the signature (since GnuPG 2.1.16), the configured
3948 keyservers are tried.
3950 Note that this option makes a "web bug" like behavior possible.
3951 Keyserver or Web Key Directory operators can see which keys you
3952 request, so by sending you a message signed by a brand new key
3953 (which you naturally will not have on your local keyring), the
3954 operator can tell both your IP address and the time when you
3955 verified the signature.
3957 '--keyid-format {none|short|0xshort|long|0xlong}'
3958 Select how to display key IDs. "none" does not show the key ID at
3959 all but shows the fingerprint in a separate line. "short" is the
3960 traditional 8-character key ID. "long" is the more accurate (but
3961 less convenient) 16-character key ID. Add an "0x" to either to
3962 include an "0x" at the beginning of the key ID, as in 0x99242560.
3963 Note that this option is ignored if the option '--with-colons' is
3967 This option is deprecated - please use the '--keyserver' in
3968 'dirmngr.conf' instead.
3970 Use NAME as your keyserver. This is the server that
3971 '--receive-keys', '--send-keys', and '--search-keys' will
3972 communicate with to receive keys from, send keys to, and search for
3973 keys on. The format of the NAME is a URI:
3974 'scheme:[//]keyservername[:port]' The scheme is the type of
3975 keyserver: "hkp"/"hkps" for the HTTP (or compatible) keyservers or
3976 "ldap"/"ldaps" for the LDAP keyservers. Note that your particular
3977 installation of GnuPG may have other keyserver types available as
3978 well. Keyserver schemes are case-insensitive.
3980 Most keyservers synchronize with each other, so there is generally
3981 no need to send keys to more than one server. The keyserver
3982 'hkp://keys.gnupg.net' uses round robin DNS to give a different
3983 keyserver each time you use it.
3985 '--keyserver-options {NAME=VALUE}'
3986 This is a space or comma delimited string that gives options for
3987 the keyserver. Options can be prefixed with a 'no-' to give the
3988 opposite meaning. Valid import-options or export-options may be
3989 used here as well to apply to importing ('--recv-key') or exporting
3990 ('--send-key') a key from a keyserver. While not all options are
3991 available for all keyserver types, some common options are:
3994 When searching for a key with '--search-keys', include keys
3995 that are marked on the keyserver as revoked. Note that not
3996 all keyservers differentiate between revoked and unrevoked
3997 keys, and for such keyservers this option is meaningless.
3998 Note also that most keyservers do not have cryptographic
3999 verification of key revocations, and so turning this option
4000 off may result in skipping keys that are incorrectly marked as
4004 When searching for a key with '--search-keys', include keys
4005 that are marked on the keyserver as disabled. Note that this
4006 option is not used with HKP keyservers.
4009 This is an obsolete alias for the option 'auto-key-retrieve'.
4010 Please do not use it; it will be removed in future versions..
4013 When using '--refresh-keys', if the key in question has a
4014 preferred keyserver URL, then use that preferred keyserver to
4015 refresh the key from. In addition, if auto-key-retrieve is
4016 set, and the signature being verified has a preferred
4017 keyserver URL, then use that preferred keyserver to fetch the
4018 key from. Note that this option introduces a "web bug": The
4019 creator of the key can see when the keys is refreshed. Thus
4020 this option is not enabled by default.
4023 If '--auto-key-retrieve' is used, and the signature being
4024 verified has a PKA record, then use the PKA information to
4025 fetch the key. Defaults to "yes".
4028 When receiving a key, include subkeys as potential targets.
4029 Note that this option is not used with HKP keyservers, as they
4030 do not support retrieving keys by subkey id.
4038 These options have no more function since GnuPG 2.1. Use the
4039 'dirmngr' configuration options instead.
4041 The default list of options is: "self-sigs-only, import-clean,
4042 repair-keys, repair-pks-subkey-bug, export-attributes,
4043 honor-pka-record". However, if the actual used source is an LDAP
4044 server "no-self-sigs-only" is assumed unless "self-sigs-only" has
4045 been explictly configured.
4047 '--completes-needed N'
4048 Number of completely trusted users to introduce a new key signer
4051 '--marginals-needed N'
4052 Number of marginally trusted users to introduce a new key signer
4055 '--tofu-default-policy {auto|good|unknown|bad|ask}'
4056 The default TOFU policy (defaults to 'auto'). For more information
4057 about the meaning of this option, *note trust-model-tofu::.
4059 '--max-cert-depth N'
4060 Maximum depth of a certification chain (default is 5).
4063 Do not cache the verification status of key signatures. Caching
4064 gives a much better performance in key listings. However, if you
4065 suspect that your public keyring is not safe against write
4066 modifications, you can use this option to disable the caching. It
4067 probably does not make sense to disable it because all kind of
4068 damage can be done if someone else has write access to your public
4071 '--auto-check-trustdb'
4072 '--no-auto-check-trustdb'
4073 If GnuPG feels that its information about the Web of Trust has to
4074 be updated, it automatically runs the '--check-trustdb' command
4075 internally. This may be a time consuming process.
4076 '--no-auto-check-trustdb' disables this option.
4080 This is dummy option. 'gpg' always requires the agent.
4083 This is dummy option. It has no effect when used with 'gpg'.
4085 '--agent-program FILE'
4086 Specify an agent program to be used for secret key operations. The
4087 default value is determined by running 'gpgconf' with the option
4088 '--list-dirs'. Note that the pipe symbol ('|') is used for a
4089 regression test suite hack and may thus not be used in the file
4092 '--dirmngr-program FILE'
4093 Specify a dirmngr program to be used for keyserver access. The
4094 default value is '/usr/local/bin/dirmngr'.
4097 Entirely disable the use of the Dirmngr.
4100 Do not start the gpg-agent or the dirmngr if it has not yet been
4101 started and its service is required. This option is mostly useful
4102 on machines where the connection to gpg-agent has been redirected
4103 to another machines. If dirmngr is required on the remote machine,
4104 it may be started manually using 'gpgconf --launch dirmngr'.
4107 Lock the databases the first time a lock is requested and do not
4108 release the lock until the process terminates.
4111 Release the locks every time a lock is no longer needed. Use this
4112 to override a previous '--lock-once' from a config file.
4115 Disable locking entirely. This option should be used only in very
4116 special environments, where it can be assured that only one process
4117 is accessing those files. A bootable floppy with a stand-alone
4118 encryption system will probably use this. Improper usage of this
4119 option may lead to data and key corruption.
4121 '--exit-on-status-write-error'
4122 This option will cause write errors on the status FD to immediately
4123 terminate the process. That should in fact be the default but it
4124 never worked this way and thus we need an option to enable this, so
4125 that the change won't break applications which close their end of a
4126 status fd connected pipe too early. Using this option along with
4127 '--enable-progress-filter' may be used to cleanly cancel long
4128 running gpg operations.
4130 '--limit-card-insert-tries N'
4131 With N greater than 0 the number of prompts asking to insert a
4132 smartcard gets limited to N-1. Thus with a value of 1 gpg won't at
4133 all ask to insert a card if none has been inserted at startup.
4134 This option is useful in the configuration file in case an
4135 application does not know about the smartcard support and waits ad
4136 infinitum for an inserted card.
4138 '--no-random-seed-file'
4139 GnuPG uses a file to store its internal random pool over
4140 invocations. This makes random generation faster; however
4141 sometimes write operations are not desired. This option can be
4142 used to achieve that with the cost of slower random generation.
4145 Suppress the initial copyright message.
4147 '--no-secmem-warning'
4148 Suppress the warning about "using insecure memory".
4150 '--no-permission-warning'
4151 Suppress the warning about unsafe file and home directory
4152 ('--homedir') permissions. Note that the permission checks that
4153 GnuPG performs are not intended to be authoritative, but rather
4154 they simply warn about certain common permission problems. Do not
4155 assume that the lack of a warning means that your system is secure.
4157 Note that the warning for unsafe '--homedir' permissions cannot be
4158 suppressed in the gpg.conf file, as this would allow an attacker to
4159 place an unsafe gpg.conf file in place, and use this file to
4160 suppress warnings about itself. The '--homedir' permissions
4161 warning may only be suppressed on the command line.
4164 '--no-require-secmem'
4165 Refuse to run if GnuPG cannot get secure memory. Defaults to no
4166 (i.e. run, but give a warning).
4168 '--require-cross-certification'
4169 '--no-require-cross-certification'
4170 When verifying a signature made from a subkey, ensure that the
4171 cross certification "back signature" on the subkey is present and
4172 valid. This protects against a subtle attack against subkeys that
4173 can sign. Defaults to '--require-cross-certification' for 'gpg'.
4177 Allow the user to do certain nonsensical or "silly" things like
4178 signing an expired or revoked key, or certain potentially
4179 incompatible things like generating unusual key types. This also
4180 disables certain warning messages about potentially incompatible
4181 actions. As the name implies, this option is for experts only. If
4182 you don't fully understand the implications of what it allows you
4183 to do, leave this off. '--no-expert' disables this option.
4186 File: gnupg.info, Node: GPG Key related Options, Next: GPG Input and Output, Prev: GPG Configuration Options, Up: GPG Options
4188 4.2.2 Key related options
4189 -------------------------
4193 Encrypt for user id NAME. If this option or '--hidden-recipient'
4194 is not specified, GnuPG asks for the user-id unless
4195 '--default-recipient' is given.
4197 '--hidden-recipient NAME'
4199 Encrypt for user ID NAME, but hide the key ID of this user's key.
4200 This option helps to hide the receiver of the message and is a
4201 limited countermeasure against traffic analysis. If this option or
4202 '--recipient' is not specified, GnuPG asks for the user ID unless
4203 '--default-recipient' is given.
4205 '--recipient-file FILE'
4207 This option is similar to '--recipient' except that it encrypts to
4208 a key stored in the given file. FILE must be the name of a file
4209 containing exactly one key. 'gpg' assumes that the key in this
4210 file is fully valid.
4212 '--hidden-recipient-file FILE'
4214 This option is similar to '--hidden-recipient' except that it
4215 encrypts to a key stored in the given file. FILE must be the name
4216 of a file containing exactly one key. 'gpg' assumes that the key
4217 in this file is fully valid.
4220 Same as '--recipient' but this one is intended for use in the
4221 options file and may be used with your own user-id as an
4222 "encrypt-to-self". These keys are only used when there are other
4223 recipients given either by use of '--recipient' or by the asked
4224 user id. No trust checking is performed for these user ids and
4225 even disabled keys can be used.
4227 '--hidden-encrypt-to NAME'
4228 Same as '--hidden-recipient' but this one is intended for use in
4229 the options file and may be used with your own user-id as a hidden
4230 "encrypt-to-self". These keys are only used when there are other
4231 recipients given either by use of '--recipient' or by the asked
4232 user id. No trust checking is performed for these user ids and
4233 even disabled keys can be used.
4236 Disable the use of all '--encrypt-to' and '--hidden-encrypt-to'
4239 '--group {NAME=VALUE}'
4240 Sets up a named group, which is similar to aliases in email
4241 programs. Any time the group name is a recipient ('-r' or
4242 '--recipient'), it will be expanded to the values specified.
4243 Multiple groups with the same name are automatically merged into a
4246 The values are 'key IDs' or fingerprints, but any key description
4247 is accepted. Note that a value with spaces in it will be treated
4248 as two different values. Note also there is only one level of
4249 expansion -- you cannot make an group that points to another group.
4250 When used from the command line, it may be necessary to quote the
4251 argument to this option to prevent the shell from treating it as
4255 Remove a given entry from the '--group' list.
4258 Remove all entries from the '--group' list.
4262 Use NAME as the key to sign with. Note that this option overrides
4266 This option has two purposes. MBOX must either be a complete user
4267 id with a proper mail address or just a mail address. When
4268 creating a signature this option tells gpg the user id of a key
4269 used to make a signature if the key was not directly specified by a
4270 user id. When verifying a signature the MBOX is used to restrict
4271 the information printed by the TOFU code to matching user ids.
4273 '--try-secret-key NAME'
4274 For hidden recipients GPG needs to know the keys to use for trial
4275 decryption. The key set with '--default-key' is always tried
4276 first, but this is often not sufficient. This option allows
4277 setting more keys to be used for trial decryption. Although any
4278 valid user-id specification may be used for NAME it makes sense to
4279 use at least the long keyid to avoid ambiguities. Note that
4280 gpg-agent might pop up a pinentry for a lot keys to do the trial
4281 decryption. If you want to stop all further trial decryption you
4282 may use close-window button instead of the cancel button.
4285 Don't look at the key ID as stored in the message but try all
4286 secret keys in turn to find the right decryption key. This option
4287 forces the behaviour as used by anonymous recipients (created by
4288 using '--throw-keyids' or '--hidden-recipient') and might come
4289 handy in case where an encrypted message contains a bogus key ID.
4291 '--skip-hidden-recipients'
4292 '--no-skip-hidden-recipients'
4293 During decryption skip all anonymous recipients. This option helps
4294 in the case that people use the hidden recipients feature to hide
4295 their own encrypt-to key from others. If one has many secret keys
4296 this may lead to a major annoyance because all keys are tried in
4297 turn to decrypt something which was not really intended for it.
4298 The drawback of this option is that it is currently not possible to
4299 decrypt a message which includes real anonymous recipients.
4302 File: gnupg.info, Node: GPG Input and Output, Next: OpenPGP Options, Prev: GPG Key related Options, Up: GPG Options
4304 4.2.3 Input and Output
4305 ----------------------
4309 Create ASCII armored output. The default is to create the binary
4313 Assume the input data is not in ASCII armored format.
4317 Write output to FILE. To write to stdout use '-' as the filename.
4320 This option sets a limit on the number of bytes that will be
4321 generated when processing a file. Since OpenPGP supports various
4322 levels of compression, it is possible that the plaintext of a given
4323 message may be significantly larger than the original OpenPGP
4324 message. While GnuPG works properly with such messages, there is
4325 often a desire to set a maximum file size that will be generated
4326 before processing is forced to stop by the OS limits. Defaults to
4327 0, which means "no limit".
4329 '--input-size-hint N'
4330 This option can be used to tell GPG the size of the input data in
4331 bytes. N must be a positive base-10 number. This option is only
4332 useful if the input is not taken from a file. GPG may use this
4333 hint to optimize its buffer allocation strategy. It is also used
4334 by the '--status-fd' line "PROGRESS" to provide a value for "total"
4335 if that is not available by other means.
4337 '--key-origin STRING[,URL]'
4338 gpg can track the origin of a key. Certain origins are implicitly
4339 known (e.g. keyserver, web key directory) and set. For a standard
4340 import the origin of the keys imported can be set with this option.
4341 To list the possible values use "help" for STRING. Some origins
4342 can store an optional URL argument. That URL can appended to
4343 STRING after a comma.
4345 '--import-options PARAMETERS'
4346 This is a space or comma delimited string that gives options for
4347 importing keys. Options can be prepended with a 'no-' to give the
4348 opposite meaning. The options are:
4351 Allow importing key signatures marked as "local". This is not
4352 generally useful unless a shared keyring scheme is being used.
4356 Normally possible still existing ownertrust values of a key
4357 are cleared if a key is imported. This is in general
4358 desirable so that a formerly deleted key does not
4359 automatically gain an ownertrust values merely due to import.
4360 On the other hand it is sometimes necessary to re-import a
4361 trusted set of keys again but keeping already assigned
4362 ownertrust values. This can be achieved by using this option.
4364 repair-pks-subkey-bug
4365 During import, attempt to repair the damage caused by the PKS
4366 keyserver bug (pre version 0.9.6) that mangles keys with
4367 multiple subkeys. Note that this cannot completely repair the
4368 damaged key as some crucial data is removed by the keyserver,
4369 but it does at least give you back one subkey. Defaults to no
4370 for regular '--import' and to yes for keyserver
4375 Show a listing of the key as imported right before it is
4376 stored. This can be combined with the option '--dry-run' to
4377 only look at keys; the option 'show-only' is a shortcut for
4378 this combination. The command '--show-keys' is another
4379 shortcut for this. Note that suffixes like '#' for "sec" and
4380 "sbb" lines may or may not be printed.
4383 Run the entire import code but instead of storing the key to
4384 the local keyring write it to the output. The export options
4385 'export-pka' and 'export-dane' affect the output. This option
4386 can be used to remove all invalid parts from a key without the
4390 During import, allow key updates to existing keys, but do not
4391 allow any new keys to be imported. Defaults to no.
4394 After import, compact (remove all signatures except the
4395 self-signature) any user IDs from the new key that are not
4396 usable. Then, remove any signatures from the new key that are
4397 not usable. This includes signatures that were issued by keys
4398 that are not present on the keyring. This option is the same
4399 as running the '--edit-key' command "clean" after import.
4403 Accept only self-signatures while importing a key. All other
4404 key signatures are skipped at an early import stage. This
4405 option can be used with 'keyserver-options' to mitigate
4406 attempts to flood a key with bogus signatures from a
4407 keyserver. The drawback is that all other valid key
4408 signatures, as required by the Web of Trust are also not
4409 imported. Note that when using this option along with
4410 import-clean it suppresses the final clean step after merging
4411 the imported key into the existing key.
4414 After import, fix various problems with the keys. For
4415 example, this reorders signatures, and strips duplicate
4416 signatures. Defaults to yes.
4419 Import the smallest key possible. This removes all signatures
4420 except the most recent self-signature on each user ID. This
4421 option is the same as running the '--edit-key' command
4422 "minimize" after import. Defaults to no.
4426 Import in key restore mode. This imports all data which is
4427 usually skipped during import; including all GnuPG specific
4428 data. All other contradicting options are overridden.
4430 '--import-filter {NAME=EXPR}'
4431 '--export-filter {NAME=EXPR}'
4432 These options define an import/export filter which are applied to
4433 the imported/exported keyblock right before it will be
4434 stored/written. NAME defines the type of filter to use, EXPR the
4435 expression to evaluate. The option can be used several times which
4436 then appends more expression to the same NAME.
4438 The available filter types are:
4441 This filter will keep a user id packet and its dependent
4442 packets in the keyblock if the expression evaluates to true.
4445 This filter drops the selected subkeys. Currently only
4446 implemented for -export-filter.
4449 This filter drops the selected key signatures on user ids.
4450 Self-signatures are not considered. Currently only
4451 implemented for -import-filter.
4453 For the syntax of the expression see the chapter "FILTER
4454 EXPRESSIONS". The property names for the expressions depend on the
4455 actual filter type and are indicated in the following table.
4457 The available properties are:
4460 A string with the user id. (keep-uid)
4463 The addr-spec part of a user id with mailbox or the empty
4467 A number with the public key algorithm of a key or subkey
4468 packet. (drop-subkey)
4472 The first is the timestamp a public key or subkey packet was
4473 created. The second is the same but given as an ISO string,
4474 e.g. "2016-08-17". (drop-subkey)
4477 The hexified fingerprint of the current subkey or primary key.
4481 Boolean indicating whether the user id is the primary one.
4485 Boolean indicating whether a user id (keep-uid), a key
4486 (drop-subkey), or a signature (drop-sig) expired.
4489 Boolean indicating whether a user id (keep-uid) or a key
4490 (drop-subkey) has been revoked.
4493 Boolean indicating whether a primary key is disabled. (not
4497 Boolean indicating whether a key or subkey is a secret one.
4501 A string indicating the usage flags for the subkey, from the
4502 sequence "ecsa?". For example, a subkey capable of just
4503 signing and authentication would be an exact match for "sa".
4508 The first is the timestamp a signature packet was created.
4509 The second is the same but given as an ISO date string, e.g.
4510 "2016-08-17". (drop-sig)
4513 A number with the public key algorithm of a signature packet.
4517 A number with the digest algorithm of a signature packet.
4520 '--export-options PARAMETERS'
4521 This is a space or comma delimited string that gives options for
4522 exporting keys. Options can be prepended with a 'no-' to give the
4523 opposite meaning. The options are:
4526 Allow exporting key signatures marked as "local". This is not
4527 generally useful unless a shared keyring scheme is being used.
4531 Include attribute user IDs (photo IDs) while exporting. Not
4532 including attribute user IDs is useful to export keys that are
4533 going to be used by an OpenPGP program that does not accept
4534 attribute user IDs. Defaults to yes.
4536 export-sensitive-revkeys
4537 Include designated revoker information that was marked as
4538 "sensitive". Defaults to no.
4542 Export for use as a backup. The exported data includes all
4543 data which is needed to restore the key or keys later with
4544 GnuPG. The format is basically the OpenPGP format but enhanced
4545 with GnuPG specific data. All other contradicting options are
4549 Compact (remove all signatures from) user IDs on the key being
4550 exported if the user IDs are not usable. Also, do not export
4551 any signatures that are not usable. This includes signatures
4552 that were issued by keys that are not present on the keyring.
4553 This option is the same as running the '--edit-key' command
4554 "clean" before export except that the local copy of the key is
4555 not modified. Defaults to no.
4558 Export the smallest key possible. This removes all signatures
4559 except the most recent self-signature on each user ID. This
4560 option is the same as running the '--edit-key' command
4561 "minimize" before export except that the local copy of the key
4562 is not modified. Defaults to no.
4565 Instead of outputting the key material output PKA records
4566 suitable to put into DNS zone files. An ORIGIN line is
4567 printed before each record to allow diverting the records to
4568 the corresponding zone file.
4571 Instead of outputting the key material output OpenPGP DANE
4572 records suitable to put into DNS zone files. An ORIGIN line
4573 is printed before each record to allow diverting the records
4574 to the corresponding zone file.
4577 Print key listings delimited by colons. Note that the output will
4578 be encoded in UTF-8 regardless of any '--display-charset' setting.
4579 This format is useful when GnuPG is called from scripts and other
4580 programs as it is easily machine parsed. The details of this
4581 format are documented in the file 'doc/DETAILS', which is included
4582 in the GnuPG source distribution.
4585 Do not merge primary user ID and primary key in '--with-colon'
4586 listing mode and print all timestamps as seconds since 1970-01-01.
4587 Since GnuPG 2.0.10, this mode is always used and thus this option
4588 is obsolete; it does not harm to use it though.
4590 '--legacy-list-mode'
4591 Revert to the pre-2.1 public key list mode. This only affects the
4592 human readable output and not the machine interface (i.e.
4593 '--with-colons'). Note that the legacy format does not convey
4594 suitable information for elliptic curves.
4596 '--with-fingerprint'
4597 Same as the command '--fingerprint' but changes only the format of
4598 the output and may be used together with another command.
4600 '--with-subkey-fingerprint'
4601 If a fingerprint is printed for the primary key, this option forces
4602 printing of the fingerprint for all subkeys. This could also be
4603 achieved by using the '--with-fingerprint' twice but by using this
4604 option along with keyid-format "none" a compact fingerprint is
4607 '--with-icao-spelling'
4608 Print the ICAO spelling of the fingerprint in addition to the hex
4612 Include the keygrip in the key listings. In '--with-colons' mode
4613 this is implicitly enable for secret keys.
4616 Include the locally held information on the origin and last update
4617 of a key in a key listing. In '--with-colons' mode this is always
4618 printed. This data is currently experimental and shall not be
4619 considered part of the stable API.
4622 Print a Web Key Directory identifier along with each user ID in key
4623 listings. This is an experimental feature and semantics may
4627 Include info about the presence of a secret key in public key
4628 listings done with '--with-colons'.
4631 File: gnupg.info, Node: OpenPGP Options, Next: Compliance Options, Prev: GPG Input and Output, Up: GPG Options
4633 4.2.4 OpenPGP protocol specific options
4634 ---------------------------------------
4638 Treat input files as text and store them in the OpenPGP canonical
4639 text form with standard "CRLF" line endings. This also sets the
4640 necessary flags to inform the recipient that the encrypted or
4641 signed data is text and may need its line endings converted back to
4642 whatever the local system uses. This option is useful when
4643 communicating between two platforms that have different line ending
4644 conventions (UNIX-like to Mac, Mac to Windows, etc).
4645 '--no-textmode' disables this option, and is the default.
4648 '--no-force-v3-sigs'
4650 '--no-force-v4-certs'
4651 These options are obsolete and have no effect since GnuPG 2.1.
4655 These options are obsolete and have no effect since GnuPG 2.2.8.
4656 The MDC is always used. But note: If the creation of a legacy
4657 non-MDC message is exceptionally required, the option '--rfc2440'
4660 '--disable-signer-uid'
4661 By default the user ID of the signing key is embedded in the data
4662 signature. As of now this is only done if the signing key has been
4663 specified with 'local-user' using a mail address, or with 'sender'.
4664 This information can be helpful for verifier to locate the key; see
4665 option '--auto-key-retrieve'.
4667 '--include-key-block'
4668 This option is used to embed the actual signing key into a data
4669 signature. The embedded key is stripped down to a single user id
4670 and includes only the signing subkey used to create the signature
4671 as well as as valid encryption subkeys. All other info is removed
4672 from the key to keep it and thus the signature small. This option
4673 is the OpenPGP counterpart to the 'gpgsm' option '--include-certs'.
4675 '--personal-cipher-preferences STRING'
4676 Set the list of personal cipher preferences to STRING. Use 'gpg
4677 --version' to get a list of available algorithms, and use 'none' to
4678 set no preference at all. This allows the user to safely override
4679 the algorithm chosen by the recipient key preferences, as GPG will
4680 only select an algorithm that is usable by all recipients. The
4681 most highly ranked cipher in this list is also used for the
4682 '--symmetric' encryption command.
4684 '--personal-digest-preferences STRING'
4685 Set the list of personal digest preferences to STRING. Use 'gpg
4686 --version' to get a list of available algorithms, and use 'none' to
4687 set no preference at all. This allows the user to safely override
4688 the algorithm chosen by the recipient key preferences, as GPG will
4689 only select an algorithm that is usable by all recipients. The
4690 most highly ranked digest algorithm in this list is also used when
4691 signing without encryption (e.g. '--clear-sign' or '--sign').
4693 '--personal-compress-preferences STRING'
4694 Set the list of personal compression preferences to STRING. Use
4695 'gpg --version' to get a list of available algorithms, and use
4696 'none' to set no preference at all. This allows the user to safely
4697 override the algorithm chosen by the recipient key preferences, as
4698 GPG will only select an algorithm that is usable by all recipients.
4699 The most highly ranked compression algorithm in this list is also
4700 used when there are no recipient keys to consider (e.g.
4703 '--s2k-cipher-algo NAME'
4704 Use NAME as the cipher algorithm for symmetric encryption with a
4705 passphrase if '--personal-cipher-preferences' and '--cipher-algo'
4706 are not given. The default is AES-128.
4708 '--s2k-digest-algo NAME'
4709 Use NAME as the digest algorithm used to mangle the passphrases for
4710 symmetric encryption. The default is SHA-1.
4713 Selects how passphrases for symmetric encryption are mangled. If N
4714 is 0 a plain passphrase (which is in general not recommended) will
4715 be used, a 1 adds a salt (which should not be used) to the
4716 passphrase and a 3 (the default) iterates the whole process a
4717 number of times (see '--s2k-count').
4720 Specify how many times the passphrases mangling for symmetric
4721 encryption is repeated. This value may range between 1024 and
4722 65011712 inclusive. The default is inquired from gpg-agent. Note
4723 that not all values in the 1024-65011712 range are legal and if an
4724 illegal value is selected, GnuPG will round up to the nearest legal
4725 value. This option is only meaningful if '--s2k-mode' is set to
4729 File: gnupg.info, Node: Compliance Options, Next: GPG Esoteric Options, Prev: OpenPGP Options, Up: GPG Options
4731 4.2.5 Compliance options
4732 ------------------------
4734 These options control what GnuPG is compliant to. Only one of these
4735 options may be active at a time. Note that the default setting of this
4736 is nearly always the correct one. See the INTEROPERABILITY WITH OTHER
4737 OPENPGP PROGRAMS section below before using one of these options.
4740 Use standard GnuPG behavior. This is essentially OpenPGP behavior
4741 (see '--openpgp'), but with some additional workarounds for common
4742 compatibility problems in different versions of PGP. This is the
4743 default option, so it is not generally needed, but it may be useful
4744 to override a different compliance option in the gpg.conf file.
4747 Reset all packet, cipher and digest options to strict OpenPGP
4748 behavior. Use this option to reset all previous options like
4749 '--s2k-*', '--cipher-algo', '--digest-algo' and '--compress-algo'
4750 to OpenPGP compliant values. All PGP workarounds are disabled.
4753 Reset all packet, cipher and digest options to strict RFC-4880
4754 behavior. Note that this is currently the same thing as
4758 Enable experimental features from proposed updates to RFC-4880.
4759 This option can be used in addition to the other compliance
4760 options. Warning: The behavior may change with any GnuPG release
4761 and created keys or data may not be usable with future GnuPG
4765 Reset all packet, cipher and digest options to strict RFC-2440
4766 behavior. Note that by using this option encryption packets are
4767 created in a legacy mode without MDC protection. This is dangerous
4768 and should thus only be used for experiments. See also option
4769 '--ignore-mdc-error'.
4772 Set up all options to be as PGP 6 compliant as possible. This
4773 restricts you to the ciphers IDEA (if the IDEA plugin is
4774 installed), 3DES, and CAST5, the hashes MD5, SHA1 and RIPEMD160,
4775 and the compression algorithms none and ZIP. This also disables
4776 '--throw-keyids', and making signatures with signing subkeys as PGP
4777 6 does not understand signatures made by signing subkeys.
4779 This option implies '--escape-from-lines'.
4782 Set up all options to be as PGP 7 compliant as possible. This is
4783 identical to '--pgp6' except that MDCs are not disabled, and the
4784 list of allowable ciphers is expanded to add AES128, AES192,
4785 AES256, and TWOFISH.
4788 Set up all options to be as PGP 8 compliant as possible. PGP 8 is
4789 a lot closer to the OpenPGP standard than previous versions of PGP,
4790 so all this does is disable '--throw-keyids' and set
4791 '--escape-from-lines'. All algorithms are allowed except for the
4792 SHA224, SHA384, and SHA512 digests.
4794 '--compliance STRING'
4795 This option can be used instead of one of the options above. Valid
4796 values for STRING are the above option names (without the double
4797 dash) and possibly others as shown when using "help" for VALUE.
4800 File: gnupg.info, Node: GPG Esoteric Options, Next: Deprecated Options, Prev: Compliance Options, Up: GPG Options
4802 4.2.6 Doing things one usually doesn't want to do
4803 -------------------------------------------------
4807 Don't make any changes (this is not completely implemented).
4810 Changes the behaviour of some commands. This is like '--dry-run'
4811 but different in some cases. The semantic of this option may be
4812 extended in the future. Currently it only skips the actual
4813 decryption pass and therefore enables a fast listing of the
4818 Prompt before overwriting any files.
4820 '--debug-level LEVEL'
4821 Select the debug level for investigating problems. LEVEL may be a
4822 numeric value or by a keyword:
4825 No debugging at all. A value of less than 1 may be used
4826 instead of the keyword.
4828 Some basic debug messages. A value between 1 and 2 may be
4829 used instead of the keyword.
4831 More verbose debug messages. A value between 3 and 5 may be
4832 used instead of the keyword.
4834 Even more detailed messages. A value between 6 and 8 may be
4835 used instead of the keyword.
4837 All of the debug messages you can get. A value greater than 8
4838 may be used instead of the keyword. The creation of hash
4839 tracing files is only enabled if the keyword is used.
4841 How these messages are mapped to the actual debugging flags is not
4842 specified and may change with newer releases of this program. They
4843 are however carefully selected to best aid in debugging.
4846 Set debugging flags. All flags are or-ed and FLAGS may be given in
4847 C syntax (e.g. 0x0042) or as a comma separated list of flag names.
4848 To get a list of all supported flags the single word "help" can be
4852 Set all useful debugging flags.
4855 Set stdout into line buffered mode. This option is only honored
4856 when given on the command line.
4858 '--faked-system-time EPOCH'
4859 This option is only useful for testing; it sets the system time
4860 back or forth to EPOCH which is the number of seconds elapsed since
4861 the year 1970. Alternatively EPOCH may be given as a full ISO time
4862 string (e.g. "20070924T154812").
4864 If you suffix EPOCH with an exclamation mark (!), the system time
4865 will appear to be frozen at the specified time.
4867 '--enable-progress-filter'
4868 Enable certain PROGRESS status outputs. This option allows
4869 frontends to display a progress indicator while gpg is processing
4870 larger files. There is a slight performance overhead using it.
4873 Write special status strings to the file descriptor N. See the
4874 file DETAILS in the documentation for a listing of them.
4876 '--status-file FILE'
4877 Same as '--status-fd', except the status data is written to file
4881 Write log output to file descriptor N and not to STDERR.
4884 '--logger-file FILE'
4885 Same as '--logger-fd', except the logger data is written to file
4886 FILE. Use 'socket://' to log to a socket. Note that in this
4887 version of gpg the option has only an effect if '--batch' is also
4891 Write attribute subpackets to the file descriptor N. This is most
4892 useful for use with '--status-fd', since the status messages are
4893 needed to separate out the various subpackets from the stream
4894 delivered to the file descriptor.
4896 '--attribute-file FILE'
4897 Same as '--attribute-fd', except the attribute data is written to
4902 Use STRING as a comment string in cleartext signatures and ASCII
4903 armored messages or keys (see '--armor'). The default behavior is
4904 not to use a comment string. '--comment' may be repeated multiple
4905 times to get multiple comment strings. '--no-comments' removes all
4906 comments. It is a good idea to keep the length of a single comment
4907 below 60 characters to avoid problems with mail programs wrapping
4908 such lines. Note that comment lines, like all other header lines,
4909 are not protected by the signature.
4913 Force inclusion of the version string in ASCII armored output. If
4914 given once only the name of the program and the major number is
4915 emitted, given twice the minor is also emitted, given thrice the
4916 micro is added, and given four times an operating system
4917 identification is also emitted. '--no-emit-version' (default)
4918 disables the version line.
4920 '--sig-notation {NAME=VALUE}'
4921 '--cert-notation {NAME=VALUE}'
4922 '-N, --set-notation {NAME=VALUE}'
4923 Put the name value pair into the signature as notation data. NAME
4924 must consist only of printable characters or spaces, and must
4925 contain a '@' character in the form keyname@domain.example.com
4926 (substituting the appropriate keyname and domain name, of course).
4927 This is to help prevent pollution of the IETF reserved notation
4928 namespace. The '--expert' flag overrides the '@' check. VALUE may
4929 be any printable string; it will be encoded in UTF-8, so you should
4930 check that your '--display-charset' is set correctly. If you
4931 prefix NAME with an exclamation mark (!), the notation data will be
4932 flagged as critical (rfc4880:5.2.3.16). '--sig-notation' sets a
4933 notation for data signatures. '--cert-notation' sets a notation
4934 for key signatures (certifications). '--set-notation' sets both.
4936 There are special codes that may be used in notation names. "%k"
4937 will be expanded into the key ID of the key being signed, "%K" into
4938 the long key ID of the key being signed, "%f" into the fingerprint
4939 of the key being signed, "%s" into the key ID of the key making the
4940 signature, "%S" into the long key ID of the key making the
4941 signature, "%g" into the fingerprint of the key making the
4942 signature (which might be a subkey), "%p" into the fingerprint of
4943 the primary key of the key making the signature, "%c" into the
4944 signature count from the OpenPGP smartcard, and "%%" results in a
4945 single "%". %k, %K, and %f are only meaningful when making a key
4946 signature (certification), and %c is only meaningful when using the
4949 '--known-notation NAME'
4950 Adds NAME to a list of known critical signature notations. The
4951 effect of this is that gpg will not mark a signature with a
4952 critical signature notation of that name as bad. Note that gpg
4953 already knows by default about a few critical signatures notation
4956 '--sig-policy-url STRING'
4957 '--cert-policy-url STRING'
4958 '--set-policy-url STRING'
4959 Use STRING as a Policy URL for signatures (rfc4880:5.2.3.20). If
4960 you prefix it with an exclamation mark (!), the policy URL packet
4961 will be flagged as critical. '--sig-policy-url' sets a policy url
4962 for data signatures. '--cert-policy-url' sets a policy url for key
4963 signatures (certifications). '--set-policy-url' sets both.
4965 The same %-expandos used for notation data are available here as
4968 '--sig-keyserver-url STRING'
4969 Use STRING as a preferred keyserver URL for data signatures. If
4970 you prefix it with an exclamation mark (!), the keyserver URL
4971 packet will be flagged as critical.
4973 The same %-expandos used for notation data are available here as
4976 '--set-filename STRING'
4977 Use STRING as the filename which is stored inside messages. This
4978 overrides the default, which is to use the actual filename of the
4979 file being encrypted. Using the empty string for STRING
4980 effectively removes the filename from the output.
4982 '--for-your-eyes-only'
4983 '--no-for-your-eyes-only'
4984 Set the 'for your eyes only' flag in the message. This causes
4985 GnuPG to refuse to save the file unless the '--output' option is
4986 given, and PGP to use a "secure viewer" with a claimed
4987 Tempest-resistant font to display the message. This option
4988 overrides '--set-filename'. '--no-for-your-eyes-only' disables
4991 '--use-embedded-filename'
4992 '--no-use-embedded-filename'
4993 Try to create a file with a name as embedded in the data. This can
4994 be a dangerous option as it enables overwriting files. Defaults to
4995 no. Note that the option '--output' overrides this option.
4997 '--cipher-algo NAME'
4998 Use NAME as cipher algorithm. Running the program with the command
4999 '--version' yields a list of supported algorithms. If this is not
5000 used the cipher algorithm is selected from the preferences stored
5001 with the key. In general, you do not want to use this option as it
5002 allows you to violate the OpenPGP standard.
5003 '--personal-cipher-preferences' is the safe way to accomplish the
5006 '--digest-algo NAME'
5007 Use NAME as the message digest algorithm. Running the program with
5008 the command '--version' yields a list of supported algorithms. In
5009 general, you do not want to use this option as it allows you to
5010 violate the OpenPGP standard. '--personal-digest-preferences' is
5011 the safe way to accomplish the same thing.
5013 '--compress-algo NAME'
5014 Use compression algorithm NAME. "zlib" is RFC-1950 ZLIB
5015 compression. "zip" is RFC-1951 ZIP compression which is used by
5016 PGP. "bzip2" is a more modern compression scheme that can compress
5017 some things better than zip or zlib, but at the cost of more memory
5018 used during compression and decompression. "uncompressed" or
5019 "none" disables compression. If this option is not used, the
5020 default behavior is to examine the recipient key preferences to see
5021 which algorithms the recipient supports. If all else fails, ZIP is
5022 used for maximum compatibility.
5024 ZLIB may give better compression results than ZIP, as the
5025 compression window size is not limited to 8k. BZIP2 may give even
5026 better compression results than that, but will use a significantly
5027 larger amount of memory while compressing and decompressing. This
5028 may be significant in low memory situations. Note, however, that
5029 PGP (all versions) only supports ZIP compression. Using any
5030 algorithm other than ZIP or "none" will make the message unreadable
5031 with PGP. In general, you do not want to use this option as it
5032 allows you to violate the OpenPGP standard.
5033 '--personal-compress-preferences' is the safe way to accomplish the
5036 '--cert-digest-algo NAME'
5037 Use NAME as the message digest algorithm used when signing a key.
5038 Running the program with the command '--version' yields a list of
5039 supported algorithms. Be aware that if you choose an algorithm
5040 that GnuPG supports but other OpenPGP implementations do not, then
5041 some users will not be able to use the key signatures you make, or
5042 quite possibly your entire key.
5044 '--disable-cipher-algo NAME'
5045 Never allow the use of NAME as cipher algorithm. The given name
5046 will not be checked so that a later loaded algorithm will still get
5049 '--disable-pubkey-algo NAME'
5050 Never allow the use of NAME as public key algorithm. The given
5051 name will not be checked so that a later loaded algorithm will
5056 Do not put the recipient key IDs into encrypted messages. This
5057 helps to hide the receivers of the message and is a limited
5058 countermeasure against traffic analysis.(1) On the receiving side,
5059 it may slow down the decryption process because all available
5060 secret keys must be tried. '--no-throw-keyids' disables this
5061 option. This option is essentially the same as using
5062 '--hidden-recipient' for all recipients.
5064 '--not-dash-escaped'
5065 This option changes the behavior of cleartext signatures so that
5066 they can be used for patch files. You should not send such an
5067 armored file via email because all spaces and line endings are
5068 hashed too. You can not use this option for data which has 5
5069 dashes at the beginning of a line, patch files don't have this. A
5070 special armor header line tells GnuPG about this cleartext
5073 '--escape-from-lines'
5074 '--no-escape-from-lines'
5075 Because some mailers change lines starting with "From " to ">From "
5076 it is good to handle such lines in a special way when creating
5077 cleartext signatures to prevent the mail system from breaking the
5078 signature. Note that all other PGP versions do it this way too.
5079 Enabled by default. '--no-escape-from-lines' disables this option.
5081 '--passphrase-repeat N'
5082 Specify how many times 'gpg' will request a new passphrase be
5083 repeated. This is useful for helping memorize a passphrase.
5084 Defaults to 1 repetition; can be set to 0 to disable any passphrase
5085 repetition. Note that a N greater than 1 will pop up the pinentry
5086 window N+1 times even if a modern pinentry with two entry fields is
5090 Read the passphrase from file descriptor N. Only the first line
5091 will be read from file descriptor N. If you use 0 for N, the
5092 passphrase will be read from STDIN. This can only be used if only
5093 one passphrase is supplied.
5095 Note that since Version 2.0 this passphrase is only used if the
5096 option '--batch' has also been given. Since Version 2.1 the
5097 '--pinentry-mode' also needs to be set to 'loopback'.
5099 '--passphrase-file FILE'
5100 Read the passphrase from file FILE. Only the first line will be
5101 read from file FILE. This can only be used if only one passphrase
5102 is supplied. Obviously, a passphrase stored in a file is of
5103 questionable security if other users can read this file. Don't use
5104 this option if you can avoid it.
5106 Note that since Version 2.0 this passphrase is only used if the
5107 option '--batch' has also been given. Since Version 2.1 the
5108 '--pinentry-mode' also needs to be set to 'loopback'.
5110 '--passphrase STRING'
5111 Use STRING as the passphrase. This can only be used if only one
5112 passphrase is supplied. Obviously, this is of very questionable
5113 security on a multi-user system. Don't use this option if you can
5116 Note that since Version 2.0 this passphrase is only used if the
5117 option '--batch' has also been given. Since Version 2.1 the
5118 '--pinentry-mode' also needs to be set to 'loopback'.
5120 '--pinentry-mode MODE'
5121 Set the pinentry mode to MODE. Allowed values for MODE are:
5123 Use the default of the agent, which is 'ask'.
5125 Force the use of the Pinentry.
5127 Emulate use of Pinentry's cancel button.
5129 Return a Pinentry error ("No Pinentry").
5131 Redirect Pinentry queries to the caller. Note that in
5132 contrast to Pinentry the user is not prompted again if he
5133 enters a bad password.
5136 Disable the passphrase cache used for symmetrical en- and
5137 decryption. This cache is based on the message specific salt value
5140 '--request-origin ORIGIN'
5141 Tell gpg to assume that the operation ultimately originated at
5142 ORIGIN. Depending on the origin certain restrictions are applied
5143 and the Pinentry may include an extra note on the origin.
5144 Supported values for ORIGIN are: 'local' which is the default,
5145 'remote' to indicate a remote origin or 'browser' for an operation
5146 requested by a web browser.
5149 This is a replacement for the deprecated shared-memory IPC mode.
5150 If this option is enabled, user input on questions is not expected
5151 from the TTY but from the given file descriptor. It should be used
5152 together with '--status-fd'. See the file doc/DETAILS in the
5153 source distribution for details on how to use it.
5155 '--command-file FILE'
5156 Same as '--command-fd', except the commands are read out of file
5159 '--allow-non-selfsigned-uid'
5160 '--no-allow-non-selfsigned-uid'
5161 Allow the import and use of keys with user IDs which are not
5162 self-signed. This is not recommended, as a non self-signed user ID
5163 is trivial to forge. '--no-allow-non-selfsigned-uid' disables.
5165 '--allow-freeform-uid'
5166 Disable all checks on the form of the user ID while generating a
5167 new one. This option should only be used in very special
5168 environments as it does not ensure the de-facto standard format of
5171 '--ignore-time-conflict'
5172 GnuPG normally checks that the timestamps associated with keys and
5173 signatures have plausible values. However, sometimes a signature
5174 seems to be older than the key due to clock problems. This option
5175 makes these checks just a warning. See also '--ignore-valid-from'
5176 for timestamp issues on subkeys.
5178 '--ignore-valid-from'
5179 GnuPG normally does not select and use subkeys created in the
5180 future. This option allows the use of such keys and thus exhibits
5181 the pre-1.0.7 behaviour. You should not use this option unless
5182 there is some clock problem. See also '--ignore-time-conflict' for
5183 timestamp issues with signatures.
5185 '--ignore-crc-error'
5186 The ASCII armor used by OpenPGP is protected by a CRC checksum
5187 against transmission errors. Occasionally the CRC gets mangled
5188 somewhere on the transmission channel but the actual content (which
5189 is protected by the OpenPGP protocol anyway) is still okay. This
5190 option allows GnuPG to ignore CRC errors.
5192 '--ignore-mdc-error'
5193 This option changes a MDC integrity protection failure into a
5194 warning. It is required to decrypt old messages which did not use
5195 an MDC. It may also be useful if a message is partially garbled,
5196 but it is necessary to get as much data as possible out of that
5197 garbled message. Be aware that a missing or failed MDC can be an
5198 indication of an attack. Use with great caution; see also option
5201 '--allow-weak-digest-algos'
5202 Signatures made with known-weak digest algorithms are normally
5203 rejected with an "invalid digest algorithm" message. This option
5204 allows the verification of signatures made with such weak
5205 algorithms. MD5 is the only digest algorithm considered weak by
5206 default. See also '--weak-digest' to reject other digest
5209 '--weak-digest NAME'
5210 Treat the specified digest algorithm as weak. Signatures made over
5211 weak digests algorithms are normally rejected. This option can be
5212 supplied multiple times if multiple algorithms should be considered
5213 weak. See also '--allow-weak-digest-algos' to disable rejection of
5214 weak digests. MD5 is always considered weak, and does not need to
5215 be listed explicitly.
5217 '--allow-weak-key-signatures'
5218 To avoid a minor risk of collision attacks on third-party key
5219 signatures made using SHA-1, those key signatures are considered
5220 invalid. This options allows to override this restriction.
5222 '--no-default-keyring'
5223 Do not add the default keyring to the list of keyrings. Note that
5224 GnuPG needs for almost all operations a keyring. Thus if you use
5225 this option and do not provide alternate keyrings via '--keyring',
5226 then GnuPG will still use the default keyring.
5229 Do not use any keyring at all. This overrides the default and all
5230 options which specify keyrings.
5233 Skip the signature verification step. This may be used to make the
5234 decryption faster if the signature verification is not needed.
5237 Print key listings delimited by colons (like '--with-colons') and
5238 print the public key data.
5242 Same as '--list-keys', but the signatures are listed too. This
5243 command has the same effect as using '--list-keys' with
5244 '--with-sig-list'. Note that in contrast to '--check-signatures'
5245 the key signatures are not verified. This command can be used to
5246 create a list of signing keys missing in the local keyring; for
5249 gpg --list-sigs --with-colons USERID | \
5250 awk -F: '$1=="sig" && $2=="?" {if($13){print $13}else{print $5}}'
5253 Changes the output of the list commands to work faster; this is
5254 achieved by leaving some parts empty. Some applications don't need
5255 the user ID and the trust information given in the listings. By
5256 using this options they can get a faster listing. The exact
5257 behaviour of this option may change in future versions. If you are
5258 missing some information, don't use this option.
5261 This is not for normal use. Use the source to see for what it
5265 This is not for normal use. Use the source to see for what it
5268 '--show-session-key'
5269 Display the session key used for one message. See
5270 '--override-session-key' for the counterpart of this option.
5272 We think that Key Escrow is a Bad Thing; however the user should
5273 have the freedom to decide whether to go to prison or to reveal the
5274 content of one specific message without compromising all messages
5275 ever encrypted for one secret key.
5277 You can also use this option if you receive an encrypted message
5278 which is abusive or offensive, to prove to the administrators of
5279 the messaging system that the ciphertext transmitted corresponds to
5280 an inappropriate plaintext so they can take action against the
5283 '--override-session-key STRING'
5284 '--override-session-key-fd FD'
5285 Don't use the public key but the session key STRING respective the
5286 session key taken from the first line read from file descriptor FD.
5287 The format of this string is the same as the one printed by
5288 '--show-session-key'. This option is normally not used but comes
5289 handy in case someone forces you to reveal the content of an
5290 encrypted message; using this option you can do this without
5291 handing out the secret key. Note that using
5292 '--override-session-key' may reveal the session key to all local
5293 users via the global process table. Often it is useful to combine
5294 this option with '--no-keyring'.
5297 '--no-ask-sig-expire'
5298 When making a data signature, prompt for an expiration time. If
5299 this option is not specified, the expiration time set via
5300 '--default-sig-expire' is used. '--no-ask-sig-expire' disables
5303 '--default-sig-expire'
5304 The default expiration time to use for signature expiration. Valid
5305 values are "0" for no expiration, a number followed by the letter d
5306 (for days), w (for weeks), m (for months), or y (for years) (for
5307 example "2m" for two months, or "5y" for five years), or an
5308 absolute date in the form YYYY-MM-DD. Defaults to "0".
5311 '--no-ask-cert-expire'
5312 When making a key signature, prompt for an expiration time. If
5313 this option is not specified, the expiration time set via
5314 '--default-cert-expire' is used. '--no-ask-cert-expire' disables
5317 '--default-cert-expire'
5318 The default expiration time to use for key signature expiration.
5319 Valid values are "0" for no expiration, a number followed by the
5320 letter d (for days), w (for weeks), m (for months), or y (for
5321 years) (for example "2m" for two months, or "5y" for five years),
5322 or an absolute date in the form YYYY-MM-DD. Defaults to "0".
5324 '--default-new-key-algo STRING'
5325 This option can be used to change the default algorithms for key
5326 generation. The STRING is similar to the arguments required for
5327 the command '--quick-add-key' but slightly different. For example
5328 the current default of '"rsa2048/cert,sign+rsa2048/encr"' (or
5329 '"rsa3072"') can be changed to the value of what we currently call
5330 future default, which is '"ed25519/cert,sign+cv25519/encr"'. You
5331 need to consult the source code to learn the details. Note that
5332 the advanced key generation commands can always be used to specify
5333 a key algorithm directly.
5336 This option modifies the behaviour of the commands
5337 '--quick-sign-key', '--quick-lsign-key', and the "sign"
5338 sub-commands of '--edit-key' by forcing the creation of a key
5339 signature, even if one already exists.
5341 '--allow-secret-key-import'
5342 This is an obsolete option and is not used anywhere.
5344 '--allow-multiple-messages'
5345 '--no-allow-multiple-messages'
5346 Allow processing of multiple OpenPGP messages contained in a single
5347 file or stream. Some programs that call GPG are not prepared to
5348 deal with multiple messages being processed together, so this
5349 option defaults to no. Note that versions of GPG prior to 1.4.7
5350 always allowed multiple messages. Future versions of GnUPG will
5353 Warning: Do not use this option unless you need it as a temporary
5356 '--enable-special-filenames'
5357 This option enables a mode in which filenames of the form '-&n',
5358 where n is a non-negative decimal number, refer to the file
5359 descriptor n and not to a file with that name.
5361 '--no-expensive-trust-checks'
5362 Experimental use only.
5364 '--preserve-permissions'
5365 Don't change the permissions of a secret keyring back to user
5366 read/write only. Use this option only if you really know what you
5369 '--default-preference-list STRING'
5370 Set the list of default preferences to STRING. This preference
5371 list is used for new keys and becomes the default for "setpref" in
5374 '--default-keyserver-url NAME'
5375 Set the default keyserver URL to NAME. This keyserver will be used
5376 as the keyserver URL when writing a new self-signature on a key,
5377 which includes key generation and changing preferences.
5380 Display various internal configuration parameters of GnuPG. This
5381 option is intended for external programs that call GnuPG to perform
5382 tasks, and is thus not generally useful. See the file
5383 'doc/DETAILS' in the source distribution for the details of which
5384 configuration items may be listed. '--list-config' is only usable
5385 with '--with-colons' set.
5387 '--list-gcrypt-config'
5388 Display various internal configuration parameters of Libgcrypt.
5391 This command is similar to '--list-config' but in general only
5392 internally used by the 'gpgconf' tool.
5395 This is more or less dummy action. However it parses the
5396 configuration file and returns with failure if the configuration
5397 file would prevent 'gpg' from startup. Thus it may be used to run
5398 a syntax check on the configuration file.
5400 ---------- Footnotes ----------
5402 (1) Using a little social engineering anyone who is able to decrypt
5403 the message can check whether one of the other recipients is the one he
5407 File: gnupg.info, Node: Deprecated Options, Prev: GPG Esoteric Options, Up: GPG Options
5409 4.2.7 Deprecated options
5410 ------------------------
5414 Causes '--list-keys', '--list-signatures', '--list-public-keys',
5415 '--list-secret-keys', and verifying a signature to also display the
5416 photo ID attached to the key, if any. See also '--photo-viewer'.
5417 These options are deprecated. Use '--list-options
5418 [no-]show-photos' and/or '--verify-options [no-]show-photos'
5422 Display the keyring name at the head of key listings to show which
5423 keyring a given key resides on. This option is deprecated: use
5424 '--list-options [no-]show-keyring' instead.
5427 Identical to '--trust-model always'. This option is deprecated.
5430 '--no-show-notation'
5431 Show signature notations in the '--list-signatures' or
5432 '--check-signatures' listings as well as when verifying a signature
5433 with a notation in it. These options are deprecated. Use
5434 '--list-options [no-]show-notation' and/or '--verify-options
5435 [no-]show-notation' instead.
5438 '--no-show-policy-url'
5439 Show policy URLs in the '--list-signatures' or '--check-signatures'
5440 listings as well as when verifying a signature with a policy URL in
5441 it. These options are deprecated. Use '--list-options
5442 [no-]show-policy-url' and/or '--verify-options
5443 [no-]show-policy-url' instead.
5446 File: gnupg.info, Node: GPG Configuration, Next: GPG Examples, Prev: GPG Options, Up: Invoking GPG
5448 4.3 Configuration files
5449 =======================
5451 There are a few configuration files to control certain aspects of
5452 'gpg''s operation. Unless noted, they are expected in the current home
5453 directory (*note option --homedir::).
5456 This is the standard configuration file read by 'gpg' on startup.
5457 It may contain any valid long option; the leading two dashes may
5458 not be entered and the option may not be abbreviated. This default
5459 name may be changed on the command line (*note gpg-option
5460 --options::). You should backup this file.
5462 Note that on larger installations, it is useful to put predefined
5463 files into the directory '/etc/skel/.gnupg' so that newly created users
5464 start up with a working configuration. For existing users a small
5465 helper script is provided to create these files (*note addgnupghome::).
5467 For internal purposes 'gpg' creates and maintains a few other files;
5468 They all live in the current home directory (*note option --homedir::).
5469 Only the 'gpg' program may modify these files.
5472 This is the default home directory which is used if neither the
5473 environment variable 'GNUPGHOME' nor the option '--homedir' is
5476 '~/.gnupg/pubring.gpg'
5477 The public keyring using a legacy format. You should backup this
5480 If this file is not available, 'gpg' defaults to the new keybox
5481 format and creates a file 'pubring.kbx' unless that file already
5482 exists in which case that file will also be used for OpenPGP keys.
5484 Note that in the case that both files, 'pubring.gpg' and
5485 'pubring.kbx' exists but the latter has no OpenPGP keys, the legacy
5486 file 'pubring.gpg' will be used. Take care: GnuPG versions before
5487 2.1 will always use the file 'pubring.gpg' because they do not know
5488 about the new keybox format. In the case that you have to use
5489 GnuPG 1.4 to decrypt archived data you should keep this file.
5491 '~/.gnupg/pubring.gpg.lock'
5492 The lock file for the public keyring.
5494 '~/.gnupg/pubring.kbx'
5495 The public keyring using the new keybox format. This file is
5496 shared with 'gpgsm'. You should backup this file. See above for
5497 the relation between this file and it predecessor.
5499 To convert an existing 'pubring.gpg' file to the keybox format, you
5500 first backup the ownertrust values, then rename 'pubring.gpg' to
5501 'publickeys.backup', so it won’t be recognized by any GnuPG
5502 version, run import, and finally restore the ownertrust values:
5505 $ gpg --export-ownertrust >otrust.lst
5506 $ mv pubring.gpg publickeys.backup
5507 $ gpg --import-options restore --import publickeys.backups
5508 $ gpg --import-ownertrust otrust.lst
5510 '~/.gnupg/pubring.kbx.lock'
5511 The lock file for 'pubring.kbx'.
5513 '~/.gnupg/secring.gpg'
5514 The legacy secret keyring as used by GnuPG versions before 2.1. It
5515 is not used by GnuPG 2.1 and later. You may want to keep it in
5516 case you have to use GnuPG 1.4 to decrypt archived data.
5518 '~/.gnupg/secring.gpg.lock'
5519 The lock file for the legacy secret keyring.
5521 '~/.gnupg/.gpg-v21-migrated'
5522 File indicating that a migration to GnuPG 2.1 has been done.
5524 '~/.gnupg/trustdb.gpg'
5525 The trust database. There is no need to backup this file; it is
5526 better to backup the ownertrust values (*note option
5527 --export-ownertrust::).
5529 '~/.gnupg/trustdb.gpg.lock'
5530 The lock file for the trust database.
5532 '~/.gnupg/random_seed'
5533 A file used to preserve the state of the internal random pool.
5535 '~/.gnupg/openpgp-revocs.d/'
5536 This is the directory where gpg stores pre-generated revocation
5537 certificates. The file name corresponds to the OpenPGP fingerprint
5538 of the respective key. It is suggested to backup those
5539 certificates and if the primary private key is not stored on the
5540 disk to move them to an external storage device. Anyone who can
5541 access theses files is able to revoke the corresponding key. You
5542 may want to print them out. You should backup all files in this
5543 directory and take care to keep this backup closed away.
5545 Operation is further controlled by a few environment variables:
5548 Used to locate the default home directory.
5551 If set directory used instead of "~/.gnupg".
5554 This variable is obsolete; it was used by GnuPG versions before
5558 This value is passed via gpg-agent to pinentry. It is useful to
5559 convey extra information to a custom pinentry.
5563 Used to size some displays to the full size of the screen.
5566 Apart from its use by GNU, it is used in the W32 version to
5567 override the language selection done through the Registry. If used
5568 and set to a valid and available language name (LANGID), the file
5569 with the translation is loaded from 'GPGDIR/gnupg.nls/LANGID.mo'.
5570 Here GPGDIR is the directory out of which the gpg binary has been
5571 loaded. If it can't be loaded the Registry is tried and as last
5572 resort the native Windows locale system is used.
5574 When calling the gpg-agent component 'gpg' sends a set of environment
5575 variables to gpg-agent. The names of these variables can be listed
5578 gpg-connect-agent 'getinfo std_env_names' /bye | awk '$1=="D" {print $2}'
5581 File: gnupg.info, Node: GPG Examples, Next: Unattended Usage of GPG, Prev: GPG Configuration, Up: Invoking GPG
5586 gpg -se -r 'Bob' 'file'
5587 sign and encrypt for user Bob
5589 gpg -clear-sign 'file'
5590 make a cleartext signature
5593 make a detached signature
5595 gpg -u 0x12345678 -sb 'file'
5596 make a detached signature with the key 0x12345678
5598 gpg -list-keys 'user_ID'
5601 gpg -fingerprint 'user_ID'
5604 gpg -verify 'pgpfile'
5605 gpg -verify 'sigfile' ['datafile']
5606 Verify the signature of the file but do not output the data unless
5607 requested. The second form is used for detached signatures, where
5608 'sigfile' is the detached signature (either ASCII armored or
5609 binary) and 'datafile' are the signed data; if this is not given,
5610 the name of the file holding the signed data is constructed by
5611 cutting off the extension (".asc" or ".sig") of 'sigfile' or by
5612 asking the user for the filename. If the option '--output' is also
5613 used the signed data is written to the file specified by that
5614 option; use '-' to write the signed data to stdout.
5619 The options '--import-filter' and '--export-filter' use expressions with
5620 this syntax (square brackets indicate an optional part and curly braces
5621 a repetition, white space between the elements are allowed):
5623 [lc] {[{flag}] PROPNAME op VALUE [lc]}
5625 The name of a property (PROPNAME) may only consist of letters, digits
5626 and underscores. The description for the filter type describes which
5627 properties are defined. If an undefined property is used it evaluates
5628 to the empty string. Unless otherwise noted, the VALUE must always be
5629 given and may not be the empty string. No quoting is defined for the
5630 value, thus the value may not contain the strings '&&' or '||', which
5631 are used as logical connection operators. The flag '--' can be used to
5632 remove this restriction.
5634 Numerical values are computed as long int; standard C notation
5635 applies. LC is the logical connection operator; either '&&' for a
5636 conjunction or '||' for a disjunction. A conjunction is assumed at the
5637 begin of an expression. Conjunctions have higher precedence than
5638 disjunctions. If VALUE starts with one of the characters used in any OP
5639 a space after the OP is required.
5641 The supported operators (OP) are:
5644 Substring must match.
5647 Substring must not match.
5650 The full string must match.
5653 The full string must not match.
5656 The numerical value must match.
5659 The numerical value must not match.
5662 The numerical value of the field must be LE than the value.
5665 The numerical value of the field must be LT than the value.
5668 The numerical value of the field must be GT than the value.
5671 The numerical value of the field must be GE than the value.
5674 The string value of the field must be less or equal than the value.
5677 The string value of the field must be less than the value.
5680 The string value of the field must be greater than the value.
5683 The string value of the field must be greater or equal than the
5687 True if value is not empty (no value allowed).
5690 True if value is empty (no value allowed).
5693 Alias for "PROPNAME != 0" (no value allowed).
5696 Alias for "PROPNAME == 0" (no value allowed).
5698 Values for FLAG must be space separated. The supported flags are:
5701 VALUE spans to the end of the expression.
5703 The string match in this part is done case-sensitive.
5705 Leading and trailing spaces are not removed from VALUE. The
5706 optional single space after OP is here required.
5708 The filter options concatenate several specifications for a filter of
5709 the same type. For example the four options in this example:
5711 --import-filter keep-uid="uid =~ Alfa"
5712 --import-filter keep-uid="&& uid !~ Test"
5713 --import-filter keep-uid="|| uid =~ Alpha"
5714 --import-filter keep-uid="uid !~ Test"
5716 which is equivalent to
5719 keep-uid="uid =~ Alfa" && uid !~ Test" || uid =~ Alpha" && "uid !~ Test"
5721 imports only the user ids of a key containing the strings "Alfa" or
5722 "Alpha" but not the string "test".
5727 The program returns 0 if there are no severe errors, 1 if at least a
5728 signature was bad, and other error codes for fatal errors.
5730 Note that signature verification requires exact knowledge of what has
5731 been signed and by whom it has beensigned. Using only the return code
5732 is thus not an appropriate way to verify a signature by a script.
5733 Either make proper use or the status codes or use the 'gpgv' tool which
5734 has been designed to make signature verification easy for scripts.
5739 Use a good password for your user account and make sure that all
5740 security issues are always fixed on your machine. Also employ diligent
5741 physical protection to your machine. Consider to use a good passphrase
5742 as a last resort protection to your secret key in the case your machine
5743 gets stolen. It is important that your secret key is never leaked.
5744 Using an easy to carry around token or smartcard with the secret key is
5747 If you are going to verify detached signatures, make sure that the
5748 program knows about it; either give both filenames on the command line
5749 or use '-' to specify STDIN.
5751 For scripted or other unattended use of 'gpg' make sure to use the
5752 machine-parseable interface and not the default interface which is
5753 intended for direct use by humans. The machine-parseable interface
5754 provides a stable and well documented API independent of the locale or
5755 future changes of 'gpg'. To enable this interface use the options
5756 '--with-colons' and '--status-fd'. For certain operations the option
5757 '--command-fd' may come handy too. See this man page and the file
5758 'DETAILS' for the specification of the interface. Note that the GnuPG
5759 "info" pages as well as the PDF version of the GnuPG manual features a
5760 chapter on unattended use of GnuPG. As an alternative the library
5761 'GPGME' can be used as a high-level abstraction on top of that
5764 INTEROPERABILITY WITH OTHER OPENPGP PROGRAMS
5765 ********************************************
5767 GnuPG tries to be a very flexible implementation of the OpenPGP
5768 standard. In particular, GnuPG implements many of the optional parts of
5769 the standard, such as the SHA-512 hash, and the ZLIB and BZIP2
5770 compression algorithms. It is important to be aware that not all
5771 OpenPGP programs implement these optional algorithms and that by forcing
5772 their use via the '--cipher-algo', '--digest-algo',
5773 '--cert-digest-algo', or '--compress-algo' options in GnuPG, it is
5774 possible to create a perfectly valid OpenPGP message, but one that
5775 cannot be read by the intended recipient.
5777 There are dozens of variations of OpenPGP programs available, and
5778 each supports a slightly different subset of these optional algorithms.
5779 For example, until recently, no (unhacked) version of PGP supported the
5780 BLOWFISH cipher algorithm. A message using BLOWFISH simply could not be
5781 read by a PGP user. By default, GnuPG uses the standard OpenPGP
5782 preferences system that will always do the right thing and create
5783 messages that are usable by all recipients, regardless of which OpenPGP
5784 program they use. Only override this safe default if you really know
5787 If you absolutely must override the safe default, or if the
5788 preferences on a given key are invalid for some reason, you are far
5789 better off using the '--pgp6', '--pgp7', or '--pgp8' options. These
5790 options are safe as they do not force any particular algorithms in
5791 violation of OpenPGP, but rather reduce the available algorithms to a
5797 On older systems this program should be installed as setuid(root). This
5798 is necessary to lock memory pages. Locking memory pages prevents the
5799 operating system from writing memory pages (which may contain
5800 passphrases or other sensitive material) to disk. If you get no warning
5801 message about insecure memory your operating system supports locking
5802 without being root. The program drops root privileges as soon as locked
5803 memory is allocated.
5805 Note also that some systems (especially laptops) have the ability to
5806 "suspend to disk" (also known as "safe sleep" or "hibernate"). This
5807 writes all memory to disk before going into a low power or even powered
5808 off mode. Unless measures are taken in the operating system to protect
5809 the saved memory, passphrases or other sensitive material may be
5810 recoverable from it later.
5812 Before you report a bug you should first search the mailing list
5813 archives for similar problems and second check whether such a bug has
5814 already been reported to our bug tracker at <https://bugs.gnupg.org>.
5817 File: gnupg.info, Node: Unattended Usage of GPG, Prev: GPG Examples, Up: Invoking GPG
5819 4.5 Unattended Usage
5820 ====================
5822 'gpg' is often used as a backend engine by other software. To help with
5823 this a machine interface has been defined to have an unambiguous way to
5824 do this. The options '--status-fd' and '--batch' are almost always
5829 * Programmatic use of GnuPG:: Programmatic use of GnuPG
5830 * Ephemeral home directories:: Ephemeral home directories
5831 * The quick key manipulation interface:: The quick key manipulation interface
5832 * Unattended GPG key generation:: Unattended key generation
5835 File: gnupg.info, Node: Programmatic use of GnuPG, Next: Ephemeral home directories, Up: Unattended Usage of GPG
5837 4.5.1 Programmatic use of GnuPG
5838 -------------------------------
5840 Please consider using GPGME instead of calling 'gpg' directly. GPGME
5841 offers a stable, backend-independent interface for many cryptographic
5842 operations. It supports OpenPGP and S/MIME, and also allows interaction
5843 with various GnuPG components.
5845 GPGME provides a C-API, and comes with bindings for C++, Qt, and
5846 Python. Bindings for other languages are available.
5849 File: gnupg.info, Node: Ephemeral home directories, Next: The quick key manipulation interface, Prev: Programmatic use of GnuPG, Up: Unattended Usage of GPG
5851 4.5.2 Ephemeral home directories
5852 --------------------------------
5854 Sometimes you want to contain effects of some operation, for example you
5855 want to import a key to inspect it, but you do not want this key to be
5856 added to your keyring. In earlier versions of GnuPG, it was possible to
5857 specify alternate keyring files for both public and secret keys. In
5858 modern GnuPG versions, however, we changed how secret keys are stored in
5859 order to better protect secret key material, and it was not possible to
5860 preserve this interface.
5862 The preferred way to do this is to use ephemeral home directories.
5863 This technique works across all versions of GnuPG.
5865 Create a temporary directory, create (or copy) a configuration that
5866 meets your needs, make 'gpg' use this directory either using the
5867 environment variable GNUPGHOME, or the option '--homedir'. GPGME
5868 supports this too on a per-context basis, by modifying the engine info
5869 of contexts. Now execute whatever operation you like, import and export
5870 key material as necessary. Once finished, you can delete the directory.
5871 All GnuPG backend services that were started will detect this and shut
5875 File: gnupg.info, Node: The quick key manipulation interface, Next: Unattended GPG key generation, Prev: Ephemeral home directories, Up: Unattended Usage of GPG
5877 4.5.3 The quick key manipulation interface
5878 ------------------------------------------
5880 Recent versions of GnuPG have an interface to manipulate keys without
5881 using the interactive command '--edit-key'. This interface was added
5882 mainly for the benefit of GPGME (please consider using GPGME, see the
5883 manual subsection "Programmatic use of GnuPG"). This interface is
5884 described in the subsection "How to manage your keys".
5887 File: gnupg.info, Node: Unattended GPG key generation, Prev: The quick key manipulation interface, Up: Unattended Usage of GPG
5889 4.5.4 Unattended key generation
5890 -------------------------------
5892 The command '--generate-key' may be used along with the option '--batch'
5893 for unattended key generation. This is the most flexible way of
5894 generating keys, but it is also the most complex one. Consider using
5895 the quick key manipulation interface described in the previous
5896 subsection "The quick key manipulation interface".
5898 The parameters for the key are either read from stdin or given as a
5899 file on the command line. The format of the parameter file is as
5902 * Text only, line length is limited to about 1000 characters.
5903 * UTF-8 encoding must be used to specify non-ASCII characters.
5904 * Empty lines are ignored.
5905 * Leading and trailing white space is ignored.
5906 * A hash sign as the first non white space character indicates a
5908 * Control statements are indicated by a leading percent sign, the
5909 arguments are separated by white space from the keyword.
5910 * Parameters are specified by a keyword, followed by a colon.
5911 Arguments are separated by white space.
5912 * The first parameter must be 'Key-Type'; control statements may be
5914 * The order of the parameters does not matter except for 'Key-Type'
5915 which must be the first parameter. The parameters are only used
5916 for the generated keyblock (primary and subkeys); parameters from
5917 previous sets are not used. Some syntactically checks may be
5919 * Key generation takes place when either the end of the parameter
5920 file is reached, the next 'Key-Type' parameter is encountered or at
5921 the control statement '%commit' is encountered.
5926 Print TEXT as diagnostic.
5929 Suppress actual key generation (useful for syntax checking).
5932 Perform the key generation. Note that an implicit commit is done
5933 at the next Key-Type parameter.
5936 Do not write the key to the default or commandline given keyring
5937 but to FILENAME. This must be given before the first commit to
5938 take place, duplicate specification of the same filename is
5939 ignored, the last filename before a commit is used. The filename
5940 is used until a new filename is used (at commit points) and all
5941 keys are written to that file. If a new filename is given, this
5942 file is created (and overwrites an existing one).
5944 See the previous subsection "Ephemeral home directories" for a more
5945 robust way to contain side-effects.
5948 This option is a no-op for GnuPG 2.1 and later.
5950 See the previous subsection "Ephemeral home directories".
5954 This option is a no-op for GnuPG 2.1 and later.
5957 Using this option allows the creation of keys without any
5958 passphrase protection. This option is mainly intended for
5962 If given the keys are created using a faster and a somewhat less
5963 secure random number generator. This option may be used for keys
5964 which are only used for a short time and do not require full
5965 cryptographic strength. It takes only effect if used together with
5966 the control statement '%no-protection'.
5971 Starts a new parameter block by giving the type of the primary key.
5972 The algorithm must be capable of signing. This is a required
5973 parameter. ALGO may either be an OpenPGP algorithm number or a
5974 string with the algorithm name. The special value 'default' may be
5975 used for ALGO to create the default key type; in this case a
5976 'Key-Usage' shall not be given and 'default' also be used for
5980 The requested length of the generated key in bits. The default is
5981 returned by running the command 'gpg --gpgconf-list'. For ECC keys
5982 this parameter is ignored.
5985 The requested elliptic curve of the generated key. This is a
5986 required parameter for ECC keys. It is ignored for non-ECC keys.
5989 This is optional and used to generate a CSR or certificate for an
5990 already existing key. Key-Length will be ignored when given.
5992 Key-Usage: USAGE-LIST
5993 Space or comma delimited list of key usages. Allowed values are
5994 'encrypt', 'sign', and 'auth'. This is used to generate the key
5995 flags. Please make sure that the algorithm is capable of this
5996 usage. Note that OpenPGP requires that all primary keys are
5997 capable of certification, so no matter what usage is given here,
5998 the 'cert' flag will be on. If no 'Key-Usage' is specified and the
5999 'Key-Type' is not 'default', all allowed usages for that particular
6000 algorithm are used; if it is not given but 'default' is used the
6001 usage will be 'sign'.
6004 This generates a secondary key (subkey). Currently only one subkey
6005 can be handled. See also 'Key-Type' above.
6007 Subkey-Length: NBITS
6008 Length of the secondary key (subkey) in bits. The default is
6009 returned by running the command 'gpg --gpgconf-list'.
6012 Key curve for a subkey; similar to 'Key-Curve'.
6014 Subkey-Usage: USAGE-LIST
6015 Key usage lists for a subkey; similar to 'Key-Usage'.
6018 If you want to specify a passphrase for the secret key, enter it
6019 here. Default is to use the Pinentry dialog to ask for a
6023 Name-Comment: COMMENT
6025 The three parts of a user name. Remember to use UTF-8 encoding
6026 here. If you don't give any of them, no user ID is created.
6028 Expire-Date: ISO-DATE|(NUMBER[d|w|m|y])
6029 Set the expiration date for the key (and the subkey). It may
6030 either be entered in ISO date format (e.g. "20000815T145012") or
6031 as number of days, weeks, month or years after the creation date.
6032 The special notation "seconds=N" is also allowed to specify a
6033 number of seconds since creation. Without a letter days are
6034 assumed. Note that there is no check done on the overflow of the
6035 type used by OpenPGP for timestamps. Thus you better make sure
6036 that the given value make sense. Although OpenPGP works with time
6037 intervals, GnuPG uses an absolute value internally and thus the
6038 last year we can represent is 2105.
6040 Creation-Date: ISO-DATE
6041 Set the creation date of the key as stored in the key information
6042 and which is also part of the fingerprint calculation. Either a
6043 date like "1986-04-26" or a full timestamp like "19860426T042640"
6044 may be used. The time is considered to be UTC. The special
6045 notation "seconds=N" may be used to directly specify a the number
6046 of seconds since Epoch (Unix time). If it is not given the current
6050 Set the cipher, hash, and compression preference values for this
6051 key. This expects the same type of string as the sub-command
6052 'setpref' in the '--edit-key' menu.
6054 Revoker: ALGO:FPR [sensitive]
6055 Add a designated revoker to the generated key. Algo is the public
6056 key algorithm of the designated revoker (i.e. RSA=1, DSA=17, etc.)
6057 FPR is the fingerprint of the designated revoker. The optional
6058 'sensitive' flag marks the designated revoker as sensitive
6059 information. Only v4 keys may be designated revokers.
6062 This is an optional parameter that specifies the preferred
6063 keyserver URL for the key.
6066 This is an optional parameter only used with the status lines
6067 KEY_CREATED and KEY_NOT_CREATED. STRING may be up to 100 characters
6068 and should not contain spaces. It is useful for batch key
6069 generation to associate a key parameter block with a status line.
6071 Here is an example on how to create a key in an ephemeral home
6073 $ export GNUPGHOME="$(mktemp -d)"
6075 %echo Generating a basic OpenPGP key
6080 Name-Real: Joe Tester
6081 Name-Comment: with stupid passphrase
6082 Name-Email: joe@foo.bar
6085 # Do a commit here, so that we can later print "done" :-)
6089 $ gpg --batch --generate-key foo
6091 $ gpg --list-secret-keys
6092 /tmp/tmp.0NQxB74PEf/pubring.kbx
6093 -------------------------------
6094 sec dsa1024 2016-12-16 [SCA]
6095 768E895903FC1C44045C8CB95EEBDB71E9E849D0
6096 uid [ultimate] Joe Tester (with stupid passphrase) <joe@foo.bar>
6097 ssb elg1024 2016-12-16 [E]
6099 If you want to create a key with the default algorithms you would use
6101 %echo Generating a default key
6103 Subkey-Type: default
6104 Name-Real: Joe Tester
6105 Name-Comment: with stupid passphrase
6106 Name-Email: joe@foo.bar
6109 # Do a commit here, so that we can later print "done" :-)
6114 File: gnupg.info, Node: Invoking GPGSM, Next: Invoking SCDAEMON, Prev: Invoking GPG, Up: Top
6119 'gpgsm' is a tool similar to 'gpg' to provide digital encryption and
6120 signing services on X.509 certificates and the CMS protocol. It is
6121 mainly used as a backend for S/MIME mail processing. 'gpgsm' includes a
6122 full featured certificate management and complies with all rules defined
6123 for the German Sphinx project.
6125 *Note Option Index::, for an index to 'GPGSM''s commands and options.
6129 * GPGSM Commands:: List of all commands.
6130 * GPGSM Options:: List of all options.
6131 * GPGSM Configuration:: Configuration files.
6132 * GPGSM Examples:: Some usage examples.
6134 Developer information:
6135 * Unattended Usage:: Using 'gpgsm' from other programs.
6136 * GPGSM Protocol:: The protocol the server mode uses.
6139 File: gnupg.info, Node: GPGSM Commands, Next: GPGSM Options, Up: Invoking GPGSM
6144 Commands are not distinguished from options except for the fact that
6145 only one command is allowed.
6149 * General GPGSM Commands:: Commands not specific to the functionality.
6150 * Operational GPGSM Commands:: Commands to select the type of operation.
6151 * Certificate Management:: How to manage certificates.
6154 File: gnupg.info, Node: General GPGSM Commands, Next: Operational GPGSM Commands, Up: GPGSM Commands
6156 5.1.1 Commands not specific to the function
6157 -------------------------------------------
6160 Print the program version and licensing information. Note that you
6161 cannot abbreviate this command.
6164 Print a usage message summarizing the most useful command-line
6165 options. Note that you cannot abbreviate this command.
6168 Print warranty information. Note that you cannot abbreviate this
6172 Print a list of all available options and commands. Note that you
6173 cannot abbreviate this command.
6176 File: gnupg.info, Node: Operational GPGSM Commands, Next: Certificate Management, Prev: General GPGSM Commands, Up: GPGSM Commands
6178 5.1.2 Commands to select the type of operation
6179 ----------------------------------------------
6182 Perform an encryption. The keys the data is encrypted to must be
6183 set using the option '--recipient'.
6186 Perform a decryption; the type of input is automatically
6187 determined. It may either be in binary form or PEM encoded;
6188 automatic determination of base-64 encoding is not done.
6191 Create a digital signature. The key used is either the fist one
6192 found in the keybox or those set with the '--local-user' option.
6195 Check a signature file for validity. Depending on the arguments a
6196 detached signature may also be checked.
6199 Run in server mode and wait for commands on the 'stdin'.
6201 '--call-dirmngr COMMAND [ARGS]'
6202 Behave as a Dirmngr client issuing the request COMMAND with the
6203 optional list of ARGS. The output of the Dirmngr is printed
6204 stdout. Please note that file names given as arguments should have
6205 an absolute file name (i.e. commencing with '/') because they are
6206 passed verbatim to the Dirmngr and the working directory of the
6207 Dirmngr might not be the same as the one of this client. Currently
6208 it is not possible to pass data via stdin to the Dirmngr. COMMAND
6209 should not contain spaces.
6211 This is command is required for certain maintaining tasks of the
6212 dirmngr where a dirmngr must be able to call back to 'gpgsm'. See
6213 the Dirmngr manual for details.
6215 '--call-protect-tool ARGUMENTS'
6216 Certain maintenance operations are done by an external program call
6217 'gpg-protect-tool'; this is usually not installed in a directory
6218 listed in the PATH variable. This command provides a simple
6219 wrapper to access this tool. ARGUMENTS are passed verbatim to this
6220 command; use '--help' to get a list of supported operations.
6223 File: gnupg.info, Node: Certificate Management, Prev: Operational GPGSM Commands, Up: GPGSM Commands
6225 5.1.3 How to manage the certificates and keys
6226 ---------------------------------------------
6230 This command allows the creation of a certificate signing request
6231 or a self-signed certificate. It is commonly used along with the
6232 '--output' option to save the created CSR or certificate into a
6233 file. If used with the '--batch' a parameter file is used to
6234 create the CSR or certificate and it is further possible to create
6235 non-self-signed certificates.
6239 List all available certificates stored in the local key database.
6240 Note that the displayed data might be reformatted for better human
6241 readability and illegal characters are replaced by safe
6244 '--list-secret-keys'
6246 List all available certificates for which a corresponding a secret
6249 '--list-external-keys PATTERN'
6250 List certificates matching PATTERN using an external server. This
6251 utilizes the 'dirmngr' service.
6254 Same as '--list-keys' but also prints all keys making up the chain.
6258 List all available certificates stored in the local key database
6259 using a format useful mainly for debugging.
6262 Same as '--dump-keys' but also prints all keys making up the chain.
6264 '--dump-secret-keys'
6265 List all available certificates for which a corresponding a secret
6266 key is available using a format useful mainly for debugging.
6268 '--dump-external-keys PATTERN'
6269 List certificates matching PATTERN using an external server. This
6270 utilizes the 'dirmngr' service. It uses a format useful mainly for
6273 '--keydb-clear-some-cert-flags'
6274 This is a debugging aid to reset certain flags in the key database
6275 which are used to cache certain certificate stati. It is
6276 especially useful if a bad CRL or a weird running OCSP responder
6277 did accidentally revoke certificate. There is no security issue
6278 with this command because 'gpgsm' always make sure that the
6279 validity of a certificate is checked right before it is used.
6281 '--delete-keys PATTERN'
6282 Delete the keys matching PATTERN. Note that there is no command to
6283 delete the secret part of the key directly. In case you need to do
6284 this, you should run the command 'gpgsm --dump-secret-keys KEYID'
6285 before you delete the key, copy the string of hex-digits in the
6286 "keygrip" line and delete the file consisting of these hex-digits
6287 and the suffix '.key' from the 'private-keys-v1.d' directory below
6288 our GnuPG home directory (usually '~/.gnupg').
6290 '--export [PATTERN]'
6291 Export all certificates stored in the Keybox or those specified by
6292 the optional PATTERN. Those pattern consist of a list of user ids
6293 (*note how-to-specify-a-user-id::). When used along with the
6294 '--armor' option a few informational lines are prepended before
6295 each block. There is one limitation: As there is no commonly
6296 agreed upon way to pack more than one certificate into an ASN.1
6297 structure, the binary export (i.e. without using 'armor') works
6298 only for the export of one certificate. Thus it is required to
6299 specify a PATTERN which yields exactly one certificate. Ephemeral
6300 certificate are only exported if all PATTERN are given as
6301 fingerprints or keygrips.
6303 '--export-secret-key-p12 KEY-ID'
6304 Export the private key and the certificate identified by KEY-ID
6305 using the PKCS#12 format. When used with the '--armor' option a
6306 few informational lines are prepended to the output. Note, that
6307 the PKCS#12 format is not very secure and proper transport security
6308 should be used to convey the exported key. (*Note option
6311 '--export-secret-key-p8 KEY-ID'
6312 '--export-secret-key-raw KEY-ID'
6313 Export the private key of the certificate identified by KEY-ID with
6314 any encryption stripped. The '...-raw' command exports in PKCS#1
6315 format; the '...-p8' command exports in PKCS#8 format. When used
6316 with the '--armor' option a few informational lines are prepended
6317 to the output. These commands are useful to prepare a key for use
6321 Import the certificates from the PEM or binary encoded files as
6322 well as from signed-only messages. This command may also be used
6323 to import a secret key from a PKCS#12 file.
6326 Read information about the private keys from the smartcard and
6327 import the certificates from there. This command utilizes the
6328 'gpg-agent' and in turn the 'scdaemon'.
6330 '--change-passphrase USER_ID'
6332 Change the passphrase of the private key belonging to the
6333 certificate specified as USER_ID. Note, that changing the
6334 passphrase/PIN of a smartcard is not yet supported.
6337 File: gnupg.info, Node: GPGSM Options, Next: GPGSM Configuration, Prev: GPGSM Commands, Up: Invoking GPGSM
6342 'GPGSM' features a bunch of options to control the exact behaviour and
6343 to change the default configuration.
6347 * Configuration Options:: How to change the configuration.
6348 * Certificate Options:: Certificate related options.
6349 * Input and Output:: Input and Output.
6350 * CMS Options:: How to change how the CMS is created.
6351 * Esoteric Options:: Doing things one usually do not want to do.
6354 File: gnupg.info, Node: Configuration Options, Next: Certificate Options, Up: GPGSM Options
6356 5.2.1 How to change the configuration
6357 -------------------------------------
6359 These options are used to change the configuration and are usually found
6363 Reads configuration from FILE instead of from the default per-user
6364 configuration file. The default configuration file is named
6365 'gpgsm.conf' and expected in the '.gnupg' directory directly below
6366 the home directory of the user.
6369 Set the name of the home directory to DIR. If this option is not
6370 used, the home directory defaults to '~/.gnupg'. It is only
6371 recognized when given on the command line. It also overrides any
6372 home directory stated through the environment variable 'GNUPGHOME'
6373 or (on Windows systems) by means of the Registry entry
6374 HKCU\SOFTWARE\GNU\GNUPG:HOMEDIR.
6376 On Windows systems it is possible to install GnuPG as a portable
6377 application. In this case only this command line option is
6378 considered, all other ways to set a home directory are ignored.
6380 To install GnuPG as a portable application under Windows, create an
6381 empty file named 'gpgconf.ctl' in the same directory as the tool
6382 'gpgconf.exe'. The root of the installation is then that
6383 directory; or, if 'gpgconf.exe' has been installed directly below a
6384 directory named 'bin', its parent directory. You also need to make
6385 sure that the following directories exist and are writable:
6386 'ROOT/home' for the GnuPG home and 'ROOT/usr/local/var/cache/gnupg'
6387 for internal cache files.
6391 Outputs additional information while running. You can increase the
6392 verbosity by giving several verbose commands to 'gpgsm', such as
6395 '--ldapserver STRING'
6396 '--keyserver STRING'
6397 Add an LDAP server to use for X.509 certificate and CRL lookup.
6398 This option can be given multiple times to configure more than one
6399 LDAP server. Note that in general 'dirmngr' should be configured
6400 with the list of LDAP servers; if this option is also configured
6401 here, it is used in addition to those configured in dirmngr. For
6402 the syntax see the description of dirmngr's ldapserver option.
6404 '--policy-file FILENAME'
6405 Change the default name of the policy file to FILENAME.
6407 '--agent-program FILE'
6408 Specify an agent program to be used for secret key operations. The
6409 default value is determined by running the command 'gpgconf'. Note
6410 that the pipe symbol ('|') is used for a regression test suite hack
6411 and may thus not be used in the file name.
6413 '--dirmngr-program FILE'
6414 Specify a dirmngr program to be used for CRL checks. The default
6415 value is '/usr/local/bin/dirmngr'.
6417 '--prefer-system-dirmngr'
6418 This option is obsolete and ignored.
6421 Entirely disable the use of the Dirmngr.
6424 Do not start the gpg-agent or the dirmngr if it has not yet been
6425 started and its service is required. This option is mostly useful
6426 on machines where the connection to gpg-agent has been redirected
6427 to another machines. If dirmngr is required on the remote machine,
6428 it may be started manually using 'gpgconf --launch dirmngr'.
6430 '--no-secmem-warning'
6431 Do not print a warning when the so called "secure memory" cannot be
6435 When running in server mode, append all logging output to FILE.
6436 Use 'socket://' to log to socket.
6439 File: gnupg.info, Node: Certificate Options, Next: Input and Output, Prev: Configuration Options, Up: GPGSM Options
6441 5.2.2 Certificate related options
6442 ---------------------------------
6444 '--enable-policy-checks'
6445 '--disable-policy-checks'
6446 By default policy checks are enabled. These options may be used to
6449 '--enable-crl-checks'
6450 '--disable-crl-checks'
6451 By default the CRL checks are enabled and the DirMngr is used to
6452 check for revoked certificates. The disable option is most useful
6453 with an off-line network connection to suppress this check and also
6454 to avoid that new certificates introduce a web bug by including a
6455 certificate specific CRL DP. The disable option also disables an
6456 issuer certificate lookup via the authorityInfoAccess property of
6457 the certificate; the '--enable-issuer-key-retrieve' can be used to
6458 make use of that property anyway.
6460 '--enable-trusted-cert-crl-check'
6461 '--disable-trusted-cert-crl-check'
6462 By default the CRL for trusted root certificates are checked like
6463 for any other certificates. This allows a CA to revoke its own
6464 certificates voluntary without the need of putting all ever issued
6465 certificates into a CRL. The disable option may be used to switch
6466 this extra check off. Due to the caching done by the Dirmngr,
6467 there will not be any noticeable performance gain. Note, that this
6468 also disables possible OCSP checks for trusted root certificates.
6469 A more specific way of disabling this check is by adding the
6470 "relax" keyword to the root CA line of the 'trustlist.txt'
6472 '--force-crl-refresh'
6473 Tell the dirmngr to reload the CRL for each request. For better
6474 performance, the dirmngr will actually optimize this by suppressing
6475 the loading for short time intervals (e.g. 30 minutes). This
6476 option is useful to make sure that a fresh CRL is available for
6477 certificates hold in the keybox. The suggested way of doing this
6478 is by using it along with the option '--with-validation' for a key
6479 listing command. This option should not be used in a configuration
6482 '--enable-issuer-based-crl-check'
6483 Run a CRL check even for certificates which do not have any CRL
6484 distribution point. This requires that a suitable LDAP server has
6485 been configured in Dirmngr and that the CRL can be found using the
6486 issuer. This option reverts to what GnuPG did up to version
6487 2.2.20. This option is in general not useful.
6491 By default OCSP checks are disabled. The enable option may be used
6492 to enable OCSP checks via Dirmngr. If CRL checks are also enabled,
6493 CRLs will be used as a fallback if for some reason an OCSP request
6494 will not succeed. Note, that you have to allow OCSP requests in
6495 Dirmngr's configuration too (option '--allow-ocsp') and configure
6496 Dirmngr properly. If you do not do so you will get the error code
6499 '--auto-issuer-key-retrieve'
6500 If a required certificate is missing while validating the chain of
6501 certificates, try to load that certificate from an external
6502 location. This usually means that Dirmngr is employed to search
6503 for the certificate. Note that this option makes a "web bug" like
6504 behavior possible. LDAP server operators can see which keys you
6505 request, so by sending you a message signed by a brand new key
6506 (which you naturally will not have on your local keybox), the
6507 operator can tell both your IP address and the time when you
6508 verified the signature.
6510 '--validation-model NAME'
6511 This option changes the default validation model. The only
6512 possible values are "shell" (which is the default), "chain" which
6513 forces the use of the chain model and "steed" for a new simplified
6514 model. The chain model is also used if an option in the
6515 'trustlist.txt' or an attribute of the certificate requests it.
6516 However the standard model (shell) is in that case always tried
6519 '--ignore-cert-extension OID'
6520 Add OID to the list of ignored certificate extensions. The OID is
6521 expected to be in dotted decimal form, like '2.5.29.3'. This
6522 option may be used more than once. Critical flagged certificate
6523 extensions matching one of the OIDs in the list are treated as if
6524 they are actually handled and thus the certificate will not be
6525 rejected due to an unknown critical extension. Use this option
6526 with care because extensions are usually flagged as critical for a
6530 File: gnupg.info, Node: Input and Output, Next: CMS Options, Prev: Certificate Options, Up: GPGSM Options
6532 5.2.3 Input and Output
6533 ----------------------
6537 Create PEM encoded output. Default is binary output.
6540 Create Base-64 encoded output; i.e. PEM without the header lines.
6543 Assume the input data is PEM encoded. Default is to autodetect the
6544 encoding but this is may fail.
6547 Assume the input data is plain base-64 encoded.
6550 Assume the input data is binary encoded.
6552 '--p12-charset NAME'
6553 'gpgsm' uses the UTF-8 encoding when encoding passphrases for
6554 PKCS#12 files. This option may be used to force the passphrase to
6555 be encoded in the specified encoding NAME. This is useful if the
6556 application used to import the key uses a different encoding and
6557 thus will not be able to import a file generated by 'gpgsm'.
6558 Commonly used values for NAME are 'Latin1' and 'CP850'. Note that
6559 'gpgsm' itself automagically imports any file with a passphrase
6560 encoded to the most commonly used encodings.
6562 '--default-key USER_ID'
6563 Use USER_ID as the standard key for signing. This key is used if
6564 no other key has been defined as a signing key. Note, that the
6565 first '--local-users' option also sets this key if it has not yet
6566 been set; however '--default-key' always overrides this.
6568 '--local-user USER_ID'
6570 Set the user(s) to be used for signing. The default is the first
6571 secret key found in the database.
6575 Encrypt to the user id NAME. There are several ways a user id may
6576 be given (*note how-to-specify-a-user-id::).
6580 Write output to FILE. The default is to write it to stdout.
6583 Displays extra information with the '--list-keys' commands.
6584 Especially a line tagged 'grp' is printed which tells you the
6585 keygrip of a key. This string is for example used as the file name
6586 of the secret key. Implies '--with-colons'.
6589 When doing a key listing, do a full validation check for each key
6590 and print the result. This is usually a slow operation because it
6591 requires a CRL lookup and other operations.
6593 When used along with '--import', a validation of the certificate to
6594 import is done and only imported if it succeeds the test. Note
6595 that this does not affect an already available certificate in the
6596 DB. This option is therefore useful to simply verify a certificate.
6598 '--with-md5-fingerprint'
6599 For standard key listings, also print the MD5 fingerprint of the
6603 Include the keygrip in standard key listings. Note that the
6604 keygrip is always listed in '--with-colons' mode.
6607 Include info about the presence of a secret key in public key
6608 listings done with '--with-colons'.
6611 File: gnupg.info, Node: CMS Options, Next: Esoteric Options, Prev: Input and Output, Up: GPGSM Options
6613 5.2.4 How to change how the CMS is created
6614 ------------------------------------------
6617 Using N of -2 includes all certificate except for the root cert, -1
6618 includes all certs, 0 does not include any certs, 1 includes only
6619 the signers cert and all other positive values include up to N
6620 certificates starting with the signer cert. The default is -2.
6623 Use the cipher algorithm with the ASN.1 object identifier OID for
6624 encryption. For convenience the strings '3DES', 'AES' and 'AES256'
6625 may be used instead of their OIDs. The default is 'AES'
6626 (2.16.840.1.101.3.4.1.2).
6628 '--digest-algo name'
6629 Use 'name' as the message digest algorithm. Usually this algorithm
6630 is deduced from the respective signing certificate. This option
6631 forces the use of the given algorithm and may lead to severe
6632 interoperability problems.
6635 File: gnupg.info, Node: Esoteric Options, Prev: CMS Options, Up: GPGSM Options
6637 5.2.5 Doing things one usually do not want to do
6638 ------------------------------------------------
6640 '--extra-digest-algo NAME'
6641 Sometimes signatures are broken in that they announce a different
6642 digest algorithm than actually used. 'gpgsm' uses a one-pass data
6643 processing model and thus needs to rely on the announced digest
6644 algorithms to properly hash the data. As a workaround this option
6645 may be used to tell 'gpgsm' to also hash the data using the
6646 algorithm NAME; this slows processing down a little bit but allows
6647 verification of such broken signatures. If 'gpgsm' prints an error
6648 like "digest algo 8 has not been enabled" you may want to try this
6649 option, with 'SHA256' for NAME.
6651 '--faked-system-time EPOCH'
6652 This option is only useful for testing; it sets the system time
6653 back or forth to EPOCH which is the number of seconds elapsed since
6654 the year 1970. Alternatively EPOCH may be given as a full ISO time
6655 string (e.g. "20070924T154812").
6657 '--with-ephemeral-keys'
6658 Include ephemeral flagged keys in the output of key listings. Note
6659 that they are included anyway if the key specification for a
6660 listing is given as fingerprint or keygrip.
6662 '--debug-level LEVEL'
6663 Select the debug level for investigating problems. LEVEL may be a
6664 numeric value or by a keyword:
6667 No debugging at all. A value of less than 1 may be used
6668 instead of the keyword.
6670 Some basic debug messages. A value between 1 and 2 may be
6671 used instead of the keyword.
6673 More verbose debug messages. A value between 3 and 5 may be
6674 used instead of the keyword.
6676 Even more detailed messages. A value between 6 and 8 may be
6677 used instead of the keyword.
6679 All of the debug messages you can get. A value greater than 8
6680 may be used instead of the keyword. The creation of hash
6681 tracing files is only enabled if the keyword is used.
6683 How these messages are mapped to the actual debugging flags is not
6684 specified and may change with newer releases of this program. They
6685 are however carefully selected to best aid in debugging.
6688 This option is only useful for debugging and the behaviour may
6689 change at any time without notice; using '--debug-levels' is the
6690 preferred method to select the debug verbosity. FLAGS are bit
6691 encoded and may be given in usual C-Syntax. The currently defined
6695 X.509 or OpenPGP protocol related data
6697 values of big number integers
6699 low level crypto operations
6705 show memory statistics
6707 write hashed data to files named 'dbgmd-000*'
6709 trace Assuan protocol
6711 Note, that all flags set using this option may get overridden by
6715 Same as '--debug=0xffffffff'
6717 '--debug-allow-core-dump'
6718 Usually 'gpgsm' tries to avoid dumping core by well written code
6719 and by disabling core dumps for security reasons. However, bugs
6720 are pretty durable beasts and to squash them it is sometimes useful
6721 to have a core dump. This option enables core dumps unless the Bad
6722 Thing happened before the option parsing.
6724 '--debug-no-chain-validation'
6725 This is actually not a debugging option but only useful as such.
6726 It lets 'gpgsm' bypass all certificate chain validation checks.
6728 '--debug-ignore-expiration'
6729 This is actually not a debugging option but only useful as such.
6730 It lets 'gpgsm' ignore all notAfter dates, this is used by the
6734 Read the passphrase from file descriptor 'n'. Only the first line
6735 will be read from file descriptor 'n'. If you use 0 for 'n', the
6736 passphrase will be read from STDIN. This can only be used if only
6737 one passphrase is supplied.
6739 Note that this passphrase is only used if the option '--batch' has
6742 '--pinentry-mode mode'
6743 Set the pinentry mode to 'mode'. Allowed values for 'mode' are:
6745 Use the default of the agent, which is 'ask'.
6747 Force the use of the Pinentry.
6749 Emulate use of Pinentry's cancel button.
6751 Return a Pinentry error ("No Pinentry").
6753 Redirect Pinentry queries to the caller. Note that in
6754 contrast to Pinentry the user is not prompted again if he
6755 enters a bad password.
6757 '--request-origin ORIGIN'
6758 Tell gpgsm to assume that the operation ultimately originated at
6759 ORIGIN. Depending on the origin certain restrictions are applied
6760 and the Pinentry may include an extra note on the origin.
6761 Supported values for ORIGIN are: 'local' which is the default,
6762 'remote' to indicate a remote origin or 'browser' for an operation
6763 requested by a web browser.
6765 '--no-common-certs-import'
6766 Suppress the import of common certificates on keybox creation.
6768 All the long options may also be given in the configuration file
6769 after stripping off the two leading dashes.
6772 File: gnupg.info, Node: GPGSM Configuration, Next: GPGSM Examples, Prev: GPGSM Options, Up: Invoking GPGSM
6774 5.3 Configuration files
6775 =======================
6777 There are a few configuration files to control certain aspects of
6778 'gpgsm''s operation. Unless noted, they are expected in the current
6779 home directory (*note option --homedir::).
6782 This is the standard configuration file read by 'gpgsm' on startup.
6783 It may contain any valid long option; the leading two dashes may
6784 not be entered and the option may not be abbreviated. This default
6785 name may be changed on the command line (*note gpgsm-option
6786 --options::). You should backup this file.
6789 This is a list of allowed CA policies. This file should list the
6790 object identifiers of the policies line by line. Empty lines and
6791 lines starting with a hash mark are ignored. Policies missing in
6792 this file and not marked as critical in the certificate will print
6793 only a warning; certificates with policies marked as critical and
6794 not listed in this file will fail the signature verification. You
6795 should backup this file.
6797 For example, to allow only the policy 2.289.9.9, the file should
6804 This is the list of root certificates used for qualified
6805 certificates. They are defined as certificates capable of creating
6806 legally binding signatures in the same way as handwritten
6807 signatures are. Comments start with a hash mark and empty lines
6808 are ignored. Lines do have a length limit but this is not a
6809 serious limitation as the format of the entries is fixed and
6810 checked by 'gpgsm': A non-comment line starts with optional
6811 whitespace, followed by exactly 40 hex characters, white space and
6812 a lowercased 2 letter country code. Additional data delimited with
6813 by a white space is current ignored but might late be used for
6816 Note that even if a certificate is listed in this file, this does
6817 not mean that the certificate is trusted; in general the
6818 certificates listed in this file need to be listed also in
6821 This is a global file an installed in the data directory (e.g.
6822 '/usr/local/share/gnupg/qualified.txt'). GnuPG installs a suitable
6823 file with root certificates as used in Germany. As new Root-CA
6824 certificates may be issued over time, these entries may need to be
6825 updated; new distributions of this software should come with an
6826 updated list but it is still the responsibility of the
6827 Administrator to check that this list is correct.
6829 Every time 'gpgsm' uses a certificate for signing or verification
6830 this file will be consulted to check whether the certificate under
6831 question has ultimately been issued by one of these CAs. If this
6832 is the case the user will be informed that the verified signature
6833 represents a legally binding ("qualified") signature. When
6834 creating a signature using such a certificate an extra prompt will
6835 be issued to let the user confirm that such a legally binding
6836 signature shall really be created.
6838 Because this software has not yet been approved for use with such
6839 certificates, appropriate notices will be shown to indicate this
6843 This is plain text file with a few help entries used with
6844 'pinentry' as well as a large list of help items for 'gpg' and
6845 'gpgsm'. The standard file has English help texts; to install
6846 localized versions use filenames like 'help.LL.txt' with LL
6847 denoting the locale. GnuPG comes with a set of predefined help
6848 files in the data directory (e.g.
6849 '/usr/local/share/gnupg/gnupg/help.de.txt') and allows overriding
6850 of any help item by help files stored in the system configuration
6851 directory (e.g. '/etc/gnupg/help.de.txt'). For a reference of the
6852 help file's syntax, please see the installed 'help.txt' file.
6855 This file is a collection of common certificates used to populated
6856 a newly created 'pubring.kbx'. An administrator may replace this
6857 file with a custom one. The format is a concatenation of PEM
6858 encoded X.509 certificates. This global file is installed in the
6859 data directory (e.g. '/usr/local/share/gnupg/com-certs.pem').
6861 Note that on larger installations, it is useful to put predefined
6862 files into the directory '/etc/skel/.gnupg/' so that newly created users
6863 start up with a working configuration. For existing users a small
6864 helper script is provided to create these files (*note addgnupghome::).
6866 For internal purposes 'gpgsm' creates and maintains a few other
6867 files; they all live in the current home directory (*note option
6868 --homedir::). Only 'gpgsm' may modify these files.
6871 This a database file storing the certificates as well as meta
6872 information. For debugging purposes the tool 'kbxutil' may be used
6873 to show the internal structure of this file. You should backup
6877 This content of this file is used to maintain the internal state of
6878 the random number generator across invocations. The same file is
6879 used by other programs of this software too.
6882 If this file exists 'gpgsm' will first try to connect to this
6883 socket for accessing 'gpg-agent' before starting a new 'gpg-agent'
6884 instance. Under Windows this socket (which in reality be a plain
6885 file describing a regular TCP listening port) is the standard way
6886 of connecting the 'gpg-agent'.
6889 File: gnupg.info, Node: GPGSM Examples, Next: Unattended Usage, Prev: GPGSM Configuration, Up: Invoking GPGSM
6894 $ gpgsm -er goo@bar.net <plaintext >ciphertext
6897 File: gnupg.info, Node: Unattended Usage, Next: GPGSM Protocol, Prev: GPGSM Examples, Up: Invoking GPGSM
6899 5.5 Unattended Usage
6900 ====================
6902 'gpgsm' is often used as a backend engine by other software. To help
6903 with this a machine interface has been defined to have an unambiguous
6904 way to do this. This is most likely used with the '--server' command
6905 but may also be used in the standard operation mode by using the
6906 '--status-fd' option.
6910 * Automated signature checking:: Automated signature checking.
6911 * CSR and certificate creation:: CSR and certificate creation.
6914 File: gnupg.info, Node: Automated signature checking, Next: CSR and certificate creation, Up: Unattended Usage
6916 5.5.1 Automated signature checking
6917 ----------------------------------
6919 It is very important to understand the semantics used with signature
6920 verification. Checking a signature is not as simple as it may sound and
6921 so the operation is a bit complicated. In most cases it is required to
6922 look at several status lines. Here is a table of all cases a signed
6925 The signature is valid
6926 This does mean that the signature has been successfully verified,
6927 the certificates are all sane. However there are two subcases with
6928 important information: One of the certificates may have expired or
6929 a signature of a message itself as expired. It is a sound practise
6930 to consider such a signature still as valid but additional
6931 information should be displayed. Depending on the subcase 'gpgsm'
6932 will issue these status codes:
6933 signature valid and nothing did expire
6934 'GOODSIG', 'VALIDSIG', 'TRUST_FULLY'
6935 signature valid but at least one certificate has expired
6936 'EXPKEYSIG', 'VALIDSIG', 'TRUST_FULLY'
6937 signature valid but expired
6938 'EXPSIG', 'VALIDSIG', 'TRUST_FULLY' Note, that this case is
6939 currently not implemented.
6941 The signature is invalid
6942 This means that the signature verification failed (this is an
6943 indication of a transfer error, a program error or tampering with
6944 the message). 'gpgsm' issues one of these status codes sequences:
6946 'GOODSIG, VALIDSIG TRUST_NEVER'
6948 Error verifying a signature
6949 For some reason the signature could not be verified, i.e. it
6950 cannot be decided whether the signature is valid or invalid. A
6951 common reason for this is a missing certificate.
6954 File: gnupg.info, Node: CSR and certificate creation, Prev: Automated signature checking, Up: Unattended Usage
6956 5.5.2 CSR and certificate creation
6957 ----------------------------------
6959 The command '--generate-key' may be used along with the option '--batch'
6960 to either create a certificate signing request (CSR) or an X.509
6961 certificate. This is controlled by a parameter file; the format of this
6964 * Text only, line length is limited to about 1000 characters.
6965 * UTF-8 encoding must be used to specify non-ASCII characters.
6966 * Empty lines are ignored.
6967 * Leading and trailing while space is ignored.
6968 * A hash sign as the first non white space character indicates a
6970 * Control statements are indicated by a leading percent sign, the
6971 arguments are separated by white space from the keyword.
6972 * Parameters are specified by a keyword, followed by a colon.
6973 Arguments are separated by white space.
6974 * The first parameter must be 'Key-Type', control statements may be
6976 * The order of the parameters does not matter except for 'Key-Type'
6977 which must be the first parameter. The parameters are only used
6978 for the generated CSR/certificate; parameters from previous sets
6979 are not used. Some syntactically checks may be performed.
6980 * Key generation takes place when either the end of the parameter
6981 file is reached, the next 'Key-Type' parameter is encountered or at
6982 the control statement '%commit' is encountered.
6987 Print TEXT as diagnostic.
6990 Suppress actual key generation (useful for syntax checking).
6993 Perform the key generation. Note that an implicit commit is done
6994 at the next Key-Type parameter.
6999 Starts a new parameter block by giving the type of the primary key.
7000 The algorithm must be capable of signing. This is a required
7001 parameter. The only supported value for ALGO is 'rsa'.
7004 The requested length of a generated key in bits. Defaults to 3072.
7007 This is optional and used to generate a CSR or certificate for an
7008 already existing key. Key-Length will be ignored when given.
7010 Key-Usage: USAGE-LIST
7011 Space or comma delimited list of key usage, allowed values are
7012 'encrypt', 'sign' and 'cert'. This is used to generate the
7013 keyUsage extension. Please make sure that the algorithm is capable
7014 of this usage. Default is to allow encrypt and sign.
7016 Name-DN: SUBJECT-NAME
7017 This is the Distinguished Name (DN) of the subject in RFC-2253
7021 This is an email address for the altSubjectName. This parameter is
7022 optional but may occur several times to add several email addresses
7026 The is an DNS name for the altSubjectName. This parameter is
7027 optional but may occur several times to add several DNS names to a
7031 This is an URI for the altSubjectName. This parameter is optional
7032 but may occur several times to add several URIs to a certificate.
7034 Additional parameters used to create a certificate (in contrast to a
7035 certificate signing request):
7038 If this parameter is given an X.509 certificate will be generated.
7039 SN is expected to be a hex string representing an unsigned integer
7040 of arbitrary length. The special value 'random' can be used to
7041 create a 64 bit random serial number.
7043 Issuer-DN: ISSUER-NAME
7044 This is the DN name of the issuer in RFC-2253 format. If it is not
7045 set it will default to the subject DN and a special GnuPG extension
7046 will be included in the certificate to mark it as a standalone
7049 Creation-Date: ISO-DATE
7050 Not-Before: ISO-DATE
7051 Set the notBefore date of the certificate. Either a date like
7052 '1986-04-26' or '1986-04-26 12:00' or a standard ISO timestamp like
7053 '19860426T042640' may be used. The time is considered to be UTC.
7054 If it is not given the current date is used.
7056 Expire-Date: ISO-DATE
7058 Set the notAfter date of the certificate. Either a date like
7059 '2063-04-05' or '2063-04-05 17:00' or a standard ISO timestamp like
7060 '20630405T170000' may be used. The time is considered to be UTC.
7061 If it is not given a default value in the not too far future is
7064 Signing-Key: KEYGRIP
7065 This gives the keygrip of the key used to sign the certificate. If
7066 it is not given a self-signed certificate will be created. For
7067 compatibility with future versions, it is suggested to prefix the
7070 Hash-Algo: HASH-ALGO
7071 Use HASH-ALGO for this CSR or certificate. The supported hash
7072 algorithms are: 'sha1', 'sha256', 'sha384' and 'sha512'; they may
7073 also be specified with uppercase letters. The default is 'sha256'.
7076 File: gnupg.info, Node: GPGSM Protocol, Prev: Unattended Usage, Up: Invoking GPGSM
7078 5.6 The Protocol the Server Mode Uses
7079 =====================================
7081 Description of the protocol used to access 'GPGSM'. 'GPGSM' does
7082 implement the Assuan protocol and in addition provides a regular command
7083 line interface which exhibits a full client to this protocol (but uses
7084 internal linking). To start 'gpgsm' as a server the command line the
7085 option '--server' must be used. Additional options are provided to
7086 select the communication method (i.e. the name of the socket).
7088 We assume that the connection has already been established; see the
7089 Assuan manual for details.
7093 * GPGSM ENCRYPT:: Encrypting a message.
7094 * GPGSM DECRYPT:: Decrypting a message.
7095 * GPGSM SIGN:: Signing a message.
7096 * GPGSM VERIFY:: Verifying a message.
7097 * GPGSM GENKEY:: Generating a key.
7098 * GPGSM LISTKEYS:: List available keys.
7099 * GPGSM EXPORT:: Export certificates.
7100 * GPGSM IMPORT:: Import certificates.
7101 * GPGSM DELETE:: Delete certificates.
7102 * GPGSM GETAUDITLOG:: Retrieve an audit log.
7103 * GPGSM GETINFO:: Information about the process
7104 * GPGSM OPTION:: Session options.