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