Changed license of the manual stuff to GPL.
[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 --allow-mark-trusted
242 @opindex allow-mark-trusted
243 Allow clients to mark keys as trusted, i.e. put them into the
244 @code{trustlist.txt} file.  This is by default not allowed to make it
245 harder for users to inadvertly accept Root-CA keys.
246
247 @item --ignore-cache-for-signing
248 @opindex ignore-cache-for-signing
249 This option will let gpg-agent bypass the passphrase cache for all
250 signing operation.  Note that there is also a per-session option to
251 control this behaviour but this command line option takes precedence.
252
253 @item --default-cache-ttl @var{n}
254 @opindex default-cache-ttl
255 Set the time a cache entry is valid to @var{n} seconds.  The default are
256 600 seconds.
257
258 @item --max-cache-ttl @var{n}
259 @opindex max-cache-ttl
260 Set the maximum time a cache entry is valid to @var{n} seconds.  After
261 this time a cache entry will get expired even if it has been accessed
262 recently.  The default are 2 hours (7200 seconds).
263
264 @item --pinentry-program @var{filename}
265 @opindex pinentry-program
266 Use program @var{filename} as the PIN entry.  The default is installation
267 dependend and can be shown with the @code{--version} command.
268
269 @item --scdaemon-program @var{filename}
270 @opindex scdaemon-program
271 Use program @var{filename} as the Smartcard daemon.  The default is
272 installation dependend and can be shown with the @code{--version}
273 command.
274
275
276 @item --display @var{string}
277 @itemx --ttyname @var{string}
278 @itemx --ttytype @var{string}
279 @itemx --lc-type @var{string}
280 @itemx --lc-messages @var{string}
281 @opindex display 
282 @opindex ttyname 
283 @opindex ttytype 
284 @opindex lc-type 
285 @opindex lc-messages
286 These options are used with the server mode to pass localization
287 information.
288
289 @item --keep-tty
290 @itemx --keep-display
291 @opindex keep-tty
292 @opindex keep-display
293 Ignore requests to change change the current @sc{tty} respective the X
294 window system's @code{DISPLAY} variable.  This is useful to lock the
295 pinentry to pop up at the @sc{tty} or display you started the agent.
296
297
298 @end table
299
300 All the long options may also be given in the configuration file after
301 stripping off the two leading dashes.
302
303 @c
304 @c Agent Signals
305 @c
306 @node Agent Signals
307 @section Use of some signals.
308 A running @command{gpg-agent} may be controlled by signals, i.e. using
309 the @command{kill} command to send a signal to the process. 
310
311 Here is a list of supported signals:
312
313 @table @gnupgtabopt
314
315 @item SIGHUP
316 @cpindex SIGHUP
317 This signals flushes all chached passphrases and when the program was
318 started with a configuration file, the configuration file is read again.
319 Only certain options are honored: @code{quiet}, @code{verbose},
320 @code{debug}, @code{debug-all}, @code{no-grab}, @code{pinentry-program},
321 @code{default-cache-ttl} and @code{ignore-cache-for-signing}.
322 @code{scdaemon-program} is also supported but due to the current
323 implementation, which calls the scdaemon only once, it is not of much
324 use.
325
326
327 @item SIGTERM
328 @cpindex SIGTERM
329 Shuts down the process but waits until all current requests are
330 fulfilled.  If the process has received 3 of these signals and requests
331 are still pending, a shutdown is forced.
332
333 @item SIGINT
334 @cpindex SIGINT
335 Shuts down the process immediately.
336
337
338 @item SIGUSR1
339 @itemx SIGUSR2
340 @cpindex SIGUSR1
341 @cpindex SIGUSR2
342 These signals are used for internal purposes.
343
344 @end table
345
346 @c 
347 @c  Examples
348 @c
349 @node Agent Examples
350 @section Examples
351
352 @c man begin EXAMPLES
353
354 @example
355 $ eval `gpg-agent --daemon`
356 @end example
357
358 @c man end
359
360
361 @c 
362 @c  Assuan Protocol
363 @c
364 @node Agent Protocol
365 @section Agent's Assuan Protocol
366
367 The gpg-agent should be started by the login shell and set an
368 environment variable to tell clients about the socket to be used.
369 Clients should deny to access an agent with a socket name which does
370 not match its own configuration.  An application may choose to start
371 an instance of the gpgagent if it does not figure that any has been
372 started; it should not do this if a gpgagent is running but not
373 usable.  Because gpg-agent can only be used in background mode, no
374 special command line option is required to activate the use of the
375 protocol.
376
377 To identify a key we use a thing called keygrip which is the SHA-1 hash
378 of an canoncical encoded S-Expression of the the public key as used in
379 Libgcrypt.  For the purpose of this interface the keygrip is given as a
380 hex string.  The advantage of using this and not the hash of a
381 certificate is that it will be possible to use the same keypair for
382 different protocols, thereby saving space on the token used to keep the
383 secret keys.
384
385 @menu
386 * Agent PKDECRYPT::       Decrypting a session key
387 * Agent PKSIGN::          Signing a Hash
388 * Agent GENKEY::          Generating a Key
389 * Agent IMPORT::          Importing a Secret Key
390 * Agent EXPORT::          Exporting a Secret Key
391 * Agent ISTRUSTED::       Importing a Root Certificate
392 * Agent GET_PASSPHRASE::  Ask for a passphrase
393 * Agent GET_CONFIRMATION:: Ask for confirmation
394 * Agent HAVEKEY::         Check whether a key is available
395 * Agent LEARN::           Register a smartcard
396 * Agent PASSWD::          Change a Passphrase
397 @end menu
398
399 @node Agent PKDECRYPT
400 @subsection Decrypting a session key
401
402 The client asks the server to decrypt a session key.  The encrypted
403 session key should have all information needed to select the
404 appropriate secret key or to delegate it to a smartcard.
405
406 @example
407   SETKEY <keyGrip>
408 @end example
409
410 Tell the server about the key to be used for decryption.  If this is
411 not used, gpg-agent may try to figure out the key by trying to
412 decrypt the message with each key available.
413
414 @example
415   PKDECRYPT
416 @end example
417
418 The agent checks whether this command is allowed and then does an
419 INQUIRY to get the ciphertext the client should then send the cipher
420 text.
421
422 @example
423     S: INQUIRE CIPHERTEXT
424     C: D (xxxxxx
425     C: D xxxx)
426     C: END
427 @end example
428     
429 Please note that the server may send status info lines while reading the
430 data lines from the client.  The data send is a SPKI like S-Exp with
431 this structure:
432
433 @example
434      (enc-val   
435        (<algo>
436          (<param_name1> <mpi>)
437            ...
438          (<param_namen> <mpi>)))
439 @end example
440
441 Where algo is a string with the name of the algorithm; see the libgcrypt
442 documentation for a list of valid algorithms.  The number and names of
443 the parameters depend on the algorithm.  The agent does return an error
444 if there is an inconsistency.
445
446 If the decryption was successful the decrypted data is returned by
447 means of "D" lines. 
448
449 Here is an example session:
450
451 @example
452    C: PKDECRYPT
453    S: INQUIRE CIPHERTEXT
454    C: D (enc-val elg (a 349324324) 
455    C: D    (b 3F444677CA)))
456    C: END
457    S: # session key follows
458    S: D 1234567890ABCDEF0
459    S: OK descryption successful
460 @end example         
461
462
463 @node Agent PKSIGN
464 @subsection Signing a Hash
465
466 The client ask the agent to sign a given hash value.  A default key
467 will be chosen if no key has been set.  To set a key a client first
468 uses:
469
470 @example
471    SIGKEY <keyGrip>
472 @end example
473
474 This can be used multiple times to create multiple signature, the list
475 of keys is reset with the next PKSIGN command or a RESET.  The server
476 test whether the key is a valid key to sign something and responds with
477 okay.
478
479 @example
480    SETHASH <hexstring>
481 @end example
482
483 The client can use this command to tell the server about the data
484 (which usually is a hash) to be signed.  
485
486 The actual signing is done using
487
488 @example
489    PKSIGN <options>
490 @end example
491
492 Options are not yet defined, but my later be used to choosen among
493 different algorithms (e.g. pkcs 1.5)
494
495 The agent does then some checks, asks for the passphrase and
496 if SETHASH has not been used asks the client for the data to sign:
497
498 @example
499    S: INQUIRE HASHVAL
500    C: D ABCDEF012345678901234
501    C: END
502 @end example
503
504 As a result the server returns the signature as an SPKI like S-Exp
505 in "D" lines:
506
507 @example  
508      (sig-val   
509        (<algo>
510          (<param_name1> <mpi>)
511            ...
512          (<param_namen> <mpi>)))
513 @end example
514
515
516 The operation is affected by the option
517
518 @example
519    OPTION use-cache-for-signing=0|1
520 @end example
521
522 The default of @code{1} uses the cache.  Setting this option to @code{0}
523 will lead gpg-agent to ignore the passphrase cache.  Note, that there is
524 also a global command line option for gpg-agent to globally disable the
525 caching.
526
527
528 Here is an example session:
529
530 @example
531    C: SIGKEY <keyGrip>
532    S: OK key available
533    C: SIGKEY <keyGrip>
534    S: OK key available
535    C: PKSIGN
536    S: # I did ask the user whether he really wants to sign
537    S: # I did ask the user for the passphrase
538    S: INQUIRE HASHVAL
539    C: D ABCDEF012345678901234
540    C: END
541    S: # signature follows
542    S: D (sig-val rsa (s 45435453654612121212))
543    S: OK
544 @end example
545
546
547 @node Agent GENKEY
548 @subsection Generating a Key
549
550 This is used to create a new keypair and store the secret key inside the
551 active PSE -w which is in most cases a Soft-PSE.  An not yet defined
552 option allows to choose the storage location.  To get the secret key out
553 of the PSE, a special export tool has to be used.
554
555 @example
556    GENKEY 
557 @end example
558
559 Invokes the key generation process and the server will then inquire
560 on the generation parameters, like:
561
562 @example
563    S: INQUIRE KEYPARM
564    C: D (genkey (rsa (nbits  1024)))
565    C: END
566 @end example
567
568 The format of the key parameters which depends on the algorithm is of
569 the form:
570
571 @example
572     (genkey
573       (algo
574         (parameter_name_1 ....)
575           ....
576         (parameter_name_n ....)))
577 @end example
578
579 If everything succeeds, the server returns the *public key* in a SPKI
580 like S-Expression like this:
581
582 @example
583      (public-key
584        (rsa
585          (n <mpi>)
586          (e <mpi>)))
587 @end example
588
589 Here is an example session:
590
591 @example
592    C: GENKEY
593    S: INQUIRE KEYPARM
594    C: D (genkey (rsa (nbits  1024)))
595    C: END
596    S: D (public-key
597    S: D   (rsa (n 326487324683264) (e 10001)))
598    S  OK key created
599 @end example
600
601 @node Agent IMPORT
602 @subsection Importing a Secret Key
603
604 This operation is not yet supportted by GpgAgent.  Specialized tools
605 are to be used for this.
606
607 There is no actual need because we can expect that secret keys
608 created by a 3rd party are stored on a smartcard.  If we have
609 generated the key ourself, we do not need to import it.
610
611 @node Agent EXPORT
612 @subsection Export a Secret Key
613
614 Not implemented.
615
616 Should be done by an extra tool.
617
618 @node Agent ISTRUSTED
619 @subsection Importing a Root Certificate
620
621 Actually we do not import a Root Cert but provide a way to validate
622 any piece of data by storing its Hash along with a description and
623 an identifier in the PSE.  Here is the interface desription:
624
625 @example
626     ISTRUSTED <fingerprint>
627 @end example
628
629 Check whether the OpenPGP primary key or the X.509 certificate with the
630 given fingerprint is an ultimately trusted key or a trusted Root CA
631 certificate.  The fingerprint should be given as a hexstring (without
632 any blanks or colons or whatever in between) and may be left padded with
633 00 in case of an MD5 fingerprint.  GPGAgent will answer with:
634
635 @example
636     OK
637 @end example
638
639 The key is in the table of trusted keys.
640
641 @example
642     ERR 304 (Not Trusted)
643 @end example
644
645 The key is not in this table.
646
647 Gpg needs the entire list of trusted keys to maintain the web of
648 trust; the following command is therefore quite helpful:
649
650 @example
651     LISTTRUSTED
652 @end example
653
654 GpgAgent returns a list of trusted keys line by line:
655
656 @example
657     S: D 000000001234454556565656677878AF2F1ECCFF P
658     S: D 340387563485634856435645634856438576457A P
659     S: D FEDC6532453745367FD83474357495743757435D S
660     S: OK
661 @end example
662
663 The first item on a line is the hexified fingerprint where MD5
664 ingerprints are @code{00} padded to the left and the second item is a
665 flag to indicate the type of key (so that gpg is able to only take care
666 of PGP keys).  P = OpenPGP, S = S/MIME.  A client should ignore the rest
667 of the line, so that we can extend the format in the future.
668
669 Finally a client should be able to mark a key as trusted:
670
671 @example
672    MARKTRUSTED @var{fingerprint} "P"|"S"
673 @end example
674
675 The server will then pop up a window to ask the user whether she
676 really trusts this key. For this it will probably ask for a text to
677 be displayed like this:
678
679 @example
680    S: INQUIRE TRUSTDESC
681    C: D Do you trust the key with the fingerprint @@FPR@@
682    C: D bla fasel blurb.
683    C: END
684    S: OK
685 @end example
686
687 Known sequences with the pattern @@foo@@ are replaced according to this
688 table:
689
690 @table @code
691 @item @@FPR16@@ 
692 Format the fingerprint according to gpg rules for a v3 keys.
693 @item @@FPR20@@ 
694 Format the fingerprint according to gpg rules for a v4 keys.
695 @item @@FPR@@
696 Choose an appropriate format to format the fingerprint.
697 @item @@@@ 
698 Replaced by a single @code{@@}
699 @end table
700
701 @node Agent GET_PASSPHRASE
702 @subsection Ask for a passphrase
703
704 This function is usually used to ask for a passphrase to be used for
705 conventional encryption, but may also be used by programs which need
706 special handling of passphrases.  This command uses a syntax which helps
707 clients to use the agent with minimum effort.
708
709 @example
710   GET_PASSPHRASE @var{cache_id} [@var{error_message} @var{prompt} @var{description}]
711 @end example
712
713 @var{cache_id} is expected to be a hex string used for caching a
714 passphrase.  Use a @code{X} to bypass the cache.  With no other
715 arguments the agent returns a cached passphrase or an error.
716   
717 @var{error_message} is either a single @code{X} for no error message or
718 a string to be shown as an error message like (e.g. "invalid
719 passphrase").  Blanks must be percent escaped or replaced by @code{+}'.
720
721 @var{prompt} is either a single @code{X} for a default prompt or the
722 text to be shown as the prompt.  Blanks must be percent escaped or
723 replaced by @code{+}.
724
725 @var{description} is a text shown above the entry field.  Blanks must be
726 percent escaped or replaced by @code{+}.
727
728 The agent either returns with an error or with a OK followed by the 
729 hex encoded passphrase.  Note that the length of the strings is
730 implicitly limited by the maximum length of a command.
731
732 @example
733   CLEAR_PASSPHRASE @var{cache_id}
734 @end example
735
736 may be used to invalidate the cache entry for a passphrase.  The
737 function returns with OK even when there is no cached passphrase.
738
739
740 @node Agent GET_CONFIRMATION
741 @subsection Ask for confirmation
742
743 This command may be used to ask for a simple confirmation by
744 presenting a text and 2 bottonts: Okay and Cancel.
745
746 @example
747   GET_CONFIRMATION @var{description}
748 @end example
749
750 @var{description}is displayed along with a Okay and Cancel
751 button. Blanks must be percent escaped or replaced by @code{+}.  A
752 @code{X} may be used to display confirmation dialog with a default
753 text.
754
755 The agent either returns with an error or with a OK.  Note, that the
756 length of @var{description} is implicitly limited by the maximum
757 length of a command.
758
759
760
761 @node Agent HAVEKEY
762 @subsection Check whether a key is available
763
764 This can be used to see whether a secret key is available.  It does
765 not return any information on whether the key is somehow protected.
766
767 @example
768   HAVEKEY @var{keygrip}
769 @end example
770
771 The Agent answers either with OK or @code{No_Secret_Key} (208).  The
772 caller may want to check for other error codes as well.
773
774
775 @node Agent LEARN
776 @subsection Register a smartcard
777
778 @example
779   LEARN [--send]
780 @end example
781
782 This command is used to register a smartcard.  With the --send
783 option given the certificates are send back.
784
785
786 @node Agent PASSWD
787 @subsection Change a Passphrase
788
789 @example
790   PASSWD @var{keygrip}
791 @end example
792
793 This command is used to interactively change the passphrase of the key
794 indentified by the hex string @var{keygrip}.
795
796
797