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