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