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