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