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