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