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