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