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