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