agent: Implement socket redirection.
[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 --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.
303
304 @item --no-detach
305 @opindex no-detach
306 Don't detach the process from the console.  This is mainly useful for
307 debugging.
308
309 @item -s
310 @itemx --sh
311 @itemx -c
312 @itemx --csh
313 @opindex sh
314 @opindex csh
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
318 cases.
319
320 @ifclear gpgtwoone
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:
330
331 @example
332 eval $(cat @var{file})
333 eval $(cut -d= -f 1 < @var{file} | xargs echo export)
334 @end example
335 @end ifclear
336
337
338 @item --no-grab
339 @opindex no-grab
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.
342
343 @anchor{option --log-file}
344 @item --log-file @var{file}
345 @opindex log-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
350 the logging output.
351
352
353 @anchor{option --allow-mark-trusted}
354 @item --allow-mark-trusted
355 @opindex allow-mark-trusted
356 Allow clients to mark keys as trusted, i.e. put them into the
357 @file{trustlist.txt} file.  This is by default not allowed to make it
358 harder for users to inadvertently accept Root-CA keys.
359
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.
365
366 @ifset gpgtwoone
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.
372 @end ifset
373
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.
379
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
383 600 seconds.
384
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.
389
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).
396
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
403 seconds).
404
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.
409
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.
414
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
420 to 1.
421
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.
428
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.
435
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.
441
442 @item --enable-passphrase-history
443 @opindex enable-passphrase-history
444 This option does nothing yet.
445
446 @item --pinentry-program @var{filename}
447 @opindex pinentry-program
448 Use program @var{filename} as the PIN entry.  The default is installation
449 dependent.
450
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.
460
461
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}
466 command.
467
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.
473
474 @ifset gpgtwoone
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
481 debugging purposes.
482 @end ifset
483
484 @item --use-standard-socket
485 @itemx --no-use-standard-socket
486 @opindex use-standard-socket
487 @opindex no-use-standard-socket
488 @ifset gpgtwoone
489 Since GnuPG 2.1 the standard socket is always used.  These options
490 have no more effect.
491 @end ifset
492 @ifclear gpgtwoone
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
500 sockets.
501
502 Note, that @option{--use-standard-socket} is the default on
503 Windows systems.
504
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.
510 @end ifclear
511
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}
518 @opindex display
519 @opindex ttyname
520 @opindex ttytype
521 @opindex lc-ctype
522 @opindex lc-messages
523 @opindex xauthority
524 These options are used with the server mode to pass localization
525 information.
526
527 @item --keep-tty
528 @itemx --keep-display
529 @opindex keep-tty
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.
534
535
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
545 remote machine.
546
547
548 @anchor{option --enable-ssh-support}
549 @item --enable-ssh-support
550 @opindex enable-ssh-support
551
552 Enable the OpenSSH Agent protocol.
553
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.
558
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
565 directory.
566
567 Once a key has been added to the gpg-agent this way, the gpg-agent
568 will be ready to use the key.
569
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:
577
578 @smallexample
579 gpg-connect-agent updatestartuptty /bye
580 @end smallexample
581
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:
587
588 @smallexample
589 gpg-connect-agent /bye
590 @end smallexample
591
592 Adding the @option{--verbose} shows the progress of starting the agent.
593
594 @end table
595
596 All the long options may also be given in the configuration file after
597 stripping off the two leading dashes.
598
599
600 @mansect files
601 @node Agent Configuration
602 @section Configuration
603
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}).
607
608 @table @file
609
610 @item gpg-agent.conf
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.
619
620 @item trustlist.txt
621   This is the list of trusted keys.  You should backup this file.
622
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
629   not trusted.
630
631   Here is an example where two keys are marked as ultimately trusted
632   and one as not trusted:
633
634   @cartouche
635   @smallexample
636   # CN=Wurzel ZS 3,O=Intevation GmbH,C=DE
637   A6935DD34EF3087973C706FC311AA2CCF733765B S
638
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
641
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
644   @end smallexample
645   @end cartouche
646
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 allowing interactive
654 updates of this file by using the @xref{option --allow-mark-trusted}.
655 This is however not as secure as maintaining this file manually.  It is
656 even advisable to change the permissions to read-only so that this file
657 can't be changed inadvertently.
658
659 As a special feature a line @code{include-default} will include a global
660 list of trusted certificates (e.g. @file{/etc/gnupg/trustlist.txt}).
661 This global list is also used if the local list is not available.
662
663 It is possible to add further flags after the @code{S} for use by the
664 caller:
665
666 @table @code
667
668 @item relax
669 @cindex relax
670 Relax checking of some root certificate requirements.  As of now this
671 flag allows the use of root certificates with a missing basicConstraints
672 attribute (despite that it is a MUST for CA certificates) and disables
673 CRL checking for the root certificate.
674
675 @item cm
676 If validation of a certificate finally issued by a CA with this flag set
677 fails, try again using the chain validation model.
678
679 @end table
680
681
682 @item sshcontrol
683 @cindex sshcontrol
684 This file is used when support for the secure shell agent protocol has
685 been enabled (@pxref{option --enable-ssh-support}). Only keys present in
686 this file are used in the SSH protocol.  You should backup this file.
687
688 The @command{ssh-add} tool may be used to add new entries to this file;
689 you may also add them manually.  Comment lines, indicated by a leading
690 hash mark, as well as empty lines are ignored.  An entry starts with
691 optional whitespace, followed by the keygrip of the key given as 40 hex
692 digits, optionally followed by the caching TTL in seconds and another
693 optional field for arbitrary flags.  A non-zero TTL overrides the global
694 default as set by @option{--default-cache-ttl-ssh}.
695
696 The only flag support is @code{confirm}.  If this flag is found for a
697 key, each use of the key will pop up a pinentry to confirm the use of
698 that key.  The flag is automatically set if a new key was loaded into
699 @code{gpg-agent} using the option @option{-c} of the @code{ssh-add}
700 command.
701
702 The keygrip may be prefixed with a @code{!} to disable an entry entry.
703
704 The following example lists exactly one key.  Note that keys available
705 through a OpenPGP smartcard in the active smartcard reader are
706 implicitly added to this list; i.e. there is no need to list them.
707
708 @cartouche
709 @smallexample
710        # Key added on: 2011-07-20 20:38:46
711        # Fingerprint:  5e:8d:c4:ad:e7:af:6e:27:8a:d6:13:e4:79:ad:0b:81
712        34B62F25E277CF13D3C6BCEBFD3F85D08F0A864B 0 confirm
713 @end smallexample
714 @end cartouche
715
716 @item private-keys-v1.d/
717
718   This is the directory where gpg-agent stores the private keys.  Each
719   key is stored in a file with the name made up of the keygrip and the
720   suffix @file{key}.  You should backup all files in this directory
721   and take great care to keep this backup closed away.
722
723
724 @end table
725
726 Note that on larger installations, it is useful to put predefined
727 files into the directory @file{/etc/skel/.gnupg/} so that newly created
728 users start up with a working configuration.  For existing users the
729 a small helper script is provided to create these files (@pxref{addgnupghome}).
730
731
732
733 @c
734 @c Agent Signals
735 @c
736 @mansect signals
737 @node Agent Signals
738 @section Use of some signals.
739 A running @command{gpg-agent} may be controlled by signals, i.e. using
740 the @command{kill} command to send a signal to the process.
741
742 Here is a list of supported signals:
743
744 @table @gnupgtabopt
745
746 @item SIGHUP
747 @cpindex SIGHUP
748 This signal flushes all cached passphrases and if the program has been
749 started with a configuration file, the configuration file is read
750 again.  Only certain options are honored: @code{quiet},
751 @code{verbose}, @code{debug}, @code{debug-all}, @code{debug-level},
752 @code{no-grab}, @code{pinentry-program}, @code{default-cache-ttl},
753 @code{max-cache-ttl}, @code{ignore-cache-for-signing},
754 @code{allow-mark-trusted}, @code{disable-scdaemon}, and
755 @code{disable-check-own-socket}.  @code{scdaemon-program} is also
756 supported but due to the current implementation, which calls the
757 scdaemon only once, it is not of much use unless you manually kill the
758 scdaemon.
759
760
761 @item SIGTERM
762 @cpindex SIGTERM
763 Shuts down the process but waits until all current requests are
764 fulfilled.  If the process has received 3 of these signals and requests
765 are still pending, a shutdown is forced.
766
767 @item SIGINT
768 @cpindex SIGINT
769 Shuts down the process immediately.
770
771 @item SIGUSR1
772 @cpindex SIGUSR1
773 Dump internal information to the log file.
774
775 @item SIGUSR2
776 @cpindex SIGUSR2
777 This signal is used for internal purposes.
778
779 @end table
780
781 @c
782 @c  Examples
783 @c
784 @mansect examples
785 @node Agent Examples
786 @section Examples
787
788 @ifset gpgtwoone
789 It is important to set the GPG_TTY environment variable in
790 your login shell, for example in the @file{~/.bashrc} init script:
791
792 @cartouche
793 @example
794   export GPG_TTY=$(tty)
795 @end example
796 @end cartouche
797
798 If you enabled the Ssh Agent Support, you also need to tell ssh about
799 it by adding this to your init script:
800
801 @cartouche
802 @example
803 unset SSH_AGENT_PID
804 if [ "$@{gnupg_SSH_AUTH_SOCK_by:-0@}" -ne $$ ]; then
805   export SSH_AUTH_SOCK="$@{HOME@}/.gnupg/S.gpg-agent.ssh"
806 fi
807 @end example
808 @end cartouche
809 @end ifset
810
811 @ifclear gpgtwoone
812 The usual way to invoke @command{gpg-agent} is
813
814 @example
815 $ eval $(gpg-agent --daemon)
816 @end example
817
818 An alternative way is by replacing @command{ssh-agent} with
819 @command{gpg-agent}.  If for example @command{ssh-agent} is started as
820 part of the Xsession initialization, you may simply replace
821 @command{ssh-agent} by a script like:
822
823 @cartouche
824 @example
825 #!/bin/sh
826
827 exec /usr/local/bin/gpg-agent --enable-ssh-support --daemon \
828       --write-env-file $@{HOME@}/.gpg-agent-info "$@@"
829 @end example
830 @end cartouche
831
832 @noindent
833 and add something like (for Bourne shells)
834
835 @cartouche
836 @example
837   if [ -f "$@{HOME@}/.gpg-agent-info" ]; then
838     . "$@{HOME@}/.gpg-agent-info"
839     export GPG_AGENT_INFO
840     export SSH_AUTH_SOCK
841   fi
842 @end example
843 @end cartouche
844
845 @noindent
846 to your shell initialization file (e.g. @file{~/.bashrc}).
847 @end ifclear
848
849 @c
850 @c  Assuan Protocol
851 @c
852 @manpause
853 @node Agent Protocol
854 @section Agent's Assuan Protocol
855
856 Note: this section does only document the protocol, which is used by
857 GnuPG components; it does not deal with the ssh-agent protocol.
858
859 @ifset gpgtwoone
860 The @command{gpg-agent} daemon is started on demand by the GnuPG
861 components.
862 @end ifset
863 @ifclear gpgtwoone
864 The @command{gpg-agent} should be started by the login shell and set an
865 environment variable to tell clients about the socket to be used.
866 Clients should deny to access an agent with a socket name which does
867 not match its own configuration.  An application may choose to start
868 an instance of the gpg-agent if it does not figure that any has been
869 started; it should not do this if a gpg-agent is running but not
870 usable.  Because @command{gpg-agent} can only be used in background mode, no
871 special command line option is required to activate the use of the
872 protocol.
873 @end ifclear
874
875 To identify a key we use a thing called keygrip which is the SHA-1 hash
876 of an canonical encoded S-Expression of the public key as used in
877 Libgcrypt.  For the purpose of this interface the keygrip is given as a
878 hex string.  The advantage of using this and not the hash of a
879 certificate is that it will be possible to use the same keypair for
880 different protocols, thereby saving space on the token used to keep the
881 secret keys.
882
883 @ifset gpgtwoone
884 The @command{gpg-agent} may send status messages during a command or when
885 returning from a command to inform a client about the progress or result of an
886 operation.  For example, the @var{INQUIRE_MAXLEN} status message may be sent
887 during a server inquire to inform the client of the maximum usable length of
888 the inquired data (which should not be exceeded).
889 @end ifset
890
891 @menu
892 * Agent PKDECRYPT::       Decrypting a session key
893 * Agent PKSIGN::          Signing a Hash
894 * Agent GENKEY::          Generating a Key
895 * Agent IMPORT::          Importing a Secret Key
896 * Agent EXPORT::          Exporting a Secret Key
897 * Agent ISTRUSTED::       Importing a Root Certificate
898 * Agent GET_PASSPHRASE::  Ask for a passphrase
899 * Agent CLEAR_PASSPHRASE:: Expire a cached passphrase
900 @ifset gpgtwoone
901 * Agent PRESET_PASSPHRASE:: Set a passphrase for a keygrip
902 @end ifset
903 * Agent GET_CONFIRMATION:: Ask for confirmation
904 * Agent HAVEKEY::         Check whether a key is available
905 * Agent LEARN::           Register a smartcard
906 * Agent PASSWD::          Change a Passphrase
907 * Agent UPDATESTARTUPTTY:: Change the Standard Display
908 * Agent GETEVENTCOUNTER:: Get the Event Counters
909 * Agent GETINFO::         Return information about the process
910 * Agent OPTION::          Set options for the session
911 @end menu
912
913 @node Agent PKDECRYPT
914 @subsection Decrypting a session key
915
916 The client asks the server to decrypt a session key.  The encrypted
917 session key should have all information needed to select the
918 appropriate secret key or to delegate it to a smartcard.
919
920 @example
921   SETKEY <keyGrip>
922 @end example
923
924 Tell the server about the key to be used for decryption.  If this is
925 not used, @command{gpg-agent} may try to figure out the key by trying to
926 decrypt the message with each key available.
927
928 @example
929   PKDECRYPT
930 @end example
931
932 The agent checks whether this command is allowed and then does an
933 INQUIRY to get the ciphertext the client should then send the cipher
934 text.
935
936 @example
937     S: INQUIRE CIPHERTEXT
938     C: D (xxxxxx
939     C: D xxxx)
940     C: END
941 @end example
942
943 Please note that the server may send status info lines while reading the
944 data lines from the client.  The data send is a SPKI like S-Exp with
945 this structure:
946
947 @example
948      (enc-val
949        (<algo>
950          (<param_name1> <mpi>)
951            ...
952          (<param_namen> <mpi>)))
953 @end example
954
955 Where algo is a string with the name of the algorithm; see the libgcrypt
956 documentation for a list of valid algorithms.  The number and names of
957 the parameters depend on the algorithm.  The agent does return an error
958 if there is an inconsistency.
959
960 If the decryption was successful the decrypted data is returned by
961 means of "D" lines.
962
963 Here is an example session:
964 @cartouche
965 @smallexample
966    C: PKDECRYPT
967    S: INQUIRE CIPHERTEXT
968    C: D (enc-val elg (a 349324324)
969    C: D    (b 3F444677CA)))
970    C: END
971    S: # session key follows
972    S: S PADDING 0
973    S: D (value 1234567890ABCDEF0)
974    S: OK descryption successful
975 @end smallexample
976 @end cartouche
977
978 The “PADDING” status line is only send if gpg-agent can tell what kind
979 of padding is used.  As of now only the value 0 is used to indicate
980 that the padding has been removed.
981
982
983 @node Agent PKSIGN
984 @subsection Signing a Hash
985
986 The client ask the agent to sign a given hash value.  A default key
987 will be chosen if no key has been set.  To set a key a client first
988 uses:
989
990 @example
991    SIGKEY <keyGrip>
992 @end example
993
994 This can be used multiple times to create multiple signature, the list
995 of keys is reset with the next PKSIGN command or a RESET.  The server
996 test whether the key is a valid key to sign something and responds with
997 okay.
998
999 @example
1000    SETHASH --hash=<name>|<algo> <hexstring>
1001 @end example
1002
1003 The client can use this command to tell the server about the data <hexstring>
1004 (which usually is a hash) to be signed. <algo> is the decimal encoded hash
1005 algorithm number as used by Libgcrypt.  Either <algo> or --hash=<name>
1006 must be given.  Valid names for <name> are:
1007
1008 @table @code
1009 @item sha1
1010 The SHA-1 hash algorithm
1011 @item sha256
1012 The SHA-256 hash algorithm
1013 @item rmd160
1014 The RIPE-MD160 hash algorithm
1015 @item md5
1016 The old and broken MD5 hash algorithm
1017 @item tls-md5sha1
1018 A combined hash algorithm as used by the TLS protocol.
1019 @end table
1020
1021 @noindent
1022 The actual signing is done using
1023
1024 @example
1025    PKSIGN <options>
1026 @end example
1027
1028 Options are not yet defined, but my later be used to choose among
1029 different algorithms.  The agent does then some checks, asks for the
1030 passphrase and as a result the server returns the signature as an SPKI
1031 like S-expression in "D" lines:
1032
1033 @example
1034      (sig-val
1035        (<algo>
1036          (<param_name1> <mpi>)
1037            ...
1038          (<param_namen> <mpi>)))
1039 @end example
1040
1041
1042 The operation is affected by the option
1043
1044 @example
1045    OPTION use-cache-for-signing=0|1
1046 @end example
1047
1048 The default of @code{1} uses the cache.  Setting this option to @code{0}
1049 will lead @command{gpg-agent} to ignore the passphrase cache.  Note, that there is
1050 also a global command line option for @command{gpg-agent} to globally disable the
1051 caching.
1052
1053
1054 Here is an example session:
1055 @cartouche
1056 @smallexample
1057    C: SIGKEY <keyGrip>
1058    S: OK key available
1059    C: SIGKEY <keyGrip>
1060    S: OK key available
1061    C: PKSIGN
1062    S: # I did ask the user whether he really wants to sign
1063    S: # I did ask the user for the passphrase
1064    S: INQUIRE HASHVAL
1065    C: D ABCDEF012345678901234
1066    C: END
1067    S: # signature follows
1068    S: D (sig-val rsa (s 45435453654612121212))
1069    S: OK
1070 @end smallexample
1071 @end cartouche
1072
1073 @node Agent GENKEY
1074 @subsection Generating a Key
1075
1076 This is used to create a new keypair and store the secret key inside the
1077 active PSE --- which is in most cases a Soft-PSE.  An not yet defined
1078 option allows to choose the storage location.  To get the secret key out
1079 of the PSE, a special export tool has to be used.
1080
1081 @example
1082 @ifset gpgtwoone
1083    GENKEY [--no-protection] [--preset] [<cache_nonce>]
1084 @end ifset
1085 @ifclear gpgtwoone
1086    GENKEY
1087 @end ifclear
1088 @end example
1089
1090 Invokes the key generation process and the server will then inquire
1091 on the generation parameters, like:
1092
1093 @example
1094    S: INQUIRE KEYPARM
1095    C: D (genkey (rsa (nbits  1024)))
1096    C: END
1097 @end example
1098
1099 The format of the key parameters which depends on the algorithm is of
1100 the form:
1101
1102 @example
1103     (genkey
1104       (algo
1105         (parameter_name_1 ....)
1106           ....
1107         (parameter_name_n ....)))
1108 @end example
1109
1110 If everything succeeds, the server returns the *public key* in a SPKI
1111 like S-Expression like this:
1112
1113 @example
1114      (public-key
1115        (rsa
1116          (n <mpi>)
1117          (e <mpi>)))
1118 @end example
1119
1120 Here is an example session:
1121 @cartouche
1122 @smallexample
1123    C: GENKEY
1124    S: INQUIRE KEYPARM
1125    C: D (genkey (rsa (nbits  1024)))
1126    C: END
1127    S: D (public-key
1128    S: D   (rsa (n 326487324683264) (e 10001)))
1129    S  OK key created
1130 @end smallexample
1131 @end cartouche
1132
1133 @ifset gpgtwoone
1134 The @option{--no-protection} option may be used to prevent prompting for a
1135 passphrase to protect the secret key while leaving the secret key unprotected.
1136 The @option{--preset} option may be used to add the passphrase to the cache
1137 using the default cache parameters.
1138 @end ifset
1139
1140 @node Agent IMPORT
1141 @subsection Importing a Secret Key
1142
1143 This operation is not yet supported by GpgAgent.  Specialized tools
1144 are to be used for this.
1145
1146 There is no actual need because we can expect that secret keys
1147 created by a 3rd party are stored on a smartcard.  If we have
1148 generated the key ourself, we do not need to import it.
1149
1150 @node Agent EXPORT
1151 @subsection Export a Secret Key
1152
1153 Not implemented.
1154
1155 Should be done by an extra tool.
1156
1157 @node Agent ISTRUSTED
1158 @subsection Importing a Root Certificate
1159
1160 Actually we do not import a Root Cert but provide a way to validate
1161 any piece of data by storing its Hash along with a description and
1162 an identifier in the PSE.  Here is the interface description:
1163
1164 @example
1165     ISTRUSTED <fingerprint>
1166 @end example
1167
1168 Check whether the OpenPGP primary key or the X.509 certificate with the
1169 given fingerprint is an ultimately trusted key or a trusted Root CA
1170 certificate.  The fingerprint should be given as a hexstring (without
1171 any blanks or colons or whatever in between) and may be left padded with
1172 00 in case of an MD5 fingerprint.  GPGAgent will answer with:
1173
1174 @example
1175     OK
1176 @end example
1177
1178 The key is in the table of trusted keys.
1179
1180 @example
1181     ERR 304 (Not Trusted)
1182 @end example
1183
1184 The key is not in this table.
1185
1186 Gpg needs the entire list of trusted keys to maintain the web of
1187 trust; the following command is therefore quite helpful:
1188
1189 @example
1190     LISTTRUSTED
1191 @end example
1192
1193 GpgAgent returns a list of trusted keys line by line:
1194
1195 @example
1196     S: D 000000001234454556565656677878AF2F1ECCFF P
1197     S: D 340387563485634856435645634856438576457A P
1198     S: D FEDC6532453745367FD83474357495743757435D S
1199     S: OK
1200 @end example
1201
1202 The first item on a line is the hexified fingerprint where MD5
1203 fingerprints are @code{00} padded to the left and the second item is a
1204 flag to indicate the type of key (so that gpg is able to only take care
1205 of PGP keys).  P = OpenPGP, S = S/MIME.  A client should ignore the rest
1206 of the line, so that we can extend the format in the future.
1207
1208 Finally a client should be able to mark a key as trusted:
1209
1210 @example
1211    MARKTRUSTED @var{fingerprint} "P"|"S"
1212 @end example
1213
1214 The server will then pop up a window to ask the user whether she
1215 really trusts this key. For this it will probably ask for a text to
1216 be displayed like this:
1217
1218 @example
1219    S: INQUIRE TRUSTDESC
1220    C: D Do you trust the key with the fingerprint @@FPR@@
1221    C: D bla fasel blurb.
1222    C: END
1223    S: OK
1224 @end example
1225
1226 Known sequences with the pattern @@foo@@ are replaced according to this
1227 table:
1228
1229 @table @code
1230 @item @@FPR16@@
1231 Format the fingerprint according to gpg rules for a v3 keys.
1232 @item @@FPR20@@
1233 Format the fingerprint according to gpg rules for a v4 keys.
1234 @item @@FPR@@
1235 Choose an appropriate format to format the fingerprint.
1236 @item @@@@
1237 Replaced by a single @code{@@}
1238 @end table
1239
1240 @node Agent GET_PASSPHRASE
1241 @subsection Ask for a passphrase
1242
1243 This function is usually used to ask for a passphrase to be used for
1244 conventional encryption, but may also be used by programs which need
1245 special handling of passphrases.  This command uses a syntax which helps
1246 clients to use the agent with minimum effort.
1247
1248 @example
1249   GET_PASSPHRASE [--data] [--check] [--no-ask] [--repeat[=N]] \
1250                  [--qualitybar] @var{cache_id}                \
1251                  [@var{error_message} @var{prompt} @var{description}]
1252 @end example
1253
1254 @var{cache_id} is expected to be a string used to identify a cached
1255 passphrase.  Use a @code{X} to bypass the cache.  With no other
1256 arguments the agent returns a cached passphrase or an error.  By
1257 convention either the hexified fingerprint of the key shall be used for
1258 @var{cache_id} or an arbitrary string prefixed with the name of the
1259 calling application and a colon: Like @code{gpg:somestring}.
1260
1261 @var{error_message} is either a single @code{X} for no error message or
1262 a string to be shown as an error message like (e.g. "invalid
1263 passphrase").  Blanks must be percent escaped or replaced by @code{+}'.
1264
1265 @var{prompt} is either a single @code{X} for a default prompt or the
1266 text to be shown as the prompt.  Blanks must be percent escaped or
1267 replaced by @code{+}.
1268
1269 @var{description} is a text shown above the entry field.  Blanks must be
1270 percent escaped or replaced by @code{+}.
1271
1272 The agent either returns with an error or with a OK followed by the hex
1273 encoded passphrase.  Note that the length of the strings is implicitly
1274 limited by the maximum length of a command.  If the option
1275 @option{--data} is used, the passphrase is not returned on the OK line
1276 but by regular data lines; this is the preferred method.
1277
1278 If the option @option{--check} is used, the standard passphrase
1279 constraints checks are applied.  A check is not done if the passphrase
1280 has been found in the cache.
1281
1282 If the option @option{--no-ask} is used and the passphrase is not in the
1283 cache the user will not be asked to enter a passphrase but the error
1284 code @code{GPG_ERR_NO_DATA} is returned.
1285
1286 If the option @option{--qualitybar} is used and a minimum passphrase
1287 length has been configured, a visual indication of the entered
1288 passphrase quality is shown.
1289
1290 @example
1291   CLEAR_PASSPHRASE @var{cache_id}
1292 @end example
1293
1294 may be used to invalidate the cache entry for a passphrase.  The
1295 function returns with OK even when there is no cached passphrase.
1296
1297
1298
1299 @node Agent CLEAR_PASSPHRASE
1300 @subsection Remove a cached passphrase
1301
1302 Use this command to remove a cached passphrase.
1303
1304 @example
1305 @ifset gpgtwoone
1306   CLEAR_PASSPHRASE [--mode=normal] <cache_id>
1307 @end ifset
1308 @ifclear gpgtwoone
1309   CLEAR_PASSPHRASE <cache_id>
1310 @end ifclear
1311 @end example
1312
1313 @ifset gpgtwoone
1314 The @option{--mode=normal} option can be used to clear a @var{cache_id} that
1315 was set by gpg-agent.
1316 @end ifset
1317
1318
1319
1320 @ifset gpgtwoone
1321 @node Agent PRESET_PASSPHRASE
1322 @subsection Set a passphrase for a keygrip
1323
1324 This command adds a passphrase to the cache for the specified @var{keygrip}.
1325
1326 @example
1327   PRESET_PASSPHRASE [--inquire] <string_or_keygrip> <timeout> [<hexstring>]
1328 @end example
1329
1330 The passphrase is a hexidecimal string when specified. When not specified, the
1331 passphrase will be retrieved from the pinentry module unless the
1332 @option{--inquire} option was specified in which case the passphrase will be
1333 retrieved from the client.
1334
1335 The @var{timeout} parameter keeps the passphrase cached for the specified
1336 number of seconds. A value of @code{-1} means infinate while @code{0} means
1337 the default (currently only a timeout of -1 is allowed, which means to never
1338 expire it).
1339 @end ifset
1340
1341
1342
1343
1344 @node Agent GET_CONFIRMATION
1345 @subsection Ask for confirmation
1346
1347 This command may be used to ask for a simple confirmation by
1348 presenting a text and 2 buttons: Okay and Cancel.
1349
1350 @example
1351   GET_CONFIRMATION @var{description}
1352 @end example
1353
1354 @var{description}is displayed along with a Okay and Cancel
1355 button. Blanks must be percent escaped or replaced by @code{+}.  A
1356 @code{X} may be used to display confirmation dialog with a default
1357 text.
1358
1359 The agent either returns with an error or with a OK.  Note, that the
1360 length of @var{description} is implicitly limited by the maximum
1361 length of a command.
1362
1363
1364
1365 @node Agent HAVEKEY
1366 @subsection Check whether a key is available
1367
1368 This can be used to see whether a secret key is available.  It does
1369 not return any information on whether the key is somehow protected.
1370
1371 @example
1372   HAVEKEY @var{keygrips}
1373 @end example
1374
1375 The agent answers either with OK or @code{No_Secret_Key} (208).  The
1376 caller may want to check for other error codes as well.  More than one
1377 keygrip may be given.  In this case the command returns success if at
1378 least one of the keygrips corresponds to an available secret key.
1379
1380
1381 @node Agent LEARN
1382 @subsection Register a smartcard
1383
1384 @example
1385   LEARN [--send]
1386 @end example
1387
1388 This command is used to register a smartcard.  With the --send
1389 option given the certificates are send back.
1390
1391
1392 @node Agent PASSWD
1393 @subsection Change a Passphrase
1394
1395 @example
1396 @ifset gpgtwoone
1397   PASSWD [--cache-nonce=<c>] [--passwd-nonce=<s>] [--preset] @var{keygrip}
1398 @end ifset
1399 @ifclear gpgtwoone
1400   PASSWD @var{keygrip}
1401 @end ifclear
1402 @end example
1403
1404 This command is used to interactively change the passphrase of the key
1405 identified by the hex string @var{keygrip}.
1406
1407 @ifset gpgtwoone
1408 The @option{--preset} option may be used to add the new passphrase to the
1409 cache using the default cache parameters.
1410 @end ifset
1411
1412
1413 @node Agent UPDATESTARTUPTTY
1414 @subsection Change the standard display
1415
1416 @example
1417   UPDATESTARTUPTTY
1418 @end example
1419
1420 Set the startup TTY and X-DISPLAY variables to the values of this
1421 session.  This command is useful to direct future pinentry invocations
1422 to another screen.  It is only required because there is no way in the
1423 ssh-agent protocol to convey this information.
1424
1425
1426 @node Agent GETEVENTCOUNTER
1427 @subsection Get the Event Counters
1428
1429 @example
1430   GETEVENTCOUNTER
1431 @end example
1432
1433 This function return one status line with the current values of the
1434 event counters.  The event counters are useful to avoid polling by
1435 delaying a poll until something has changed.  The values are decimal
1436 numbers in the range @code{0} to @code{UINT_MAX} and wrapping around to
1437 0.  The actual values should not be relied upon; they shall only be used
1438 to detect a change.
1439
1440 The currently defined counters are are:
1441 @table @code
1442 @item ANY
1443 Incremented with any change of any of the other counters.
1444 @item KEY
1445 Incremented for added or removed private keys.
1446 @item CARD
1447 Incremented for changes of the card readers stati.
1448 @end table
1449
1450 @node Agent GETINFO
1451 @subsection  Return information about the process
1452
1453 This is a multipurpose function to return a variety of information.
1454
1455 @example
1456 GETINFO @var{what}
1457 @end example
1458
1459 The value of @var{what} specifies the kind of information returned:
1460 @table @code
1461 @item version
1462 Return the version of the program.
1463 @item pid
1464 Return the process id of the process.
1465 @item socket_name
1466 Return the name of the socket used to connect the agent.
1467 @item ssh_socket_name
1468 Return the name of the socket used for SSH connections.  If SSH support
1469 has not been enabled the error @code{GPG_ERR_NO_DATA} will be returned.
1470 @end table
1471
1472 @node Agent OPTION
1473 @subsection Set options for the session
1474
1475 Here is a list of session options which are not yet described with
1476 other commands.  The general syntax for an Assuan option is:
1477
1478 @smallexample
1479 OPTION  @var{key}=@var{value}
1480 @end smallexample
1481
1482 @noindent
1483 Supported @var{key}s are:
1484
1485 @table @code
1486 @item agent-awareness
1487 This may be used to tell gpg-agent of which gpg-agent version the
1488 client is aware of.  gpg-agent uses this information to enable
1489 features which might break older clients.
1490
1491 @item putenv
1492 Change the session's environment to be used for the
1493 Pinentry.  Valid values are:
1494
1495   @table @code
1496   @item @var{name}
1497   Delete envvar @var{name}
1498   @item @var{name}=
1499   Set envvar @var{name} to the empty string
1500   @item @var{name}=@var{value}
1501   Set envvar @var{name} to the string @var{value}.
1502   @end table
1503
1504 @item use-cache-for-signing
1505 See Assuan command @code{PKSIGN}.
1506
1507 @item allow-pinentry-notify
1508 This does not need any value.  It is used to enable the
1509 PINENTRY_LAUNCHED inquiry.
1510
1511 @ifset gpgtwoone
1512 @item pinentry-mode
1513 This option is used to change the operation mode of the pinentry.  The
1514 following values are defined:
1515
1516   @table @code
1517   @item ask
1518   This is the default mode which pops up a pinentry as needed.
1519
1520   @item cancel
1521   Instead of popping up a pinentry, return the error code
1522   @code{GPG_ERR_CANCELED}.
1523
1524   @item error
1525   Instead of popping up a pinentry, return the error code
1526   @code{GPG_ERR_NO_PIN_ENTRY}.
1527
1528   @item loopback
1529   Use a loopback pinentry.  This fakes a pinentry by using inquiries
1530   back to the caller to ask for a passphrase.  This option may only be
1531   set if the agent has been configured for that.
1532   Use the @xref{option --allow-loopback-pinentry}.
1533
1534   @end table
1535 @end ifset
1536
1537 @ifset gpgtwoone
1538 @item cache-ttl-opt-preset
1539 This option sets the cache TTL for new entries created by GENKEY and
1540 PASSWD commands when using the @option{--preset} option.  It it is not
1541 used a default value is used.
1542 @end ifset
1543
1544 @ifset gpgtwoone
1545 @item s2k-count
1546 Instead of using the standard S2K count (which is computed on the
1547 fly), the given S2K count is used for new keys or when changing the
1548 passphrase of a key.  Values below 65536 are considered to be 0.  This
1549 option is valid for the entire session or until reset to 0.  This
1550 option is useful if the key is later used on boxes which are either
1551 much slower or faster than the actual box.
1552 @end ifset
1553
1554 @end table
1555
1556
1557 @mansect see also
1558 @ifset isman
1559 @command{gpg2}(1),
1560 @command{gpgsm}(1),
1561 @command{gpg-connect-agent}(1),
1562 @command{scdaemon}(1)
1563 @end ifset
1564 @include see-also-note.texi