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