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