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