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