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