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