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