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