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