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