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