1ecd92887b236ae4640259fdf55a63cf0b65fe19
[openssl.git] / doc / apps / ocsp.pod
1 =pod
2
3 =head1 NAME
4
5 ocsp - Online Certificate Status Protocol utility
6
7 =head1 SYNOPSIS
8
9 B<openssl> B<ocsp>
10 [B<-help>]
11 [B<-out file>]
12 [B<-issuer file>]
13 [B<-cert file>]
14 [B<-serial n>]
15 [B<-signer file>]
16 [B<-signkey file>]
17 [B<-sign_other file>]
18 [B<-no_certs>]
19 [B<-req_text>]
20 [B<-resp_text>]
21 [B<-text>]
22 [B<-reqout file>]
23 [B<-respout file>]
24 [B<-reqin file>]
25 [B<-respin file>]
26 [B<-nonce>]
27 [B<-no_nonce>]
28 [B<-url URL>]
29 [B<-host host:port>]
30 [B<-header>]
31 [B<-path>]
32 [B<-CApath dir>]
33 [B<-CAfile file>]
34 [B<-no-CAfile>]
35 [B<-no-CApath>]
36 [B<-attime timestamp>]
37 [B<-check_ss_sig>]
38 [B<-crl_check>]
39 [B<-crl_check_all>]
40 [B<-explicit_policy>]
41 [B<-extended_crl>]
42 [B<-ignore_critical>]
43 [B<-inhibit_any>]
44 [B<-inhibit_map>]
45 [B<-partial_chain>]
46 [B<-policy arg>]
47 [B<-policy_check>]
48 [B<-policy_print>]
49 [B<-purpose purpose>]
50 [B<-suiteB_128>]
51 [B<-suiteB_128_only>]
52 [B<-suiteB_192>]
53 [B<-trusted_first>]
54 [B<-no_alt_chains>]
55 [B<-use_deltas>]
56 [B<-verify_depth num>]
57 [B<-verify_email email>]
58 [B<-verify_hostname hostname>]
59 [B<-verify_ip ip>]
60 [B<-verify_name name>]
61 [B<-x509_strict>]
62 [B<-VAfile file>]
63 [B<-validity_period n>]
64 [B<-status_age n>]
65 [B<-noverify>]
66 [B<-verify_other file>]
67 [B<-trust_other>]
68 [B<-no_intern>]
69 [B<-no_signature_verify>]
70 [B<-no_cert_verify>]
71 [B<-no_chain>]
72 [B<-no_cert_checks>]
73 [B<-no_explicit>]
74 [B<-port num>]
75 [B<-index file>]
76 [B<-CA file>]
77 [B<-rsigner file>]
78 [B<-rkey file>]
79 [B<-rother file>]
80 [B<-resp_no_certs>]
81 [B<-nmin n>]
82 [B<-ndays n>]
83 [B<-resp_key_id>]
84 [B<-nrequest n>]
85 [B<-md5|-sha1|...>]
86
87 =head1 DESCRIPTION
88
89 The Online Certificate Status Protocol (OCSP) enables applications to
90 determine the (revocation) state of an identified certificate (RFC 2560).
91
92 The B<ocsp> command performs many common OCSP tasks. It can be used
93 to print out requests and responses, create requests and send queries
94 to an OCSP responder and behave like a mini OCSP server itself.
95
96 =head1 OCSP CLIENT OPTIONS
97
98 =over 4
99
100 =item B<-help>
101
102 Print out a usage message.
103
104 =item B<-out filename>
105
106 specify output filename, default is standard output.
107
108 =item B<-issuer filename>
109
110 This specifies the current issuer certificate. This option can be used
111 multiple times. The certificate specified in B<filename> must be in
112 PEM format. This option B<MUST> come before any B<-cert> options.
113
114 =item B<-cert filename>
115
116 Add the certificate B<filename> to the request. The issuer certificate
117 is taken from the previous B<issuer> option, or an error occurs if no
118 issuer certificate is specified.
119
120 =item B<-serial num>
121
122 Same as the B<cert> option except the certificate with serial number
123 B<num> is added to the request. The serial number is interpreted as a
124 decimal integer unless preceded by B<0x>. Negative integers can also
125 be specified by preceding the value by a B<-> sign.
126
127 =item B<-signer filename>, B<-signkey filename>
128
129 Sign the OCSP request using the certificate specified in the B<signer>
130 option and the private key specified by the B<signkey> option. If
131 the B<signkey> option is not present then the private key is read
132 from the same file as the certificate. If neither option is specified then
133 the OCSP request is not signed.
134
135 =item B<-sign_other filename>
136
137 Additional certificates to include in the signed request.
138
139 =item B<-nonce>, B<-no_nonce>
140
141 Add an OCSP nonce extension to a request or disable OCSP nonce addition.
142 Normally if an OCSP request is input using the B<respin> option no
143 nonce is added: using the B<nonce> option will force addition of a nonce.
144 If an OCSP request is being created (using B<cert> and B<serial> options)
145 a nonce is automatically added specifying B<no_nonce> overrides this.
146
147 =item B<-req_text>, B<-resp_text>, B<-text>
148
149 print out the text form of the OCSP request, response or both respectively.
150
151 =item B<-reqout file>, B<-respout file>
152
153 write out the DER encoded certificate request or response to B<file>.
154
155 =item B<-reqin file>, B<-respin file>
156
157 read OCSP request or response file from B<file>. These option are ignored
158 if OCSP request or response creation is implied by other options (for example
159 with B<serial>, B<cert> and B<host> options).
160
161 =item B<-url responder_url>
162
163 specify the responder URL. Both HTTP and HTTPS (SSL/TLS) URLs can be specified.
164
165 =item B<-host hostname:port>, B<-path pathname>
166
167 if the B<host> option is present then the OCSP request is sent to the host
168 B<hostname> on port B<port>. B<path> specifies the HTTP path name to use
169 or "/" by default.
170
171 =item B<-header name=value>
172
173 Adds the header B<name> with the specified B<value> to the OCSP request
174 that is sent to the responder.
175 This may be repeated.
176
177 =item B<-timeout seconds>
178
179 connection timeout to the OCSP responder in seconds
180
181 =item B<-CAfile file>, B<-CApath pathname>
182
183 file or pathname containing trusted CA certificates. These are used to verify
184 the signature on the OCSP response.
185
186 =item B<-no-CAfile>
187
188 Do not load the trusted CA certificates from the default file location
189
190 =item B<-no-CApath>
191
192 Do not load the trusted CA certificates from the default directory location
193
194 =item B<-attime>, B<-check_ss_sig>, B<-crl_check>, B<-crl_check_all>,
195 B<-explicit_policy>, B<-extended_crl>, B<-ignore_critical>, B<-inhibit_any>,
196 B<-inhibit_map>, B<-no_alt_chains>, B<-partial_chain>, B<-policy>,
197 B<-policy_check>, B<-policy_print>, B<-purpose>, B<-suiteB_128>,
198 B<-suiteB_128_only>, B<-suiteB_192>, B<-trusted_first>, B<-use_deltas>,
199 B<-verify_depth>, B<-verify_email>, B<-verify_hostname>, B<-verify_ip>,
200 B<-verify_name>, B<-x509_strict>
201
202 Set different certificate verification options.
203 See L<B<verify>|verify(1)> manual page for details.
204
205 =item B<-verify_other file>
206
207 file containing additional certificates to search when attempting to locate
208 the OCSP response signing certificate. Some responders omit the actual signer's
209 certificate from the response: this option can be used to supply the necessary
210 certificate in such cases.
211
212 =item B<-trust_other>
213
214 the certificates specified by the B<-verify_other> option should be explicitly
215 trusted and no additional checks will be performed on them. This is useful
216 when the complete responder certificate chain is not available or trusting a
217 root CA is not appropriate.
218
219 =item B<-VAfile file>
220
221 file containing explicitly trusted responder certificates. Equivalent to the
222 B<-verify_other> and B<-trust_other> options.
223
224 =item B<-noverify>
225
226 don't attempt to verify the OCSP response signature or the nonce values. This
227 option will normally only be used for debugging since it disables all verification
228 of the responders certificate.
229
230 =item B<-no_intern>
231
232 ignore certificates contained in the OCSP response when searching for the
233 signers certificate. With this option the signers certificate must be specified
234 with either the B<-verify_other> or B<-VAfile> options.
235
236 =item B<-no_signature_verify>
237
238 don't check the signature on the OCSP response. Since this option tolerates invalid
239 signatures on OCSP responses it will normally only be used for testing purposes.
240
241 =item B<-no_cert_verify>
242
243 don't verify the OCSP response signers certificate at all. Since this option allows
244 the OCSP response to be signed by any certificate it should only be used for
245 testing purposes.
246
247 =item B<-no_chain>
248
249 do not use certificates in the response as additional untrusted CA
250 certificates.
251
252 =item B<-no_explicit>
253
254 do not explicitly trust the root CA if it is set to be trusted for OCSP signing.
255
256 =item B<-no_cert_checks>
257
258 don't perform any additional checks on the OCSP response signers certificate.
259 That is do not make any checks to see if the signers certificate is authorised
260 to provide the necessary status information: as a result this option should
261 only be used for testing purposes.
262
263 =item B<-validity_period nsec>, B<-status_age age>
264
265 these options specify the range of times, in seconds, which will be tolerated
266 in an OCSP response. Each certificate status response includes a B<notBefore> time and
267 an optional B<notAfter> time. The current time should fall between these two values, but
268 the interval between the two times may be only a few seconds. In practice the OCSP
269 responder and clients clocks may not be precisely synchronised and so such a check
270 may fail. To avoid this the B<-validity_period> option can be used to specify an
271 acceptable error range in seconds, the default value is 5 minutes.
272
273 If the B<notAfter> time is omitted from a response then this means that new status
274 information is immediately available. In this case the age of the B<notBefore> field
275 is checked to see it is not older than B<age> seconds old. By default this additional
276 check is not performed.
277
278 =item B<-[digest]>
279
280 this option sets digest algorithm to use for certificate identification
281 in the OCSP request.
282 Any digest supported by the OpenSSL B<dgst> command can be used.
283 The default is SHA-1.
284
285 =back
286
287 =head1 OCSP SERVER OPTIONS
288
289 =over 4
290
291 =item B<-index indexfile>
292
293 B<indexfile> is a text index file in B<ca> format containing certificate revocation
294 information.
295
296 If the B<index> option is specified the B<ocsp> utility is in responder mode, otherwise
297 it is in client mode. The request(s) the responder processes can be either specified on
298 the command line (using B<issuer> and B<serial> options), supplied in a file (using the
299 B<respin> option) or via external OCSP clients (if B<port> or B<url> is specified).
300
301 If the B<index> option is present then the B<CA> and B<rsigner> options must also be
302 present.
303
304 =item B<-CA file>
305
306 CA certificate corresponding to the revocation information in B<indexfile>.
307
308 =item B<-rsigner file>
309
310 The certificate to sign OCSP responses with.
311
312 =item B<-rother file>
313
314 Additional certificates to include in the OCSP response.
315
316 =item B<-resp_no_certs>
317
318 Don't include any certificates in the OCSP response.
319
320 =item B<-resp_key_id>
321
322 Identify the signer certificate using the key ID, default is to use the subject name.
323
324 =item B<-rkey file>
325
326 The private key to sign OCSP responses with: if not present the file specified in the
327 B<rsigner> option is used.
328
329 =item B<-port portnum>
330
331 Port to listen for OCSP requests on. The port may also be specified using the B<url>
332 option.
333
334 =item B<-nrequest number>
335
336 The OCSP server will exit after receiving B<number> requests, default unlimited. 
337
338 =item B<-nmin minutes>, B<-ndays days>
339
340 Number of minutes or days when fresh revocation information is available: used in the
341 B<nextUpdate> field. If neither option is present then the B<nextUpdate> field is 
342 omitted meaning fresh revocation information is immediately available.
343
344 =back
345
346 =head1 OCSP Response verification.
347
348 OCSP Response follows the rules specified in RFC2560.
349
350 Initially the OCSP responder certificate is located and the signature on
351 the OCSP request checked using the responder certificate's public key.
352
353 Then a normal certificate verify is performed on the OCSP responder certificate
354 building up a certificate chain in the process. The locations of the trusted
355 certificates used to build the chain can be specified by the B<CAfile>
356 and B<CApath> options or they will be looked for in the standard OpenSSL
357 certificates directory.
358
359 If the initial verify fails then the OCSP verify process halts with an
360 error.
361
362 Otherwise the issuing CA certificate in the request is compared to the OCSP
363 responder certificate: if there is a match then the OCSP verify succeeds.
364
365 Otherwise the OCSP responder certificate's CA is checked against the issuing
366 CA certificate in the request. If there is a match and the OCSPSigning
367 extended key usage is present in the OCSP responder certificate then the
368 OCSP verify succeeds.
369
370 Otherwise, if B<-no_explicit> is B<not> set the root CA of the OCSP responders
371 CA is checked to see if it is trusted for OCSP signing. If it is the OCSP
372 verify succeeds.
373
374 If none of these checks is successful then the OCSP verify fails.
375
376 What this effectively means if that if the OCSP responder certificate is
377 authorised directly by the CA it is issuing revocation information about
378 (and it is correctly configured) then verification will succeed.
379
380 If the OCSP responder is a "global responder" which can give details about
381 multiple CAs and has its own separate certificate chain then its root
382 CA can be trusted for OCSP signing. For example:
383
384  openssl x509 -in ocspCA.pem -addtrust OCSPSigning -out trustedCA.pem
385
386 Alternatively the responder certificate itself can be explicitly trusted
387 with the B<-VAfile> option.
388
389 =head1 NOTES
390
391 As noted, most of the verify options are for testing or debugging purposes.
392 Normally only the B<-CApath>, B<-CAfile> and (if the responder is a 'global
393 VA') B<-VAfile> options need to be used.
394
395 The OCSP server is only useful for test and demonstration purposes: it is
396 not really usable as a full OCSP responder. It contains only a very
397 simple HTTP request handling and can only handle the POST form of OCSP
398 queries. It also handles requests serially meaning it cannot respond to
399 new requests until it has processed the current one. The text index file
400 format of revocation is also inefficient for large quantities of revocation
401 data.
402
403 It is possible to run the B<ocsp> application in responder mode via a CGI
404 script using the B<respin> and B<respout> options.
405
406 =head1 EXAMPLES
407
408 Create an OCSP request and write it to a file:
409
410  openssl ocsp -issuer issuer.pem -cert c1.pem -cert c2.pem -reqout req.der
411
412 Send a query to an OCSP responder with URL http://ocsp.myhost.com/ save the 
413 response to a file and print it out in text form
414
415  openssl ocsp -issuer issuer.pem -cert c1.pem -cert c2.pem \
416      -url http://ocsp.myhost.com/ -resp_text -respout resp.der
417
418 Read in an OCSP response and print out text form:
419
420  openssl ocsp -respin resp.der -text
421
422 OCSP server on port 8888 using a standard B<ca> configuration, and a separate
423 responder certificate. All requests and responses are printed to a file.
424
425  openssl ocsp -index demoCA/index.txt -port 8888 -rsigner rcert.pem -CA demoCA/cacert.pem
426         -text -out log.txt
427
428 As above but exit after processing one request:
429
430  openssl ocsp -index demoCA/index.txt -port 8888 -rsigner rcert.pem -CA demoCA/cacert.pem
431      -nrequest 1
432
433 Query status information using internally generated request:
434
435  openssl ocsp -index demoCA/index.txt -rsigner rcert.pem -CA demoCA/cacert.pem
436      -issuer demoCA/cacert.pem -serial 1
437
438 Query status information using request read from a file, write response to a
439 second file.
440
441  openssl ocsp -index demoCA/index.txt -rsigner rcert.pem -CA demoCA/cacert.pem
442      -reqin req.der -respout resp.der
443
444 =head1 HISTORY
445
446 The -no_alt_chains options was first added to OpenSSL 1.1.0.
447
448 =cut