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