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