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