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