1 .\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
9 .de Vb \" Begin verbatim text
14 .de Ve \" End verbatim text
18 .\" Set up some character translations and predefined strings. \*(-- will
19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20 .\" double quote, and \*(R" will give a right double quote. \*(C+ will
21 .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
22 .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
23 .\" nothing in troff, for use with C<>.
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
29 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
45 .\" Escape single quotes in literal strings from groff's Unicode transform.
49 .\" If the F register is turned on, we'll generate index entries on stderr for
50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
51 .\" entries marked with X<> in POD. Of course, you'll have to process the
52 .\" output yourself in some meaningful fashion.
54 .\" Avoid warning from groff about undefined register 'F'.
58 .if \n(.g .if rF .nr rF 1
59 .if (\n(rF:(\n(.g==0)) \{
62 . tm Index:\\$1\t\\n%\t"\\$2"
72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
73 .\" Fear. Run. Save yourself. No user-serviceable parts.
74 . \" fudge factors for nroff and troff
83 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
89 . \" simple accents for nroff and troff
99 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
100 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
101 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
102 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
103 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
104 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
106 . \" troff and (daisy-wheel) nroff accents
107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
114 .ds ae a\h'-(\w'a'u*4/10)'e
115 .ds Ae A\h'-(\w'A'u*4/10)'E
116 . \" corrections for vroff
117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
119 . \" for low resolution devices (crt and lpr)
120 .if \n(.H>23 .if \n(.V>19 \
133 .\" ========================================================================
136 .TH OCSP 1 "2016-09-22" "1.0.2i" "OpenSSL"
137 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
138 .\" way too many mistakes in technical documents.
142 ocsp \- Online Certificate Status Protocol utility
144 .IX Header "SYNOPSIS"
145 \&\fBopenssl\fR \fBocsp\fR
147 [\fB\-issuer file\fR]
150 [\fB\-signer file\fR]
151 [\fB\-signkey file\fR]
152 [\fB\-sign_other file\fR]
157 [\fB\-reqout file\fR]
158 [\fB\-respout file\fR]
160 [\fB\-respin file\fR]
163 [\fB\-url \s-1URL\s0\fR]
164 [\fB\-host host:n\fR]
167 [\fB\-CAfile file\fR]
168 [\fB\-no_alt_chains\fR]
169 [\fB\-VAfile file\fR]
170 [\fB\-validity_period n\fR]
171 [\fB\-status_age n\fR]
173 [\fB\-verify_other file\fR]
174 [\fB\-trust_other\fR]
176 [\fB\-no_signature_verify\fR]
177 [\fB\-no_cert_verify\fR]
179 [\fB\-no_cert_checks\fR]
180 [\fB\-no_explicit\fR]
184 [\fB\-rsigner file\fR]
186 [\fB\-rother file\fR]
187 [\fB\-resp_no_certs\fR]
190 [\fB\-resp_key_id\fR]
192 [\fB\-md5|\-sha1|...\fR]
194 .IX Header "DESCRIPTION"
195 The Online Certificate Status Protocol (\s-1OCSP\s0) enables applications to
196 determine the (revocation) state of an identified certificate (\s-1RFC 2560\s0).
198 The \fBocsp\fR command performs many common \s-1OCSP\s0 tasks. It can be used
199 to print out requests and responses, create requests and send queries
200 to an \s-1OCSP\s0 responder and behave like a mini \s-1OCSP\s0 server itself.
201 .SH "OCSP CLIENT OPTIONS"
202 .IX Header "OCSP CLIENT OPTIONS"
203 .IP "\fB\-out filename\fR" 4
204 .IX Item "-out filename"
205 specify output filename, default is standard output.
206 .IP "\fB\-issuer filename\fR" 4
207 .IX Item "-issuer filename"
208 This specifies the current issuer certificate. This option can be used
209 multiple times. The certificate specified in \fBfilename\fR must be in
210 \&\s-1PEM\s0 format. This option \fB\s-1MUST\s0\fR come before any \fB\-cert\fR options.
211 .IP "\fB\-cert filename\fR" 4
212 .IX Item "-cert filename"
213 Add the certificate \fBfilename\fR to the request. The issuer certificate
214 is taken from the previous \fBissuer\fR option, or an error occurs if no
215 issuer certificate is specified.
216 .IP "\fB\-serial num\fR" 4
217 .IX Item "-serial num"
218 Same as the \fBcert\fR option except the certificate with serial number
219 \&\fBnum\fR is added to the request. The serial number is interpreted as a
220 decimal integer unless preceded by \fB0x\fR. Negative integers can also
221 be specified by preceding the value by a \fB\-\fR sign.
222 .IP "\fB\-signer filename\fR, \fB\-signkey filename\fR" 4
223 .IX Item "-signer filename, -signkey filename"
224 Sign the \s-1OCSP\s0 request using the certificate specified in the \fBsigner\fR
225 option and the private key specified by the \fBsignkey\fR option. If
226 the \fBsignkey\fR option is not present then the private key is read
227 from the same file as the certificate. If neither option is specified then
228 the \s-1OCSP\s0 request is not signed.
229 .IP "\fB\-sign_other filename\fR" 4
230 .IX Item "-sign_other filename"
231 Additional certificates to include in the signed request.
232 .IP "\fB\-nonce\fR, \fB\-no_nonce\fR" 4
233 .IX Item "-nonce, -no_nonce"
234 Add an \s-1OCSP\s0 nonce extension to a request or disable \s-1OCSP\s0 nonce addition.
235 Normally if an \s-1OCSP\s0 request is input using the \fBrespin\fR option no
236 nonce is added: using the \fBnonce\fR option will force addition of a nonce.
237 If an \s-1OCSP\s0 request is being created (using \fBcert\fR and \fBserial\fR options)
238 a nonce is automatically added specifying \fBno_nonce\fR overrides this.
239 .IP "\fB\-req_text\fR, \fB\-resp_text\fR, \fB\-text\fR" 4
240 .IX Item "-req_text, -resp_text, -text"
241 print out the text form of the \s-1OCSP\s0 request, response or both respectively.
242 .IP "\fB\-reqout file\fR, \fB\-respout file\fR" 4
243 .IX Item "-reqout file, -respout file"
244 write out the \s-1DER\s0 encoded certificate request or response to \fBfile\fR.
245 .IP "\fB\-reqin file\fR, \fB\-respin file\fR" 4
246 .IX Item "-reqin file, -respin file"
247 read \s-1OCSP\s0 request or response file from \fBfile\fR. These option are ignored
248 if \s-1OCSP\s0 request or response creation is implied by other options (for example
249 with \fBserial\fR, \fBcert\fR and \fBhost\fR options).
250 .IP "\fB\-url responder_url\fR" 4
251 .IX Item "-url responder_url"
252 specify the responder \s-1URL.\s0 Both \s-1HTTP\s0 and \s-1HTTPS \s0(\s-1SSL/TLS\s0) URLs can be specified.
253 .IP "\fB\-host hostname:port\fR, \fB\-path pathname\fR" 4
254 .IX Item "-host hostname:port, -path pathname"
255 if the \fBhost\fR option is present then the \s-1OCSP\s0 request is sent to the host
256 \&\fBhostname\fR on port \fBport\fR. \fBpath\fR specifies the \s-1HTTP\s0 path name to use
257 or \*(L"/\*(R" by default.
258 .IP "\fB\-timeout seconds\fR" 4
259 .IX Item "-timeout seconds"
260 connection timeout to the \s-1OCSP\s0 responder in seconds
261 .IP "\fB\-CAfile file\fR, \fB\-CApath pathname\fR" 4
262 .IX Item "-CAfile file, -CApath pathname"
263 file or pathname containing trusted \s-1CA\s0 certificates. These are used to verify
264 the signature on the \s-1OCSP\s0 response.
265 .IP "\fB\-no_alt_chains\fR" 4
266 .IX Item "-no_alt_chains"
267 See \fBverify\fR manual page for details.
268 .IP "\fB\-verify_other file\fR" 4
269 .IX Item "-verify_other file"
270 file containing additional certificates to search when attempting to locate
271 the \s-1OCSP\s0 response signing certificate. Some responders omit the actual signer's
272 certificate from the response: this option can be used to supply the necessary
273 certificate in such cases.
274 .IP "\fB\-trust_other\fR" 4
275 .IX Item "-trust_other"
276 the certificates specified by the \fB\-verify_other\fR option should be explicitly
277 trusted and no additional checks will be performed on them. This is useful
278 when the complete responder certificate chain is not available or trusting a
279 root \s-1CA\s0 is not appropriate.
280 .IP "\fB\-VAfile file\fR" 4
281 .IX Item "-VAfile file"
282 file containing explicitly trusted responder certificates. Equivalent to the
283 \&\fB\-verify_other\fR and \fB\-trust_other\fR options.
284 .IP "\fB\-noverify\fR" 4
286 don't attempt to verify the \s-1OCSP\s0 response signature or the nonce values. This
287 option will normally only be used for debugging since it disables all verification
288 of the responders certificate.
289 .IP "\fB\-no_intern\fR" 4
290 .IX Item "-no_intern"
291 ignore certificates contained in the \s-1OCSP\s0 response when searching for the
292 signers certificate. With this option the signers certificate must be specified
293 with either the \fB\-verify_other\fR or \fB\-VAfile\fR options.
294 .IP "\fB\-no_signature_verify\fR" 4
295 .IX Item "-no_signature_verify"
296 don't check the signature on the \s-1OCSP\s0 response. Since this option tolerates invalid
297 signatures on \s-1OCSP\s0 responses it will normally only be used for testing purposes.
298 .IP "\fB\-no_cert_verify\fR" 4
299 .IX Item "-no_cert_verify"
300 don't verify the \s-1OCSP\s0 response signers certificate at all. Since this option allows
301 the \s-1OCSP\s0 response to be signed by any certificate it should only be used for
303 .IP "\fB\-no_chain\fR" 4
305 do not use certificates in the response as additional untrusted \s-1CA\s0
307 .IP "\fB\-no_explicit\fR" 4
308 .IX Item "-no_explicit"
309 do not explicitly trust the root \s-1CA\s0 if it is set to be trusted for \s-1OCSP\s0 signing.
310 .IP "\fB\-no_cert_checks\fR" 4
311 .IX Item "-no_cert_checks"
312 don't perform any additional checks on the \s-1OCSP\s0 response signers certificate.
313 That is do not make any checks to see if the signers certificate is authorised
314 to provide the necessary status information: as a result this option should
315 only be used for testing purposes.
316 .IP "\fB\-validity_period nsec\fR, \fB\-status_age age\fR" 4
317 .IX Item "-validity_period nsec, -status_age age"
318 these options specify the range of times, in seconds, which will be tolerated
319 in an \s-1OCSP\s0 response. Each certificate status response includes a \fBnotBefore\fR time and
320 an optional \fBnotAfter\fR time. The current time should fall between these two values, but
321 the interval between the two times may be only a few seconds. In practice the \s-1OCSP\s0
322 responder and clients clocks may not be precisely synchronised and so such a check
323 may fail. To avoid this the \fB\-validity_period\fR option can be used to specify an
324 acceptable error range in seconds, the default value is 5 minutes.
326 If the \fBnotAfter\fR time is omitted from a response then this means that new status
327 information is immediately available. In this case the age of the \fBnotBefore\fR field
328 is checked to see it is not older than \fBage\fR seconds old. By default this additional
329 check is not performed.
330 .IP "\fB\-md5|\-sha1|\-sha256|\-ripemod160|...\fR" 4
331 .IX Item "-md5|-sha1|-sha256|-ripemod160|..."
332 this option sets digest algorithm to use for certificate identification
333 in the \s-1OCSP\s0 request. By default \s-1SHA\-1\s0 is used.
334 .SH "OCSP SERVER OPTIONS"
335 .IX Header "OCSP SERVER OPTIONS"
336 .IP "\fB\-index indexfile\fR" 4
337 .IX Item "-index indexfile"
338 \&\fBindexfile\fR is a text index file in \fBca\fR format containing certificate revocation
341 If the \fBindex\fR option is specified the \fBocsp\fR utility is in responder mode, otherwise
342 it is in client mode. The request(s) the responder processes can be either specified on
343 the command line (using \fBissuer\fR and \fBserial\fR options), supplied in a file (using the
344 \&\fBrespin\fR option) or via external \s-1OCSP\s0 clients (if \fBport\fR or \fBurl\fR is specified).
346 If the \fBindex\fR option is present then the \fB\s-1CA\s0\fR and \fBrsigner\fR options must also be
348 .IP "\fB\-CA file\fR" 4
350 \&\s-1CA\s0 certificate corresponding to the revocation information in \fBindexfile\fR.
351 .IP "\fB\-rsigner file\fR" 4
352 .IX Item "-rsigner file"
353 The certificate to sign \s-1OCSP\s0 responses with.
354 .IP "\fB\-rother file\fR" 4
355 .IX Item "-rother file"
356 Additional certificates to include in the \s-1OCSP\s0 response.
357 .IP "\fB\-resp_no_certs\fR" 4
358 .IX Item "-resp_no_certs"
359 Don't include any certificates in the \s-1OCSP\s0 response.
360 .IP "\fB\-resp_key_id\fR" 4
361 .IX Item "-resp_key_id"
362 Identify the signer certificate using the key \s-1ID,\s0 default is to use the subject name.
363 .IP "\fB\-rkey file\fR" 4
364 .IX Item "-rkey file"
365 The private key to sign \s-1OCSP\s0 responses with: if not present the file specified in the
366 \&\fBrsigner\fR option is used.
367 .IP "\fB\-port portnum\fR" 4
368 .IX Item "-port portnum"
369 Port to listen for \s-1OCSP\s0 requests on. The port may also be specified using the \fBurl\fR
371 .IP "\fB\-nrequest number\fR" 4
372 .IX Item "-nrequest number"
373 The \s-1OCSP\s0 server will exit after receiving \fBnumber\fR requests, default unlimited.
374 .IP "\fB\-nmin minutes\fR, \fB\-ndays days\fR" 4
375 .IX Item "-nmin minutes, -ndays days"
376 Number of minutes or days when fresh revocation information is available: used in the
377 \&\fBnextUpdate\fR field. If neither option is present then the \fBnextUpdate\fR field is
378 omitted meaning fresh revocation information is immediately available.
379 .SH "OCSP Response verification."
380 .IX Header "OCSP Response verification."
381 \&\s-1OCSP\s0 Response follows the rules specified in \s-1RFC2560.\s0
383 Initially the \s-1OCSP\s0 responder certificate is located and the signature on
384 the \s-1OCSP\s0 request checked using the responder certificate's public key.
386 Then a normal certificate verify is performed on the \s-1OCSP\s0 responder certificate
387 building up a certificate chain in the process. The locations of the trusted
388 certificates used to build the chain can be specified by the \fBCAfile\fR
389 and \fBCApath\fR options or they will be looked for in the standard OpenSSL
390 certificates directory.
392 If the initial verify fails then the \s-1OCSP\s0 verify process halts with an
395 Otherwise the issuing \s-1CA\s0 certificate in the request is compared to the \s-1OCSP\s0
396 responder certificate: if there is a match then the \s-1OCSP\s0 verify succeeds.
398 Otherwise the \s-1OCSP\s0 responder certificate's \s-1CA\s0 is checked against the issuing
399 \&\s-1CA\s0 certificate in the request. If there is a match and the OCSPSigning
400 extended key usage is present in the \s-1OCSP\s0 responder certificate then the
401 \&\s-1OCSP\s0 verify succeeds.
403 Otherwise, if \fB\-no_explicit\fR is \fBnot\fR set the root \s-1CA\s0 of the \s-1OCSP\s0 responders
404 \&\s-1CA\s0 is checked to see if it is trusted for \s-1OCSP\s0 signing. If it is the \s-1OCSP\s0
407 If none of these checks is successful then the \s-1OCSP\s0 verify fails.
409 What this effectively means if that if the \s-1OCSP\s0 responder certificate is
410 authorised directly by the \s-1CA\s0 it is issuing revocation information about
411 (and it is correctly configured) then verification will succeed.
413 If the \s-1OCSP\s0 responder is a \*(L"global responder\*(R" which can give details about
414 multiple CAs and has its own separate certificate chain then its root
415 \&\s-1CA\s0 can be trusted for \s-1OCSP\s0 signing. For example:
418 \& openssl x509 \-in ocspCA.pem \-addtrust OCSPSigning \-out trustedCA.pem
421 Alternatively the responder certificate itself can be explicitly trusted
422 with the \fB\-VAfile\fR option.
425 As noted, most of the verify options are for testing or debugging purposes.
426 Normally only the \fB\-CApath\fR, \fB\-CAfile\fR and (if the responder is a 'global
427 \&\s-1VA\s0') \fB\-VAfile\fR options need to be used.
429 The \s-1OCSP\s0 server is only useful for test and demonstration purposes: it is
430 not really usable as a full \s-1OCSP\s0 responder. It contains only a very
431 simple \s-1HTTP\s0 request handling and can only handle the \s-1POST\s0 form of \s-1OCSP\s0
432 queries. It also handles requests serially meaning it cannot respond to
433 new requests until it has processed the current one. The text index file
434 format of revocation is also inefficient for large quantities of revocation
437 It is possible to run the \fBocsp\fR application in responder mode via a \s-1CGI\s0
438 script using the \fBrespin\fR and \fBrespout\fR options.
440 .IX Header "EXAMPLES"
441 Create an \s-1OCSP\s0 request and write it to a file:
444 \& openssl ocsp \-issuer issuer.pem \-cert c1.pem \-cert c2.pem \-reqout req.der
447 Send a query to an \s-1OCSP\s0 responder with \s-1URL\s0 http://ocsp.myhost.com/ save the
448 response to a file and print it out in text form
451 \& openssl ocsp \-issuer issuer.pem \-cert c1.pem \-cert c2.pem \e
452 \& \-url http://ocsp.myhost.com/ \-resp_text \-respout resp.der
455 Read in an \s-1OCSP\s0 response and print out text form:
458 \& openssl ocsp \-respin resp.der \-text
461 \&\s-1OCSP\s0 server on port 8888 using a standard \fBca\fR configuration, and a separate
462 responder certificate. All requests and responses are printed to a file.
465 \& openssl ocsp \-index demoCA/index.txt \-port 8888 \-rsigner rcert.pem \-CA demoCA/cacert.pem
466 \& \-text \-out log.txt
469 As above but exit after processing one request:
472 \& openssl ocsp \-index demoCA/index.txt \-port 8888 \-rsigner rcert.pem \-CA demoCA/cacert.pem
476 Query status information using internally generated request:
479 \& openssl ocsp \-index demoCA/index.txt \-rsigner rcert.pem \-CA demoCA/cacert.pem
480 \& \-issuer demoCA/cacert.pem \-serial 1
483 Query status information using request read from a file, write response to a
487 \& openssl ocsp \-index demoCA/index.txt \-rsigner rcert.pem \-CA demoCA/cacert.pem
488 \& \-reqin req.der \-respout resp.der
492 The \-no_alt_chains options was first added to OpenSSL 1.0.2b.