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