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