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