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