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