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