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