dirmngr: Auto-enable Tor on startup or reload.
[gnupg.git] / doc / dirmngr.texi
1 @c Copyright (C) 2002 Klar"alvdalens Datakonsult AB
2 @c Copyright (C) 2004, 2005, 2006, 2007 g10 Code GmbH
3 @c This is part of the GnuPG manual.
4 @c For copying conditions, see the file gnupg.texi.
5
6 @include defs.inc
7
8 @node Invoking DIRMNGR
9 @chapter Invoking DIRMNGR
10 @cindex DIRMNGR command options
11 @cindex command options
12 @cindex options, DIRMNGR command
13
14 @manpage dirmngr.8
15 @ifset manverb
16 .B dirmngr
17 \- CRL and OCSP daemon
18 @end ifset
19
20 @mansect synopsis
21 @ifset manverb
22 .B  dirmngr
23 .RI [ options ]
24 .I command
25 .RI [ args ]
26 @end ifset
27
28 @mansect description
29 Since version 2.1 of GnuPG, @command{dirmngr} takes care of accessing
30 the OpenPGP keyservers.  As with previous versions it is also used as
31 a server for managing and downloading certificate revocation lists
32 (CRLs) for X.509 certificates, downloading X.509 certificates, and
33 providing access to OCSP providers.  Dirmngr is invoked internally by
34 @command{gpg}, @command{gpgsm}, or via the @command{gpg-connect-agent}
35 tool.
36
37 @manpause
38 @noindent
39 @xref{Option Index},for an index to @command{DIRMNGR}'s commands and
40 options.
41 @mancont
42
43 @menu
44 * Dirmngr Commands::      List of all commands.
45 * Dirmngr Options::       List of all options.
46 * Dirmngr Configuration:: Configuration files.
47 * Dirmngr Signals::       Use of signals.
48 * Dirmngr Examples::      Some usage examples.
49 * Dirmngr Protocol::      The protocol dirmngr uses.
50 @end menu
51
52
53 @node Dirmngr Commands
54 @section Commands
55 @mansect commands
56
57 Commands are not distinguished from options except for the fact that
58 only one command is allowed.
59
60 @table @gnupgtabopt
61 @item --version
62 @opindex version
63 Print the program version and licensing information.  Note that you cannot
64 abbreviate this command.
65
66 @item --help, -h
67 @opindex help
68 Print a usage message summarizing the most useful command-line options.
69 Note that you cannot abbreviate this command.
70
71 @item --dump-options
72 @opindex dump-options
73 Print a list of all available options and commands.  Note that you cannot
74 abbreviate this command.
75
76 @item --server
77 @opindex server
78 Run in server mode and wait for commands on the @code{stdin}.  The
79 default mode is to create a socket and listen for commands there.
80 This is only used for testing.
81
82 @item --daemon
83 @opindex daemon
84 Run in background daemon mode and listen for commands on a socket.
85 This is the way @command{dirmngr} is started on demand by the other
86 GnuPG components.  To force starting @command{dirmngr} it is in
87 general best to use @code{gpgconf --launch dirmngr}.
88
89 @item --supervised
90 @opindex supervised
91 Run in the foreground, sending logs to stderr, and listening on file
92 descriptor 3, which must already be bound to a listening socket.  This
93 is useful when running under systemd or other similar process
94 supervision schemes.  This option is not supported on Windows.
95
96 @item --list-crls
97 @opindex list-crls
98 List the contents of the CRL cache on @code{stdout}. This is probably
99 only useful for debugging purposes.
100
101 @item --load-crl @var{file}
102 @opindex load-crl
103 This command requires a filename as additional argument, and it will
104 make Dirmngr try to import the CRL in @var{file} into it's cache.
105 Note, that this is only possible if Dirmngr is able to retrieve the
106 CA's certificate directly by its own means.  In general it is better
107 to use @code{gpgsm}'s @code{--call-dirmngr loadcrl filename} command
108 so that @code{gpgsm} can help dirmngr.
109
110 @item --fetch-crl @var{url}
111 @opindex fetch-crl
112 This command requires an URL as additional argument, and it will make
113 dirmngr try to retrieve and import the CRL from that @var{url} into
114 it's cache.  This is mainly useful for debugging purposes.  The
115 @command{dirmngr-client} provides the same feature for a running dirmngr.
116
117 @item --shutdown
118 @opindex shutdown
119 This commands shuts down an running instance of Dirmngr.  This command
120 has currently no effect.
121
122 @item --flush
123 @opindex flush
124 This command removes all CRLs from Dirmngr's cache.  Client requests
125 will thus trigger reading of fresh CRLs.
126
127 @end table
128
129
130 @mansect options
131 @node Dirmngr Options
132 @section Option Summary
133
134 Note that all long options with the exception of @option{--options}
135 and @option{--homedir} may also be given in the configuration file
136 after stripping off the two leading dashes.
137
138 @table @gnupgtabopt
139
140 @item --options @var{file}
141 @opindex options
142 Reads configuration from @var{file} instead of from the default
143 per-user configuration file.  The default configuration file is named
144 @file{dirmngr.conf} and expected in the home directory.
145
146 @item --homedir @var{dir}
147 @opindex options
148 Set the name of the home directory to @var{dir}.  This option is only
149 effective when used on the command line.  The default is
150 the directory named @file{.gnupg} directly below the home directory
151 of the user unless the environment variable @code{GNUPGHOME} has been set
152 in which case its value will be used.  Many kinds of data are stored within
153 this directory.
154
155
156 @item -v
157 @item --verbose
158 @opindex v
159 @opindex verbose
160 Outputs additional information while running.
161 You can increase the verbosity by giving several
162 verbose commands to @sc{dirmngr}, such as @option{-vv}.
163
164
165 @item --log-file @var{file}
166 @opindex log-file
167 Append all logging output to @var{file}.  This is very helpful in
168 seeing what the agent actually does.  Use @file{socket://} to log to
169 socket.
170
171 @item --debug-level @var{level}
172 @opindex debug-level
173 Select the debug level for investigating problems.  @var{level} may be a
174 numeric value or by a keyword:
175
176 @table @code
177 @item none
178 No debugging at all.  A value of less than 1 may be used instead of
179 the keyword.
180 @item basic
181 Some basic debug messages.  A value between 1 and 2 may be used
182 instead of the keyword.
183 @item advanced
184 More verbose debug messages.  A value between 3 and 5 may be used
185 instead of the keyword.
186 @item expert
187 Even more detailed messages.  A value between 6 and 8 may be used
188 instead of the keyword.
189 @item guru
190 All of the debug messages you can get. A value greater than 8 may be
191 used instead of the keyword.  The creation of hash tracing files is
192 only enabled if the keyword is used.
193 @end table
194
195 How these messages are mapped to the actual debugging flags is not
196 specified and may change with newer releases of this program. They are
197 however carefully selected to best aid in debugging.
198
199 @item --debug @var{flags}
200 @opindex debug
201 Set debugging flags.  This option is only useful for debugging and its
202 behavior may change with a new release.  All flags are or-ed and may
203 be given in C syntax (e.g. 0x0042) or as a comma separated list of
204 flag names.  To get a list of all supported flags the single word
205 "help" can be used.
206
207 @item --debug-all
208 @opindex debug-all
209 Same as @code{--debug=0xffffffff}
210
211 @item --gnutls-debug @var{level}
212 @opindex gnutls-debug
213 Enable debugging of GNUTLS at @var{level}.
214
215 @item --debug-wait @var{n}
216 @opindex debug-wait
217 When running in server mode, wait @var{n} seconds before entering the
218 actual processing loop and print the pid.  This gives time to attach a
219 debugger.
220
221 @item --disable-check-own-socket
222 @opindex disable-check-own-socket
223 On some platforms @command{dirmngr} is able to detect the removal of
224 its socket file and shutdown itself.  This option disable this
225 self-test for debugging purposes.
226
227 @item -s
228 @itemx --sh
229 @itemx -c
230 @itemx --csh
231 @opindex s
232 @opindex sh
233 @opindex c
234 @opindex csh
235 Format the info output in daemon mode for use with the standard Bourne
236 shell respective the C-shell. The default is to guess it based on the
237 environment variable @code{SHELL} which is in almost all cases
238 sufficient.
239
240 @item --force
241 @opindex force
242 Enabling this option forces loading of expired CRLs; this is only
243 useful for debugging.
244
245 @item --use-tor
246 @itemx --no-use-tor
247 @opindex use-tor
248 @opindex no-use-tor
249 The option @option{--use-tor} switches Dirmngr and thus GnuPG into
250 ``Tor mode'' to route all network access via Tor (an anonymity
251 network).  Certain other features are disabled in this mode.  The
252 effect of @option{--use-tor} cannot be overridden by any other command
253 or even be reloading gpg-agent.  The use of @option{--no-use-tor}
254 disables the use of Tor.  The default is to use Tor if it is available
255 on startup or after reloading dirmngr.
256
257 @item --standard-resolver
258 @opindex standard-resolver
259 This option forces the use of the system's standard DNS resolver code.
260 This is mainly used for debugging.  Note that on Windows a standard
261 resolver is not used and all DNS access will return the error ``Not
262 Implemented'' if this function is used.
263
264 @item --recursive-resolver
265 @opindex recursive-resolver
266 When possible use a recursive resolver instead of a stub resolver.
267
268 @item --resolver-timeout @var{n}
269 @opindex resolver-timeout
270 Set the timeout for the DNS resolver to N seconds.  The default are 30
271 seconds.
272
273 @item --connect-timeout @var{n}
274 @item --connect-quick-timeout @var{n}
275 @opindex connect-timeout
276 @opindex connect-quick-timeout
277 Set the timeout for HTTP and generic TCP connection attempts to N
278 seconds.  The value set with the quick variant is used when the
279 --quick option has been given to certain Assuan commands.  The quick
280 value is capped at the value of the regular connect timeout.  The
281 default values are 15 and 2 seconds.  Note that the timeout values are
282 for each connection attempt; the connection code will attempt to
283 connect all addresses listed for a server.
284
285 @item --allow-version-check
286 @opindex allow-version-check
287 Allow Dirmngr to connect to @code{https://versions.gnupg.org} to get
288 the list of current software versions.  If this option is enabled
289 the list is retrieved in case the local
290 copy does not exist or is older than 5 to 7 days.  See the option
291 @option{--query-swdb} of the command @command{gpgconf} for more
292 details.  Note, that regardless of this option a version check can
293 always be triggered using this command:
294
295 @example
296        gpg-connect-agent --dirmngr 'loadswdb --force' /bye
297 @end example
298
299
300 @item --keyserver @var{name}
301 @opindex keyserver
302 Use @var{name} as your keyserver.  This is the server that @command{gpg}
303 communicates with to receive keys, send keys, and search for
304 keys.  The format of the @var{name} is a URI:
305 `scheme:[//]keyservername[:port]' The scheme is the type of keyserver:
306 "hkp" for the HTTP (or compatible) keyservers, "ldap" for the LDAP
307 keyservers, or "mailto" for the Graff email keyserver. Note that your
308 particular installation of GnuPG may have other keyserver types
309 available as well. Keyserver schemes are case-insensitive. After the
310 keyserver name, optional keyserver configuration options may be
311 provided.  These are the same as the @option{--keyserver-options} of
312 @command{gpg}, but apply only to this particular keyserver.
313
314 Most keyservers synchronize with each other, so there is generally no
315 need to send keys to more than one server. The keyserver
316 @code{hkp://keys.gnupg.net} uses round robin DNS to give a different
317 keyserver each time you use it.
318
319 If exactly two keyservers are configured and only one is a Tor hidden
320 service (.onion), Dirmngr selects the keyserver to use depending on
321 whether Tor is locally running or not.  The check for a running Tor is
322 done for each new connection.
323
324 If no keyserver is explicitly configured, dirmngr will use the
325 built-in default of hkps://hkps.pool.sks-keyservers.net.
326
327 @item --nameserver @var{ipaddr}
328 @opindex nameserver
329 In ``Tor mode'' Dirmngr uses a public resolver via Tor to resolve DNS
330 names.  If the default public resolver, which is @code{8.8.8.8}, shall
331 not be used a different one can be given using this option.  Note that
332 a numerical IP address must be given (IPv6 or IPv4) and that no error
333 checking is done for @var{ipaddr}.
334
335 @item --disable-ipv4
336 @item --disable-ipv6
337 @opindex disable-ipv4
338 @opindex disable-ipv6
339 Disable the use of all IPv4 or IPv6 addresses.
340
341 @item --disable-ldap
342 @opindex disable-ldap
343 Entirely disables the use of LDAP.
344
345 @item --disable-http
346 @opindex disable-http
347 Entirely disables the use of HTTP.
348
349 @item --ignore-http-dp
350 @opindex ignore-http-dp
351 When looking for the location of a CRL, the to be tested certificate
352 usually contains so called @dfn{CRL Distribution Point} (DP) entries
353 which are URLs describing the way to access the CRL.  The first found DP
354 entry is used.  With this option all entries using the @acronym{HTTP}
355 scheme are ignored when looking for a suitable DP.
356
357 @item --ignore-ldap-dp
358 @opindex ignore-ldap-dp
359 This is similar to @option{--ignore-http-dp} but ignores entries using
360 the @acronym{LDAP} scheme.  Both options may be combined resulting in
361 ignoring DPs entirely.
362
363 @item --ignore-ocsp-service-url
364 @opindex ignore-ocsp-service-url
365 Ignore all OCSP URLs contained in the certificate.  The effect is to
366 force the use of the default responder.
367
368 @item --honor-http-proxy
369 @opindex honor-http-proxy
370 If the environment variable @env{http_proxy} has been set, use its
371 value to access HTTP servers.
372
373 @item --http-proxy @var{host}[:@var{port}]
374 @opindex http-proxy
375 @efindex http_proxy
376 Use @var{host} and @var{port} to access HTTP servers.  The use of this
377 option overrides the environment variable @env{http_proxy} regardless
378 whether @option{--honor-http-proxy} has been set.
379
380
381 @item --ldap-proxy @var{host}[:@var{port}]
382 @opindex ldap-proxy
383 Use @var{host} and @var{port} to connect to LDAP servers.  If @var{port}
384 is omitted, port 389 (standard LDAP port) is used.  This overrides any
385 specified host and port part in a LDAP URL and will also be used if host
386 and port have been omitted from the URL.
387
388 @item --only-ldap-proxy
389 @opindex only-ldap-proxy
390 Never use anything else but the LDAP "proxy" as configured with
391 @option{--ldap-proxy}.  Usually @command{dirmngr} tries to use other
392 configured LDAP server if the connection using the "proxy" failed.
393
394
395 @item --ldapserverlist-file @var{file}
396 @opindex ldapserverlist-file
397 Read the list of LDAP servers to consult for CRLs and certificates from
398 file instead of the default per-user ldap server list file. The default
399 value for @var{file} is @file{dirmngr_ldapservers.conf}.
400
401 This server list file contains one LDAP server per line in the format
402
403 @sc{hostname:port:username:password:base_dn}
404
405 Lines starting with a  @samp{#} are comments.
406
407 Note that as usual all strings entered are expected to be UTF-8 encoded.
408 Obviously this will lead to problems if the password has originally been
409 encoded as Latin-1.  There is no other solution here than to put such a
410 password in the binary encoding into the file (i.e. non-ascii characters
411 won't show up readable).@footnote{The @command{gpgconf} tool might be
412 helpful for frontends as it enables editing this configuration file using
413 percent-escaped strings.}
414
415
416 @item --ldaptimeout @var{secs}
417 @opindex ldaptimeout
418 Specify the number of seconds to wait for an LDAP query before timing
419 out. The default is currently 100 seconds.  0 will never timeout.
420
421
422 @item --add-servers
423 @opindex add-servers
424 This option makes dirmngr add any servers it discovers when validating
425 certificates against CRLs to the internal list of servers to consult for
426 certificates and CRLs.
427
428 This option is useful when trying to validate a certificate that has
429 a CRL distribution point that points to a server that is not already
430 listed in the ldapserverlist. Dirmngr will always go to this server and
431 try to download the CRL, but chances are high that the certificate used
432 to sign the CRL is located on the same server. So if dirmngr doesn't add
433 that new server to list, it will often not be able to verify the
434 signature of the CRL unless the @code{--add-servers} option is used.
435
436 Note: The current version of dirmngr has this option disabled by default.
437
438
439 @item --allow-ocsp
440 @opindex allow-ocsp
441 This option enables OCSP support if requested by the client.
442
443 OCSP requests are rejected by default because they may violate the
444 privacy of the user; for example it is possible to track the time when
445 a user is reading a mail.
446
447
448 @item --ocsp-responder @var{url}
449 @opindex ocsp-responder
450 Use @var{url} as the default OCSP Responder if the certificate does
451 not contain information about an assigned responder.  Note, that
452 @code{--ocsp-signer} must also be set to a valid certificate.
453
454 @item --ocsp-signer @var{fpr}|@var{file}
455 @opindex ocsp-signer
456 Use the certificate with the fingerprint @var{fpr} to check the
457 responses of the default OCSP Responder.  Alternatively a filename can be
458 given in which case the response is expected to be signed by one of the
459 certificates described in that file.  Any argument which contains a
460 slash, dot or tilde is considered a filename.  Usual filename expansion
461 takes place: A tilde at the start followed by a slash is replaced by the
462 content of @env{HOME}, no slash at start describes a relative filename
463 which will be searched at the home directory.  To make sure that the
464 @var{file} is searched in the home directory, either prepend the name
465 with "./" or use a name which contains a dot.
466
467 If a response has been signed by a certificate described by these
468 fingerprints no further check upon the validity of this certificate is
469 done.
470
471 The format of the @var{FILE} is a list of SHA-1 fingerprint, one per
472 line with optional colons between the bytes.  Empty lines and lines
473 prefix with a hash mark are ignored.
474
475
476 @item --ocsp-max-clock-skew @var{n}
477 @opindex ocsp-max-clock-skew
478 The number of seconds a skew between the OCSP responder and them local
479 clock is accepted.  Default is 600 (10 minutes).
480
481 @item --ocsp-max-period @var{n}
482 @opindex ocsp-max-period
483 Seconds a response is at maximum considered valid after the time given
484 in the thisUpdate field.  Default is 7776000 (90 days).
485
486 @item --ocsp-current-period @var{n}
487 @opindex ocsp-current-period
488 The number of seconds an OCSP response is considered valid after the
489 time given in the NEXT_UPDATE datum.  Default is 10800 (3 hours).
490
491
492 @item --max-replies @var{n}
493 @opindex max-replies
494 Do not return more that @var{n} items in one query.  The default is
495 10.
496
497 @item --ignore-cert-extension @var{oid}
498 @opindex ignore-cert-extension
499 Add @var{oid} to the list of ignored certificate extensions.  The
500 @var{oid} is expected to be in dotted decimal form, like
501 @code{2.5.29.3}.  This option may be used more than once.  Critical
502 flagged certificate extensions matching one of the OIDs in the list
503 are treated as if they are actually handled and thus the certificate
504 won't be rejected due to an unknown critical extension.  Use this
505 option with care because extensions are usually flagged as critical
506 for a reason.
507
508 @item --hkp-cacert @var{file}
509 Use the root certificates in @var{file} for verification of the TLS
510 certificates used with @code{hkps} (keyserver access over TLS).  If
511 the file is in PEM format a suffix of @code{.pem} is expected for
512 @var{file}.  This option may be given multiple times to add more
513 root certificates.  Tilde expansion is supported.
514
515 If no @code{hkp-cacert} directive is present, dirmngr will make a
516 reasonable choice: if the keyserver in question is the special pool
517 @code{hkps.pool.sks-keyservers.net}, it will use the bundled root
518 certificate for that pool.  Otherwise, it will use the system CAs.
519
520 @end table
521
522
523 @c
524 @c Dirmngr Configuration
525 @c
526 @mansect files
527 @node Dirmngr Configuration
528 @section Configuration
529
530 Dirmngr makes use of several directories when running in daemon mode:
531 There are a few configuration files whih control the operation of
532 dirmngr.  By default they may all be found in the current home
533 directory (@pxref{option --homedir}).
534
535 @table @file
536
537 @item dirmngr.conf
538 @efindex dirmngr.conf
539 This is the standard configuration file read by @command{dirmngr} on
540 startup.  It may contain any valid long option; the leading two dashes
541 may not be entered and the option may not be abbreviated.  This file
542 is also read after a @code{SIGHUP} however not all options will
543 actually have an effect.  This default name may be changed on the
544 command line (@pxref{option --options}).  You should backup this file.
545
546 @item /etc/gnupg/trusted-certs
547 This directory should be filled with certificates of Root CAs you
548 are trusting in checking the CRLs and signing OCSP Responses.
549
550 Usually these are the same certificates you use with the applications
551 making use of dirmngr.  It is expected that each of these certificate
552 files contain exactly one @acronym{DER} encoded certificate in a file
553 with the suffix @file{.crt} or @file{.der}.  @command{dirmngr} reads
554 those certificates on startup and when given a SIGHUP.  Certificates
555 which are not readable or do not make up a proper X.509 certificate
556 are ignored; see the log file for details.
557
558 Applications using dirmngr (e.g. gpgsm) can request these
559 certificates to complete a trust chain in the same way as with the
560 extra-certs directory (see below).
561
562 Note that for OCSP responses the certificate specified using the option
563 @option{--ocsp-signer} is always considered valid to sign OCSP requests.
564
565 @item /etc/gnupg/extra-certs
566 This directory may contain extra certificates which are preloaded
567 into the internal cache on startup. Applications using dirmngr (e.g. gpgsm)
568 can request cached certificates to complete a trust chain.
569 This is convenient in cases you have a couple intermediate CA certificates
570 or certificates usually used to sign OCSP responses.
571 These certificates are first tried before going
572 out to the net to look for them.  These certificates must also be
573 @acronym{DER} encoded and suffixed with @file{.crt} or @file{.der}.
574
575 @item ~/.gnupg/crls.d
576 This directory is used to store cached CRLs.  The @file{crls.d}
577 part will be created by dirmngr if it does not exists but you need to
578 make sure that the upper directory exists.
579
580 @end table
581 @manpause
582
583 To be able to see what's going on you should create the configure file
584 @file{~/gnupg/dirmngr.conf} with at least one line:
585
586 @example
587 log-file ~/dirmngr.log
588 @end example
589
590 To be able to perform OCSP requests you probably want to add the line:
591
592 @example
593 allow-ocsp
594 @end example
595
596 To make sure that new options are read and that after the installation
597 of a new GnuPG versions the installed dirmngr is running, you may want
598 to kill an existing dirmngr first:
599
600 @example
601 gpgconf --kill dirmngr
602 @end example
603
604 You may check the log file to see whether all desired root
605 certificates have been loaded correctly.
606
607
608 @c
609 @c Dirmngr Signals
610 @c
611 @mansect signals
612 @node Dirmngr Signals
613 @section Use of signals
614
615 A running @command{dirmngr} may be controlled by signals, i.e. using
616 the @command{kill} command to send a signal to the process.
617
618 Here is a list of supported signals:
619
620 @table @gnupgtabopt
621
622 @item SIGHUP
623 @cpindex SIGHUP
624 This signal flushes all internally cached CRLs as well as any cached
625 certificates.  Then the certificate cache is reinitialized as on
626 startup.  Options are re-read from the configuration file.  Instead of
627 sending this signal it is better to use
628 @example
629 gpgconf --reload dirmngr
630 @end example
631
632 @item SIGTERM
633 @cpindex SIGTERM
634 Shuts down the process but waits until all current requests are
635 fulfilled.  If the process has received 3 of these signals and requests
636 are still pending, a shutdown is forced.  You may also use
637 @example
638 gpgconf --kill dirmngr
639 @end example
640 instead of this signal
641
642 @item SIGINT
643 @cpindex SIGINT
644 Shuts down the process immediately.
645
646
647 @item SIGUSR1
648 @cpindex SIGUSR1
649 This prints some caching statistics to the log file.
650
651 @end table
652
653
654
655 @c
656 @c  Examples
657 @c
658 @mansect examples
659 @node Dirmngr Examples
660 @section Examples
661
662 Here is an example on how to show dirmngr's internal table of OpenPGP
663 keyserver addresses.  The output is intended for debugging purposes
664 and not part of a defined API.
665
666 @example
667   gpg-connect-agent --dirmngr 'keyserver --hosttable' /bye
668 @end example
669
670 To inhibit the use of a particular host you have noticed in one of the
671 keyserver pools, you may use
672
673 @example
674  gpg-connect-agent --dirmngr 'keyserver --dead pgpkeys.bnd.de' /bye
675 @end example
676
677 The description of the @code{keyserver} command can be printed using
678
679 @example
680  gpg-connect-agent --dirmngr 'help keyserver' /bye
681 @end example
682
683
684
685 @c
686 @c  Assuan Protocol
687 @c
688 @manpause
689 @node Dirmngr Protocol
690 @section Dirmngr's Assuan Protocol
691
692 Assuan is the IPC protocol used to access dirmngr.  This is a
693 description of the commands implemented by dirmngr.
694
695 @menu
696 * Dirmngr LOOKUP::      Look up a certificate via LDAP
697 * Dirmngr ISVALID::     Validate a certificate using a CRL or OCSP.
698 * Dirmngr CHECKCRL::    Validate a certificate using a CRL.
699 * Dirmngr CHECKOCSP::   Validate a certificate using OCSP.
700 * Dirmngr CACHECERT::   Put a certificate into the internal cache.
701 * Dirmngr VALIDATE::    Validate a certificate for debugging.
702 @end menu
703
704 @node Dirmngr LOOKUP
705 @subsection Return the certificate(s) found
706
707 Lookup certificate.  To allow multiple patterns (which are ORed)
708 quoting is required: Spaces are to be translated into "+" or into
709 "%20"; obviously this requires that the usual escape quoting rules
710 are applied.  The server responds with:
711
712 @example
713   S: D <DER encoded certificate>
714   S: END
715   S: D <second DER encoded certificate>
716   S: END
717   S: OK
718 @end example
719
720 In this example 2 certificates are returned.  The server may return
721 any number of certificates; OK will also be returned when no
722 certificates were found.  The dirmngr might return a status line
723
724 @example
725   S: S TRUNCATED <n>
726 @end example
727
728
729 To indicate that the output was truncated to N items due to a
730 limitation of the server or by an arbitrary set limit.
731
732 The option @option{--url} may be used if instead of a search pattern a
733 complete URL to the certificate is known:
734
735 @example
736   C: LOOKUP --url CN%3DWerner%20Koch,o%3DIntevation%20GmbH,c%3DDE?userCertificate
737 @end example
738
739 If the option @option{--cache-only} is given, no external lookup is done
740 so that only certificates from the cache are returned.
741
742 With the option @option{--single}, the first and only the first match
743 will be returned.  Unless option @option{--cache-only} is also used, no
744 local lookup will be done in this case.
745
746
747
748 @node Dirmngr ISVALID
749 @subsection Validate a certificate using a CRL or OCSP
750
751 @example
752   ISVALID [--only-ocsp] [--force-default-responder] @var{certid}|@var{certfpr}
753 @end example
754
755 Check whether the certificate described by the @var{certid} has been
756 revoked.  Due to caching, the Dirmngr is able to answer immediately in
757 most cases.
758
759 The @var{certid} is a hex encoded string consisting of two parts,
760 delimited by a single dot.  The first part is the SHA-1 hash of the
761 issuer name and the second part the serial number.
762
763 Alternatively the certificate's SHA-1 fingerprint @var{certfpr} may be
764 given in which case an OCSP request is done before consulting the CRL.
765 If the option @option{--only-ocsp} is given, no fallback to a CRL check
766 will be used.  If the option @option{--force-default-responder} is
767 given, only the default OCSP responder will be used and any other
768 methods of obtaining an OCSP responder URL won't be used.
769
770 @noindent
771 Common return values are:
772
773 @table @code
774 @item GPG_ERR_NO_ERROR (0)
775 This is the positive answer: The certificate is not revoked and we have
776 an up-to-date revocation list for that certificate.  If OCSP was used
777 the responder confirmed that the certificate has not been revoked.
778
779 @item GPG_ERR_CERT_REVOKED
780 This is the negative answer: The certificate has been revoked.  Either
781 it is in a CRL and that list is up to date or an OCSP responder informed
782 us that it has been revoked.
783
784 @item GPG_ERR_NO_CRL_KNOWN
785 No CRL is known for this certificate or the CRL is not valid or out of
786 date.
787
788 @item GPG_ERR_NO_DATA
789 The OCSP responder returned an ``unknown'' status.  This means that it
790 is not aware of the certificate's status.
791
792 @item GPG_ERR_NOT_SUPPORTED
793 This is commonly seen if OCSP support has not been enabled in the
794 configuration.
795 @end table
796
797 If DirMngr has not enough information about the given certificate (which
798 is the case for not yet cached certificates), it will inquire the
799 missing data:
800
801 @example
802   S: INQUIRE SENDCERT <CertID>
803   C: D <DER encoded certificate>
804   C: END
805 @end example
806
807 A client should be aware that DirMngr may ask for more than one
808 certificate.
809
810 If Dirmngr has a certificate but the signature of the certificate
811 could not been validated because the root certificate is not known to
812 dirmngr as trusted, it may ask back to see whether the client trusts
813 this the root certificate:
814
815 @example
816   S: INQUIRE ISTRUSTED <CertHexfpr>
817   C: D 1
818   C: END
819 @end example
820
821 Only this answer will let Dirmngr consider the certificate as valid.
822
823
824 @node Dirmngr CHECKCRL
825 @subsection Validate a certificate using a CRL
826
827 Check whether the certificate with FINGERPRINT (SHA-1 hash of the
828 entire X.509 certificate blob) is valid or not by consulting the CRL
829 responsible for this certificate.  If the fingerprint has not been
830 given or the certificate is not known, the function inquires the
831 certificate using:
832
833 @example
834   S: INQUIRE TARGETCERT
835   C: D <DER encoded certificate>
836   C: END
837 @end example
838
839 Thus the caller is expected to return the certificate for the request
840 (which should match FINGERPRINT) as a binary blob.  Processing then
841 takes place without further interaction; in particular dirmngr tries
842 to locate other required certificate by its own mechanism which
843 includes a local certificate store as well as a list of trusted root
844 certificates.
845
846 @noindent
847 The return code is 0 for success; i.e. the certificate has not been
848 revoked or one of the usual error codes from libgpg-error.
849
850 @node Dirmngr CHECKOCSP
851 @subsection Validate a certificate using OCSP
852
853 @example
854   CHECKOCSP [--force-default-responder] [@var{fingerprint}]
855 @end example
856
857 Check whether the certificate with @var{fingerprint} (the SHA-1 hash of
858 the entire X.509 certificate blob) is valid by consulting the appropriate
859 OCSP responder.  If the fingerprint has not been given or the
860 certificate is not known by Dirmngr, the function inquires the
861 certificate using:
862
863 @example
864   S: INQUIRE TARGETCERT
865   C: D <DER encoded certificate>
866   C: END
867 @end example
868
869 Thus the caller is expected to return the certificate for the request
870 (which should match @var{fingerprint}) as a binary blob.  Processing
871 then takes place without further interaction; in particular dirmngr
872 tries to locate other required certificates by its own mechanism which
873 includes a local certificate store as well as a list of trusted root
874 certificates.
875
876 If the option @option{--force-default-responder} is given, only the
877 default OCSP responder is used.  This option is the per-command variant
878 of the global option @option{--ignore-ocsp-service-url}.
879
880
881 @noindent
882 The return code is 0 for success; i.e. the certificate has not been
883 revoked or one of the usual error codes from libgpg-error.
884
885 @node Dirmngr CACHECERT
886 @subsection Put a certificate into the internal cache
887
888 Put a certificate into the internal cache.  This command might be
889 useful if a client knows in advance certificates required for a test and
890 wants to make sure they get added to the internal cache.  It is also
891 helpful for debugging.  To get the actual certificate, this command
892 immediately inquires it using
893
894 @example
895   S: INQUIRE TARGETCERT
896   C: D <DER encoded certificate>
897   C: END
898 @end example
899
900 Thus the caller is expected to return the certificate for the request
901 as a binary blob.
902
903 @noindent
904 The return code is 0 for success; i.e. the certificate has not been
905 successfully cached or one of the usual error codes from libgpg-error.
906
907 @node Dirmngr VALIDATE
908 @subsection Validate a certificate for debugging
909
910 Validate a certificate using the certificate validation function used
911 internally by dirmngr.  This command is only useful for debugging.  To
912 get the actual certificate, this command immediately inquires it using
913
914 @example
915   S: INQUIRE TARGETCERT
916   C: D <DER encoded certificate>
917   C: END
918 @end example
919
920 Thus the caller is expected to return the certificate for the request
921 as a binary blob.
922
923
924 @mansect see also
925 @ifset isman
926 @command{gpgsm}(1),
927 @command{dirmngr-client}(1)
928 @end ifset
929 @include see-also-note.texi
930
931 @c
932 @c !!! UNDER CONSTRUCTION !!!
933 @c
934 @c
935 @c @section Verifying a Certificate
936 @c
937 @c There are several ways to request services from Dirmngr.  Almost all of
938 @c them are done using the Assuan protocol.  What we describe here is the
939 @c Assuan command CHECKCRL as used for example by the dirmnr-client tool if
940 @c invoked as
941 @c
942 @c @example
943 @c   dirmngr-client foo.crt
944 @c @end example
945 @c
946 @c This command will send an Assuan request to an already running Dirmngr
947 @c instance.  foo.crt is expected to be a standard X.509 certificate and
948 @c dirmngr will receive the Assuan command
949 @c
950 @c @example
951 @c    CHECKCRL @var [{fingerprint}]
952 @c @end example
953 @c
954 @c @var{fingerprint} is optional and expected to be the SHA-1 has of the
955 @c DER encoding of the certificate under question.  It is to be HEX
956 @c encoded.  The rationale for sending the fingerprint is that it allows
957 @c dirmngr to reply immediately if it has already cached such a request.  If
958 @c this is not the case and no certificate has been found in dirmngr's
959 @c internal certificate storage, dirmngr will request the certificate using
960 @c the Assuan inquiry
961 @c
962 @c @example
963 @c       INQUIRE TARGETCERT
964 @c @end example
965 @c
966 @c The caller (in our example dirmngr-client) is then expected to return
967 @c the certificate for the request (which should match @var{fingerprint})
968 @c as a binary blob.
969 @c
970 @c Dirmngr now passes control to @code{crl_cache_cert_isvalid}.  This
971 @c function checks whether a CRL item exists for target certificate.  These
972 @c CRL items are kept in a database of already loaded and verified CRLs.
973 @c This mechanism is called the CRL cache.  Obviously timestamps are kept
974 @c there with each item to cope with the expiration date of the CRL.  The
975 @c possible return values are: @code{0} to indicate that a valid CRL is
976 @c available for the certificate and the certificate itself is not listed
977 @c in this CRL, @code{GPG_ERR_CERT_REVOKED} to indicate that the certificate is
978 @c listed in the CRL or @code{GPG_ERR_NO_CRL_KNOWN} in cases where no CRL or no
979 @c information is available.  The first two codes are immediately returned to
980 @c the caller and the processing of this request has been done.
981 @c
982 @c Only the @code{GPG_ERR_NO_CRL_KNOWN} needs more attention: Dirmngr now
983 @c calls @code{clr_cache_reload_crl} and if this succeeds calls
984 @c @code{crl_cache_cert_isvald) once more.  All further errors are
985 @c immediately returned to the caller.
986 @c
987 @c @code{crl_cache_reload_crl} is the actual heart of the CRL management.
988 @c It locates the corresponding CRL for the target certificate, reads and
989 @c verifies this CRL and stores it in the CRL cache.  It works like this:
990 @c
991 @c * Loop over all crlDPs in the target certificate.
992 @c     * If the crlDP is invalid immediately terminate the loop.
993 @c     * Loop over all names in the current crlDP.
994 @c         * If the URL scheme is unknown or not enabled
995 @c           (--ignore-http-dp, --ignore-ldap-dp) continues with
996 @c           the next name.
997 @c         * @code{crl_fetch} is called to actually retrieve the CRL.
998 @c           In case of problems this name is ignore and we continue with
999 @c           the next name.  Note that @code{crl_fetch} does only return
1000 @c           a descriptor for the CRL for further reading so does the CRL
1001 @c           does not yet end up in memory.
1002 @c         * @code{crl_cache_insert} is called with that descriptor to
1003 @c           actually read the CRL into the cache. See below for a
1004 @c           description of this function.  If there is any error (e.g. read
1005 @c           problem, CRL not correctly signed or verification of signature
1006 @c           not possible), this descriptor is rejected and we continue
1007 @c           with the next name.  If the CRL has been successfully loaded,
1008 @c           the loop is terminated.
1009 @c * If no crlDP has been found in the previous loop use a default CRL.
1010 @c   Note, that if any crlDP has been found but loading of the CRL failed,
1011 @c   this condition is not true.
1012 @c     * Try to load a CRL from all configured servers (ldapservers.conf)
1013 @c       in turn.  The first server returning a CRL is used.
1014 @c     * @code(crl_cache_insert) is then used to actually insert the CRL
1015 @c       into the cache.  If this failed we give up immediately without
1016 @c       checking the rest of the servers from the first step.
1017 @c * Ready.
1018 @c
1019 @c
1020 @c The @code{crl_cache_insert} function takes care of reading the bulk of
1021 @c the CRL, parsing it and checking the signature.  It works like this: A
1022 @c new database file is created using a temporary file name.  The CRL
1023 @c parsing machinery is started and all items of the CRL are put into
1024 @c this database file.  At the end the issuer certificate of the CRL
1025 @c needs to be retrieved.  Three cases are to be distinguished:
1026 @c
1027 @c  a) An authorityKeyIdentifier with an issuer and serialno exits: The
1028 @c     certificate is retrieved using @code{find_cert_bysn}.  If
1029 @c     the certificate is in the certificate cache, it is directly
1030 @c     returned. Then the requester (i.e. the client who requested the
1031 @c     CRL check) is asked via the Assuan inquiry ``SENDCERT'' whether
1032 @c     he can provide this certificate.  If this succeed the returned
1033 @c     certificate gets cached and returned.  Note, that dirmngr does not
1034 @c     verify in any way whether the expected certificate is returned.
1035 @c     It is in the interest of the client to return a useful certificate
1036 @c     as otherwise the service request will fail due to a bad signature.
1037 @c     The last way to get the certificate is by looking it up at
1038 @c     external resources.  This is done using the @code{ca_cert_fetch}
1039 @c     and @code{fetch_next_ksba_cert} and comparing the returned
1040 @c     certificate to match the requested issuer and seriano (This is
1041 @c     needed because the LDAP layer may return several certificates as
1042 @c     LDAP as no standard way to retrieve by serial number).
1043 @c
1044 @c  b) An authorityKeyIdentifier with a key ID exists: The certificate is
1045 @c     retrieved using @code{find_cert_bysubject}.  If the certificate is
1046 @c     in the certificate cache, it is directly returned.  Then the
1047 @c     requester is asked via the Assuan inquiry ``SENDCERT_SKI'' whether
1048 @c     he can provide this certificate.  If this succeed the returned
1049 @c     certificate gets cached and returned.  Note, that dirmngr does not
1050 @c     verify in any way whether the expected certificate is returned.
1051 @c     It is in the interest of the client to return a useful certificate
1052 @c     as otherwise the service request will fail due to a bad signature.
1053 @c     The last way to get the certificate is by looking it up at
1054 @c     external resources.  This is done using the @code{ca_cert_fetch}
1055 @c     and @code{fetch_next_ksba_cert} and comparing the returned
1056 @c     certificate to match the requested subject and key ID.
1057 @c
1058 @c  c) No authorityKeyIdentifier exits: The certificate is retrieved
1059 @c     using @code{find_cert_bysubject} without the key ID argument.  If
1060 @c     the certificate is in the certificate cache the first one with a
1061 @c     matching subject is directly returned.  Then the requester is
1062 @c     asked via the Assuan inquiry ``SENDCERT'' and an exact
1063 @c     specification of the subject whether he can
1064 @c     provide this certificate.  If this succeed the returned
1065 @c     certificate gets cached and returned.  Note, that dirmngr does not
1066 @c     verify in any way whether the expected certificate is returned.
1067 @c     It is in the interest of the client to return a useful certificate
1068 @c     as otherwise the service request will fail due to a bad signature.
1069 @c     The last way to get the certificate is by looking it up at
1070 @c     external resources.  This is done using the @code{ca_cert_fetch}
1071 @c     and @code{fetch_next_ksba_cert} and comparing the returned
1072 @c     certificate to match the requested subject; the first certificate
1073 @c     with a matching subject is then returned.
1074 @c
1075 @c If no certificate was found, the function returns with the error
1076 @c GPG_ERR_MISSING_CERT.  Now the signature is verified.  If this fails,
1077 @c the erro is returned.  On success the @code{validate_cert_chain} is
1078 @c used to verify that the certificate is actually valid.
1079 @c
1080 @c Here we may encounter a recursive situation:
1081 @c @code{validate_cert_chain} needs to look at other certificates and
1082 @c also at CRLs to check whether these other certificates and well, the
1083 @c CRL issuer certificate itself are not revoked.  FIXME: We need to make
1084 @c sure that @code{validate_cert_chain} does not try to lookup the CRL we
1085 @c are currently processing. This would be a catch-22 and may indicate a
1086 @c broken PKI.  However, due to overlapping expiring times and imprecise
1087 @c clocks this may actually happen.
1088 @c
1089 @c For historical reasons the Assuan command ISVALID is a bit different
1090 @c to CHECKCRL but this is mainly due to different calling conventions.
1091 @c In the end the same fucntionality is used, albeit hidden by a couple
1092 @c of indirection and argument and result code mangling.  It furthere
1093 @c ingetrages OCSP checking depending on options are the way it is
1094 @c called.  GPGSM still uses this command but might eventuall switch over
1095 @c to CHECKCRL and CHECKOCSP so that ISVALID can be retired.
1096 @c
1097 @c
1098 @c @section Validating a certificate
1099 @c
1100 @c We describe here how the internal function @code{validate_cert_chain}
1101 @c works. Note that mainly testing purposes this functionality may be
1102 @c called directly using @cmd{dirmngr-client --validate @file{foo.crt}}.
1103 @c
1104 @c The function takes the target certificate and a mode argument as
1105 @c parameters and returns an error code and optionally the closes
1106 @c expiration time of all certificates in the chain.
1107 @c
1108 @c We first check that the certificate may be used for the requested
1109 @c purpose (i.e. OCSP or CRL signing).  If this is not the case
1110 @c GPG_ERR_WRONG_KEY_USAGE is returned.
1111 @c
1112 @c The next step is to find the trust anchor (root certificate) and to
1113 @c assemble the chain in memory: Starting with the target certificate,
1114 @c the expiration time is checked against the current date, unknown
1115 @c critical extensions are detected and certificate policies are matched
1116 @c (We only allow 2.289.9.9 but I have no clue about that OID and from
1117 @c where I got it - it does not even seem to be assigned - debug cruft?).
1118 @c
1119 @c Now if this certificate is a self-signed one, we have reached the
1120 @c trust anchor.  In this case we check that the signature is good, the
1121 @c certificate is allowed to act as a CA, that it is a trusted one (by
1122 @c checking whether it is has been put into the trusted-certs
1123 @c configuration directory) and finally prepend into to our list
1124 @c representing the certificate chain.  This steps ends then.
1125 @c
1126 @c If it is not a self-signed certificate, we check that the chain won't
1127 @c get too long (current limit is 100), if this is the case we terminate
1128 @c with the error GPG_ERR_BAD_CERT_CHAIN.
1129 @c
1130 @c Now the issuer's certificate is looked up: If an
1131 @c authorityKeyIdentifier is available, this one is used to locate the
1132 @c certificate either using issuer and serialnumber or subject DN
1133 @c (i.e. the issuer's DN) and the keyID.  The functions
1134 @c @code{find_cert_bysn) and @code{find_cert_bysubject} are used
1135 @c respectively. The have already been described above under the
1136 @c description of @code{crl_cache_insert}.  If no certificate was found
1137 @c or with no authorityKeyIdentifier, only the cache is consulted using
1138 @c @code{get_cert_bysubject}.  The latter is done under the assumption
1139 @c that a matching certificate has explicitly been put into the
1140 @c certificate cache.  If the issuer's certificate could not be found,
1141 @c the validation terminates with the error code @code{GPG_ERR_MISSING_CERT}.
1142 @c
1143 @c If the issuer's certificate has been found, the signature of the
1144 @c actual certificate is checked and in case this fails the error
1145 @c #code{GPG_ERR_BAD_CERT_CHAIN} is returned.  If the signature checks out, the
1146 @c maximum chain length of the issuing certificate is checked as well as
1147 @c the capability of the certificate (i.e. whether he may be used for
1148 @c certificate signing).  Then the certificate is prepended to our list
1149 @c representing the certificate chain.  Finally the loop is continued now
1150 @c with the issuer's certificate as the current certificate.
1151 @c
1152 @c After the end of the loop and if no error as been encountered
1153 @c (i.e. the certificate chain has been assempled correctly), a check is
1154 @c done whether any certificate expired or a critical policy has not been
1155 @c met.  In any of these cases the validation terminates with an
1156 @c appropriate error.
1157 @c
1158 @c Finally the function @code{check_revocations} is called to verify no
1159 @c certificate in the assempled chain has been revoked: This is an
1160 @c recursive process because a CRL has to be checked for each certificate
1161 @c in the chain except for the root certificate, of which we already know
1162 @c that it is trusted and we avoid checking a CRL here due to common
1163 @c setup problems and the assumption that a revoked root certificate has
1164 @c been removed from the list of trusted certificates.
1165 @c
1166 @c
1167 @c
1168 @c
1169 @c @section Looking up certificates through LDAP.
1170 @c
1171 @c This describes the LDAP layer to retrieve certificates.
1172 @c the functions @code{ca_cert_fetch} and @code{fetch_next_ksba_cert} are
1173 @c used for this.  The first one starts a search and the second one is
1174 @c used to retrieve certificate after certificate.
1175 @c
1176
1177