Fixed agent access for gpg.
[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 It is possible to add further flags after the @code{S} for use by the
483 caller.  The only flag currently defined is @code{relax} to relax
484 checking of some root certificate requirements.
485
486 As a special feature a line @code{include-default} will include a global
487 list of trusted certificates (e.g. @file{/etc/gnupg/trustlist.txt}).
488 This global list is also used if the local list ios not available.
489
490   
491 @item sshcontrol
492
493   This file is used when support for the secure shell agent protocol has
494   been enabled (@pxref{option --enable-ssh-support}). Only keys present in
495   this file are used in the SSH protocol.  The @command{ssh-add} tool y be
496   used to add new entries to this file; you may also add them manually.
497   Comment lines, indicated by a leading hash mark, as well as empty lines
498   are ignored.  An entry starts with optional white spaces, followed by
499   the keygrip of the key given as 40 hex digits, optionally followed by
500   the caching TTL in seconds and another optional field for arbitrary
501   flags.  A @code{!} may be prepended to the keygrip to disable this
502   entry.
503     
504   The follwoing example lists exactly one key.  Note that keys available
505   through a OpenPGP smartcard in the active smartcard reader are implictly
506   added to this list; i.e. there is no need to list them.
507   
508   @example
509   # Key added on 2005-02-25 15:08:29
510   5A6592BF45DC73BD876874A28FD4639282E29B52 0
511   @end example
512
513 @item private-keys-v1.d/
514
515   This is the directory where gpg-agent stores the private keys.  Each
516   key is stored in a file with the name made up of the keygrip and the
517   suffix @file{key}.
518
519
520 @end table
521
522 Note that on larger installations, it is useful to put predefined
523 files into the directory @file{/etc/skel/.gnupg/} so that newly created
524 users start up with a working configuration.  For existing users the
525 a small helper script is provied to create these files (@pxref{addgnupghome}).
526
527
528
529 @c
530 @c Agent Signals
531 @c
532 @mansect signals
533 @node Agent Signals
534 @section Use of some signals.
535 A running @command{gpg-agent} may be controlled by signals, i.e. using
536 the @command{kill} command to send a signal to the process. 
537
538 Here is a list of supported signals:
539
540 @table @gnupgtabopt
541
542 @item SIGHUP
543 @cpindex SIGHUP
544 This signal flushes all chached passphrases and if the program has been
545 started with a configuration file, the configuration file is read again.
546 Only certain options are honored: @code{quiet}, @code{verbose},
547 @code{debug}, @code{debug-all}, @code{debug-level}, @code{no-grab},
548 @code{pinentry-program}, @code{default-cache-ttl}, @code{max-cache-ttl},
549 @code{ignore-cache-for-signing}, @code{allow-mark-trusted} and
550 @code{disable-scdaemon}.  @code{scdaemon-program} is also supported but
551 due to the current implementation, which calls the scdaemon only once,
552 it is not of much use unless you manually kill the scdaemon.
553
554
555 @item SIGTERM
556 @cpindex SIGTERM
557 Shuts down the process but waits until all current requests are
558 fulfilled.  If the process has received 3 of these signals and requests
559 are still pending, a shutdown is forced.
560
561 @item SIGINT
562 @cpindex SIGINT
563 Shuts down the process immediately.
564
565 @item SIGUSR1
566 @cpindex SIGUSR1
567 Dump internal information to the log file.
568
569 @item SIGUSR2
570 @cpindex SIGUSR2
571 This signal is used for internal purposes.
572
573 @end table
574
575 @c 
576 @c  Examples
577 @c
578 @mansect examples
579 @node Agent Examples
580 @section Examples
581
582 The usual way to invoke @command{gpg-agent} is
583
584 @example
585 $ eval `gpg-agent --daemon`
586 @end example
587
588 An alternative way is by replacing @command{ssh-agent} with
589 @command{gpg-agent}.  If for example @command{ssh-agent} is started as
590 part of the Xsession intialization you may simply replace
591 @command{ssh-agent} by a script like:
592
593 @cartouche
594 @example
595 #!/bin/sh
596
597 exec /usr/local/bin/gpg-agent --enable-ssh-support --daemon \
598       --write-env-file $@{HOME@}/.gpg-agent-info "$@@"
599 @end example
600 @end cartouche
601
602 @noindent
603 and add something like (for Bourne shells)
604
605 @cartouche
606 @example
607   if [ -f "$@{HOME@}/.gpg-agent-info" ]; then
608     . "$@{HOME@}/.gpg-agent-info"
609     export GPG_AGENT_INFO
610     export SSH_AUTH_SOCK
611     export SSH_AGENT_PID
612   fi
613 @end example
614 @end cartouche
615
616 @noindent
617 to your shell initialization file (e.g. @file{~/.bashrc}).
618
619 @c 
620 @c  Assuan Protocol
621 @c
622 @manpause
623 @node Agent Protocol
624 @section Agent's Assuan Protocol
625
626 Note: this section does only document the protocol, which is used by
627 GnuPG components; it does not deal with the ssh-agent protocol.
628
629 The @command{gpg-agent} should be started by the login shell and set an
630 environment variable to tell clients about the socket to be used.
631 Clients should deny to access an agent with a socket name which does
632 not match its own configuration.  An application may choose to start
633 an instance of the gpgagent if it does not figure that any has been
634 started; it should not do this if a gpgagent is running but not
635 usable.  Because @command{gpg-agent} can only be used in background mode, no
636 special command line option is required to activate the use of the
637 protocol.
638
639 To identify a key we use a thing called keygrip which is the SHA-1 hash
640 of an canoncical encoded S-Expression of the the public key as used in
641 Libgcrypt.  For the purpose of this interface the keygrip is given as a
642 hex string.  The advantage of using this and not the hash of a
643 certificate is that it will be possible to use the same keypair for
644 different protocols, thereby saving space on the token used to keep the
645 secret keys.
646
647 @menu
648 * Agent PKDECRYPT::       Decrypting a session key
649 * Agent PKSIGN::          Signing a Hash
650 * Agent GENKEY::          Generating a Key
651 * Agent IMPORT::          Importing a Secret Key
652 * Agent EXPORT::          Exporting a Secret Key
653 * Agent ISTRUSTED::       Importing a Root Certificate
654 * Agent GET_PASSPHRASE::  Ask for a passphrase
655 * Agent GET_CONFIRMATION:: Ask for confirmation
656 * Agent HAVEKEY::         Check whether a key is available
657 * Agent LEARN::           Register a smartcard
658 * Agent PASSWD::          Change a Passphrase
659 * Agent UPDATESTARTUPTTY:: Change the Standard Display
660 @end menu
661
662 @node Agent PKDECRYPT
663 @subsection Decrypting a session key
664
665 The client asks the server to decrypt a session key.  The encrypted
666 session key should have all information needed to select the
667 appropriate secret key or to delegate it to a smartcard.
668
669 @example
670   SETKEY <keyGrip>
671 @end example
672
673 Tell the server about the key to be used for decryption.  If this is
674 not used, @command{gpg-agent} may try to figure out the key by trying to
675 decrypt the message with each key available.
676
677 @example
678   PKDECRYPT
679 @end example
680
681 The agent checks whether this command is allowed and then does an
682 INQUIRY to get the ciphertext the client should then send the cipher
683 text.
684
685 @example
686     S: INQUIRE CIPHERTEXT
687     C: D (xxxxxx
688     C: D xxxx)
689     C: END
690 @end example
691     
692 Please note that the server may send status info lines while reading the
693 data lines from the client.  The data send is a SPKI like S-Exp with
694 this structure:
695
696 @example
697      (enc-val   
698        (<algo>
699          (<param_name1> <mpi>)
700            ...
701          (<param_namen> <mpi>)))
702 @end example
703
704 Where algo is a string with the name of the algorithm; see the libgcrypt
705 documentation for a list of valid algorithms.  The number and names of
706 the parameters depend on the algorithm.  The agent does return an error
707 if there is an inconsistency.
708
709 If the decryption was successful the decrypted data is returned by
710 means of "D" lines. 
711
712 Here is an example session:
713
714 @example
715    C: PKDECRYPT
716    S: INQUIRE CIPHERTEXT
717    C: D (enc-val elg (a 349324324) 
718    C: D    (b 3F444677CA)))
719    C: END
720    S: # session key follows
721    S: D (value 1234567890ABCDEF0)
722    S: OK descryption successful
723 @end example         
724
725
726 @node Agent PKSIGN
727 @subsection Signing a Hash
728
729 The client ask the agent to sign a given hash value.  A default key
730 will be chosen if no key has been set.  To set a key a client first
731 uses:
732
733 @example
734    SIGKEY <keyGrip>
735 @end example
736
737 This can be used multiple times to create multiple signature, the list
738 of keys is reset with the next PKSIGN command or a RESET.  The server
739 test whether the key is a valid key to sign something and responds with
740 okay.
741
742 @example
743    SETHASH <hexstring>
744 @end example
745
746 The client can use this command to tell the server about the data
747 (which usually is a hash) to be signed.  
748
749 The actual signing is done using
750
751 @example
752    PKSIGN <options>
753 @end example
754
755 Options are not yet defined, but my later be used to choosen among
756 different algorithms (e.g. pkcs 1.5)
757
758 The agent does then some checks, asks for the passphrase and
759 if SETHASH has not been used asks the client for the data to sign:
760
761 @example
762    S: INQUIRE HASHVAL
763    C: D ABCDEF012345678901234
764    C: END
765 @end example
766
767 As a result the server returns the signature as an SPKI like S-Exp
768 in "D" lines:
769
770 @example  
771      (sig-val   
772        (<algo>
773          (<param_name1> <mpi>)
774            ...
775          (<param_namen> <mpi>)))
776 @end example
777
778
779 The operation is affected by the option
780
781 @example
782    OPTION use-cache-for-signing=0|1
783 @end example
784
785 The default of @code{1} uses the cache.  Setting this option to @code{0}
786 will lead @command{gpg-agent} to ignore the passphrase cache.  Note, that there is
787 also a global command line option for @command{gpg-agent} to globally disable the
788 caching.
789
790
791 Here is an example session:
792
793 @example
794    C: SIGKEY <keyGrip>
795    S: OK key available
796    C: SIGKEY <keyGrip>
797    S: OK key available
798    C: PKSIGN
799    S: # I did ask the user whether he really wants to sign
800    S: # I did ask the user for the passphrase
801    S: INQUIRE HASHVAL
802    C: D ABCDEF012345678901234
803    C: END
804    S: # signature follows
805    S: D (sig-val rsa (s 45435453654612121212))
806    S: OK
807 @end example
808
809
810 @node Agent GENKEY
811 @subsection Generating a Key
812
813 This is used to create a new keypair and store the secret key inside the
814 active PSE -w which is in most cases a Soft-PSE.  An not yet defined
815 option allows to choose the storage location.  To get the secret key out
816 of the PSE, a special export tool has to be used.
817
818 @example
819    GENKEY 
820 @end example
821
822 Invokes the key generation process and the server will then inquire
823 on the generation parameters, like:
824
825 @example
826    S: INQUIRE KEYPARM
827    C: D (genkey (rsa (nbits  1024)))
828    C: END
829 @end example
830
831 The format of the key parameters which depends on the algorithm is of
832 the form:
833
834 @example
835     (genkey
836       (algo
837         (parameter_name_1 ....)
838           ....
839         (parameter_name_n ....)))
840 @end example
841
842 If everything succeeds, the server returns the *public key* in a SPKI
843 like S-Expression like this:
844
845 @example
846      (public-key
847        (rsa
848          (n <mpi>)
849          (e <mpi>)))
850 @end example
851
852 Here is an example session:
853
854 @example
855    C: GENKEY
856    S: INQUIRE KEYPARM
857    C: D (genkey (rsa (nbits  1024)))
858    C: END
859    S: D (public-key
860    S: D   (rsa (n 326487324683264) (e 10001)))
861    S  OK key created
862 @end example
863
864 @node Agent IMPORT
865 @subsection Importing a Secret Key
866
867 This operation is not yet supportted by GpgAgent.  Specialized tools
868 are to be used for this.
869
870 There is no actual need because we can expect that secret keys
871 created by a 3rd party are stored on a smartcard.  If we have
872 generated the key ourself, we do not need to import it.
873
874 @node Agent EXPORT
875 @subsection Export a Secret Key
876
877 Not implemented.
878
879 Should be done by an extra tool.
880
881 @node Agent ISTRUSTED
882 @subsection Importing a Root Certificate
883
884 Actually we do not import a Root Cert but provide a way to validate
885 any piece of data by storing its Hash along with a description and
886 an identifier in the PSE.  Here is the interface desription:
887
888 @example
889     ISTRUSTED <fingerprint>
890 @end example
891
892 Check whether the OpenPGP primary key or the X.509 certificate with the
893 given fingerprint is an ultimately trusted key or a trusted Root CA
894 certificate.  The fingerprint should be given as a hexstring (without
895 any blanks or colons or whatever in between) and may be left padded with
896 00 in case of an MD5 fingerprint.  GPGAgent will answer with:
897
898 @example
899     OK
900 @end example
901
902 The key is in the table of trusted keys.
903
904 @example
905     ERR 304 (Not Trusted)
906 @end example
907
908 The key is not in this table.
909
910 Gpg needs the entire list of trusted keys to maintain the web of
911 trust; the following command is therefore quite helpful:
912
913 @example
914     LISTTRUSTED
915 @end example
916
917 GpgAgent returns a list of trusted keys line by line:
918
919 @example
920     S: D 000000001234454556565656677878AF2F1ECCFF P
921     S: D 340387563485634856435645634856438576457A P
922     S: D FEDC6532453745367FD83474357495743757435D S
923     S: OK
924 @end example
925
926 The first item on a line is the hexified fingerprint where MD5
927 ingerprints are @code{00} padded to the left and the second item is a
928 flag to indicate the type of key (so that gpg is able to only take care
929 of PGP keys).  P = OpenPGP, S = S/MIME.  A client should ignore the rest
930 of the line, so that we can extend the format in the future.
931
932 Finally a client should be able to mark a key as trusted:
933
934 @example
935    MARKTRUSTED @var{fingerprint} "P"|"S"
936 @end example
937
938 The server will then pop up a window to ask the user whether she
939 really trusts this key. For this it will probably ask for a text to
940 be displayed like this:
941
942 @example
943    S: INQUIRE TRUSTDESC
944    C: D Do you trust the key with the fingerprint @@FPR@@
945    C: D bla fasel blurb.
946    C: END
947    S: OK
948 @end example
949
950 Known sequences with the pattern @@foo@@ are replaced according to this
951 table:
952
953 @table @code
954 @item @@FPR16@@ 
955 Format the fingerprint according to gpg rules for a v3 keys.
956 @item @@FPR20@@ 
957 Format the fingerprint according to gpg rules for a v4 keys.
958 @item @@FPR@@
959 Choose an appropriate format to format the fingerprint.
960 @item @@@@ 
961 Replaced by a single @code{@@}
962 @end table
963
964 @node Agent GET_PASSPHRASE
965 @subsection Ask for a passphrase
966
967 This function is usually used to ask for a passphrase to be used for
968 conventional encryption, but may also be used by programs which need
969 special handling of passphrases.  This command uses a syntax which helps
970 clients to use the agent with minimum effort.
971
972 @example
973   GET_PASSPHRASE [--data] @var{cache_id} [@var{error_message} @var{prompt} @var{description}]
974 @end example
975
976 @var{cache_id} is expected to be a string used to identify a cached
977 passphrase.  Use a @code{X} to bypass the cache.  With no other
978 arguments the agent returns a cached passphrase or an error.  By
979 convention either the hexified fingerprint of the key shall be used for
980 @var{cache_id} or an arbitrary string prefixed with the name of the
981 calling application and a colon: Like @code{gpg:somestring}.
982   
983 @var{error_message} is either a single @code{X} for no error message or
984 a string to be shown as an error message like (e.g. "invalid
985 passphrase").  Blanks must be percent escaped or replaced by @code{+}'.
986
987 @var{prompt} is either a single @code{X} for a default prompt or the
988 text to be shown as the prompt.  Blanks must be percent escaped or
989 replaced by @code{+}.
990
991 @var{description} is a text shown above the entry field.  Blanks must be
992 percent escaped or replaced by @code{+}.
993
994 The agent either returns with an error or with a OK followed by the hex
995 encoded passphrase.  Note that the length of the strings is implicitly
996 limited by the maximum length of a command.  If the option
997 @option{--data} is used, the passphrase is not returned on the OK line
998 but by regular data lines; this is the preferred method.
999
1000 @example
1001   CLEAR_PASSPHRASE @var{cache_id}
1002 @end example
1003
1004 may be used to invalidate the cache entry for a passphrase.  The
1005 function returns with OK even when there is no cached passphrase.
1006
1007
1008 @node Agent GET_CONFIRMATION
1009 @subsection Ask for confirmation
1010
1011 This command may be used to ask for a simple confirmation by
1012 presenting a text and 2 bottonts: Okay and Cancel.
1013
1014 @example
1015   GET_CONFIRMATION @var{description}
1016 @end example
1017
1018 @var{description}is displayed along with a Okay and Cancel
1019 button. Blanks must be percent escaped or replaced by @code{+}.  A
1020 @code{X} may be used to display confirmation dialog with a default
1021 text.
1022
1023 The agent either returns with an error or with a OK.  Note, that the
1024 length of @var{description} is implicitly limited by the maximum
1025 length of a command.
1026
1027
1028
1029 @node Agent HAVEKEY
1030 @subsection Check whether a key is available
1031
1032 This can be used to see whether a secret key is available.  It does
1033 not return any information on whether the key is somehow protected.
1034
1035 @example
1036   HAVEKEY @var{keygrip}
1037 @end example
1038
1039 The Agent answers either with OK or @code{No_Secret_Key} (208).  The
1040 caller may want to check for other error codes as well.
1041
1042
1043 @node Agent LEARN
1044 @subsection Register a smartcard
1045
1046 @example
1047   LEARN [--send]
1048 @end example
1049
1050 This command is used to register a smartcard.  With the --send
1051 option given the certificates are send back.
1052
1053
1054 @node Agent PASSWD
1055 @subsection Change a Passphrase
1056
1057 @example
1058   PASSWD @var{keygrip}
1059 @end example
1060
1061 This command is used to interactively change the passphrase of the key
1062 indentified by the hex string @var{keygrip}.
1063
1064
1065 @node Agent UPDATESTARTUPTTY
1066 @subsection Change the standard display
1067
1068 @example
1069   UPDATESTARTUPTTY
1070 @end example
1071
1072 Set the startup TTY and X-DISPLAY variables to the values of this
1073 session.  This command is useful to direct future pinentry invocations
1074 to another screen.  It is only required because there is no way in the
1075 ssh-agent protocol to convey this information.
1076
1077
1078 @mansect see also
1079 @ifset isman
1080 @command{gpg2}(1), 
1081 @command{gpgsm}(1), 
1082 @command{gpg-connect-agent}(1),
1083 @command{scdaemon}(1)
1084 @end ifset
1085 @include see-also-note.texi