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