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