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