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