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