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