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