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