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