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