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