* certlist.c (gpgsm_cert_use_ocsp_p): New.
[gnupg.git] / doc / debugging.texi
1 @c Copyright (C) 2004 Free Software Foundation, Inc.
2 @c This is part of the GnuPG manual.
3 @c For copying conditions, see the file gnupg.texi.
4
5 @node Debugging
6 @chapter How to solve problems
7
8 Everone knows that software often does not do what it should do and thus
9 there is a need to track down problems.  We call this debugging in a
10 reminiscent to the moth jamming a relay in a Mark II box back in 1947.
11
12 Most of the probelsm a merely configuration and user problems but
13 nevertheless there are the most annoying ones and reposnible for may
14 gray hairs.  We try to give some guidelines here on how to identify and
15 solve the problem at hand.
16
17
18 @menu
19 * Debugging Tools::       Description of some useful tools
20 * Common Problems::       Commonly seen problems.
21 @end menu
22
23
24 @node Debugging Tools
25 @section Debugging Tools
26
27 The GnuPG distribution comes with a couple of tools, useful to help find
28 and solving problems.
29
30 @menu
31 * kbxutil::        Scrutinizing a keybox file.
32 @end menu
33
34 @node kbxutil
35 @subsection Scrutinizing a keybox file
36
37 A keybox is a file fomat used to store public keys along with meta
38 information and indices.  The commonly used one is the file
39 @file{pubring.kbx} in the @file{.gnupg} directory. It contains all
40 X.509 certificates as well as OpenPGP keys@footnote{Well, OpenPGP keys
41 are not implemented, @command{gpg} still used the keyring file
42 @file{pubring.gpg}} .
43
44 @noindent
45 When called the standard way, e.g.:
46
47 @samp{kbxutil ~/.gnupg/pubring.kbx}
48
49 @noindent
50 it lists all records (called @acronym{blobs}) with there meta-information
51 in a human readable format.
52
53 @noindent
54 To see statistics on the keybox in question, run it using
55
56 @samp{kbxutil --stats ~/.gnupg/pubring.kbx}
57
58 @noindent
59 and you get an output like:
60
61 @example
62 Total number of blobs:       99
63                header:        1
64                 empty:        0
65               openpgp:        0
66                  x509:       98
67           non flagged:       81
68        secret flagged:        0
69     ephemeral flagged:       17
70 @end example
71
72 In this example you see that the keybox does not have any OpenPGP keys
73 but contains 98 X.509 cerificates and a total of 17 keys or certificates
74 are flagges as ephemeral, meaning that they are only temporary stored
75 (cached) in the keybox and won't get listed using the usual commands
76 provided by @command{gpgsm} or @command{gpg}. 81 certifcates are stored
77 in a standard way and directly available from @command{gpgsm}.
78
79
80
81
82
83 @node Common Problems
84 @section Commonly Seen Problems
85
86
87 @itemize @bullet
88 @item Error code @samp{Not supported} from Dirmngr
89
90   Most likely the option @option{enable-ocsp} is active for gpgsm
91   but Dirmngr's OCSP feature has not been enabled using
92   @option{allow-ocsp} in @file{dirmngr.conf}.
93
94 @end itemize
95