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