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