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