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