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