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