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