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