1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
|
@node ocsptool Invocation
@subsection Invoking ocsptool
@pindex ocsptool
@ignore
# -*- buffer-read-only: t -*- vi: set ro:
#
# DO NOT EDIT THIS FILE (invoke-ocsptool.texi)
#
# It has been AutoGen-ed November 17, 2013 at 12:30:23 PM by AutoGen 5.18
# From the definitions ../src/ocsptool-args.def
# and the template file agtexi-cmd.tpl
@end ignore
Ocsptool is a program that can parse and print information about
OCSP requests/responses, generate requests and verify responses.
This section was generated by @strong{AutoGen},
using the @code{agtexi-cmd} template and the option descriptions for the @code{ocsptool} program.
This software is released under the GNU General Public License, version 3 or later.
@anchor{ocsptool usage}
@subsubheading ocsptool help/usage (@option{--help})
@cindex ocsptool help
This is the automatically generated usage text for ocsptool.
The text printed is the same whether selected with the @code{help} option
(@option{--help}) or the @code{more-help} option (@option{--more-help}). @code{more-help} will print
the usage text by passing it through a pager program.
@code{more-help} is disabled on platforms without a working
@code{fork(2)} function. The @code{PAGER} environment variable is
used to select the program, defaulting to @file{more}. Both will exit
with a status code of 0.
@exampleindent 0
@example
ocsptool - GnuTLS OCSP tool
Usage: ocsptool [ -<flag> [<val>] | --<name>[@{=| @}<val>] ]...
-d, --debug=num Enable debugging
- it must be in the range:
0 to 9999
-V, --verbose More verbose output
- may appear multiple times
--infile=file Input file
- file must pre-exist
--outfile=str Output file
--ask[=arg] Ask an OCSP/HTTP server on a certificate validity
- requires these options:
load-cert
load-issuer
-e, --verify-response Verify response
-i, --request-info Print information on a OCSP request
-j, --response-info Print information on a OCSP response
-q, --generate-request Generate an OCSP request
--nonce Don't add nonce to OCSP request
- disabled as '--no-nonce'
--load-issuer=file Read issuer certificate from file
- file must pre-exist
--load-cert=file Read certificate to check from file
- file must pre-exist
--load-trust=file Read OCSP trust anchors from file
- prohibits the option 'load-signer'
- file must pre-exist
--load-signer=file Read OCSP response signer from file
- prohibits the option 'load-trust'
- file must pre-exist
--inder Use DER format for input certificates and private keys
- disabled as '--no-inder'
-Q, --load-request=file Read DER encoded OCSP request from file
- file must pre-exist
-S, --load-response=file Read DER encoded OCSP response from file
- file must pre-exist
-v, --version[=arg] output version information and exit
-h, --help display extended usage information and exit
-!, --more-help extended usage information passed thru pager
Options are specified by doubled hyphens and their name or by a single
hyphen and the flag character.
Ocsptool is a program that can parse and print information about OCSP
requests/responses, generate requests and verify responses.
Please send bug reports to: <bugs@@gnutls.org>
@end example
@exampleindent 4
@anchor{ocsptool debug}
@subsubheading debug option (-d)
This is the ``enable debugging'' option.
This option takes an argument number.
Specifies the debug level.
@anchor{ocsptool ask}
@subsubheading ask option
This is the ``ask an ocsp/http server on a certificate validity'' option.
This option takes an optional argument string @file{server name|url}.
@noindent
This option has some usage constraints. It:
@itemize @bullet
@item
must appear in combination with the following options:
load-cert, load-issuer.
@end itemize
Connects to the specified HTTP OCSP server and queries on the validity of the loaded certificate.
@anchor{ocsptool exit status}
@subsubheading ocsptool exit status
One of the following exit values will be returned:
@table @samp
@item 0 (EXIT_SUCCESS)
Successful program execution.
@item 1 (EXIT_FAILURE)
The operation failed or the command syntax was not valid.
@end table
@anchor{ocsptool See Also}
@subsubheading ocsptool See Also
certtool (1)
@anchor{ocsptool Examples}
@subsubheading ocsptool Examples
@subsubheading Print information about an OCSP request
To parse an OCSP request and print information about the content, the
@code{-i} or @code{--request-info} parameter may be used as follows.
The @code{-Q} parameter specify the name of the file containing the
OCSP request, and it should contain the OCSP request in binary DER
format.
@example
$ ocsptool -i -Q ocsp-request.der
@end example
The input file may also be sent to standard input like this:
@example
$ cat ocsp-request.der | ocsptool --request-info
@end example
@subsubheading Print information about an OCSP response
Similar to parsing OCSP requests, OCSP responses can be parsed using
the @code{-j} or @code{--response-info} as follows.
@example
$ ocsptool -j -Q ocsp-response.der
$ cat ocsp-response.der | ocsptool --response-info
@end example
@subsubheading Generate an OCSP request
The @code{-q} or @code{--generate-request} parameters are used to
generate an OCSP request. By default the OCSP request is written to
standard output in binary DER format, but can be stored in a file
using @code{--outfile}. To generate an OCSP request the issuer of the
certificate to check needs to be specified with @code{--load-issuer}
and the certificate to check with @code{--load-cert}. By default PEM
format is used for these files, although @code{--inder} can be used to
specify that the input files are in DER format.
@example
$ ocsptool -q --load-issuer issuer.pem --load-cert client.pem \
--outfile ocsp-request.der
@end example
When generating OCSP requests, the tool will add an OCSP extension
containing a nonce. This behaviour can be disabled by specifying
@code{--no-nonce}.
@subsubheading Verify signature in OCSP response
To verify the signature in an OCSP response the @code{-e} or
@code{--verify-response} parameter is used. The tool will read an
OCSP response in DER format from standard input, or from the file
specified by @code{--load-response}. The OCSP response is verified
against a set of trust anchors, which are specified using
@code{--load-trust}. The trust anchors are concatenated certificates
in PEM format. The certificate that signed the OCSP response needs to
be in the set of trust anchors, or the issuer of the signer
certificate needs to be in the set of trust anchors and the OCSP
Extended Key Usage bit has to be asserted in the signer certificate.
@example
$ ocsptool -e --load-trust issuer.pem \
--load-response ocsp-response.der
@end example
The tool will print status of verification.
@subsubheading Verify signature in OCSP response against given certificate
It is possible to override the normal trust logic if you know that a
certain certificate is supposed to have signed the OCSP response, and
you want to use it to check the signature. This is achieved using
@code{--load-signer} instead of @code{--load-trust}. This will load
one certificate and it will be used to verify the signature in the
OCSP response. It will not check the Extended Key Usage bit.
@example
$ ocsptool -e --load-signer ocsp-signer.pem \
--load-response ocsp-response.der
@end example
This approach is normally only relevant in two situations. The first
is when the OCSP response does not contain a copy of the signer
certificate, so the @code{--load-trust} code would fail. The second
is if you want to avoid the indirect mode where the OCSP response
signer certificate is signed by a trust anchor.
@subsubheading Real-world example
Here is an example of how to generate an OCSP request for a
certificate and to verify the response. For illustration we'll use
the @code{blog.josefsson.org} host, which (as of writing) uses a
certificate from CACert. First we'll use @code{gnutls-cli} to get a
copy of the server certificate chain. The server is not required to
send this information, but this particular one is configured to do so.
@example
$ echo | gnutls-cli -p 443 blog.josefsson.org --print-cert > chain.pem
@end example
Use a text editor on @code{chain.pem} to create three files for each
separate certificates, called @code{cert.pem} for the first
certificate for the domain itself, secondly @code{issuer.pem} for the
intermediate certificate and @code{root.pem} for the final root
certificate.
The domain certificate normally contains a pointer to where the OCSP
responder is located, in the Authority Information Access Information
extension. For example, from @code{certtool -i < cert.pem} there is
this information:
@example
Authority Information Access Information (not critical):
Access Method: 1.3.6.1.5.5.7.48.1 (id-ad-ocsp)
Access Location URI: http://ocsp.CAcert.org/
@end example
This means the CA support OCSP queries over HTTP. We are now ready to
create a OCSP request for the certificate.
@example
$ ocsptool --ask ocsp.CAcert.org --load-issuer issuer.pem \
--load-cert cert.pem --outfile ocsp-response.der
@end example
The request is sent via HTTP to the OCSP server address specified. If the
address is ommited ocsptool will use the address stored in the certificate.
|