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