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