More man pages.
[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 .R \- 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 @code{pinentry-pgm} 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 execpt for the fact that
121 only one 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 @item --homedir @var{dir}
172 @opindex homedir
173 Set the name of the home directory to @var{dir}. If his option is not
174 used, the home directory defaults to @file{~/.gnupg}.  It is only
175 recognized when given on the command line.  It also overrides any home
176 directory stated through the environment variable @env{GNUPGHOME} or
177 (on W32 systems) by means on the Registry entry
178 @var{HKCU\Software\GNU\GnuPG:HomeDir}.
179
180 @item -v
181 @item --verbose
182 @opindex v
183 @opindex verbose
184 Outputs additional information while running.
185 You can increase the verbosity by giving several
186 verbose commands to @command{gpgsm}, such as @samp{-vv}.
187
188 @item -q
189 @item --quiet
190 @opindex q
191 @opindex quiet
192 Try to be as quiet as possible.
193
194 @item --batch
195 @opindex batch
196 Don't invoke a pinentry or do any other thing requiring human interaction.
197
198 @item --faked-system-time @var{epoch}
199 @opindex faked-system-time
200 This option is only useful for testing; it sets the system time back or
201 forth to @var{epoch} which is the number of seconds elapsed since the year
202 1970.
203
204 @item --debug-level @var{level}
205 @opindex debug-level
206 Select the debug level for investigating problems. @var{level} may be
207 one of:
208
209    @table @code
210    @item none
211    no debugging at all.
212    @item basic  
213    some basic debug messages
214    @item advanced
215    more verbose debug messages
216    @item expert
217    even more detailed messages
218    @item guru
219    all of the debug messages you can get
220    @end table
221
222 How these messages are mapped to the actual debugging flags is not
223 specified and may change with newer releaes of this program. They are
224 however carefully selected to best aid in debugging.
225
226 @item --debug @var{flags}
227 @opindex debug
228 This option is only useful for debugging and the behaviour may change at
229 any time without notice.  FLAGS are bit encoded and may be given in
230 usual C-Syntax. The currently defined bits are:
231
232 @table @code
233 @item 0  (1)
234 X.509 or OpenPGP protocol related data
235 @item 1  (2)  
236 values of big number integers 
237 @item 2  (4)
238 low level crypto operations
239 @item 5  (32)
240 memory allocation
241 @item 6  (64)
242 caching
243 @item 7  (128)
244 show memory statistics.
245 @item 9  (512)
246 write hashed data to files named @code{dbgmd-000*}
247 @item 10 (1024)
248 trace Assuan protocol
249 @item 12 (4096)
250 bypass all certificate validation
251 @end table
252
253 @item --debug-all
254 @opindex debug-all
255 Same as @code{--debug=0xffffffff}
256
257 @item --debug-wait @var{n}
258 @opindex debug-wait
259 When running in server mode, wait @var{n} seconds before entering the
260 actual processing loop and print the pid.  This gives time to attach a
261 debugger.
262
263 @item --no-detach
264 @opindex no-detach
265 Don't detach the process from the console.  This is manly usefule for
266 debugging.
267
268 @item -s
269 @itemx --sh
270 @itemx -c
271 @itemx --csh
272 @opindex s
273 @opindex sh
274 @opindex c
275 @opindex csh
276 Format the info output in daemon mode for use with the standard Bourne
277 shell respective the C-shell . The default ist to guess it based on the
278 environment variable @code{SHELL} which is in almost all cases
279 sufficient.
280
281 @item --write-env-file @var{file}
282 @opindex write-env-file
283 Often it is required to connect to the agent from a process not being an
284 inferior of @command{gpg-agent} and thus the environment variable with
285 the socket name is not available.  To help setting up those variables in
286 other sessions, this option may be used to write the information into
287 @var{file}.  If @var{file} is not specified the default name
288 @file{$@{HOME@}/.gpg-agent-info} will be used.  The format is suitable
289 to be evaluated by a Bourne shell like in this simple example:
290
291 @example
292 eval `cat @var{file}`
293 eval `cut -d= -f 1 < @var{file} | xargs echo export`
294 @end example
295
296
297
298 @item --no-grab
299 @opindex no-grab
300 Tell the pinentryo not to grab the keyboard and mouse.  This option
301 should in general not be used to avaoid X-sniffing attacks.
302
303 @item --log-file @var{file}
304 @opindex log-file
305 Append all logging output to @var{file}.  This is very helpful in
306 seeing what the agent actually does.
307
308 @anchor{option --allow-mark-trusted}
309 @item --allow-mark-trusted
310 @opindex allow-mark-trusted
311 Allow clients to mark keys as trusted, i.e. put them into the
312 @file{trustlist.txt} file.  This is by default not allowed to make it
313 harder for users to inadvertly accept Root-CA keys.
314
315 @item --ignore-cache-for-signing
316 @opindex ignore-cache-for-signing
317 This option will let @command{gpg-agent} bypass the passphrase cache for all
318 signing operation.  Note that there is also a per-session option to
319 control this behaviour but this command line option takes precedence.
320
321 @item --default-cache-ttl @var{n}
322 @opindex default-cache-ttl
323 Set the time a cache entry is valid to @var{n} seconds.  The default are
324 600 seconds.
325
326 @item --default-cache-ttl-ssh @var{n}
327 @opindex default-cache-ttl
328 Set the time a cache entry used for SSH keys is valid to @var{n}
329 seconds.  The default are 1800 seconds.
330
331 @item --max-cache-ttl @var{n}
332 @opindex max-cache-ttl
333 Set the maximum time a cache entry is valid to @var{n} seconds.  After
334 this time a cache entry will get expired even if it has been accessed
335 recently.  The default are 2 hours (7200 seconds).
336
337 @item --max-cache-ttl-ssh @var{n}
338 @opindex max-cache-ttl-ssh
339 Set the maximum time a cache entry used for SSH keys is valid to @var{n}
340 seconds.  After this time a cache entry will get expired even if it has
341 been accessed recently.  The default are 2 hours (7200 seconds).
342
343 @item --pinentry-program @var{filename}
344 @opindex pinentry-program
345 Use program @var{filename} as the PIN entry.  The default is installation
346 dependend and can be shown with the @code{--version} command.
347
348 @item --scdaemon-program @var{filename}
349 @opindex scdaemon-program
350 Use program @var{filename} as the Smartcard daemon.  The default is
351 installation dependend and can be shown with the @code{--version}
352 command.
353
354 @item --disable-scdaemon
355 @opindex disable-scdaemon
356 Do not make use of the scdaemon tool.  This option has the effect of
357 disabling the ability to do smartcard operations.  Note, that enabling
358 this option at runtime does not kill an already forked scdaemon.
359
360 @item --use-standard-socket
361 @itemx --no-use-standard-socket
362 @opindex use-standard-socket
363 @opindex no-use-standard-socket
364 By enabling this option @command{gpg-agent} will listen on the socket
365 named @file{S.gpg-agent}, located in the home directory, and not create
366 a random socket below a temporary directory.  Tools connecting to
367 @command{gpg-agent} should first try to connect to the socket given in
368 environment variable @var{GPG_AGENT_INFO} and the fall back to this
369 socket.  This option may not be used if the home directory is mounted as
370 a remote file system.  
371
372 @noindent
373 Note, that as of now, W32 systems default to this option.
374
375
376 @item --display @var{string}
377 @itemx --ttyname @var{string}
378 @itemx --ttytype @var{string}
379 @itemx --lc-type @var{string}
380 @itemx --lc-messages @var{string}
381 @opindex display 
382 @opindex ttyname 
383 @opindex ttytype 
384 @opindex lc-type 
385 @opindex lc-messages
386 These options are used with the server mode to pass localization
387 information.
388
389 @item --keep-tty
390 @itemx --keep-display
391 @opindex keep-tty
392 @opindex keep-display
393 Ignore requests to change change the current @code{tty} respective the X
394 window system's @code{DISPLAY} variable.  This is useful to lock the
395 pinentry to pop up at the @code{tty} or display you started the agent.
396
397 @anchor{option --enable-ssh-support}
398 @item --enable-ssh-support
399 @opindex enable-ssh-support
400
401 Enable emulation of the OpenSSH Agent protocol.
402
403 In this mode of operation, the agent does not only implement the
404 gpg-agent protocol, but also the agent protocol used by OpenSSH
405 (through a seperate socket).  Consequently, it should possible to use
406 the gpg-agent as a drop-in replacement for the well known ssh-agent.
407
408 SSH Keys, which are to be used through the agent, need to be added to
409 the gpg-agent initially through the ssh-add utility.  When a key is
410 added, ssh-add will ask for the password of the provided key file and
411 send the unprotected key material to the agent; this causes the
412 gpg-agent to ask for a passphrase, which is to be used for encrypting
413 the newly received key and storing it in a gpg-agent specific
414 directory.
415
416 Once, a key has been added to the gpg-agent this way, the gpg-agent
417 will be ready to use the key.
418
419 Note: in case the gpg-agent receives a signature request, the user might
420 need to be prompted for a passphrase, which is necessary for decrypting
421 the stored key.  Since the ssh-agent protocol does not contain a
422 mechanism for telling the agent on which display/terminal it is running,
423 gpg-agent's ssh-support will use the TTY or X display where gpg-agent
424 has been started.  To switch this display to the current one, the
425 follwing command may be used:
426
427 @smallexample
428 echo UPDATESTARTUPTTY | gpg-connect-agent
429 @end smallexample
430
431
432
433 @end table
434
435 All the long options may also be given in the configuration file after
436 stripping off the two leading dashes.
437
438
439 @mansect files
440 @node Agent Configuration
441 @section Configuration
442
443 There are a few configuration files needed for the operation of the
444 agent. By default they may all be found in the current home directory
445 (@pxref{option --homedir}).
446
447 @table @file
448
449 @item gpg-agent.conf
450 @cindex gpg-agent.conf
451   This is the standard configuration file read by @command{gpg-agent} on
452   startup.  It may contain any valid long option; the leading
453   two dashes may not be entered and the option may not be abbreviated.
454   This file is also read after a @code{SIGHUP} however only a few
455   options will actually have an effect.  This default name may be
456   changed on the command line (@pxref{option --options}).
457
458 @item trustlist.txt
459   This is the list of trusted keys.  Comment lines, indicated by a leading
460   hash mark, as well as empty lines are ignored.  To mark a key as trusted
461   you need to enter its fingerprint followed by a space and a capital
462   letter @code{S}.  Colons may optionally be used to separate the bytes of
463   a fingerprint; this allows to cut and paste the fingerprint from a key
464   listing output.
465   
466   Here is an example where two keys are marked as ultimately trusted:
467   
468   @example
469   # CN=Wurzel ZS 3,O=Intevation GmbH,C=DE
470   A6935DD34EF3087973C706FC311AA2CCF733765B S
471   
472   # CN=PCA-1-Verwaltung-02/O=PKI-1-Verwaltung/C=DE
473   DC:BD:69:25:48:BD:BB:7E:31:6E:BB:80:D3:00:80:35:D4:F8:A6:CD S 
474   @end example
475   
476   Before entering a key into this file, you need to ensure its
477   authenticity.  How to do this depends on your organisation; your
478   administrator might have already entered those keys which are deemed
479   trustworthy enough into this file.  Places where to look for the
480   fingerprint of a root certificate are letters received from the CA or
481   the website of the CA (after making 100% sure that this is indeed the
482   website of that CA).  You may want to consider allowing interactive
483   updates of this file by using the @xref{option --allow-mark-trusted}.
484   This is however not as secure as maintaining this file manually.  It is
485   even advisable to change the permissions to read-only so that this file
486   can't be changed inadvertently.
487   
488 @item sshcontrol
489
490   This file is used when support for the secure shell agent protocol has
491   been enabled (@pxref{option --enable-ssh-support}). Only keys present in
492   this file are used in the SSH protocol.  The @command{ssh-add} tool y be
493   used to add new entries to this file; you may also add them manually.
494   Comment lines, indicated by a leading hash mark, as well as empty lines
495   are ignored.  An entry starts with optional white spaces, followed by
496   the keygrip of the key given as 40 hex digits, optionally followed by
497   the caching TTL in seconds and another optional field for arbitrary
498   flags.  A @code{!} may be prepended to the keygrip to disable this
499   entry.
500     
501   The follwoing example lists exactly one key.  Note that keys available
502   through a OpenPGP smartcard in the active smartcard reader are implictly
503   added to this list; i.e. there is no need to list them.
504   
505   @example
506   # Key added on 2005-02-25 15:08:29
507   5A6592BF45DC73BD876874A28FD4639282E29B52 0
508   @end example
509 @end table
510
511 Note that on larger installations, it is useful to put predefined
512 files into the directory @file{/etc/skel/.gnupg/} so that newly created
513 users start up with a working configuration.  For existing users the
514 a small helper script is provied to create these files (@pxref{addgnupghome}).
515
516
517
518 @c
519 @c Agent Signals
520 @c
521 @mansect signals
522 @node Agent Signals
523 @section Use of some signals.
524 A running @command{gpg-agent} may be controlled by signals, i.e. using
525 the @command{kill} command to send a signal to the process. 
526
527 Here is a list of supported signals:
528
529 @table @gnupgtabopt
530
531 @item SIGHUP
532 @cpindex SIGHUP
533 This signal flushes all chached passphrases and if the program has been
534 started with a configuration file, the configuration file is read again.
535 Only certain options are honored: @code{quiet}, @code{verbose},
536 @code{debug}, @code{debug-all}, @code{debug-level}, @code{no-grab},
537 @code{pinentry-program}, @code{default-cache-ttl}, @code{max-cache-ttl},
538 @code{ignore-cache-for-signing}, @code{allow-mark-trusted} and
539 @code{disable-scdaemon}.  @code{scdaemon-program} is also supported but
540 due to the current implementation, which calls the scdaemon only once,
541 it is not of much use unless you manually kill the scdaemon.
542
543
544 @item SIGTERM
545 @cpindex SIGTERM
546 Shuts down the process but waits until all current requests are
547 fulfilled.  If the process has received 3 of these signals and requests
548 are still pending, a shutdown is forced.
549
550 @item SIGINT
551 @cpindex SIGINT
552 Shuts down the process immediately.
553
554 @item SIGUSR1
555 @cpindex SIGUSR1
556 Dump internal information to the log file.
557
558 @item SIGUSR2
559 @cpindex SIGUSR2
560 This signal is used for internal purposes.
561
562 @end table
563
564 @c 
565 @c  Examples
566 @c
567 @mansect examples
568 @node Agent Examples
569 @section Examples
570
571 The usual way to invoke @command{gpg-agent} is
572
573 @example
574 $ eval `gpg-agent --daemon`
575 @end example
576
577 An alternative way is by replacing @command{ssh-agent} with
578 @command{gpg-agent}.  If for example @command{ssh-agent} is started as
579 part of the Xsession intialization you may simply replace
580 @command{ssh-agent} by a script like:
581
582 @cartouche
583 @example
584 #!/bin/sh
585
586 exec /usr/local/bin/gpg-agent --enable-ssh-support --daemon \
587       --write-env-file $@{HOME@}/.gpg-agent-info "$@@"
588 @end example
589 @end cartouche
590
591 @noindent
592 and add something like (for Bourne shells)
593
594 @cartouche
595 @example
596   if [ -f "$@{HOME@}/.gpg-agent-info" ]; then
597     . "$@{HOME@}/.gpg-agent-info"
598     export GPG_AGENT_INFO
599     export SSH_AUTH_SOCK
600     export SSH_AGENT_PID
601   fi
602 @end example
603 @end cartouche
604
605 @noindent
606 to your shell initialization file (e.g. @file{~/.bashrc}).
607
608 @c 
609 @c  Assuan Protocol
610 @c
611 @mansect assuan
612 @node Agent Protocol
613 @section Agent's Assuan Protocol
614
615 Note: this section does only document the protocol, which is used by
616 GnuPG components; it does not deal with the ssh-agent protocol.
617
618 The @command{gpg-agent} should be started by the login shell and set an
619 environment variable to tell clients about the socket to be used.
620 Clients should deny to access an agent with a socket name which does
621 not match its own configuration.  An application may choose to start
622 an instance of the gpgagent if it does not figure that any has been
623 started; it should not do this if a gpgagent is running but not
624 usable.  Because @command{gpg-agent} can only be used in background mode, no
625 special command line option is required to activate the use of the
626 protocol.
627
628 To identify a key we use a thing called keygrip which is the SHA-1 hash
629 of an canoncical encoded S-Expression of the the public key as used in
630 Libgcrypt.  For the purpose of this interface the keygrip is given as a
631 hex string.  The advantage of using this and not the hash of a
632 certificate is that it will be possible to use the same keypair for
633 different protocols, thereby saving space on the token used to keep the
634 secret keys.
635
636 @menu
637 * Agent PKDECRYPT::       Decrypting a session key
638 * Agent PKSIGN::          Signing a Hash
639 * Agent GENKEY::          Generating a Key
640 * Agent IMPORT::          Importing a Secret Key
641 * Agent EXPORT::          Exporting a Secret Key
642 * Agent ISTRUSTED::       Importing a Root Certificate
643 * Agent GET_PASSPHRASE::  Ask for a passphrase
644 * Agent GET_CONFIRMATION:: Ask for confirmation
645 * Agent HAVEKEY::         Check whether a key is available
646 * Agent LEARN::           Register a smartcard
647 * Agent PASSWD::          Change a Passphrase
648 * Agent UPDATESTARTUPTTY:: Change the Standard Display
649 @end menu
650
651 @node Agent PKDECRYPT
652 @subsection Decrypting a session key
653
654 The client asks the server to decrypt a session key.  The encrypted
655 session key should have all information needed to select the
656 appropriate secret key or to delegate it to a smartcard.
657
658 @example
659   SETKEY <keyGrip>
660 @end example
661
662 Tell the server about the key to be used for decryption.  If this is
663 not used, @command{gpg-agent} may try to figure out the key by trying to
664 decrypt the message with each key available.
665
666 @example
667   PKDECRYPT
668 @end example
669
670 The agent checks whether this command is allowed and then does an
671 INQUIRY to get the ciphertext the client should then send the cipher
672 text.
673
674 @example
675     S: INQUIRE CIPHERTEXT
676     C: D (xxxxxx
677     C: D xxxx)
678     C: END
679 @end example
680     
681 Please note that the server may send status info lines while reading the
682 data lines from the client.  The data send is a SPKI like S-Exp with
683 this structure:
684
685 @example
686      (enc-val   
687        (<algo>
688          (<param_name1> <mpi>)
689            ...
690          (<param_namen> <mpi>)))
691 @end example
692
693 Where algo is a string with the name of the algorithm; see the libgcrypt
694 documentation for a list of valid algorithms.  The number and names of
695 the parameters depend on the algorithm.  The agent does return an error
696 if there is an inconsistency.
697
698 If the decryption was successful the decrypted data is returned by
699 means of "D" lines. 
700
701 Here is an example session:
702
703 @example
704    C: PKDECRYPT
705    S: INQUIRE CIPHERTEXT
706    C: D (enc-val elg (a 349324324) 
707    C: D    (b 3F444677CA)))
708    C: END
709    S: # session key follows
710    S: D 1234567890ABCDEF0
711    S: OK descryption successful
712 @end example         
713
714
715 @node Agent PKSIGN
716 @subsection Signing a Hash
717
718 The client ask the agent to sign a given hash value.  A default key
719 will be chosen if no key has been set.  To set a key a client first
720 uses:
721
722 @example
723    SIGKEY <keyGrip>
724 @end example
725
726 This can be used multiple times to create multiple signature, the list
727 of keys is reset with the next PKSIGN command or a RESET.  The server
728 test whether the key is a valid key to sign something and responds with
729 okay.
730
731 @example
732    SETHASH <hexstring>
733 @end example
734
735 The client can use this command to tell the server about the data
736 (which usually is a hash) to be signed.  
737
738 The actual signing is done using
739
740 @example
741    PKSIGN <options>
742 @end example
743
744 Options are not yet defined, but my later be used to choosen among
745 different algorithms (e.g. pkcs 1.5)
746
747 The agent does then some checks, asks for the passphrase and
748 if SETHASH has not been used asks the client for the data to sign:
749
750 @example
751    S: INQUIRE HASHVAL
752    C: D ABCDEF012345678901234
753    C: END
754 @end example
755
756 As a result the server returns the signature as an SPKI like S-Exp
757 in "D" lines:
758
759 @example  
760      (sig-val   
761        (<algo>
762          (<param_name1> <mpi>)
763            ...
764          (<param_namen> <mpi>)))
765 @end example
766
767
768 The operation is affected by the option
769
770 @example
771    OPTION use-cache-for-signing=0|1
772 @end example
773
774 The default of @code{1} uses the cache.  Setting this option to @code{0}
775 will lead @command{gpg-agent} to ignore the passphrase cache.  Note, that there is
776 also a global command line option for @command{gpg-agent} to globally disable the
777 caching.
778
779
780 Here is an example session:
781
782 @example
783    C: SIGKEY <keyGrip>
784    S: OK key available
785    C: SIGKEY <keyGrip>
786    S: OK key available
787    C: PKSIGN
788    S: # I did ask the user whether he really wants to sign
789    S: # I did ask the user for the passphrase
790    S: INQUIRE HASHVAL
791    C: D ABCDEF012345678901234
792    C: END
793    S: # signature follows
794    S: D (sig-val rsa (s 45435453654612121212))
795    S: OK
796 @end example
797
798
799 @node Agent GENKEY
800 @subsection Generating a Key
801
802 This is used to create a new keypair and store the secret key inside the
803 active PSE -w which is in most cases a Soft-PSE.  An not yet defined
804 option allows to choose the storage location.  To get the secret key out
805 of the PSE, a special export tool has to be used.
806
807 @example
808    GENKEY 
809 @end example
810
811 Invokes the key generation process and the server will then inquire
812 on the generation parameters, like:
813
814 @example
815    S: INQUIRE KEYPARM
816    C: D (genkey (rsa (nbits  1024)))
817    C: END
818 @end example
819
820 The format of the key parameters which depends on the algorithm is of
821 the form:
822
823 @example
824     (genkey
825       (algo
826         (parameter_name_1 ....)
827           ....
828         (parameter_name_n ....)))
829 @end example
830
831 If everything succeeds, the server returns the *public key* in a SPKI
832 like S-Expression like this:
833
834 @example
835      (public-key
836        (rsa
837          (n <mpi>)
838          (e <mpi>)))
839 @end example
840
841 Here is an example session:
842
843 @example
844    C: GENKEY
845    S: INQUIRE KEYPARM
846    C: D (genkey (rsa (nbits  1024)))
847    C: END
848    S: D (public-key
849    S: D   (rsa (n 326487324683264) (e 10001)))
850    S  OK key created
851 @end example
852
853 @node Agent IMPORT
854 @subsection Importing a Secret Key
855
856 This operation is not yet supportted by GpgAgent.  Specialized tools
857 are to be used for this.
858
859 There is no actual need because we can expect that secret keys
860 created by a 3rd party are stored on a smartcard.  If we have
861 generated the key ourself, we do not need to import it.
862
863 @node Agent EXPORT
864 @subsection Export a Secret Key
865
866 Not implemented.
867
868 Should be done by an extra tool.
869
870 @node Agent ISTRUSTED
871 @subsection Importing a Root Certificate
872
873 Actually we do not import a Root Cert but provide a way to validate
874 any piece of data by storing its Hash along with a description and
875 an identifier in the PSE.  Here is the interface desription:
876
877 @example
878     ISTRUSTED <fingerprint>
879 @end example
880
881 Check whether the OpenPGP primary key or the X.509 certificate with the
882 given fingerprint is an ultimately trusted key or a trusted Root CA
883 certificate.  The fingerprint should be given as a hexstring (without
884 any blanks or colons or whatever in between) and may be left padded with
885 00 in case of an MD5 fingerprint.  GPGAgent will answer with:
886
887 @example
888     OK
889 @end example
890
891 The key is in the table of trusted keys.
892
893 @example
894     ERR 304 (Not Trusted)
895 @end example
896
897 The key is not in this table.
898
899 Gpg needs the entire list of trusted keys to maintain the web of
900 trust; the following command is therefore quite helpful:
901
902 @example
903     LISTTRUSTED
904 @end example
905
906 GpgAgent returns a list of trusted keys line by line:
907
908 @example
909     S: D 000000001234454556565656677878AF2F1ECCFF P
910     S: D 340387563485634856435645634856438576457A P
911     S: D FEDC6532453745367FD83474357495743757435D S
912     S: OK
913 @end example
914
915 The first item on a line is the hexified fingerprint where MD5
916 ingerprints are @code{00} padded to the left and the second item is a
917 flag to indicate the type of key (so that gpg is able to only take care
918 of PGP keys).  P = OpenPGP, S = S/MIME.  A client should ignore the rest
919 of the line, so that we can extend the format in the future.
920
921 Finally a client should be able to mark a key as trusted:
922
923 @example
924    MARKTRUSTED @var{fingerprint} "P"|"S"
925 @end example
926
927 The server will then pop up a window to ask the user whether she
928 really trusts this key. For this it will probably ask for a text to
929 be displayed like this:
930
931 @example
932    S: INQUIRE TRUSTDESC
933    C: D Do you trust the key with the fingerprint @@FPR@@
934    C: D bla fasel blurb.
935    C: END
936    S: OK
937 @end example
938
939 Known sequences with the pattern @@foo@@ are replaced according to this
940 table:
941
942 @table @code
943 @item @@FPR16@@ 
944 Format the fingerprint according to gpg rules for a v3 keys.
945 @item @@FPR20@@ 
946 Format the fingerprint according to gpg rules for a v4 keys.
947 @item @@FPR@@
948 Choose an appropriate format to format the fingerprint.
949 @item @@@@ 
950 Replaced by a single @code{@@}
951 @end table
952
953 @node Agent GET_PASSPHRASE
954 @subsection Ask for a passphrase
955
956 This function is usually used to ask for a passphrase to be used for
957 conventional encryption, but may also be used by programs which need
958 special handling of passphrases.  This command uses a syntax which helps
959 clients to use the agent with minimum effort.
960
961 @example
962   GET_PASSPHRASE @var{cache_id} [@var{error_message} @var{prompt} @var{description}]
963 @end example
964
965 @var{cache_id} is expected to be a hex string used for caching a
966 passphrase.  Use a @code{X} to bypass the cache.  With no other
967 arguments the agent returns a cached passphrase or an error.
968   
969 @var{error_message} is either a single @code{X} for no error message or
970 a string to be shown as an error message like (e.g. "invalid
971 passphrase").  Blanks must be percent escaped or replaced by @code{+}'.
972
973 @var{prompt} is either a single @code{X} for a default prompt or the
974 text to be shown as the prompt.  Blanks must be percent escaped or
975 replaced by @code{+}.
976
977 @var{description} is a text shown above the entry field.  Blanks must be
978 percent escaped or replaced by @code{+}.
979
980 The agent either returns with an error or with a OK followed by the 
981 hex encoded passphrase.  Note that the length of the strings is
982 implicitly limited by the maximum length of a command.
983
984 @example
985   CLEAR_PASSPHRASE @var{cache_id}
986 @end example
987
988 may be used to invalidate the cache entry for a passphrase.  The
989 function returns with OK even when there is no cached passphrase.
990
991
992 @node Agent GET_CONFIRMATION
993 @subsection Ask for confirmation
994
995 This command may be used to ask for a simple confirmation by
996 presenting a text and 2 bottonts: Okay and Cancel.
997
998 @example
999   GET_CONFIRMATION @var{description}
1000 @end example
1001
1002 @var{description}is displayed along with a Okay and Cancel
1003 button. Blanks must be percent escaped or replaced by @code{+}.  A
1004 @code{X} may be used to display confirmation dialog with a default
1005 text.
1006
1007 The agent either returns with an error or with a OK.  Note, that the
1008 length of @var{description} is implicitly limited by the maximum
1009 length of a command.
1010
1011
1012
1013 @node Agent HAVEKEY
1014 @subsection Check whether a key is available
1015
1016 This can be used to see whether a secret key is available.  It does
1017 not return any information on whether the key is somehow protected.
1018
1019 @example
1020   HAVEKEY @var{keygrip}
1021 @end example
1022
1023 The Agent answers either with OK or @code{No_Secret_Key} (208).  The
1024 caller may want to check for other error codes as well.
1025
1026
1027 @node Agent LEARN
1028 @subsection Register a smartcard
1029
1030 @example
1031   LEARN [--send]
1032 @end example
1033
1034 This command is used to register a smartcard.  With the --send
1035 option given the certificates are send back.
1036
1037
1038 @node Agent PASSWD
1039 @subsection Change a Passphrase
1040
1041 @example
1042   PASSWD @var{keygrip}
1043 @end example
1044
1045 This command is used to interactively change the passphrase of the key
1046 indentified by the hex string @var{keygrip}.
1047
1048
1049 @node Agent UPDATESTARTUPTTY
1050 @subsection Change the standard display
1051
1052 @example
1053   UPDATESTARTUPTTY
1054 @end example
1055
1056 Set the startup TTY and X-DISPLAY variables to the values of this
1057 session.  This command is useful to direct future pinentry invocations
1058 to another screen.  It is only required because there is no way in the
1059 ssh-agent protocol to convey this information.