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