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