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