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