1 @c Copyright (C) 2002 Free Software Foundation, Inc.
2 @c This is part of the GnuPG manual.
3 @c For copying conditions, see the file gnupg.texi.
5 @c Note that we use this texinfo file for all versions of GnuPG:
6 @c 2.0 and 2.1. The macro "gpgtwoone" controls parts which are only
7 @c valid for GnuPG 2.1 and later.
10 @node Invoking GPG-AGENT
11 @chapter Invoking GPG-AGENT
12 @cindex GPG-AGENT command options
13 @cindex command options
14 @cindex options, GPG-AGENT command
19 \- Secret key management for GnuPG
50 @command{gpg-agent} is a daemon to manage secret (private) keys
51 independently from any protocol. It is used as a backend for
52 @command{gpg} and @command{gpgsm} as well as for a couple of other
56 The agent is automatically started on demand by @command{gpg},
57 @command{gpgsm}, @command{gpgconf}, or @command{gpg-connect-agent}.
58 Thus there is no reason to start it manually. In case you want to use
59 the included Secure Shell Agent you may start the agent using:
62 gpg-connect-agent /bye
68 The usual way to run the agent is from the @code{~/.xsession} file:
71 eval $(gpg-agent --daemon)
74 If you don't use an X server, you can also put this into your regular
75 startup file @code{~/.profile} or @code{.bash_profile}. It is best not
76 to run multiple instance of the @command{gpg-agent}, so you should make
77 sure that only one is running: @command{gpg-agent} uses an environment
78 variable to inform clients about the communication parameters. You can
79 write the content of this environment variable to a file so that you can
80 test for a running agent. Here is an example using Bourne shell syntax:
83 gpg-agent --daemon --enable-ssh-support \
84 --write-env-file "$@{HOME@}/.gpg-agent-info"
87 This code should only be run once per user session to initially fire up
88 the agent. In the example the optional support for the included Secure
89 Shell agent is enabled and the information about the agent is written to
90 a file in the HOME directory. Note that by running gpg-agent without
91 arguments you may test whether an agent is already running; however such
92 a test may lead to a race condition, thus it is not suggested.
95 The second script needs to be run for each interactive session:
98 if [ -f "$@{HOME@}/.gpg-agent-info" ]; then
99 . "$@{HOME@}/.gpg-agent-info"
100 export GPG_AGENT_INFO
106 It reads the data out of the file and exports the variables. If you
107 don't use Secure Shell, you don't need the last two export statements.
111 You should always add the following lines to your @code{.bashrc} or
112 whatever initialization file is used for all shell invocations:
120 It is important that this environment variable always reflects the
121 output of the @code{tty} command. For W32 systems this option is not
124 Please make sure that a proper pinentry program has been installed
125 under the default filename (which is system dependant) or use the
126 option @option{pinentry-program} to specify the full name of that program.
127 It is often useful to install a symbolic link from the actual used
128 pinentry (e.g. @file{/usr/bin/pinentry-gtk}) to the expected
129 one (e.g. @file{/usr/bin/pinentry}).
133 @xref{Option Index},for an index to @command{GPG-AGENT}'s commands and options.
137 * Agent Commands:: List of all commands.
138 * Agent Options:: List of all options.
139 * Agent Configuration:: Configuration files.
140 * Agent Signals:: Use of some signals.
141 * Agent Examples:: Some usage examples.
142 * Agent Protocol:: The protocol the agent uses.
149 Commands are not distinguished from options except for the fact that
150 only one command is allowed.
155 Print the program version and licensing information. Note that you cannot
156 abbreviate this command.
161 Print a usage message summarizing the most useful command-line options.
162 Note that you cannot abbreviate this command.
165 @opindex dump-options
166 Print a list of all available options and commands. Note that you cannot
167 abbreviate this command.
171 Run in server mode and wait for commands on the @code{stdin}. The
172 default mode is to create a socket and listen for commands there.
174 @item --daemon [@var{command line}]
176 Start the gpg-agent as a daemon; that is, detach it from the console
177 and run it in the background.
179 Because @command{gpg-agent} prints out
180 important information required for further use, a common way of
181 invoking gpg-agent is: @code{eval $(gpg-agent --daemon)} to setup the
182 environment variables. The option @option{--write-env-file} is
183 another way commonly used to do this.
185 Yet another way is creating
186 a new process as a child of gpg-agent: @code{gpg-agent --daemon
187 /bin/sh}. This way you get a new shell with the environment setup
188 properly; if you exit from this shell, gpg-agent terminates as well.
193 @section Option Summary
197 @anchor{option --options}
198 @item --options @var{file}
200 Reads configuration from @var{file} instead of from the default
201 per-user configuration file. The default configuration file is named
202 @file{gpg-agent.conf} and expected in the @file{.gnupg} directory directly
203 below the home directory of the user.
205 @anchor{option --homedir}
206 @include opt-homedir.texi
212 Outputs additional information while running.
213 You can increase the verbosity by giving several
214 verbose commands to @command{gpgsm}, such as @samp{-vv}.
219 Try to be as quiet as possible.
223 Don't invoke a pinentry or do any other thing requiring human interaction.
225 @item --faked-system-time @var{epoch}
226 @opindex faked-system-time
227 This option is only useful for testing; it sets the system time back or
228 forth to @var{epoch} which is the number of seconds elapsed since the year
231 @item --debug-level @var{level}
233 Select the debug level for investigating problems. @var{level} may be
234 a numeric value or a keyword:
238 No debugging at all. A value of less than 1 may be used instead of
241 Some basic debug messages. A value between 1 and 2 may be used
242 instead of the keyword.
244 More verbose debug messages. A value between 3 and 5 may be used
245 instead of the keyword.
247 Even more detailed messages. A value between 6 and 8 may be used
248 instead of the keyword.
250 All of the debug messages you can get. A value greater than 8 may be
251 used instead of the keyword. The creation of hash tracing files is
252 only enabled if the keyword is used.
255 How these messages are mapped to the actual debugging flags is not
256 specified and may change with newer releases of this program. They are
257 however carefully selected to best aid in debugging.
259 @item --debug @var{flags}
261 This option is only useful for debugging and the behaviour may change at
262 any time without notice. FLAGS are bit encoded and may be given in
263 usual C-Syntax. The currently defined bits are:
267 X.509 or OpenPGP protocol related data
269 values of big number integers
271 low level crypto operations
277 show memory statistics.
279 write hashed data to files named @code{dbgmd-000*}
281 trace Assuan protocol
283 bypass all certificate validation
288 Same as @code{--debug=0xffffffff}
290 @item --debug-wait @var{n}
292 When running in server mode, wait @var{n} seconds before entering the
293 actual processing loop and print the pid. This gives time to attach a
296 @item --debug-quick-random
297 @opindex debug-quick-random
298 This option inhibits the use the very secure random quality level
299 (Libgcrypt’s @code{GCRY_VERY_STRONG_RANDOM}) and degrades all request
300 down to standard random quality. It is only used for testing and
301 shall not be used for any production quality keys. This option is
302 only effective when given on the command line.
306 Don't detach the process from the console. This is mainly useful for
315 Format the info output in daemon mode for use with the standard Bourne
316 shell or the C-shell respectively. The default is to guess it based on
317 the environment variable @code{SHELL} which is correct in almost all
321 @item --write-env-file @var{file}
322 @opindex write-env-file
323 Often it is required to connect to the agent from a process not being an
324 inferior of @command{gpg-agent} and thus the environment variable with
325 the socket name is not available. To help setting up those variables in
326 other sessions, this option may be used to write the information into
327 @var{file}. If @var{file} is not specified the default name
328 @file{$@{HOME@}/.gpg-agent-info} will be used. The format is suitable
329 to be evaluated by a Bourne shell like in this simple example:
332 eval $(cat @var{file})
333 eval $(cut -d= -f 1 < @var{file} | xargs echo export)
340 Tell the pinentry not to grab the keyboard and mouse. This option
341 should in general not be used to avoid X-sniffing attacks.
343 @anchor{option --log-file}
344 @item --log-file @var{file}
346 Append all logging output to @var{file}. This is very helpful in seeing
347 what the agent actually does. If neither a log file nor a log file
348 descriptor has been set on a Windows platform, the Registry entry
349 @code{HKCU\Software\GNU\GnuPG:DefaultLogFile}, if set, is used to specify
353 @anchor{option --no-allow-mark-trusted}
354 @item --no-allow-mark-trusted
355 @opindex no-allow-mark-trusted
356 Do not allow clients to mark keys as trusted, i.e. put them into the
357 @file{trustlist.txt} file. This makes it harder for users to inadvertently
360 @anchor{option --allow-preset-passphrase}
361 @item --allow-preset-passphrase
362 @opindex allow-preset-passphrase
363 This option allows the use of @command{gpg-preset-passphrase} to seed the
364 internal cache of @command{gpg-agent} with passphrases.
367 @anchor{option --allow-loopback-pinentry}
368 @item --allow-loopback-pinentry
369 @opindex allow-loopback-pinentry
370 Allow clients to use the loopback pinentry features; see the option
371 @option{pinentry-mode} for details.
374 @item --ignore-cache-for-signing
375 @opindex ignore-cache-for-signing
376 This option will let @command{gpg-agent} bypass the passphrase cache for all
377 signing operation. Note that there is also a per-session option to
378 control this behaviour but this command line option takes precedence.
380 @item --default-cache-ttl @var{n}
381 @opindex default-cache-ttl
382 Set the time a cache entry is valid to @var{n} seconds. The default is
385 @item --default-cache-ttl-ssh @var{n}
386 @opindex default-cache-ttl
387 Set the time a cache entry used for SSH keys is valid to @var{n}
388 seconds. The default is 1800 seconds.
390 @item --max-cache-ttl @var{n}
391 @opindex max-cache-ttl
392 Set the maximum time a cache entry is valid to @var{n} seconds. After
393 this time a cache entry will be expired even if it has been accessed
394 recently or has been set using @command{gpg-preset-passphrase}. The
395 default is 2 hours (7200 seconds).
397 @item --max-cache-ttl-ssh @var{n}
398 @opindex max-cache-ttl-ssh
399 Set the maximum time a cache entry used for SSH keys is valid to
400 @var{n} seconds. After this time a cache entry will be expired even
401 if it has been accessed recently or has been set using
402 @command{gpg-preset-passphrase}. The default is 2 hours (7200
405 @item --enforce-passphrase-constraints
406 @opindex enforce-passphrase-constraints
407 Enforce the passphrase constraints by not allowing the user to bypass
408 them using the ``Take it anyway'' button.
410 @item --min-passphrase-len @var{n}
411 @opindex min-passphrase-len
412 Set the minimal length of a passphrase. When entering a new passphrase
413 shorter than this value a warning will be displayed. Defaults to 8.
415 @item --min-passphrase-nonalpha @var{n}
416 @opindex min-passphrase-nonalpha
417 Set the minimal number of digits or special characters required in a
418 passphrase. When entering a new passphrase with less than this number
419 of digits or special characters a warning will be displayed. Defaults
422 @item --check-passphrase-pattern @var{file}
423 @opindex check-passphrase-pattern
424 Check the passphrase against the pattern given in @var{file}. When
425 entering a new passphrase matching one of these pattern a warning will
426 be displayed. @var{file} should be an absolute filename. The default is
427 not to use any pattern file.
429 Security note: It is known that checking a passphrase against a list of
430 pattern or even against a complete dictionary is not very effective to
431 enforce good passphrases. Users will soon figure up ways to bypass such
432 a policy. A better policy is to educate users on good security
433 behavior and optionally to run a passphrase cracker regularly on all
434 users passphrases to catch the very simple ones.
436 @item --max-passphrase-days @var{n}
437 @opindex max-passphrase-days
438 Ask the user to change the passphrase if @var{n} days have passed since
439 the last change. With @option{--enforce-passphrase-constraints} set the
440 user may not bypass this check.
442 @item --enable-passphrase-history
443 @opindex enable-passphrase-history
444 This option does nothing yet.
446 @item --pinentry-program @var{filename}
447 @opindex pinentry-program
448 Use program @var{filename} as the PIN entry. The default is installation
451 @item --pinentry-touch-file @var{filename}
452 @opindex pinentry-touch-file
453 By default the filename of the socket gpg-agent is listening for
454 requests is passed to Pinentry, so that it can touch that file before
455 exiting (it does this only in curses mode). This option changes the
456 file passed to Pinentry to @var{filename}. The special name
457 @code{/dev/null} may be used to completely disable this feature. Note
458 that Pinentry will not create that file, it will only change the
459 modification and access time.
462 @item --scdaemon-program @var{filename}
463 @opindex scdaemon-program
464 Use program @var{filename} as the Smartcard daemon. The default is
465 installation dependent and can be shown with the @command{gpgconf}
468 @item --disable-scdaemon
469 @opindex disable-scdaemon
470 Do not make use of the scdaemon tool. This option has the effect of
471 disabling the ability to do smartcard operations. Note, that enabling
472 this option at runtime does not kill an already forked scdaemon.
475 @item --disable-check-own-socket
476 @opindex disable-check-own-socket
477 @command{gpg-agent} employs a periodic self-test to detect a stolen
478 socket. This usually means a second instance of @command{gpg-agent}
479 has taken over the socket and @command{gpg-agent} will then terminate
480 itself. This option may be used to disable this self-test for
484 @item --use-standard-socket
485 @itemx --no-use-standard-socket
486 @opindex use-standard-socket
487 @opindex no-use-standard-socket
489 Since GnuPG 2.1 the standard socket is always used. These options
493 By enabling this option @command{gpg-agent} will listen on the socket
494 named @file{S.gpg-agent}, located in the home directory, and not create
495 a random socket below a temporary directory. Tools connecting to
496 @command{gpg-agent} should first try to connect to the socket given in
497 environment variable @var{GPG_AGENT_INFO} and then fall back to this
498 socket. This option may not be used if the home directory is mounted on
499 a remote file system which does not support special files like fifos or
502 Note, that @option{--use-standard-socket} is the default on
505 The default may be changed at build time. It is
506 possible to test at runtime whether the agent has been configured for
507 use with the standard socket by issuing the command @command{gpg-agent
508 --use-standard-socket-p} which returns success if the standard socket
509 option has been enabled.
512 @item --display @var{string}
513 @itemx --ttyname @var{string}
514 @itemx --ttytype @var{string}
515 @itemx --lc-ctype @var{string}
516 @itemx --lc-messages @var{string}
517 @itemx --xauthority @var{string}
524 These options are used with the server mode to pass localization
528 @itemx --keep-display
530 @opindex keep-display
531 Ignore requests to change the current @code{tty} or X window system's
532 @code{DISPLAY} variable respectively. This is useful to lock the
533 pinentry to pop up at the @code{tty} or display you started the agent.
536 @anchor{option --extra-socket}
537 @item --extra-socket @var{name}
538 @opindex extra-socket
539 Also listen on native gpg-agent connections on the given socket. The
540 intended use for this extra socket is to setup a Unix domain socket
541 forwarding from a remote machine to this socket on the local machine.
542 A @command{gpg} running on the remote machine may then connect to the
543 local gpg-agent and use its private keys. This allows to decrypt or
544 sign data on a remote machine without exposing the private keys to the
548 @anchor{option --enable-ssh-support}
549 @item --enable-ssh-support
550 @opindex enable-ssh-support
552 Enable the OpenSSH Agent protocol.
554 In this mode of operation, the agent does not only implement the
555 gpg-agent protocol, but also the agent protocol used by OpenSSH
556 (through a separate socket). Consequently, it should be possible to use
557 the gpg-agent as a drop-in replacement for the well known ssh-agent.
559 SSH Keys, which are to be used through the agent, need to be added to
560 the gpg-agent initially through the ssh-add utility. When a key is
561 added, ssh-add will ask for the password of the provided key file and
562 send the unprotected key material to the agent; this causes the
563 gpg-agent to ask for a passphrase, which is to be used for encrypting
564 the newly received key and storing it in a gpg-agent specific
567 Once a key has been added to the gpg-agent this way, the gpg-agent
568 will be ready to use the key.
570 Note: in case the gpg-agent receives a signature request, the user might
571 need to be prompted for a passphrase, which is necessary for decrypting
572 the stored key. Since the ssh-agent protocol does not contain a
573 mechanism for telling the agent on which display/terminal it is running,
574 gpg-agent's ssh-support will use the TTY or X display where gpg-agent
575 has been started. To switch this display to the current one, the
576 following command may be used:
579 gpg-connect-agent updatestartuptty /bye
582 Although all GnuPG components try to start the gpg-agent as needed, this
583 is not possible for the ssh support because ssh does not know about it.
584 Thus if no GnuPG tool which accesses the agent has been run, there is no
585 guarantee that ssh is abale to use gpg-agent for authentication. To fix
586 this you may start gpg-agent if needed using this simple command:
589 gpg-connect-agent /bye
592 Adding the @option{--verbose} shows the progress of starting the agent.
596 All the long options may also be given in the configuration file after
597 stripping off the two leading dashes.
601 @node Agent Configuration
602 @section Configuration
604 There are a few configuration files needed for the operation of the
605 agent. By default they may all be found in the current home directory
606 (@pxref{option --homedir}).
611 @cindex gpg-agent.conf
612 This is the standard configuration file read by @command{gpg-agent} on
613 startup. It may contain any valid long option; the leading
614 two dashes may not be entered and the option may not be abbreviated.
615 This file is also read after a @code{SIGHUP} however only a few
616 options will actually have an effect. This default name may be
617 changed on the command line (@pxref{option --options}).
618 You should backup this file.
621 This is the list of trusted keys. You should backup this file.
623 Comment lines, indicated by a leading hash mark, as well as empty
624 lines are ignored. To mark a key as trusted you need to enter its
625 fingerprint followed by a space and a capital letter @code{S}. Colons
626 may optionally be used to separate the bytes of a fingerprint; this
627 allows to cut and paste the fingerprint from a key listing output. If
628 the line is prefixed with a @code{!} the key is explicitly marked as
631 Here is an example where two keys are marked as ultimately trusted
632 and one as not trusted:
636 # CN=Wurzel ZS 3,O=Intevation GmbH,C=DE
637 A6935DD34EF3087973C706FC311AA2CCF733765B S
639 # CN=PCA-1-Verwaltung-02/O=PKI-1-Verwaltung/C=DE
640 DC:BD:69:25:48:BD:BB:7E:31:6E:BB:80:D3:00:80:35:D4:F8:A6:CD S
642 # CN=Root-CA/O=Schlapphuete/L=Pullach/C=DE
643 !14:56:98:D3:FE:9C:CA:5A:31:6E:BC:81:D3:11:4E:00:90:A3:44:C2 S
647 Before entering a key into this file, you need to ensure its
648 authenticity. How to do this depends on your organisation; your
649 administrator might have already entered those keys which are deemed
650 trustworthy enough into this file. Places where to look for the
651 fingerprint of a root certificate are letters received from the CA or
652 the website of the CA (after making 100% sure that this is indeed the
653 website of that CA). You may want to consider disallowing interactive
654 updates of this file by using the @xref{option --no-allow-mark-trusted}.
655 It might even be advisable to change the permissions to read-only so
656 that this file can't be changed inadvertently.
658 As a special feature a line @code{include-default} will include a global
659 list of trusted certificates (e.g. @file{/etc/gnupg/trustlist.txt}).
660 This global list is also used if the local list is not available.
662 It is possible to add further flags after the @code{S} for use by the
669 Relax checking of some root certificate requirements. As of now this
670 flag allows the use of root certificates with a missing basicConstraints
671 attribute (despite that it is a MUST for CA certificates) and disables
672 CRL checking for the root certificate.
675 If validation of a certificate finally issued by a CA with this flag set
676 fails, try again using the chain validation model.
683 This file is used when support for the secure shell agent protocol has
684 been enabled (@pxref{option --enable-ssh-support}). Only keys present in
685 this file are used in the SSH protocol. You should backup this file.
687 The @command{ssh-add} tool may be used to add new entries to this file;
688 you may also add them manually. Comment lines, indicated by a leading
689 hash mark, as well as empty lines are ignored. An entry starts with
690 optional whitespace, followed by the keygrip of the key given as 40 hex
691 digits, optionally followed by the caching TTL in seconds and another
692 optional field for arbitrary flags. A non-zero TTL overrides the global
693 default as set by @option{--default-cache-ttl-ssh}.
695 The only flag support is @code{confirm}. If this flag is found for a
696 key, each use of the key will pop up a pinentry to confirm the use of
697 that key. The flag is automatically set if a new key was loaded into
698 @code{gpg-agent} using the option @option{-c} of the @code{ssh-add}
701 The keygrip may be prefixed with a @code{!} to disable an entry entry.
703 The following example lists exactly one key. Note that keys available
704 through a OpenPGP smartcard in the active smartcard reader are
705 implicitly added to this list; i.e. there is no need to list them.
709 # Key added on: 2011-07-20 20:38:46
710 # Fingerprint: 5e:8d:c4:ad:e7:af:6e:27:8a:d6:13:e4:79:ad:0b:81
711 34B62F25E277CF13D3C6BCEBFD3F85D08F0A864B 0 confirm
715 @item private-keys-v1.d/
717 This is the directory where gpg-agent stores the private keys. Each
718 key is stored in a file with the name made up of the keygrip and the
719 suffix @file{key}. You should backup all files in this directory
720 and take great care to keep this backup closed away.
725 Note that on larger installations, it is useful to put predefined
726 files into the directory @file{/etc/skel/.gnupg/} so that newly created
727 users start up with a working configuration. For existing users the
728 a small helper script is provided to create these files (@pxref{addgnupghome}).
737 @section Use of some signals.
738 A running @command{gpg-agent} may be controlled by signals, i.e. using
739 the @command{kill} command to send a signal to the process.
741 Here is a list of supported signals:
747 This signal flushes all cached passphrases and if the program has been
748 started with a configuration file, the configuration file is read
749 again. Only certain options are honored: @code{quiet},
750 @code{verbose}, @code{debug}, @code{debug-all}, @code{debug-level},
751 @code{no-grab}, @code{pinentry-program}, @code{default-cache-ttl},
752 @code{max-cache-ttl}, @code{ignore-cache-for-signing},
753 @code{no-allow-mark-trusted}, @code{disable-scdaemon}, and
754 @code{disable-check-own-socket}. @code{scdaemon-program} is also
755 supported but due to the current implementation, which calls the
756 scdaemon only once, it is not of much use unless you manually kill the
762 Shuts down the process but waits until all current requests are
763 fulfilled. If the process has received 3 of these signals and requests
764 are still pending, a shutdown is forced.
768 Shuts down the process immediately.
772 Dump internal information to the log file.
776 This signal is used for internal purposes.
788 It is important to set the GPG_TTY environment variable in
789 your login shell, for example in the @file{~/.bashrc} init script:
793 export GPG_TTY=$(tty)
797 If you enabled the Ssh Agent Support, you also need to tell ssh about
798 it by adding this to your init script:
803 if [ "$@{gnupg_SSH_AUTH_SOCK_by:-0@}" -ne $$ ]; then
804 export SSH_AUTH_SOCK="$@{HOME@}/.gnupg/S.gpg-agent.ssh"
811 The usual way to invoke @command{gpg-agent} is
814 $ eval $(gpg-agent --daemon)
817 An alternative way is by replacing @command{ssh-agent} with
818 @command{gpg-agent}. If for example @command{ssh-agent} is started as
819 part of the Xsession initialization, you may simply replace
820 @command{ssh-agent} by a script like:
826 exec /usr/local/bin/gpg-agent --enable-ssh-support --daemon \
827 --write-env-file $@{HOME@}/.gpg-agent-info "$@@"
832 and add something like (for Bourne shells)
836 if [ -f "$@{HOME@}/.gpg-agent-info" ]; then
837 . "$@{HOME@}/.gpg-agent-info"
838 export GPG_AGENT_INFO
845 to your shell initialization file (e.g. @file{~/.bashrc}).
853 @section Agent's Assuan Protocol
855 Note: this section does only document the protocol, which is used by
856 GnuPG components; it does not deal with the ssh-agent protocol.
859 The @command{gpg-agent} daemon is started on demand by the GnuPG
863 The @command{gpg-agent} should be started by the login shell and set an
864 environment variable to tell clients about the socket to be used.
865 Clients should deny to access an agent with a socket name which does
866 not match its own configuration. An application may choose to start
867 an instance of the gpg-agent if it does not figure that any has been
868 started; it should not do this if a gpg-agent is running but not
869 usable. Because @command{gpg-agent} can only be used in background mode, no
870 special command line option is required to activate the use of the
874 To identify a key we use a thing called keygrip which is the SHA-1 hash
875 of an canonical encoded S-Expression of the public key as used in
876 Libgcrypt. For the purpose of this interface the keygrip is given as a
877 hex string. The advantage of using this and not the hash of a
878 certificate is that it will be possible to use the same keypair for
879 different protocols, thereby saving space on the token used to keep the
883 The @command{gpg-agent} may send status messages during a command or when
884 returning from a command to inform a client about the progress or result of an
885 operation. For example, the @var{INQUIRE_MAXLEN} status message may be sent
886 during a server inquire to inform the client of the maximum usable length of
887 the inquired data (which should not be exceeded).
891 * Agent PKDECRYPT:: Decrypting a session key
892 * Agent PKSIGN:: Signing a Hash
893 * Agent GENKEY:: Generating a Key
894 * Agent IMPORT:: Importing a Secret Key
895 * Agent EXPORT:: Exporting a Secret Key
896 * Agent ISTRUSTED:: Importing a Root Certificate
897 * Agent GET_PASSPHRASE:: Ask for a passphrase
898 * Agent CLEAR_PASSPHRASE:: Expire a cached passphrase
900 * Agent PRESET_PASSPHRASE:: Set a passphrase for a keygrip
902 * Agent GET_CONFIRMATION:: Ask for confirmation
903 * Agent HAVEKEY:: Check whether a key is available
904 * Agent LEARN:: Register a smartcard
905 * Agent PASSWD:: Change a Passphrase
906 * Agent UPDATESTARTUPTTY:: Change the Standard Display
907 * Agent GETEVENTCOUNTER:: Get the Event Counters
908 * Agent GETINFO:: Return information about the process
909 * Agent OPTION:: Set options for the session
912 @node Agent PKDECRYPT
913 @subsection Decrypting a session key
915 The client asks the server to decrypt a session key. The encrypted
916 session key should have all information needed to select the
917 appropriate secret key or to delegate it to a smartcard.
923 Tell the server about the key to be used for decryption. If this is
924 not used, @command{gpg-agent} may try to figure out the key by trying to
925 decrypt the message with each key available.
931 The agent checks whether this command is allowed and then does an
932 INQUIRY to get the ciphertext the client should then send the cipher
936 S: INQUIRE CIPHERTEXT
942 Please note that the server may send status info lines while reading the
943 data lines from the client. The data send is a SPKI like S-Exp with
949 (<param_name1> <mpi>)
951 (<param_namen> <mpi>)))
954 Where algo is a string with the name of the algorithm; see the libgcrypt
955 documentation for a list of valid algorithms. The number and names of
956 the parameters depend on the algorithm. The agent does return an error
957 if there is an inconsistency.
959 If the decryption was successful the decrypted data is returned by
962 Here is an example session:
966 S: INQUIRE CIPHERTEXT
967 C: D (enc-val elg (a 349324324)
968 C: D (b 3F444677CA)))
970 S: # session key follows
972 S: D (value 1234567890ABCDEF0)
973 S: OK descryption successful
977 The “PADDING” status line is only send if gpg-agent can tell what kind
978 of padding is used. As of now only the value 0 is used to indicate
979 that the padding has been removed.
983 @subsection Signing a Hash
985 The client ask the agent to sign a given hash value. A default key
986 will be chosen if no key has been set. To set a key a client first
993 This can be used multiple times to create multiple signature, the list
994 of keys is reset with the next PKSIGN command or a RESET. The server
995 test whether the key is a valid key to sign something and responds with
999 SETHASH --hash=<name>|<algo> <hexstring>
1002 The client can use this command to tell the server about the data <hexstring>
1003 (which usually is a hash) to be signed. <algo> is the decimal encoded hash
1004 algorithm number as used by Libgcrypt. Either <algo> or --hash=<name>
1005 must be given. Valid names for <name> are:
1009 The SHA-1 hash algorithm
1011 The SHA-256 hash algorithm
1013 The RIPE-MD160 hash algorithm
1015 The old and broken MD5 hash algorithm
1017 A combined hash algorithm as used by the TLS protocol.
1021 The actual signing is done using
1027 Options are not yet defined, but my later be used to choose among
1028 different algorithms. The agent does then some checks, asks for the
1029 passphrase and as a result the server returns the signature as an SPKI
1030 like S-expression in "D" lines:
1035 (<param_name1> <mpi>)
1037 (<param_namen> <mpi>)))
1041 The operation is affected by the option
1044 OPTION use-cache-for-signing=0|1
1047 The default of @code{1} uses the cache. Setting this option to @code{0}
1048 will lead @command{gpg-agent} to ignore the passphrase cache. Note, that there is
1049 also a global command line option for @command{gpg-agent} to globally disable the
1053 Here is an example session:
1061 S: # I did ask the user whether he really wants to sign
1062 S: # I did ask the user for the passphrase
1064 C: D ABCDEF012345678901234
1066 S: # signature follows
1067 S: D (sig-val rsa (s 45435453654612121212))
1073 @subsection Generating a Key
1075 This is used to create a new keypair and store the secret key inside the
1076 active PSE --- which is in most cases a Soft-PSE. An not yet defined
1077 option allows to choose the storage location. To get the secret key out
1078 of the PSE, a special export tool has to be used.
1082 GENKEY [--no-protection] [--preset] [<cache_nonce>]
1089 Invokes the key generation process and the server will then inquire
1090 on the generation parameters, like:
1094 C: D (genkey (rsa (nbits 1024)))
1098 The format of the key parameters which depends on the algorithm is of
1104 (parameter_name_1 ....)
1106 (parameter_name_n ....)))
1109 If everything succeeds, the server returns the *public key* in a SPKI
1110 like S-Expression like this:
1119 Here is an example session:
1124 C: D (genkey (rsa (nbits 1024)))
1127 S: D (rsa (n 326487324683264) (e 10001)))
1133 The @option{--no-protection} option may be used to prevent prompting for a
1134 passphrase to protect the secret key while leaving the secret key unprotected.
1135 The @option{--preset} option may be used to add the passphrase to the cache
1136 using the default cache parameters.
1140 @subsection Importing a Secret Key
1142 This operation is not yet supported by GpgAgent. Specialized tools
1143 are to be used for this.
1145 There is no actual need because we can expect that secret keys
1146 created by a 3rd party are stored on a smartcard. If we have
1147 generated the key ourself, we do not need to import it.
1150 @subsection Export a Secret Key
1154 Should be done by an extra tool.
1156 @node Agent ISTRUSTED
1157 @subsection Importing a Root Certificate
1159 Actually we do not import a Root Cert but provide a way to validate
1160 any piece of data by storing its Hash along with a description and
1161 an identifier in the PSE. Here is the interface description:
1164 ISTRUSTED <fingerprint>
1167 Check whether the OpenPGP primary key or the X.509 certificate with the
1168 given fingerprint is an ultimately trusted key or a trusted Root CA
1169 certificate. The fingerprint should be given as a hexstring (without
1170 any blanks or colons or whatever in between) and may be left padded with
1171 00 in case of an MD5 fingerprint. GPGAgent will answer with:
1177 The key is in the table of trusted keys.
1180 ERR 304 (Not Trusted)
1183 The key is not in this table.
1185 Gpg needs the entire list of trusted keys to maintain the web of
1186 trust; the following command is therefore quite helpful:
1192 GpgAgent returns a list of trusted keys line by line:
1195 S: D 000000001234454556565656677878AF2F1ECCFF P
1196 S: D 340387563485634856435645634856438576457A P
1197 S: D FEDC6532453745367FD83474357495743757435D S
1201 The first item on a line is the hexified fingerprint where MD5
1202 fingerprints are @code{00} padded to the left and the second item is a
1203 flag to indicate the type of key (so that gpg is able to only take care
1204 of PGP keys). P = OpenPGP, S = S/MIME. A client should ignore the rest
1205 of the line, so that we can extend the format in the future.
1207 Finally a client should be able to mark a key as trusted:
1210 MARKTRUSTED @var{fingerprint} "P"|"S"
1213 The server will then pop up a window to ask the user whether she
1214 really trusts this key. For this it will probably ask for a text to
1215 be displayed like this:
1218 S: INQUIRE TRUSTDESC
1219 C: D Do you trust the key with the fingerprint @@FPR@@
1220 C: D bla fasel blurb.
1225 Known sequences with the pattern @@foo@@ are replaced according to this
1230 Format the fingerprint according to gpg rules for a v3 keys.
1232 Format the fingerprint according to gpg rules for a v4 keys.
1234 Choose an appropriate format to format the fingerprint.
1236 Replaced by a single @code{@@}
1239 @node Agent GET_PASSPHRASE
1240 @subsection Ask for a passphrase
1242 This function is usually used to ask for a passphrase to be used for
1243 conventional encryption, but may also be used by programs which need
1244 special handling of passphrases. This command uses a syntax which helps
1245 clients to use the agent with minimum effort.
1248 GET_PASSPHRASE [--data] [--check] [--no-ask] [--repeat[=N]] \
1249 [--qualitybar] @var{cache_id} \
1250 [@var{error_message} @var{prompt} @var{description}]
1253 @var{cache_id} is expected to be a string used to identify a cached
1254 passphrase. Use a @code{X} to bypass the cache. With no other
1255 arguments the agent returns a cached passphrase or an error. By
1256 convention either the hexified fingerprint of the key shall be used for
1257 @var{cache_id} or an arbitrary string prefixed with the name of the
1258 calling application and a colon: Like @code{gpg:somestring}.
1260 @var{error_message} is either a single @code{X} for no error message or
1261 a string to be shown as an error message like (e.g. "invalid
1262 passphrase"). Blanks must be percent escaped or replaced by @code{+}'.
1264 @var{prompt} is either a single @code{X} for a default prompt or the
1265 text to be shown as the prompt. Blanks must be percent escaped or
1266 replaced by @code{+}.
1268 @var{description} is a text shown above the entry field. Blanks must be
1269 percent escaped or replaced by @code{+}.
1271 The agent either returns with an error or with a OK followed by the hex
1272 encoded passphrase. Note that the length of the strings is implicitly
1273 limited by the maximum length of a command. If the option
1274 @option{--data} is used, the passphrase is not returned on the OK line
1275 but by regular data lines; this is the preferred method.
1277 If the option @option{--check} is used, the standard passphrase
1278 constraints checks are applied. A check is not done if the passphrase
1279 has been found in the cache.
1281 If the option @option{--no-ask} is used and the passphrase is not in the
1282 cache the user will not be asked to enter a passphrase but the error
1283 code @code{GPG_ERR_NO_DATA} is returned.
1285 If the option @option{--qualitybar} is used and a minimum passphrase
1286 length has been configured, a visual indication of the entered
1287 passphrase quality is shown.
1290 CLEAR_PASSPHRASE @var{cache_id}
1293 may be used to invalidate the cache entry for a passphrase. The
1294 function returns with OK even when there is no cached passphrase.
1298 @node Agent CLEAR_PASSPHRASE
1299 @subsection Remove a cached passphrase
1301 Use this command to remove a cached passphrase.
1305 CLEAR_PASSPHRASE [--mode=normal] <cache_id>
1308 CLEAR_PASSPHRASE <cache_id>
1313 The @option{--mode=normal} option can be used to clear a @var{cache_id} that
1314 was set by gpg-agent.
1320 @node Agent PRESET_PASSPHRASE
1321 @subsection Set a passphrase for a keygrip
1323 This command adds a passphrase to the cache for the specified @var{keygrip}.
1326 PRESET_PASSPHRASE [--inquire] <string_or_keygrip> <timeout> [<hexstring>]
1329 The passphrase is a hexidecimal string when specified. When not specified, the
1330 passphrase will be retrieved from the pinentry module unless the
1331 @option{--inquire} option was specified in which case the passphrase will be
1332 retrieved from the client.
1334 The @var{timeout} parameter keeps the passphrase cached for the specified
1335 number of seconds. A value of @code{-1} means infinate while @code{0} means
1336 the default (currently only a timeout of -1 is allowed, which means to never
1343 @node Agent GET_CONFIRMATION
1344 @subsection Ask for confirmation
1346 This command may be used to ask for a simple confirmation by
1347 presenting a text and 2 buttons: Okay and Cancel.
1350 GET_CONFIRMATION @var{description}
1353 @var{description}is displayed along with a Okay and Cancel
1354 button. Blanks must be percent escaped or replaced by @code{+}. A
1355 @code{X} may be used to display confirmation dialog with a default
1358 The agent either returns with an error or with a OK. Note, that the
1359 length of @var{description} is implicitly limited by the maximum
1360 length of a command.
1365 @subsection Check whether a key is available
1367 This can be used to see whether a secret key is available. It does
1368 not return any information on whether the key is somehow protected.
1371 HAVEKEY @var{keygrips}
1374 The agent answers either with OK or @code{No_Secret_Key} (208). The
1375 caller may want to check for other error codes as well. More than one
1376 keygrip may be given. In this case the command returns success if at
1377 least one of the keygrips corresponds to an available secret key.
1381 @subsection Register a smartcard
1387 This command is used to register a smartcard. With the --send
1388 option given the certificates are send back.
1392 @subsection Change a Passphrase
1396 PASSWD [--cache-nonce=<c>] [--passwd-nonce=<s>] [--preset] @var{keygrip}
1399 PASSWD @var{keygrip}
1403 This command is used to interactively change the passphrase of the key
1404 identified by the hex string @var{keygrip}.
1407 The @option{--preset} option may be used to add the new passphrase to the
1408 cache using the default cache parameters.
1412 @node Agent UPDATESTARTUPTTY
1413 @subsection Change the standard display
1419 Set the startup TTY and X-DISPLAY variables to the values of this
1420 session. This command is useful to direct future pinentry invocations
1421 to another screen. It is only required because there is no way in the
1422 ssh-agent protocol to convey this information.
1425 @node Agent GETEVENTCOUNTER
1426 @subsection Get the Event Counters
1432 This function return one status line with the current values of the
1433 event counters. The event counters are useful to avoid polling by
1434 delaying a poll until something has changed. The values are decimal
1435 numbers in the range @code{0} to @code{UINT_MAX} and wrapping around to
1436 0. The actual values should not be relied upon; they shall only be used
1439 The currently defined counters are are:
1442 Incremented with any change of any of the other counters.
1444 Incremented for added or removed private keys.
1446 Incremented for changes of the card readers stati.
1450 @subsection Return information about the process
1452 This is a multipurpose function to return a variety of information.
1458 The value of @var{what} specifies the kind of information returned:
1461 Return the version of the program.
1463 Return the process id of the process.
1465 Return the name of the socket used to connect the agent.
1466 @item ssh_socket_name
1467 Return the name of the socket used for SSH connections. If SSH support
1468 has not been enabled the error @code{GPG_ERR_NO_DATA} will be returned.
1472 @subsection Set options for the session
1474 Here is a list of session options which are not yet described with
1475 other commands. The general syntax for an Assuan option is:
1478 OPTION @var{key}=@var{value}
1482 Supported @var{key}s are:
1485 @item agent-awareness
1486 This may be used to tell gpg-agent of which gpg-agent version the
1487 client is aware of. gpg-agent uses this information to enable
1488 features which might break older clients.
1491 Change the session's environment to be used for the
1492 Pinentry. Valid values are:
1496 Delete envvar @var{name}
1498 Set envvar @var{name} to the empty string
1499 @item @var{name}=@var{value}
1500 Set envvar @var{name} to the string @var{value}.
1503 @item use-cache-for-signing
1504 See Assuan command @code{PKSIGN}.
1506 @item allow-pinentry-notify
1507 This does not need any value. It is used to enable the
1508 PINENTRY_LAUNCHED inquiry.
1512 This option is used to change the operation mode of the pinentry. The
1513 following values are defined:
1517 This is the default mode which pops up a pinentry as needed.
1520 Instead of popping up a pinentry, return the error code
1521 @code{GPG_ERR_CANCELED}.
1524 Instead of popping up a pinentry, return the error code
1525 @code{GPG_ERR_NO_PIN_ENTRY}.
1528 Use a loopback pinentry. This fakes a pinentry by using inquiries
1529 back to the caller to ask for a passphrase. This option may only be
1530 set if the agent has been configured for that.
1531 Use the @xref{option --allow-loopback-pinentry}.
1537 @item cache-ttl-opt-preset
1538 This option sets the cache TTL for new entries created by GENKEY and
1539 PASSWD commands when using the @option{--preset} option. It it is not
1540 used a default value is used.
1545 Instead of using the standard S2K count (which is computed on the
1546 fly), the given S2K count is used for new keys or when changing the
1547 passphrase of a key. Values below 65536 are considered to be 0. This
1548 option is valid for the entire session or until reset to 0. This
1549 option is useful if the key is later used on boxes which are either
1550 much slower or faster than the actual box.
1560 @command{gpg-connect-agent}(1),
1561 @command{scdaemon}(1)
1563 @include see-also-note.texi