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