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