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