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