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