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