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