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