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