* call-scd.c (start_scd): Send event-signal option. Always check
[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 @c man begin DESCRIPTION
12
13 @sc{gpg-agent} is a daemon to manage secret (private) keys independelty
14 from any protocol.  It is used as a backend for @sc{gpg} and @sc{gpgsm}
15 as well as for a couple of other utilities.
16
17 @noindent
18 The usual way to run the agent is from the @code{~/.xsession} file:
19
20 @example
21 eval `gpg-agent --daemon`
22 @end example
23
24 @noindent
25 If you don't use an X server, you can also put this into your regular
26 startup file @code{~/.profile} or @code{.bash_profile}.  It is best not
27 to run multiple instance of the gpg-agent, so you should make sure that
28 only is running:  @sc{gpg-agent} uses an environment variable to inform
29 clients about the communication parameters. You can write the
30 content of this environment variable to a file so that you can test for
31 a running agent.  This short script may do the job:
32
33 @smallexample
34 if test -f $HOME/.gpg-agent-info && \
35    kill -0 `cut -d: -f 2 $HOME/.gpg-agent-info` 2>/dev/null; then
36      GPG_AGENT_INFO=`cat $HOME/.gpg-agent-info`
37      export GPG_AGENT_INFO   
38 else
39      eval `gpg-agent --daemon`
40      echo $GPG_AGENT_INFO >$HOME/.gpg-agent-info
41 fi
42 @end smallexample
43
44 @noindent
45 If you want to use a curses based pinentry (which is usually also the
46 fallback mode for a GUI based pinentry), you should add these lines to
47 your @code{.bashrc} or whatever initialization file is used for all shell
48 invocations:
49
50 @smallexample
51 GPG_TTY=`tty`
52 export GPG_TTY
53 @end smallexample
54
55 It is important that this environment variable always reflects the
56 output of the @code{tty} command.
57
58 @c man end
59
60 @noindent
61 @xref{Option Index}, for an index to GPG-AGENTS's commands and options.
62
63 @menu
64 * Agent Commands::      List of all commands.
65 * Agent Options::       List of all options.
66 * Agent Signals::       Use of some signals.
67 * Agent Examples::      Some usage examples.
68 * Agent Protocol::      The protocol the agent uses.
69 @end menu
70
71 @c man begin COMMANDS
72
73 @node Agent Commands
74 @section Commands
75
76 Commands are not distinguished from options execpt for the fact that
77 only one one command is allowed.
78
79 @table @gnupgtabopt
80 @item --version
81 @opindex version
82 Print the program version and licensing information.  Not that you can
83 abbreviate this command.
84
85 @item --help, -h
86 @opindex help
87 Print a usage message summarizing the most usefule command-line options.
88 Not that you can abbreviate this command.
89
90 @item --dump-options
91 @opindex dump-options
92 Print a list of all available options and commands.  Not that you can
93 abbreviate this command.
94
95 @item --server
96 @opindex server
97 Run in server mode and wait for commands on the @code{stdin}.  The
98 default mode is to create a socket and listen for commands there.
99
100 @item --daemon
101 @opindex daemon
102 Run the program in the background.  This option is required to prevent
103 it from being accidently running in the background.  A common way to do
104 this is:
105 @example
106 @end example
107 $ eval `gpg-agent --daemon`
108 @end table
109
110
111 @c man begin OPTIONS
112
113 @node Agent Options
114 @section Option Summary
115
116 @table @gnupgtabopt
117
118 @item --options @var{file}
119 @opindex options
120 Reads configuration from @var{file} instead of from the default
121 per-user configuration file.  The default configuration file is named
122 @file{gpg-agent.conf} and expected in the @file{.gnupg} directory directly
123 below the home directory of the user.
124
125 @item -v
126 @item --verbose
127 @opindex v
128 @opindex verbose
129 Outputs additional information while running.
130 You can increase the verbosity by giving several
131 verbose commands to @sc{gpgsm}, such as @samp{-vv}.
132
133 @item -q
134 @item --quiet
135 @opindex q
136 @opindex quiet
137 Try to be as quiet as possible.
138
139 @item --batch
140 @opindex batch
141 Don't invoke a pinentry or do any other thing requiring human interaction.
142
143 @item --faked-system-time @var{epoch}
144 @opindex faked-system-time
145 This option is only useful for testing; it sets the system time back or
146 forth to @var{epoch} which is the number of seconds elapsed since the year
147 1970.
148
149 @item --debug-level @var{level}
150 @opindex debug-level
151 Select the debug level for investigating problems. @var{level} may be
152 one of:
153
154    @table @code
155    @item none
156    no debugging at all.
157    @item basic  
158    some basic debug messages
159    @item advanced
160    more verbose debug messages
161    @item expert
162    even more detailed messages
163    @item guru
164    all of the debug messages you can get
165    @end table
166
167 How these messages are mapped to the actual debugging flags is not
168 specified and may change with newer releaes of this program. They are
169 however carefully selected to best aid in debugging.
170
171 @item --debug @var{flags}
172 @opindex debug
173 This option is only useful for debugging and the behaviour may change at
174 any time without notice.  FLAGS are bit encoded and may be given in
175 usual C-Syntax. The currently defined bits are:
176
177    @table @code
178    @item 0  (1)
179    X.509 or OpenPGP protocol related data
180    @item 1  (2)  
181    values of big number integers 
182    @item 2  (4)
183    low level crypto operations
184    @item 5  (32)
185    memory allocation
186    @item 6  (64)
187    caching
188    @item 7  (128)
189    show memory statistics.
190    @item 9  (512)
191    write hashed data to files named @code{dbgmd-000*}
192    @item 10 (1024)
193    trace Assuan protocol
194    @item 12 (4096)
195    bypass all certificate validation
196    @end table
197
198 @item --debug-all
199 @opindex debug-all
200 Same as @code{--debug=0xffffffff}
201
202 @item --debug-wait @var{n}
203 @opindex debug-wait
204 When running in server mode, wait @var{n} seconds before entering the
205 actual processing loop and print the pid.  This gives time to attach a
206 debugger.
207
208 @item --no-detach
209 @opindex no-detach
210 Don't detach the process from the console.  This is manly usefule for
211 debugging.
212
213 @item -s
214 @itemx --sh
215 @itemx -c
216 @itemx --csh
217 @opindex s
218 @opindex sh
219 @opindex c
220 @opindex csh
221 Format the info output in daemon mode for use with the standard Bourne
222 shell respective the C-shell . The default ist to guess it based on the
223 environment variable @code{SHELL} which is in almost all cases
224 sufficient.
225
226 @item --no-grab
227 @opindex no-grab
228 Tell the pinentryo not to grab the keyboard and mouse.  This option
229 should in general not be used to avaoid X-sniffing attacks.
230
231 @item --log-file @var{file}
232 @opindex log-file
233 Append all logging output to @var{file}.  This is very helpful in
234 seeing what the agent actually does.
235
236 @item --disable-pth
237 @opindex disable-pth
238 Don't allow multiple connections.  This option is in general not very
239 useful. 
240
241 @item --ignore-cache-for-signing
242 @opindex ignore-cache-for-signing
243 This option will let gpg-agent bypass the passphrase cache for all
244 signing operation.  Note that there is also a per-session option to
245 control this behaviour but this command line option takes precedence.
246
247 @item --default-cache-ttl @var{n}
248 @opindex default-cache-ttl
249 Set the time a cache entry is valid to @var{n} seconds.  The default are
250 600 seconds.
251
252 @item --pinentry-program @var{filename}
253 @opindex pinentry-program
254 Use program @var{filename} as the PIN entry.  The default is installation
255 dependend and can be shown with the @code{--version} command.
256
257 @item --scdaemon-program @var{filename}
258 @opindex scdaemon-program
259 Use program @var{filename} as the Smartcard daemon.  The default is
260 installation dependend and can be shown with the @code{--version}
261 command.
262
263
264 @item --display @var{string}
265 @itemx --ttyname @var{string}
266 @itemx --ttytype @var{string}
267 @itemx --lc-type @var{string}
268 @itemx --lc-messages @var{string}
269 @opindex display 
270 @opindex ttyname 
271 @opindex ttytype 
272 @opindex lc-type 
273 @opindex lc-messa
274 These options are used with the server mode to pass localization
275 information.
276
277 @item --keep-tty
278 @itemx --keep-display
279 @opindex keep-tty
280 @opindex keep-display
281 Ignore requests to change change the current @sc{tty} respective the X
282 window system's @code{DISPLAY} variable.  This is useful to lock the
283 pinentry to pop up at the @sc{tty} or display you started the agent.
284
285
286 @end table
287
288 All the long options may also be given in the configuration file after
289 stripping off the two leading dashes.
290
291 @c
292 @c Agent Signals
293 @c
294 @node Agent Signals
295 @section Use of some signals.
296 A running @command{gpg-agent} may be controlled by signals, i.e. using
297 the @command{kill} command to send a signal to the process. 
298
299 Here is a list of supported signals:
300
301 @table @gnupgtabopt
302
303 @item SIGHUP
304 @cpindex SIGHUP
305 This signals flushes all chached passphrases and when the program was
306 started with a configuration file, the configuration file is read again.
307 Only certain options are honored: @code{quiet}, @code{verbose},
308 @code{debug}, @code{debug-all}, @code{no-grab}, @code{pinentry-program},
309 @code{default-cache-ttl} and @code{ignore-cache-for-signing}.
310 @code{scdaemon-program} is also supported but due to the current
311 implementation, which calls the scdaemon only once, it is not of much
312 use.
313
314
315 @item SIGTERM
316 @cpindex SIGTERM
317 Shuts down the process but waits until all current requests are
318 fulfilled.  If the process has received 3 of these signals and requests
319 are still pending, a shutdown is forced.
320
321 @item SIGINT
322 @cpindex SIGINT
323 Shuts down the process immediately.
324
325
326 @item SIGUSR1
327 @itemx SIGUSR2
328 @cpindex SIGUSR1
329 @cpindex SIGUSR2
330 These signals are used for internal purposes.
331
332 @end table
333
334 @c 
335 @c  Examples
336 @c
337 @node Agent Examples
338 @section Examples
339
340 @c man begin EXAMPLES
341
342 @example
343 $ eval `gpg-agent --daemon`
344 @end example
345
346 @c man end
347
348
349 @c 
350 @c  Assuan Protocol
351 @c
352 @node Agent Protocol
353 @section Agent's Assuan Protocol
354
355 The gpg-agent should be started by the login shell and set an
356 environment variable to tell clients about the socket to be used.
357 Clients should deny to access an agent with a socket name which does
358 not match its own configuration.  An application may choose to start
359 an instance of the gpgagent if it does not figure that any has been
360 started; it should not do this if a gpgagent is running but not
361 usable.  Because gpg-agent can only be used in background mode, no
362 special command line option is required to activate the use of the
363 protocol.
364
365 To identify a key we use a thing called keygrip which is the SHA-1 hash
366 of an canoncical encoded S-Expression of the the public key as used in
367 Libgcrypt.  For the purpose of this interface the keygrip is given as a
368 hex string.  The advantage of using this and not the hash of a
369 certificate is that it will be possible to use the same keypair for
370 different protocols, thereby saving space on the token used to keep the
371 secret keys.
372
373 @menu
374 * Agent PKDECRYPT::       Decrypting a session key
375 * Agent PKSIGN::          Signing a Hash
376 * Agent GENKEY::          Generating a Key
377 * Agent IMPORT::          Importing a Secret Key
378 * Agent EXPORT::          Exporting a Secret Key
379 * Agent ISTRUSTED::       Importing a Root Certificate
380 * Agent GET_PASSPHRASE::  Ask for a passphrase
381 * Agent GET_CONFIRMATION:: Ask for confirmation
382 * Agent HAVEKEY::         Check whether a key is available
383 * Agent LEARN::           Register a smartcard
384 * Agent PASSWD::          Change a Passphrase
385 @end menu
386
387 @node Agent PKDECRYPT
388 @subsection Decrypting a session key
389
390 The client asks the server to decrypt a session key.  The encrypted
391 session key should have all information needed to select the
392 appropriate secret key or to delegate it to a smartcard.
393
394 @example
395   SETKEY <keyGrip>
396 @end example
397
398 Tell the server about the key to be used for decryption.  If this is
399 not used, gpg-agent may try to figure out the key by trying to
400 decrypt the message with each key available.
401
402 @example
403   PKDECRYPT
404 @end example
405
406 The agent checks whether this command is allowed and then does an
407 INQUIRY to get the ciphertext the client should then send the cipher
408 text.
409
410 @example
411     S: INQUIRE CIPHERTEXT
412     C: D (xxxxxx
413     C: D xxxx)
414     C: END
415 @end example
416     
417 Please note that the server may send status info lines while reading the
418 data lines from the client.  The data send is a SPKI like S-Exp with
419 this structure:
420
421 @example
422      (enc-val   
423        (<algo>
424          (<param_name1> <mpi>)
425            ...
426          (<param_namen> <mpi>)))
427 @end example
428
429 Where algo is a string with the name of the algorithm; see the libgcrypt
430 documentation for a list of valid algorithms.  The number and names of
431 the parameters depend on the algorithm.  The agent does return an error
432 if there is an inconsistency.
433
434 If the decryption was successful the decrypted data is returned by
435 means of "D" lines. 
436
437 Here is an example session:
438
439 @example
440    C: PKDECRYPT
441    S: INQUIRE CIPHERTEXT
442    C: D (enc-val elg (a 349324324) 
443    C: D    (b 3F444677CA)))
444    C: END
445    S: # session key follows
446    S: D 1234567890ABCDEF0
447    S: OK descryption successful
448 @end example         
449
450
451 @node Agent PKSIGN
452 @subsection Signing a Hash
453
454 The client ask the agent to sign a given hash value.  A default key
455 will be chosen if no key has been set.  To set a key a client first
456 uses:
457
458 @example
459    SIGKEY <keyGrip>
460 @end example
461
462 This can be used multiple times to create multiple signature, the list
463 of keys is reset with the next PKSIGN command or a RESET.  The server
464 test whether the key is a valid key to sign something and responds with
465 okay.
466
467 @example
468    SETHASH <hexstring>
469 @end example
470
471 The client can use this command to tell the server about the data
472 (which usually is a hash) to be signed.  
473
474 The actual signing is done using
475
476 @example
477    PKSIGN <options>
478 @end example
479
480 Options are not yet defined, but my later be used to choosen among
481 different algorithms (e.g. pkcs 1.5)
482
483 The agent does then some checks, asks for the passphrase and
484 if SETHASH has not been used asks the client for the data to sign:
485
486 @example
487    S: INQUIRE HASHVAL
488    C: D ABCDEF012345678901234
489    C: END
490 @end example
491
492 As a result the server returns the signature as an SPKI like S-Exp
493 in "D" lines:
494
495 @example  
496      (sig-val   
497        (<algo>
498          (<param_name1> <mpi>)
499            ...
500          (<param_namen> <mpi>)))
501 @end example
502
503
504 The operation is affected by the option
505
506 @example
507    OPTION use-cache-for-signing=0|1
508 @end example
509
510 The default of @code{1} uses the cache.  Setting this option to @code{0}
511 will lead gpg-agent to ignore the passphrase cache.  Note, that there is
512 also a global command line option for gpg-agent to globally disable the
513 caching.
514
515
516 Here is an example session:
517
518 @example
519    C: SIGKEY <keyGrip>
520    S: OK key available
521    C: SIGKEY <keyGrip>
522    S: OK key available
523    C: PKSIGN
524    S: # I did ask the user whether he really wants to sign
525    S: # I did ask the user for the passphrase
526    S: INQUIRE HASHVAL
527    C: D ABCDEF012345678901234
528    C: END
529    S: # signature follows
530    S: D (sig-val rsa (s 45435453654612121212))
531    S: OK
532 @end example
533
534
535 @node Agent GENKEY
536 @subsection Generating a Key
537
538 This is used to create a new keypair and store the secret key inside the
539 active PSE -w which is in most cases a Soft-PSE.  An not yet defined
540 option allows to choose the storage location.  To get the secret key out
541 of the PSE, a special export tool has to be used.
542
543 @example
544    GENKEY 
545 @end example
546
547 Invokes the key generation process and the server will then inquire
548 on the generation parameters, like:
549
550 @example
551    S: INQUIRE KEYPARM
552    C: D (genkey (rsa (nbits  1024)))
553    C: END
554 @end example
555
556 The format of the key parameters which depends on the algorithm is of
557 the form:
558
559 @example
560     (genkey
561       (algo
562         (parameter_name_1 ....)
563           ....
564         (parameter_name_n ....)))
565 @end example
566
567 If everything succeeds, the server returns the *public key* in a SPKI
568 like S-Expression like this:
569
570 @example
571      (public-key
572        (rsa
573          (n <mpi>)
574          (e <mpi>)))
575 @end example
576
577 Here is an example session:
578
579 @example
580    C: GENKEY
581    S: INQUIRE KEYPARM
582    C: D (genkey (rsa (nbits  1024)))
583    C: END
584    S: D (public-key
585    S: D   (rsa (n 326487324683264) (e 10001)))
586    S  OK key created
587 @end example
588
589 @node Agent IMPORT
590 @subsection Importing a Secret Key
591
592 This operation is not yet supportted by GpgAgent.  Specialized tools
593 are to be used for this.
594
595 There is no actual need because we can expect that secret keys
596 created by a 3rd party are stored on a smartcard.  If we have
597 generated the key ourself, we do not need to import it.
598
599 @node Agent EXPORT
600 @subsection Export a Secret Key
601
602 Not implemented.
603
604 Should be done by an extra tool.
605
606 @node Agent ISTRUSTED
607 @subsection Importing a Root Certificate
608
609 Actually we do not import a Root Cert but provide a way to validate
610 any piece of data by storing its Hash along with a description and
611 an identifier in the PSE.  Here is the interface desription:
612
613 @example
614     ISTRUSTED <fingerprint>
615 @end example
616
617 Check whether the OpenPGP primary key or the X.509 certificate with the
618 given fingerprint is an ultimately trusted key or a trusted Root CA
619 certificate.  The fingerprint should be given as a hexstring (without
620 any blanks or colons or whatever in between) and may be left padded with
621 00 in case of an MD5 fingerprint.  GPGAgent will answer with:
622
623 @example
624     OK
625 @end example
626
627 The key is in the table of trusted keys.
628
629 @example
630     ERR 304 (Not Trusted)
631 @end example
632
633 The key is not in this table.
634
635 Gpg needs the entire list of trusted keys to maintain the web of
636 trust; the following command is therefore quite helpful:
637
638 @example
639     LISTTRUSTED
640 @end example
641
642 GpgAgent returns a list of trusted keys line by line:
643
644 @example
645     S: D 000000001234454556565656677878AF2F1ECCFF P
646     S: D 340387563485634856435645634856438576457A P
647     S: D FEDC6532453745367FD83474357495743757435D S
648     S: OK
649 @end example
650
651 The first item on a line is the hexified fingerprint where MD5
652 ingerprints are @code{00} padded to the left and the second item is a
653 flag to indicate the type of key (so that gpg is able to only take care
654 of PGP keys).  P = OpenPGP, S = S/MIME.  A client should ignore the rest
655 of the line, so that we can extend the format in the future.
656
657 Finally a client should be able to mark a key as trusted:
658
659 @example
660    MARKTRUSTED @var{fingerprint} "P"|"S"
661 @end example
662
663 The server will then pop up a window to ask the user whether she
664 really trusts this key. For this it will probably ask for a text to
665 be displayed like this:
666
667 @example
668    S: INQUIRE TRUSTDESC
669    C: D Do you trust the key with the fingerprint @@FPR@@
670    C: D bla fasel blurb.
671    C: END
672    S: OK
673 @end example
674
675 Known sequences with the pattern @@foo@@ are replaced according to this
676 table:
677
678 @table @code
679 @item @@FPR16@@ 
680 Format the fingerprint according to gpg rules for a v3 keys.
681 @item @@FPR20@@ 
682 Format the fingerprint according to gpg rules for a v4 keys.
683 @item @@FPR@@
684 Choose an appropriate format to format the fingerprint.
685 @item @@@@ 
686 Replaced by a single @code{@@}
687 @end table
688
689 @node Agent GET_PASSPHRASE
690 @subsection Ask for a passphrase
691
692 This function is usually used to ask for a passphrase to be used for
693 conventional encryption, but may also be used by programs which need
694 special handling of passphrases.  This command uses a syntax which helps
695 clients to use the agent with minimum effort.
696
697 @example
698   GET_PASSPHRASE @var{cache_id} [@var{error_message} @var{prompt} @var{description}]
699 @end example
700
701 @var{cache_id} is expected to be a hex string used for caching a
702 passphrase.  Use a @code{X} to bypass the cache.  With no other
703 arguments the agent returns a cached passphrase or an error.
704   
705 @var{error_message} is either a single @code{X} for no error message or
706 a string to be shown as an error message like (e.g. "invalid
707 passphrase").  Blanks must be percent escaped or replaced by @code{+}'.
708
709 @var{prompt} is either a single @code{X} for a default prompt or the
710 text to be shown as the prompt.  Blanks must be percent escaped or
711 replaced by @code{+}.
712
713 @var{description} is a text shown above the entry field.  Blanks must be
714 percent escaped or replaced by @code{+}.
715
716 The agent either returns with an error or with a OK followed by the 
717 hex encoded passphrase.  Note that the length of the strings is
718 implicitly limited by the maximum length of a command.
719
720 @example
721   CLEAR_PASSPHRASE @var{cache_id}
722 @end example
723
724 may be used to invalidate the cache entry for a passphrase.  The
725 function returns with OK even when there is no cached passphrase.
726
727
728 @node Agent GET_CONFIRMATION
729 @subsection Ask for confirmation
730
731 This command may be used to ask for a simple confirmation by
732 presenting a text and 2 bottonts: Okay and Cancel.
733
734 @example
735   GET_CONFIRMATION @var{description}
736 @end example
737
738 @var{description}is displayed along with a Okay and Cancel
739 button. Blanks must be percent escaped or replaced by @code{+}.  A
740 @code{X} may be used to display confirmation dialog with a default
741 text.
742
743 The agent either returns with an error or with a OK.  Note, that the
744 length of @var{description} is implicitly limited by the maximum
745 length of a command.
746
747
748
749 @node Agent HAVEKEY
750 @subsection Check whether a key is available
751
752 This can be used to see whether a secret key is available.  It does
753 not return any information on whether the key is somehow protected.
754
755 @example
756   HAVEKEY @var{keygrip}
757 @end example
758
759 The Agent answers either with OK or @code{No_Secret_Key} (208).  The
760 caller may want to check for other error codes as well.
761
762
763 @node Agent LEARN
764 @subsection Register a smartcard
765
766 @example
767   LEARN [--send]
768 @end example
769
770 This command is used to register a smartcard.  With the --send
771 option given the certificates are send back.
772
773
774 @node Agent PASSWD
775 @subsection Change a Passphrase
776
777 @example
778   PASSWD @var{keygrip}
779 @end example
780
781 This command is used to interactively change the passphrase of the key
782 indentified by the hex string @var{keygrip}.
783
784
785