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