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