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