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