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