Remove support for the GPG_AGENT_INFO envvar.
[gnupg.git] / doc / gpg-agent.texi
1 @c Copyright (C) 2002 Free Software Foundation, Inc.
2 @c This is part of the GnuPG manual.
3 @c For copying conditions, see the file gnupg.texi.
4
5 @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.
8
9
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
15
16 @manpage gpg-agent.1
17 @ifset manverb
18 .B gpg-agent
19 \- Secret key management for GnuPG
20 @end ifset
21
22 @mansect synopsis
23 @ifset manverb
24 .B  gpg-agent
25 .RB [ \-\-homedir
26 .IR dir ]
27 .RB [ \-\-options
28 .IR file ]
29 .RI [ options ]
30 .br
31 .B  gpg-agent
32 .RB [ \-\-homedir
33 .IR dir ]
34 .RB [ \-\-options
35 .IR file ]
36 .RI [ options ]
37 .B  \-\-server
38 .br
39 .B  gpg-agent
40 .RB [ \-\-homedir
41 .IR dir ]
42 .RB [ \-\-options
43 .IR file ]
44 .RI [ options ]
45 .B  \-\-daemon
46 .RI [ command_line ]
47 @end ifset
48
49 @mansect description
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
53 utilities.
54
55 @ifset gpgtwoone
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:
60
61 @example
62 gpg-connect-agent /bye
63 @end example
64 @end ifset
65
66 @ifclear gpgtwoone
67 @noindent
68 The usual way to run the agent is from the @code{~/.xsession} file:
69
70 @example
71 eval $(gpg-agent --daemon)
72 @end example
73 @noindent
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:
81
82 @smallexample
83 gpg-agent --daemon --enable-ssh-support \
84           --write-env-file "$@{HOME@}/.gpg-agent-info"
85 @end smallexample
86
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.
93
94 @noindent
95 The second script needs to be run for each interactive session:
96
97 @smallexample
98 if [ -f "$@{HOME@}/.gpg-agent-info" ]; then
99   . "$@{HOME@}/.gpg-agent-info"
100   export GPG_AGENT_INFO
101   export SSH_AUTH_SOCK
102 fi
103 @end smallexample
104
105 @noindent
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.
108 @end ifclear
109
110 @noindent
111 You should always add the following lines to your @code{.bashrc} or
112 whatever initialization file is used for all shell invocations:
113
114 @smallexample
115 GPG_TTY=$(tty)
116 export GPG_TTY
117 @end smallexample
118
119 @noindent
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
122 required.
123
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}).
130
131 @manpause
132 @noindent
133 @xref{Option Index},for an index to @command{GPG-AGENT}'s commands and options.
134 @mancont
135
136 @menu
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.
143 @end menu
144
145 @mansect commands
146 @node Agent Commands
147 @section Commands
148
149 Commands are not distinguished from options except for the fact that
150 only one command is allowed.
151
152 @table @gnupgtabopt
153 @item --version
154 @opindex version
155 Print the program version and licensing information.  Note that you cannot
156 abbreviate this command.
157
158 @item --help
159 @itemx -h
160 @opindex help
161 Print a usage message summarizing the most useful command-line options.
162 Note that you cannot abbreviate this command.
163
164 @item --dump-options
165 @opindex dump-options
166 Print a list of all available options and commands.  Note that you cannot
167 abbreviate this command.
168
169 @item --server
170 @opindex server
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.
173
174 @item --daemon [@var{command line}]
175 @opindex daemon
176 Start the gpg-agent as a daemon; that is, detach it from the console
177 and run it in the background.
178 @ifclear gpgtwoone
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.
184 @end ifclear
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.
189 @end table
190
191 @mansect options
192 @node Agent Options
193 @section Option Summary
194
195 @table @gnupgtabopt
196
197 @anchor{option --options}
198 @item --options @var{file}
199 @opindex options
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.
204
205 @anchor{option --homedir}
206 @include opt-homedir.texi
207
208
209 @item -v
210 @item --verbose
211 @opindex verbose
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}.
215
216 @item -q
217 @item --quiet
218 @opindex quiet
219 Try to be as quiet as possible.
220
221 @item --batch
222 @opindex batch
223 Don't invoke a pinentry or do any other thing requiring human interaction.
224
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
229 1970.
230
231 @item --debug-level @var{level}
232 @opindex debug-level
233 Select the debug level for investigating problems. @var{level} may be
234 a numeric value or a keyword:
235
236 @table @code
237 @item none
238 No debugging at all.  A value of less than 1 may be used instead of
239 the keyword.
240 @item basic
241 Some basic debug messages.  A value between 1 and 2 may be used
242 instead of the keyword.
243 @item advanced
244 More verbose debug messages.  A value between 3 and 5 may be used
245 instead of the keyword.
246 @item expert
247 Even more detailed messages.  A value between 6 and 8 may be used
248 instead of the keyword.
249 @item guru
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.
253 @end table
254
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.
258
259 @item --debug @var{flags}
260 @opindex debug
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:
264
265 @table @code
266 @item 0  (1)
267 X.509 or OpenPGP protocol related data
268 @item 1  (2)
269 values of big number integers
270 @item 2  (4)
271 low level crypto operations
272 @item 5  (32)
273 memory allocation
274 @item 6  (64)
275 caching
276 @item 7  (128)
277 show memory statistics.
278 @item 9  (512)
279 write hashed data to files named @code{dbgmd-000*}
280 @item 10 (1024)
281 trace Assuan protocol
282 @item 12 (4096)
283 bypass all certificate validation
284 @end table
285
286 @item --debug-all
287 @opindex debug-all
288 Same as @code{--debug=0xffffffff}
289
290 @item --debug-wait @var{n}
291 @opindex debug-wait
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
294 debugger.
295
296 @item --no-detach
297 @opindex no-detach
298 Don't detach the process from the console.  This is mainly useful for
299 debugging.
300
301 @item -s
302 @itemx --sh
303 @itemx -c
304 @itemx --csh
305 @opindex sh
306 @opindex csh
307 Format the info output in daemon mode for use with the standard Bourne
308 shell or the C-shell respectively.  The default is to guess it based on
309 the environment variable @code{SHELL} which is correct in almost all
310 cases.
311
312 @ifclear gpgtwoone
313 @item --write-env-file @var{file}
314 @opindex write-env-file
315 Often it is required to connect to the agent from a process not being an
316 inferior of @command{gpg-agent} and thus the environment variable with
317 the socket name is not available.  To help setting up those variables in
318 other sessions, this option may be used to write the information into
319 @var{file}.  If @var{file} is not specified the default name
320 @file{$@{HOME@}/.gpg-agent-info} will be used.  The format is suitable
321 to be evaluated by a Bourne shell like in this simple example:
322
323 @example
324 eval $(cat @var{file})
325 eval $(cut -d= -f 1 < @var{file} | xargs echo export)
326 @end example
327 @end ifclear
328
329
330 @item --no-grab
331 @opindex no-grab
332 Tell the pinentry not to grab the keyboard and mouse.  This option
333 should in general not be used to avoid X-sniffing attacks.
334
335 @anchor{option --log-file}
336 @item --log-file @var{file}
337 @opindex log-file
338 Append all logging output to @var{file}.  This is very helpful in seeing
339 what the agent actually does.  If neither a log file nor a log file
340 descriptor has been set on a Windows platform, the Registry entry
341 @code{HKCU\Software\GNU\GnuPG:DefaultLogFile}, if set, is used to specify
342 the logging output.
343
344
345 @anchor{option --allow-mark-trusted}
346 @item --allow-mark-trusted
347 @opindex allow-mark-trusted
348 Allow clients to mark keys as trusted, i.e. put them into the
349 @file{trustlist.txt} file.  This is by default not allowed to make it
350 harder for users to inadvertently accept Root-CA keys.
351
352 @ifset gpgtwoone
353 @anchor{option --allow-loopback-pinentry}
354 @item --allow-loopback-pinentry
355 @opindex allow-loopback-pinentry
356 Allow clients to use the loopback pinentry features; see the option
357 @option{pinentry-mode} for details.
358 @end ifset
359
360 @item --ignore-cache-for-signing
361 @opindex ignore-cache-for-signing
362 This option will let @command{gpg-agent} bypass the passphrase cache for all
363 signing operation.  Note that there is also a per-session option to
364 control this behaviour but this command line option takes precedence.
365
366 @item --default-cache-ttl @var{n}
367 @opindex default-cache-ttl
368 Set the time a cache entry is valid to @var{n} seconds.  The default is
369 600 seconds.
370
371 @item --default-cache-ttl-ssh @var{n}
372 @opindex default-cache-ttl
373 Set the time a cache entry used for SSH keys is valid to @var{n}
374 seconds.  The default is 1800 seconds.
375
376 @item --max-cache-ttl @var{n}
377 @opindex max-cache-ttl
378 Set the maximum time a cache entry is valid to @var{n} seconds.  After
379 this time a cache entry will be expired even if it has been accessed
380 recently or has been set using @command{gpg-preset-passphrase}.  The
381 default is 2 hours (7200 seconds).
382
383 @item --max-cache-ttl-ssh @var{n}
384 @opindex max-cache-ttl-ssh
385 Set the maximum time a cache entry used for SSH keys is valid to
386 @var{n} seconds.  After this time a cache entry will be expired even
387 if it has been accessed recently or has been set using
388 @command{gpg-preset-passphrase}.  The default is 2 hours (7200
389 seconds).
390
391 @item --enforce-passphrase-constraints
392 @opindex enforce-passphrase-constraints
393 Enforce the passphrase constraints by not allowing the user to bypass
394 them using the ``Take it anyway'' button.
395
396 @item --min-passphrase-len @var{n}
397 @opindex min-passphrase-len
398 Set the minimal length of a passphrase.  When entering a new passphrase
399 shorter than this value a warning will be displayed.  Defaults to 8.
400
401 @item --min-passphrase-nonalpha @var{n}
402 @opindex min-passphrase-nonalpha
403 Set the minimal number of digits or special characters required in a
404 passphrase.  When entering a new passphrase with less than this number
405 of digits or special characters a warning will be displayed.  Defaults
406 to 1.
407
408 @item --check-passphrase-pattern @var{file}
409 @opindex check-passphrase-pattern
410 Check the passphrase against the pattern given in @var{file}.  When
411 entering a new passphrase matching one of these pattern a warning will
412 be displayed. @var{file} should be an absolute filename.  The default is
413 not to use any pattern file.
414
415 Security note: It is known that checking a passphrase against a list of
416 pattern or even against a complete dictionary is not very effective to
417 enforce good passphrases.  Users will soon figure up ways to bypass such
418 a policy.  A better policy is to educate users on good security
419 behavior and optionally to run a passphrase cracker regularly on all
420 users passphrases to catch the very simple ones.
421
422 @item --max-passphrase-days @var{n}
423 @opindex max-passphrase-days
424 Ask the user to change the passphrase if @var{n} days have passed since
425 the last change.  With @option{--enforce-passphrase-constraints} set the
426 user may not bypass this check.
427
428 @item --enable-passphrase-history
429 @opindex enable-passphrase-history
430 This option does nothing yet.
431
432 @item --pinentry-program @var{filename}
433 @opindex pinentry-program
434 Use program @var{filename} as the PIN entry.  The default is installation
435 dependent.
436
437 @item --pinentry-touch-file @var{filename}
438 @opindex pinentry-touch-file
439 By default the filename of the socket gpg-agent is listening for
440 requests is passed to Pinentry, so that it can touch that file before
441 exiting (it does this only in curses mode).  This option changes the
442 file passed to Pinentry to @var{filename}.  The special name
443 @code{/dev/null} may be used to completely disable this feature.  Note
444 that Pinentry will not create that file, it will only change the
445 modification and access time.
446
447
448 @item --scdaemon-program @var{filename}
449 @opindex scdaemon-program
450 Use program @var{filename} as the Smartcard daemon.  The default is
451 installation dependent and can be shown with the @command{gpgconf}
452 command.
453
454 @item --disable-scdaemon
455 @opindex disable-scdaemon
456 Do not make use of the scdaemon tool.  This option has the effect of
457 disabling the ability to do smartcard operations.  Note, that enabling
458 this option at runtime does not kill an already forked scdaemon.
459
460 @ifset gpgtwoone
461 @item --disable-check-own-socket
462 @opindex disable-check-own-socket
463 @command{gpg-agent} employs a periodic self-test to detect a stolen
464 socket.  This usually means a second instance of @command{gpg-agent}
465 has taken over the socket and @command{gpg-agent} will then terminate
466 itself.  This option may be used to disable this self-test for
467 debugging purposes.
468 @end ifset
469
470 @item --use-standard-socket
471 @itemx --no-use-standard-socket
472 @opindex use-standard-socket
473 @opindex no-use-standard-socket
474 @ifset gpgtwoone
475 Since GnuPG 2.1 the standard socket is always used.  These options
476 have no more effect.
477 @end ifset
478 @ifclear gpgtwoone
479 By enabling this option @command{gpg-agent} will listen on the socket
480 named @file{S.gpg-agent}, located in the home directory, and not create
481 a random socket below a temporary directory.  Tools connecting to
482 @command{gpg-agent} should first try to connect to the socket given in
483 environment variable @var{GPG_AGENT_INFO} and then fall back to this
484 socket.  This option may not be used if the home directory is mounted on
485 a remote file system which does not support special files like fifos or
486 sockets.
487
488 Note, that @option{--use-standard-socket} is the default on
489 Windows systems.
490
491 The default may be changed at build time.  It is
492 possible to test at runtime whether the agent has been configured for
493 use with the standard socket by issuing the command @command{gpg-agent
494 --use-standard-socket-p} which returns success if the standard socket
495 option has been enabled.
496 @end ifclear
497
498 @item --display @var{string}
499 @itemx --ttyname @var{string}
500 @itemx --ttytype @var{string}
501 @itemx --lc-ctype @var{string}
502 @itemx --lc-messages @var{string}
503 @itemx --xauthority @var{string}
504 @opindex display
505 @opindex ttyname
506 @opindex ttytype
507 @opindex lc-ctype
508 @opindex lc-messages
509 @opindex xauthority
510 These options are used with the server mode to pass localization
511 information.
512
513 @item --keep-tty
514 @itemx --keep-display
515 @opindex keep-tty
516 @opindex keep-display
517 Ignore requests to change the current @code{tty} or X window system's
518 @code{DISPLAY} variable respectively.  This is useful to lock the
519 pinentry to pop up at the @code{tty} or display you started the agent.
520
521 @anchor{option --enable-ssh-support}
522 @item --enable-ssh-support
523 @opindex enable-ssh-support
524
525 Enable the OpenSSH Agent protocol.
526
527 In this mode of operation, the agent does not only implement the
528 gpg-agent protocol, but also the agent protocol used by OpenSSH
529 (through a separate socket).  Consequently, it should be possible to use
530 the gpg-agent as a drop-in replacement for the well known ssh-agent.
531
532 SSH Keys, which are to be used through the agent, need to be added to
533 the gpg-agent initially through the ssh-add utility.  When a key is
534 added, ssh-add will ask for the password of the provided key file and
535 send the unprotected key material to the agent; this causes the
536 gpg-agent to ask for a passphrase, which is to be used for encrypting
537 the newly received key and storing it in a gpg-agent specific
538 directory.
539
540 Once a key has been added to the gpg-agent this way, the gpg-agent
541 will be ready to use the key.
542
543 Note: in case the gpg-agent receives a signature request, the user might
544 need to be prompted for a passphrase, which is necessary for decrypting
545 the stored key.  Since the ssh-agent protocol does not contain a
546 mechanism for telling the agent on which display/terminal it is running,
547 gpg-agent's ssh-support will use the TTY or X display where gpg-agent
548 has been started.  To switch this display to the current one, the
549 following command may be used:
550
551 @smallexample
552 gpg-connect-agent updatestartuptty /bye
553 @end smallexample
554
555 Although all GnuPG components try to start the gpg-agent as needed, this
556 is not possible for the ssh support because ssh does not know about it.
557 Thus if no GnuPG tool which accesses the agent has been run, there is no
558 guarantee that ssh is abale to use gpg-agent for authentication.  To fix
559 this you may start gpg-agent if needed using this simple command:
560
561 @smallexample
562 gpg-connect-agent /bye
563 @end smallexample
564
565 Adding the @option{--verbose} shows the progress of starting the agent.
566
567 @end table
568
569 All the long options may also be given in the configuration file after
570 stripping off the two leading dashes.
571
572
573 @mansect files
574 @node Agent Configuration
575 @section Configuration
576
577 There are a few configuration files needed for the operation of the
578 agent. By default they may all be found in the current home directory
579 (@pxref{option --homedir}).
580
581 @table @file
582
583 @item gpg-agent.conf
584 @cindex gpg-agent.conf
585   This is the standard configuration file read by @command{gpg-agent} on
586   startup.  It may contain any valid long option; the leading
587   two dashes may not be entered and the option may not be abbreviated.
588   This file is also read after a @code{SIGHUP} however only a few
589   options will actually have an effect.  This default name may be
590   changed on the command line (@pxref{option --options}).
591   You should backup this file.
592
593 @item trustlist.txt
594   This is the list of trusted keys.  You should backup this file.
595
596   Comment lines, indicated by a leading hash mark, as well as empty
597   lines are ignored.  To mark a key as trusted you need to enter its
598   fingerprint followed by a space and a capital letter @code{S}.  Colons
599   may optionally be used to separate the bytes of a fingerprint; this
600   allows to cut and paste the fingerprint from a key listing output.  If
601   the line is prefixed with a @code{!} the key is explicitly marked as
602   not trusted.
603
604   Here is an example where two keys are marked as ultimately trusted
605   and one as not trusted:
606
607   @cartouche
608   @smallexample
609   # CN=Wurzel ZS 3,O=Intevation GmbH,C=DE
610   A6935DD34EF3087973C706FC311AA2CCF733765B S
611
612   # CN=PCA-1-Verwaltung-02/O=PKI-1-Verwaltung/C=DE
613   DC:BD:69:25:48:BD:BB:7E:31:6E:BB:80:D3:00:80:35:D4:F8:A6:CD S
614
615   # CN=Root-CA/O=Schlapphuete/L=Pullach/C=DE
616   !14:56:98:D3:FE:9C:CA:5A:31:6E:BC:81:D3:11:4E:00:90:A3:44:C2 S
617   @end smallexample
618   @end cartouche
619
620 Before entering a key into this file, you need to ensure its
621 authenticity.  How to do this depends on your organisation; your
622 administrator might have already entered those keys which are deemed
623 trustworthy enough into this file.  Places where to look for the
624 fingerprint of a root certificate are letters received from the CA or
625 the website of the CA (after making 100% sure that this is indeed the
626 website of that CA).  You may want to consider allowing interactive
627 updates of this file by using the @xref{option --allow-mark-trusted}.
628 This is however not as secure as maintaining this file manually.  It is
629 even advisable to change the permissions to read-only so that this file
630 can't be changed inadvertently.
631
632 As a special feature a line @code{include-default} will include a global
633 list of trusted certificates (e.g. @file{/etc/gnupg/trustlist.txt}).
634 This global list is also used if the local list is not available.
635
636 It is possible to add further flags after the @code{S} for use by the
637 caller:
638
639 @table @code
640
641 @item relax
642 @cindex relax
643 Relax checking of some root certificate requirements.  As of now this
644 flag allows the use of root certificates with a missing basicConstraints
645 attribute (despite that it is a MUST for CA certificates) and disables
646 CRL checking for the root certificate.
647
648 @item cm
649 If validation of a certificate finally issued by a CA with this flag set
650 fails, try again using the chain validation model.
651
652 @end table
653
654
655 @item sshcontrol
656 @cindex sshcontrol
657 This file is used when support for the secure shell agent protocol has
658 been enabled (@pxref{option --enable-ssh-support}). Only keys present in
659 this file are used in the SSH protocol.  You should backup this file.
660
661 The @command{ssh-add} tool may be used to add new entries to this file;
662 you may also add them manually.  Comment lines, indicated by a leading
663 hash mark, as well as empty lines are ignored.  An entry starts with
664 optional whitespace, followed by the keygrip of the key given as 40 hex
665 digits, optionally followed by the caching TTL in seconds and another
666 optional field for arbitrary flags.  A non-zero TTL overrides the global
667 default as set by @option{--default-cache-ttl-ssh}.
668
669 The only flag support is @code{confirm}.  If this flag is found for a
670 key, each use of the key will pop up a pinentry to confirm the use of
671 that key.  The flag is automatically set if a new key was loaded into
672 @code{gpg-agent} using the option @option{-c} of the @code{ssh-add}
673 command.
674
675 The keygrip may be prefixed with a @code{!} to disable an entry entry.
676
677 The following example lists exactly one key.  Note that keys available
678 through a OpenPGP smartcard in the active smartcard reader are
679 implicitly added to this list; i.e. there is no need to list them.
680
681   @cartouche
682   @smallexample
683   # Key added on: 2011-07-20 20:38:46
684   # Fingerprint:  5e:8d:c4:ad:e7:af:6e:27:8a:d6:13:e4:79:ad:0b:81
685   34B62F25E277CF13D3C6BCEBFD3F85D08F0A864B 0 confirm
686   @end smallexample
687   @end cartouche
688
689 @item private-keys-v1.d/
690
691   This is the directory where gpg-agent stores the private keys.  Each
692   key is stored in a file with the name made up of the keygrip and the
693   suffix @file{key}.  You should backup all files in this directory
694   and take great care to keep this backup closed away.
695
696
697 @end table
698
699 Note that on larger installations, it is useful to put predefined
700 files into the directory @file{/etc/skel/.gnupg/} so that newly created
701 users start up with a working configuration.  For existing users the
702 a small helper script is provided to create these files (@pxref{addgnupghome}).
703
704
705
706 @c
707 @c Agent Signals
708 @c
709 @mansect signals
710 @node Agent Signals
711 @section Use of some signals.
712 A running @command{gpg-agent} may be controlled by signals, i.e. using
713 the @command{kill} command to send a signal to the process.
714
715 Here is a list of supported signals:
716
717 @table @gnupgtabopt
718
719 @item SIGHUP
720 @cpindex SIGHUP
721 This signal flushes all cached passphrases and if the program has been
722 started with a configuration file, the configuration file is read
723 again.  Only certain options are honored: @code{quiet},
724 @code{verbose}, @code{debug}, @code{debug-all}, @code{debug-level},
725 @code{no-grab}, @code{pinentry-program}, @code{default-cache-ttl},
726 @code{max-cache-ttl}, @code{ignore-cache-for-signing},
727 @code{allow-mark-trusted}, @code{disable-scdaemon}, and
728 @code{disable-check-own-socket}.  @code{scdaemon-program} is also
729 supported but due to the current implementation, which calls the
730 scdaemon only once, it is not of much use unless you manually kill the
731 scdaemon.
732
733
734 @item SIGTERM
735 @cpindex SIGTERM
736 Shuts down the process but waits until all current requests are
737 fulfilled.  If the process has received 3 of these signals and requests
738 are still pending, a shutdown is forced.
739
740 @item SIGINT
741 @cpindex SIGINT
742 Shuts down the process immediately.
743
744 @item SIGUSR1
745 @cpindex SIGUSR1
746 Dump internal information to the log file.
747
748 @item SIGUSR2
749 @cpindex SIGUSR2
750 This signal is used for internal purposes.
751
752 @end table
753
754 @c
755 @c  Examples
756 @c
757 @mansect examples
758 @node Agent Examples
759 @section Examples
760
761 @ifset gpgtwoone
762 It is important to set the GPG_TTY environment variable in
763 your login shell, for example in the @file{~/.bashrc} init script:
764
765 @cartouche
766 @example
767   export GPG_TTY=$(tty)
768 @end example
769 @end cartouche
770
771 If you enabled the Ssh Agent Support, you also need to tell ssh about
772 it by adding this to your init script:
773
774 @cartouche
775 @example
776 unset SSH_AGENT_PID
777 if [ "$@{gnupg_SSH_AUTH_SOCK_by:-0@}" -ne $$ ]; then
778   export SSH_AUTH_SOCK="$@{HOME@}/.gnupg/S.gpg-agent.ssh"
779 fi
780 @end example
781 @end cartouche
782 @end ifset
783
784 @ifclear gpgtwoone
785 The usual way to invoke @command{gpg-agent} is
786
787 @example
788 $ eval $(gpg-agent --daemon)
789 @end example
790
791 An alternative way is by replacing @command{ssh-agent} with
792 @command{gpg-agent}.  If for example @command{ssh-agent} is started as
793 part of the Xsession initialization, you may simply replace
794 @command{ssh-agent} by a script like:
795
796 @cartouche
797 @example
798 #!/bin/sh
799
800 exec /usr/local/bin/gpg-agent --enable-ssh-support --daemon \
801       --write-env-file $@{HOME@}/.gpg-agent-info "$@@"
802 @end example
803 @end cartouche
804
805 @noindent
806 and add something like (for Bourne shells)
807
808 @cartouche
809 @example
810   if [ -f "$@{HOME@}/.gpg-agent-info" ]; then
811     . "$@{HOME@}/.gpg-agent-info"
812     export GPG_AGENT_INFO
813     export SSH_AUTH_SOCK
814   fi
815 @end example
816 @end cartouche
817
818 @noindent
819 to your shell initialization file (e.g. @file{~/.bashrc}).
820 @end ifclear
821
822 @c
823 @c  Assuan Protocol
824 @c
825 @manpause
826 @node Agent Protocol
827 @section Agent's Assuan Protocol
828
829 Note: this section does only document the protocol, which is used by
830 GnuPG components; it does not deal with the ssh-agent protocol.
831
832 @ifset gpgtwoone
833 The @command{gpg-agent} daemon is started on demand by the GnuPG
834 components.
835 @end ifset
836 @ifclear gpgtwoone
837 The @command{gpg-agent} should be started by the login shell and set an
838 environment variable to tell clients about the socket to be used.
839 Clients should deny to access an agent with a socket name which does
840 not match its own configuration.  An application may choose to start
841 an instance of the gpg-agent if it does not figure that any has been
842 started; it should not do this if a gpg-agent is running but not
843 usable.  Because @command{gpg-agent} can only be used in background mode, no
844 special command line option is required to activate the use of the
845 protocol.
846 @end ifclear
847
848 To identify a key we use a thing called keygrip which is the SHA-1 hash
849 of an canonical encoded S-Expression of the public key as used in
850 Libgcrypt.  For the purpose of this interface the keygrip is given as a
851 hex string.  The advantage of using this and not the hash of a
852 certificate is that it will be possible to use the same keypair for
853 different protocols, thereby saving space on the token used to keep the
854 secret keys.
855
856 @ifset gpgtwoone
857 The @command{gpg-agent} may send status messages during a command or when
858 returning from a command to inform a client about the progress or result of an
859 operation.  For example, the @var{INQUIRE_MAXLEN} status message may be sent
860 during a server inquire to inform the client of the maximum usable length of
861 the inquired data (which should not be exceeded).
862 @end ifset
863
864 @menu
865 * Agent PKDECRYPT::       Decrypting a session key
866 * Agent PKSIGN::          Signing a Hash
867 * Agent GENKEY::          Generating a Key
868 * Agent IMPORT::          Importing a Secret Key
869 * Agent EXPORT::          Exporting a Secret Key
870 * Agent ISTRUSTED::       Importing a Root Certificate
871 * Agent GET_PASSPHRASE::  Ask for a passphrase
872 * Agent CLEAR_PASSPHRASE:: Expire a cached passphrase
873 @ifset gpgtwoone
874 * Agent PRESET_PASSPHRASE:: Set a passphrase for a keygrip
875 @end ifset
876 * Agent GET_CONFIRMATION:: Ask for confirmation
877 * Agent HAVEKEY::         Check whether a key is available
878 * Agent LEARN::           Register a smartcard
879 * Agent PASSWD::          Change a Passphrase
880 * Agent UPDATESTARTUPTTY:: Change the Standard Display
881 * Agent GETEVENTCOUNTER:: Get the Event Counters
882 * Agent GETINFO::         Return information about the process
883 * Agent OPTION::          Set options for the session
884 @end menu
885
886 @node Agent PKDECRYPT
887 @subsection Decrypting a session key
888
889 The client asks the server to decrypt a session key.  The encrypted
890 session key should have all information needed to select the
891 appropriate secret key or to delegate it to a smartcard.
892
893 @example
894   SETKEY <keyGrip>
895 @end example
896
897 Tell the server about the key to be used for decryption.  If this is
898 not used, @command{gpg-agent} may try to figure out the key by trying to
899 decrypt the message with each key available.
900
901 @example
902   PKDECRYPT
903 @end example
904
905 The agent checks whether this command is allowed and then does an
906 INQUIRY to get the ciphertext the client should then send the cipher
907 text.
908
909 @example
910     S: INQUIRE CIPHERTEXT
911     C: D (xxxxxx
912     C: D xxxx)
913     C: END
914 @end example
915
916 Please note that the server may send status info lines while reading the
917 data lines from the client.  The data send is a SPKI like S-Exp with
918 this structure:
919
920 @example
921      (enc-val
922        (<algo>
923          (<param_name1> <mpi>)
924            ...
925          (<param_namen> <mpi>)))
926 @end example
927
928 Where algo is a string with the name of the algorithm; see the libgcrypt
929 documentation for a list of valid algorithms.  The number and names of
930 the parameters depend on the algorithm.  The agent does return an error
931 if there is an inconsistency.
932
933 If the decryption was successful the decrypted data is returned by
934 means of "D" lines.
935
936 Here is an example session:
937 @cartouche
938 @smallexample
939    C: PKDECRYPT
940    S: INQUIRE CIPHERTEXT
941    C: D (enc-val elg (a 349324324)
942    C: D    (b 3F444677CA)))
943    C: END
944    S: # session key follows
945    S: S PADDING 0
946    S: D (value 1234567890ABCDEF0)
947    S: OK descryption successful
948 @end smallexample
949 @end cartouche
950
951 The “PADDING” status line is only send if gpg-agent can tell what kind
952 of padding is used.  As of now only the value 0 is used to indicate
953 that the padding has been removed.
954
955
956 @node Agent PKSIGN
957 @subsection Signing a Hash
958
959 The client ask the agent to sign a given hash value.  A default key
960 will be chosen if no key has been set.  To set a key a client first
961 uses:
962
963 @example
964    SIGKEY <keyGrip>
965 @end example
966
967 This can be used multiple times to create multiple signature, the list
968 of keys is reset with the next PKSIGN command or a RESET.  The server
969 test whether the key is a valid key to sign something and responds with
970 okay.
971
972 @example
973    SETHASH --hash=<name>|<algo> <hexstring>
974 @end example
975
976 The client can use this command to tell the server about the data <hexstring>
977 (which usually is a hash) to be signed. <algo> is the decimal encoded hash
978 algorithm number as used by Libgcrypt.  Either <algo> or --hash=<name>
979 must be given.  Valid names for <name> are:
980
981 @table @code
982 @item sha1
983 The SHA-1 hash algorithm
984 @item sha256
985 The SHA-256 hash algorithm
986 @item rmd160
987 The RIPE-MD160 hash algorithm
988 @item md5
989 The old and broken MD5 hash algorithm
990 @item tls-md5sha1
991 A combined hash algorithm as used by the TLS protocol.
992 @end table
993
994 @noindent
995 The actual signing is done using
996
997 @example
998    PKSIGN <options>
999 @end example
1000
1001 Options are not yet defined, but my later be used to choose among
1002 different algorithms.  The agent does then some checks, asks for the
1003 passphrase and as a result the server returns the signature as an SPKI
1004 like S-expression in "D" lines:
1005
1006 @example
1007      (sig-val
1008        (<algo>
1009          (<param_name1> <mpi>)
1010            ...
1011          (<param_namen> <mpi>)))
1012 @end example
1013
1014
1015 The operation is affected by the option
1016
1017 @example
1018    OPTION use-cache-for-signing=0|1
1019 @end example
1020
1021 The default of @code{1} uses the cache.  Setting this option to @code{0}
1022 will lead @command{gpg-agent} to ignore the passphrase cache.  Note, that there is
1023 also a global command line option for @command{gpg-agent} to globally disable the
1024 caching.
1025
1026
1027 Here is an example session:
1028 @cartouche
1029 @smallexample
1030    C: SIGKEY <keyGrip>
1031    S: OK key available
1032    C: SIGKEY <keyGrip>
1033    S: OK key available
1034    C: PKSIGN
1035    S: # I did ask the user whether he really wants to sign
1036    S: # I did ask the user for the passphrase
1037    S: INQUIRE HASHVAL
1038    C: D ABCDEF012345678901234
1039    C: END
1040    S: # signature follows
1041    S: D (sig-val rsa (s 45435453654612121212))
1042    S: OK
1043 @end smallexample
1044 @end cartouche
1045
1046 @node Agent GENKEY
1047 @subsection Generating a Key
1048
1049 This is used to create a new keypair and store the secret key inside the
1050 active PSE --- which is in most cases a Soft-PSE.  An not yet defined
1051 option allows to choose the storage location.  To get the secret key out
1052 of the PSE, a special export tool has to be used.
1053
1054 @example
1055 @ifset gpgtwoone
1056    GENKEY [--no-protection] [--preset] [<cache_nonce>]
1057 @end ifset
1058 @ifclear gpgtwoone
1059    GENKEY
1060 @end ifclear
1061 @end example
1062
1063 Invokes the key generation process and the server will then inquire
1064 on the generation parameters, like:
1065
1066 @example
1067    S: INQUIRE KEYPARM
1068    C: D (genkey (rsa (nbits  1024)))
1069    C: END
1070 @end example
1071
1072 The format of the key parameters which depends on the algorithm is of
1073 the form:
1074
1075 @example
1076     (genkey
1077       (algo
1078         (parameter_name_1 ....)
1079           ....
1080         (parameter_name_n ....)))
1081 @end example
1082
1083 If everything succeeds, the server returns the *public key* in a SPKI
1084 like S-Expression like this:
1085
1086 @example
1087      (public-key
1088        (rsa
1089          (n <mpi>)
1090          (e <mpi>)))
1091 @end example
1092
1093 Here is an example session:
1094 @cartouche
1095 @smallexample
1096    C: GENKEY
1097    S: INQUIRE KEYPARM
1098    C: D (genkey (rsa (nbits  1024)))
1099    C: END
1100    S: D (public-key
1101    S: D   (rsa (n 326487324683264) (e 10001)))
1102    S  OK key created
1103 @end smallexample
1104 @end cartouche
1105
1106 @ifset gpgtwoone
1107 The @option{--no-protection} option may be used to prevent prompting for a
1108 passphrase to protect the secret key while leaving the secret key unprotected.
1109 The @option{--preset} option may be used to add the passphrase to the cache
1110 using the default cache parameters.
1111 @end ifset
1112
1113 @node Agent IMPORT
1114 @subsection Importing a Secret Key
1115
1116 This operation is not yet supported by GpgAgent.  Specialized tools
1117 are to be used for this.
1118
1119 There is no actual need because we can expect that secret keys
1120 created by a 3rd party are stored on a smartcard.  If we have
1121 generated the key ourself, we do not need to import it.
1122
1123 @node Agent EXPORT
1124 @subsection Export a Secret Key
1125
1126 Not implemented.
1127
1128 Should be done by an extra tool.
1129
1130 @node Agent ISTRUSTED
1131 @subsection Importing a Root Certificate
1132
1133 Actually we do not import a Root Cert but provide a way to validate
1134 any piece of data by storing its Hash along with a description and
1135 an identifier in the PSE.  Here is the interface description:
1136
1137 @example
1138     ISTRUSTED <fingerprint>
1139 @end example
1140
1141 Check whether the OpenPGP primary key or the X.509 certificate with the
1142 given fingerprint is an ultimately trusted key or a trusted Root CA
1143 certificate.  The fingerprint should be given as a hexstring (without
1144 any blanks or colons or whatever in between) and may be left padded with
1145 00 in case of an MD5 fingerprint.  GPGAgent will answer with:
1146
1147 @example
1148     OK
1149 @end example
1150
1151 The key is in the table of trusted keys.
1152
1153 @example
1154     ERR 304 (Not Trusted)
1155 @end example
1156
1157 The key is not in this table.
1158
1159 Gpg needs the entire list of trusted keys to maintain the web of
1160 trust; the following command is therefore quite helpful:
1161
1162 @example
1163     LISTTRUSTED
1164 @end example
1165
1166 GpgAgent returns a list of trusted keys line by line:
1167
1168 @example
1169     S: D 000000001234454556565656677878AF2F1ECCFF P
1170     S: D 340387563485634856435645634856438576457A P
1171     S: D FEDC6532453745367FD83474357495743757435D S
1172     S: OK
1173 @end example
1174
1175 The first item on a line is the hexified fingerprint where MD5
1176 fingerprints are @code{00} padded to the left and the second item is a
1177 flag to indicate the type of key (so that gpg is able to only take care
1178 of PGP keys).  P = OpenPGP, S = S/MIME.  A client should ignore the rest
1179 of the line, so that we can extend the format in the future.
1180
1181 Finally a client should be able to mark a key as trusted:
1182
1183 @example
1184    MARKTRUSTED @var{fingerprint} "P"|"S"
1185 @end example
1186
1187 The server will then pop up a window to ask the user whether she
1188 really trusts this key. For this it will probably ask for a text to
1189 be displayed like this:
1190
1191 @example
1192    S: INQUIRE TRUSTDESC
1193    C: D Do you trust the key with the fingerprint @@FPR@@
1194    C: D bla fasel blurb.
1195    C: END
1196    S: OK
1197 @end example
1198
1199 Known sequences with the pattern @@foo@@ are replaced according to this
1200 table:
1201
1202 @table @code
1203 @item @@FPR16@@
1204 Format the fingerprint according to gpg rules for a v3 keys.
1205 @item @@FPR20@@
1206 Format the fingerprint according to gpg rules for a v4 keys.
1207 @item @@FPR@@
1208 Choose an appropriate format to format the fingerprint.
1209 @item @@@@
1210 Replaced by a single @code{@@}
1211 @end table
1212
1213 @node Agent GET_PASSPHRASE
1214 @subsection Ask for a passphrase
1215
1216 This function is usually used to ask for a passphrase to be used for
1217 conventional encryption, but may also be used by programs which need
1218 special handling of passphrases.  This command uses a syntax which helps
1219 clients to use the agent with minimum effort.
1220
1221 @example
1222   GET_PASSPHRASE [--data] [--check] [--no-ask] [--repeat[=N]] \
1223                  [--qualitybar] @var{cache_id}                \
1224                  [@var{error_message} @var{prompt} @var{description}]
1225 @end example
1226
1227 @var{cache_id} is expected to be a string used to identify a cached
1228 passphrase.  Use a @code{X} to bypass the cache.  With no other
1229 arguments the agent returns a cached passphrase or an error.  By
1230 convention either the hexified fingerprint of the key shall be used for
1231 @var{cache_id} or an arbitrary string prefixed with the name of the
1232 calling application and a colon: Like @code{gpg:somestring}.
1233
1234 @var{error_message} is either a single @code{X} for no error message or
1235 a string to be shown as an error message like (e.g. "invalid
1236 passphrase").  Blanks must be percent escaped or replaced by @code{+}'.
1237
1238 @var{prompt} is either a single @code{X} for a default prompt or the
1239 text to be shown as the prompt.  Blanks must be percent escaped or
1240 replaced by @code{+}.
1241
1242 @var{description} is a text shown above the entry field.  Blanks must be
1243 percent escaped or replaced by @code{+}.
1244
1245 The agent either returns with an error or with a OK followed by the hex
1246 encoded passphrase.  Note that the length of the strings is implicitly
1247 limited by the maximum length of a command.  If the option
1248 @option{--data} is used, the passphrase is not returned on the OK line
1249 but by regular data lines; this is the preferred method.
1250
1251 If the option @option{--check} is used, the standard passphrase
1252 constraints checks are applied.  A check is not done if the passphrase
1253 has been found in the cache.
1254
1255 If the option @option{--no-ask} is used and the passphrase is not in the
1256 cache the user will not be asked to enter a passphrase but the error
1257 code @code{GPG_ERR_NO_DATA} is returned.
1258
1259 If the option @option{--qualitybar} is used and a minimum passphrase
1260 length has been configured, a visual indication of the entered
1261 passphrase quality is shown.
1262
1263 @example
1264   CLEAR_PASSPHRASE @var{cache_id}
1265 @end example
1266
1267 may be used to invalidate the cache entry for a passphrase.  The
1268 function returns with OK even when there is no cached passphrase.
1269
1270
1271
1272 @node Agent CLEAR_PASSPHRASE
1273 @subsection Remove a cached passphrase
1274
1275 Use this command to remove a cached passphrase.
1276
1277 @example
1278 @ifset gpgtwoone
1279   CLEAR_PASSPHRASE [--mode=normal] <cache_id>
1280 @end ifset
1281 @ifclear gpgtwoone
1282   CLEAR_PASSPHRASE <cache_id>
1283 @end ifclear
1284 @end example
1285
1286 @ifset gpgtwoone
1287 The @option{--mode=normal} option can be used to clear a @var{cache_id} that
1288 was set by gpg-agent.
1289 @end ifset
1290
1291
1292
1293 @ifset gpgtwoone
1294 @node Agent PRESET_PASSPHRASE
1295 @subsection Set a passphrase for a keygrip
1296
1297 This command adds a passphrase to the cache for the specified @var{keygrip}.
1298
1299 @example
1300   PRESET_PASSPHRASE [--inquire] <string_or_keygrip> <timeout> [<hexstring>]
1301 @end example
1302
1303 The passphrase is a hexidecimal string when specified. When not specified, the
1304 passphrase will be retrieved from the pinentry module unless the
1305 @option{--inquire} option was specified in which case the passphrase will be
1306 retrieved from the client.
1307
1308 The @var{timeout} parameter keeps the passphrase cached for the specified
1309 number of seconds. A value of @code{-1} means infinate while @code{0} means
1310 the default (currently only a timeout of -1 is allowed, which means to never
1311 expire it).
1312 @end ifset
1313
1314
1315
1316
1317 @node Agent GET_CONFIRMATION
1318 @subsection Ask for confirmation
1319
1320 This command may be used to ask for a simple confirmation by
1321 presenting a text and 2 buttons: Okay and Cancel.
1322
1323 @example
1324   GET_CONFIRMATION @var{description}
1325 @end example
1326
1327 @var{description}is displayed along with a Okay and Cancel
1328 button. Blanks must be percent escaped or replaced by @code{+}.  A
1329 @code{X} may be used to display confirmation dialog with a default
1330 text.
1331
1332 The agent either returns with an error or with a OK.  Note, that the
1333 length of @var{description} is implicitly limited by the maximum
1334 length of a command.
1335
1336
1337
1338 @node Agent HAVEKEY
1339 @subsection Check whether a key is available
1340
1341 This can be used to see whether a secret key is available.  It does
1342 not return any information on whether the key is somehow protected.
1343
1344 @example
1345   HAVEKEY @var{keygrips}
1346 @end example
1347
1348 The agent answers either with OK or @code{No_Secret_Key} (208).  The
1349 caller may want to check for other error codes as well.  More than one
1350 keygrip may be given.  In this case the command returns success if at
1351 least one of the keygrips corresponds to an available secret key.
1352
1353
1354 @node Agent LEARN
1355 @subsection Register a smartcard
1356
1357 @example
1358   LEARN [--send]
1359 @end example
1360
1361 This command is used to register a smartcard.  With the --send
1362 option given the certificates are send back.
1363
1364
1365 @node Agent PASSWD
1366 @subsection Change a Passphrase
1367
1368 @example
1369 @ifset gpgtwoone
1370   PASSWD [--cache-nonce=<c>] [--passwd-nonce=<s>] [--preset] @var{keygrip}
1371 @end ifset
1372 @ifclear gpgtwoone
1373   PASSWD @var{keygrip}
1374 @end ifclear
1375 @end example
1376
1377 This command is used to interactively change the passphrase of the key
1378 identified by the hex string @var{keygrip}.
1379
1380 @ifset gpgtwoone
1381 The @option{--preset} option may be used to add the new passphrase to the
1382 cache using the default cache parameters.
1383 @end ifset
1384
1385
1386 @node Agent UPDATESTARTUPTTY
1387 @subsection Change the standard display
1388
1389 @example
1390   UPDATESTARTUPTTY
1391 @end example
1392
1393 Set the startup TTY and X-DISPLAY variables to the values of this
1394 session.  This command is useful to direct future pinentry invocations
1395 to another screen.  It is only required because there is no way in the
1396 ssh-agent protocol to convey this information.
1397
1398
1399 @node Agent GETEVENTCOUNTER
1400 @subsection Get the Event Counters
1401
1402 @example
1403   GETEVENTCOUNTER
1404 @end example
1405
1406 This function return one status line with the current values of the
1407 event counters.  The event counters are useful to avoid polling by
1408 delaying a poll until something has changed.  The values are decimal
1409 numbers in the range @code{0} to @code{UINT_MAX} and wrapping around to
1410 0.  The actual values should not be relied upon; they shall only be used
1411 to detect a change.
1412
1413 The currently defined counters are are:
1414 @table @code
1415 @item ANY
1416 Incremented with any change of any of the other counters.
1417 @item KEY
1418 Incremented for added or removed private keys.
1419 @item CARD
1420 Incremented for changes of the card readers stati.
1421 @end table
1422
1423 @node Agent GETINFO
1424 @subsection  Return information about the process
1425
1426 This is a multipurpose function to return a variety of information.
1427
1428 @example
1429 GETINFO @var{what}
1430 @end example
1431
1432 The value of @var{what} specifies the kind of information returned:
1433 @table @code
1434 @item version
1435 Return the version of the program.
1436 @item pid
1437 Return the process id of the process.
1438 @item socket_name
1439 Return the name of the socket used to connect the agent.
1440 @item ssh_socket_name
1441 Return the name of the socket used for SSH connections.  If SSH support
1442 has not been enabled the error @code{GPG_ERR_NO_DATA} will be returned.
1443 @end table
1444
1445 @node Agent OPTION
1446 @subsection Set options for the session
1447
1448 Here is a list of session options which are not yet described with
1449 other commands.  The general syntax for an Assuan option is:
1450
1451 @smallexample
1452 OPTION  @var{key}=@var{value}
1453 @end smallexample
1454
1455 @noindent
1456 Supported @var{key}s are:
1457
1458 @table @code
1459 @item agent-awareness
1460 This may be used to tell gpg-agent of which gpg-agent version the
1461 client is aware of.  gpg-agent uses this information to enable
1462 features which might break older clients.
1463
1464 @item putenv
1465 Change the session's environment to be used for the
1466 Pinentry.  Valid values are:
1467
1468   @table @code
1469   @item @var{name}
1470   Delete envvar @var{name}
1471   @item @var{name}=
1472   Set envvar @var{name} to the empty string
1473   @item @var{name}=@var{value}
1474   Set envvar @var{name} to the string @var{value}.
1475   @end table
1476
1477 @item use-cache-for-signing
1478 See Assuan command @code{PKSIGN}.
1479
1480 @item allow-pinentry-notify
1481 This does not need any value.  It is used to enable the
1482 PINENTRY_LAUNCHED inquiry.
1483
1484 @ifset gpgtwoone
1485 @item pinentry-mode
1486 This option is used to change the operation mode of the pinentry.  The
1487 following values are defined:
1488
1489   @table @code
1490   @item ask
1491   This is the default mode which pops up a pinentry as needed.
1492
1493   @item cancel
1494   Instead of popping up a pinentry, return the error code
1495   @code{GPG_ERR_CANCELED}.
1496
1497   @item error
1498   Instead of popping up a pinentry, return the error code
1499   @code{GPG_ERR_NO_PIN_ENTRY}.
1500
1501   @item loopback
1502   Use a loopback pinentry.  This fakes a pinentry by using inquiries
1503   back to the caller to ask for a passphrase.  This option may only be
1504   set if the agent has been configured for that.
1505   Use the @xref{option --allow-loopback-pinentry}.
1506
1507   @end table
1508 @end ifset
1509
1510 @ifset gpgtwoone
1511 @item cache-ttl-opt-preset
1512 This option sets the cache TTL for new entries created by GENKEY and
1513 PASSWD commands when using the @option{--preset} option.  It it is not
1514 used a default value is used.
1515 @end ifset
1516
1517 @ifset gpgtwoone
1518 @item s2k-count
1519 Instead of using the standard S2K count (which is computed on the
1520 fly), the given S2K count is used for new keys or when changing the
1521 passphrase of a key.  Values below 65536 are considered to be 0.  This
1522 option is valid for the entire session or until reset to 0.  This
1523 option is useful if the key is later used on boxes which are either
1524 much slower or faster than the actual box.
1525 @end ifset
1526
1527 @end table
1528
1529
1530 @mansect see also
1531 @ifset isman
1532 @command{gpg2}(1),
1533 @command{gpgsm}(1),
1534 @command{gpg-connect-agent}(1),
1535 @command{scdaemon}(1)
1536 @end ifset
1537 @include see-also-note.texi