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