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