]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - secure/usr.bin/openssl/man/ocsp.1
MFS: r366176
[FreeBSD/FreeBSD.git] / secure / usr.bin / openssl / man / ocsp.1
1 .\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
6 .if t .sp .5v
7 .if n .sp
8 ..
9 .de Vb \" Begin verbatim text
10 .ft CW
11 .nf
12 .ne \\$1
13 ..
14 .de Ve \" End verbatim text
15 .ft R
16 .fi
17 ..
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<>.
24 .tr \(*W-
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
26 .ie n \{\
27 .    ds -- \(*W-
28 .    ds PI pi
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
31 .    ds L" ""
32 .    ds R" ""
33 .    ds C` ""
34 .    ds C' ""
35 'br\}
36 .el\{\
37 .    ds -- \|\(em\|
38 .    ds PI \(*p
39 .    ds L" ``
40 .    ds R" ''
41 .    ds C`
42 .    ds C'
43 'br\}
44 .\"
45 .\" Escape single quotes in literal strings from groff's Unicode transform.
46 .ie \n(.g .ds Aq \(aq
47 .el       .ds Aq '
48 .\"
49 .\" If the F register is >0, 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.
53 .\"
54 .\" Avoid warning from groff about undefined register 'F'.
55 .de IX
56 ..
57 .nr rF 0
58 .if \n(.g .if rF .nr rF 1
59 .if (\n(rF:(\n(.g==0)) \{\
60 .    if \nF \{\
61 .        de IX
62 .        tm Index:\\$1\t\\n%\t"\\$2"
63 ..
64 .        if !\nF==2 \{\
65 .            nr % 0
66 .            nr F 2
67 .        \}
68 .    \}
69 .\}
70 .rr rF
71 .\"
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
75 .if n \{\
76 .    ds #H 0
77 .    ds #V .8m
78 .    ds #F .3m
79 .    ds #[ \f1
80 .    ds #] \fP
81 .\}
82 .if t \{\
83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
84 .    ds #V .6m
85 .    ds #F 0
86 .    ds #[ \&
87 .    ds #] \&
88 .\}
89 .    \" simple accents for nroff and troff
90 .if n \{\
91 .    ds ' \&
92 .    ds ` \&
93 .    ds ^ \&
94 .    ds , \&
95 .    ds ~ ~
96 .    ds /
97 .\}
98 .if t \{\
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'
105 .\}
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 \
121 \{\
122 .    ds : e
123 .    ds 8 ss
124 .    ds o a
125 .    ds d- d\h'-1'\(ga
126 .    ds D- D\h'-1'\(hy
127 .    ds th \o'bp'
128 .    ds Th \o'LP'
129 .    ds ae ae
130 .    ds Ae AE
131 .\}
132 .rm #[ #] #H #V #F C
133 .\" ========================================================================
134 .\"
135 .IX Title "OCSP 1"
136 .TH OCSP 1 "2020-09-22" "1.1.1h" "OpenSSL"
137 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
138 .\" way too many mistakes in technical documents.
139 .if n .ad l
140 .nh
141 .SH "NAME"
142 openssl\-ocsp, ocsp \- Online Certificate Status Protocol utility
143 .SH "SYNOPSIS"
144 .IX Header "SYNOPSIS"
145 \&\fBopenssl\fR \fBocsp\fR
146 [\fB\-help\fR]
147 [\fB\-out file\fR]
148 [\fB\-issuer file\fR]
149 [\fB\-cert file\fR]
150 [\fB\-serial n\fR]
151 [\fB\-signer file\fR]
152 [\fB\-signkey file\fR]
153 [\fB\-sign_other file\fR]
154 [\fB\-no_certs\fR]
155 [\fB\-req_text\fR]
156 [\fB\-resp_text\fR]
157 [\fB\-text\fR]
158 [\fB\-reqout file\fR]
159 [\fB\-respout file\fR]
160 [\fB\-reqin file\fR]
161 [\fB\-respin file\fR]
162 [\fB\-nonce\fR]
163 [\fB\-no_nonce\fR]
164 [\fB\-url \s-1URL\s0\fR]
165 [\fB\-host host:port\fR]
166 [\fB\-multi process-count\fR]
167 [\fB\-header\fR]
168 [\fB\-path\fR]
169 [\fB\-CApath dir\fR]
170 [\fB\-CAfile file\fR]
171 [\fB\-no\-CAfile\fR]
172 [\fB\-no\-CApath\fR]
173 [\fB\-attime timestamp\fR]
174 [\fB\-check_ss_sig\fR]
175 [\fB\-crl_check\fR]
176 [\fB\-crl_check_all\fR]
177 [\fB\-explicit_policy\fR]
178 [\fB\-extended_crl\fR]
179 [\fB\-ignore_critical\fR]
180 [\fB\-inhibit_any\fR]
181 [\fB\-inhibit_map\fR]
182 [\fB\-no_check_time\fR]
183 [\fB\-partial_chain\fR]
184 [\fB\-policy arg\fR]
185 [\fB\-policy_check\fR]
186 [\fB\-policy_print\fR]
187 [\fB\-purpose purpose\fR]
188 [\fB\-suiteB_128\fR]
189 [\fB\-suiteB_128_only\fR]
190 [\fB\-suiteB_192\fR]
191 [\fB\-trusted_first\fR]
192 [\fB\-no_alt_chains\fR]
193 [\fB\-use_deltas\fR]
194 [\fB\-auth_level num\fR]
195 [\fB\-verify_depth num\fR]
196 [\fB\-verify_email email\fR]
197 [\fB\-verify_hostname hostname\fR]
198 [\fB\-verify_ip ip\fR]
199 [\fB\-verify_name name\fR]
200 [\fB\-x509_strict\fR]
201 [\fB\-VAfile file\fR]
202 [\fB\-validity_period n\fR]
203 [\fB\-status_age n\fR]
204 [\fB\-noverify\fR]
205 [\fB\-verify_other file\fR]
206 [\fB\-trust_other\fR]
207 [\fB\-no_intern\fR]
208 [\fB\-no_signature_verify\fR]
209 [\fB\-no_cert_verify\fR]
210 [\fB\-no_chain\fR]
211 [\fB\-no_cert_checks\fR]
212 [\fB\-no_explicit\fR]
213 [\fB\-port num\fR]
214 [\fB\-ignore_err\fR]
215 [\fB\-index file\fR]
216 [\fB\-CA file\fR]
217 [\fB\-rsigner file\fR]
218 [\fB\-rkey file\fR]
219 [\fB\-rother file\fR]
220 [\fB\-rsigopt nm:v\fR]
221 [\fB\-resp_no_certs\fR]
222 [\fB\-nmin n\fR]
223 [\fB\-ndays n\fR]
224 [\fB\-resp_key_id\fR]
225 [\fB\-nrequest n\fR]
226 [\fB\-\f(BIdigest\fB\fR]
227 .SH "DESCRIPTION"
228 .IX Header "DESCRIPTION"
229 The Online Certificate Status Protocol (\s-1OCSP\s0) enables applications to
230 determine the (revocation) state of an identified certificate (\s-1RFC 2560\s0).
231 .PP
232 The \fBocsp\fR command performs many common \s-1OCSP\s0 tasks. It can be used
233 to print out requests and responses, create requests and send queries
234 to an \s-1OCSP\s0 responder and behave like a mini \s-1OCSP\s0 server itself.
235 .SH "OPTIONS"
236 .IX Header "OPTIONS"
237 This command operates as either a client or a server.
238 The options are described below, divided into those two modes.
239 .SS "\s-1OCSP\s0 Client Options"
240 .IX Subsection "OCSP Client Options"
241 .IP "\fB\-help\fR" 4
242 .IX Item "-help"
243 Print out a usage message.
244 .IP "\fB\-out filename\fR" 4
245 .IX Item "-out filename"
246 specify output filename, default is standard output.
247 .IP "\fB\-issuer filename\fR" 4
248 .IX Item "-issuer filename"
249 This specifies the current issuer certificate. This option can be used
250 multiple times. The certificate specified in \fBfilename\fR must be in
251 \&\s-1PEM\s0 format. This option \fB\s-1MUST\s0\fR come before any \fB\-cert\fR options.
252 .IP "\fB\-cert filename\fR" 4
253 .IX Item "-cert filename"
254 Add the certificate \fBfilename\fR to the request. The issuer certificate
255 is taken from the previous \fBissuer\fR option, or an error occurs if no
256 issuer certificate is specified.
257 .IP "\fB\-serial num\fR" 4
258 .IX Item "-serial num"
259 Same as the \fBcert\fR option except the certificate with serial number
260 \&\fBnum\fR is added to the request. The serial number is interpreted as a
261 decimal integer unless preceded by \fB0x\fR. Negative integers can also
262 be specified by preceding the value by a \fB\-\fR sign.
263 .IP "\fB\-signer filename\fR, \fB\-signkey filename\fR" 4
264 .IX Item "-signer filename, -signkey filename"
265 Sign the \s-1OCSP\s0 request using the certificate specified in the \fBsigner\fR
266 option and the private key specified by the \fBsignkey\fR option. If
267 the \fBsignkey\fR option is not present then the private key is read
268 from the same file as the certificate. If neither option is specified then
269 the \s-1OCSP\s0 request is not signed.
270 .IP "\fB\-sign_other filename\fR" 4
271 .IX Item "-sign_other filename"
272 Additional certificates to include in the signed request.
273 .IP "\fB\-nonce\fR, \fB\-no_nonce\fR" 4
274 .IX Item "-nonce, -no_nonce"
275 Add an \s-1OCSP\s0 nonce extension to a request or disable \s-1OCSP\s0 nonce addition.
276 Normally if an \s-1OCSP\s0 request is input using the \fBreqin\fR option no
277 nonce is added: using the \fBnonce\fR option will force addition of a nonce.
278 If an \s-1OCSP\s0 request is being created (using \fBcert\fR and \fBserial\fR options)
279 a nonce is automatically added specifying \fBno_nonce\fR overrides this.
280 .IP "\fB\-req_text\fR, \fB\-resp_text\fR, \fB\-text\fR" 4
281 .IX Item "-req_text, -resp_text, -text"
282 Print out the text form of the \s-1OCSP\s0 request, response or both respectively.
283 .IP "\fB\-reqout file\fR, \fB\-respout file\fR" 4
284 .IX Item "-reqout file, -respout file"
285 Write out the \s-1DER\s0 encoded certificate request or response to \fBfile\fR.
286 .IP "\fB\-reqin file\fR, \fB\-respin file\fR" 4
287 .IX Item "-reqin file, -respin file"
288 Read \s-1OCSP\s0 request or response file from \fBfile\fR. These option are ignored
289 if \s-1OCSP\s0 request or response creation is implied by other options (for example
290 with \fBserial\fR, \fBcert\fR and \fBhost\fR options).
291 .IP "\fB\-url responder_url\fR" 4
292 .IX Item "-url responder_url"
293 Specify the responder \s-1URL.\s0 Both \s-1HTTP\s0 and \s-1HTTPS\s0 (\s-1SSL/TLS\s0) URLs can be specified.
294 .IP "\fB\-host hostname:port\fR, \fB\-path pathname\fR" 4
295 .IX Item "-host hostname:port, -path pathname"
296 If the \fBhost\fR option is present then the \s-1OCSP\s0 request is sent to the host
297 \&\fBhostname\fR on port \fBport\fR. \fBpath\fR specifies the \s-1HTTP\s0 pathname to use
298 or \*(L"/\*(R" by default.  This is equivalent to specifying \fB\-url\fR with scheme
299 http:// and the given hostname, port, and pathname.
300 .IP "\fB\-header name=value\fR" 4
301 .IX Item "-header name=value"
302 Adds the header \fBname\fR with the specified \fBvalue\fR to the \s-1OCSP\s0 request
303 that is sent to the responder.
304 This may be repeated.
305 .IP "\fB\-timeout seconds\fR" 4
306 .IX Item "-timeout seconds"
307 Connection timeout to the \s-1OCSP\s0 responder in seconds.
308 On \s-1POSIX\s0 systems, when running as an \s-1OCSP\s0 responder, this option also limits
309 the time that the responder is willing to wait for the client request.
310 This time is measured from the time the responder accepts the connection until
311 the complete request is received.
312 .IP "\fB\-multi process-count\fR" 4
313 .IX Item "-multi process-count"
314 Run the specified number of \s-1OCSP\s0 responder child processes, with the parent
315 process respawning child processes as needed.
316 Child processes will detect changes in the \s-1CA\s0 index file and automatically
317 reload it.
318 When running as a responder \fB\-timeout\fR option is recommended to limit the time
319 each child is willing to wait for the client's \s-1OCSP\s0 response.
320 This option is available on \s-1POSIX\s0 systems (that support the \fBfork()\fR and other
321 required unix system-calls).
322 .IP "\fB\-CAfile file\fR, \fB\-CApath pathname\fR" 4
323 .IX Item "-CAfile file, -CApath pathname"
324 File or pathname containing trusted \s-1CA\s0 certificates. These are used to verify
325 the signature on the \s-1OCSP\s0 response.
326 .IP "\fB\-no\-CAfile\fR" 4
327 .IX Item "-no-CAfile"
328 Do not load the trusted \s-1CA\s0 certificates from the default file location
329 .IP "\fB\-no\-CApath\fR" 4
330 .IX Item "-no-CApath"
331 Do not load the trusted \s-1CA\s0 certificates from the default directory location
332 .IP "\fB\-attime\fR, \fB\-check_ss_sig\fR, \fB\-crl_check\fR, \fB\-crl_check_all\fR, \fB\-explicit_policy\fR, \fB\-extended_crl\fR, \fB\-ignore_critical\fR, \fB\-inhibit_any\fR, \fB\-inhibit_map\fR, \fB\-no_alt_chains\fR, \fB\-no_check_time\fR, \fB\-partial_chain\fR, \fB\-policy\fR, \fB\-policy_check\fR, \fB\-policy_print\fR, \fB\-purpose\fR, \fB\-suiteB_128\fR, \fB\-suiteB_128_only\fR, \fB\-suiteB_192\fR, \fB\-trusted_first\fR, \fB\-use_deltas\fR, \fB\-auth_level\fR, \fB\-verify_depth\fR, \fB\-verify_email\fR, \fB\-verify_hostname\fR, \fB\-verify_ip\fR, \fB\-verify_name\fR, \fB\-x509_strict\fR" 4
333 .IX Item "-attime, -check_ss_sig, -crl_check, -crl_check_all, -explicit_policy, -extended_crl, -ignore_critical, -inhibit_any, -inhibit_map, -no_alt_chains, -no_check_time, -partial_chain, -policy, -policy_check, -policy_print, -purpose, -suiteB_128, -suiteB_128_only, -suiteB_192, -trusted_first, -use_deltas, -auth_level, -verify_depth, -verify_email, -verify_hostname, -verify_ip, -verify_name, -x509_strict"
334 Set different certificate verification options.
335 See \fBverify\fR\|(1) manual page for details.
336 .IP "\fB\-verify_other file\fR" 4
337 .IX Item "-verify_other file"
338 File containing additional certificates to search when attempting to locate
339 the \s-1OCSP\s0 response signing certificate. Some responders omit the actual signer's
340 certificate from the response: this option can be used to supply the necessary
341 certificate in such cases.
342 .IP "\fB\-trust_other\fR" 4
343 .IX Item "-trust_other"
344 The certificates specified by the \fB\-verify_other\fR option should be explicitly
345 trusted and no additional checks will be performed on them. This is useful
346 when the complete responder certificate chain is not available or trusting a
347 root \s-1CA\s0 is not appropriate.
348 .IP "\fB\-VAfile file\fR" 4
349 .IX Item "-VAfile file"
350 File containing explicitly trusted responder certificates. Equivalent to the
351 \&\fB\-verify_other\fR and \fB\-trust_other\fR options.
352 .IP "\fB\-noverify\fR" 4
353 .IX Item "-noverify"
354 Don't attempt to verify the \s-1OCSP\s0 response signature or the nonce
355 values. This option will normally only be used for debugging since it
356 disables all verification of the responders certificate.
357 .IP "\fB\-no_intern\fR" 4
358 .IX Item "-no_intern"
359 Ignore certificates contained in the \s-1OCSP\s0 response when searching for the
360 signers certificate. With this option the signers certificate must be specified
361 with either the \fB\-verify_other\fR or \fB\-VAfile\fR options.
362 .IP "\fB\-no_signature_verify\fR" 4
363 .IX Item "-no_signature_verify"
364 Don't check the signature on the \s-1OCSP\s0 response. Since this option
365 tolerates invalid signatures on \s-1OCSP\s0 responses it will normally only be
366 used for testing purposes.
367 .IP "\fB\-no_cert_verify\fR" 4
368 .IX Item "-no_cert_verify"
369 Don't verify the \s-1OCSP\s0 response signers certificate at all. Since this
370 option allows the \s-1OCSP\s0 response to be signed by any certificate it should
371 only be used for testing purposes.
372 .IP "\fB\-no_chain\fR" 4
373 .IX Item "-no_chain"
374 Do not use certificates in the response as additional untrusted \s-1CA\s0
375 certificates.
376 .IP "\fB\-no_explicit\fR" 4
377 .IX Item "-no_explicit"
378 Do not explicitly trust the root \s-1CA\s0 if it is set to be trusted for \s-1OCSP\s0 signing.
379 .IP "\fB\-no_cert_checks\fR" 4
380 .IX Item "-no_cert_checks"
381 Don't perform any additional checks on the \s-1OCSP\s0 response signers certificate.
382 That is do not make any checks to see if the signers certificate is authorised
383 to provide the necessary status information: as a result this option should
384 only be used for testing purposes.
385 .IP "\fB\-validity_period nsec\fR, \fB\-status_age age\fR" 4
386 .IX Item "-validity_period nsec, -status_age age"
387 These options specify the range of times, in seconds, which will be tolerated
388 in an \s-1OCSP\s0 response. Each certificate status response includes a \fBnotBefore\fR
389 time and an optional \fBnotAfter\fR time. The current time should fall between
390 these two values, but the interval between the two times may be only a few
391 seconds. In practice the \s-1OCSP\s0 responder and clients clocks may not be precisely
392 synchronised and so such a check may fail. To avoid this the
393 \&\fB\-validity_period\fR option can be used to specify an acceptable error range in
394 seconds, the default value is 5 minutes.
395 .Sp
396 If the \fBnotAfter\fR time is omitted from a response then this means that new
397 status information is immediately available. In this case the age of the
398 \&\fBnotBefore\fR field is checked to see it is not older than \fBage\fR seconds old.
399 By default this additional check is not performed.
400 .IP "\fB\-\f(BIdigest\fB\fR" 4
401 .IX Item "-digest"
402 This option sets digest algorithm to use for certificate identification in the
403 \&\s-1OCSP\s0 request. Any digest supported by the OpenSSL \fBdgst\fR command can be used.
404 The default is \s-1SHA\-1.\s0 This option may be used multiple times to specify the
405 digest used by subsequent certificate identifiers.
406 .SS "\s-1OCSP\s0 Server Options"
407 .IX Subsection "OCSP Server Options"
408 .IP "\fB\-index indexfile\fR" 4
409 .IX Item "-index indexfile"
410 The \fBindexfile\fR parameter is the name of a text index file in \fBca\fR
411 format containing certificate revocation information.
412 .Sp
413 If the \fBindex\fR option is specified the \fBocsp\fR utility is in responder
414 mode, otherwise it is in client mode. The request(s) the responder
415 processes can be either specified on the command line (using \fBissuer\fR
416 and \fBserial\fR options), supplied in a file (using the \fBreqin\fR option)
417 or via external \s-1OCSP\s0 clients (if \fBport\fR or \fBurl\fR is specified).
418 .Sp
419 If the \fBindex\fR option is present then the \fB\s-1CA\s0\fR and \fBrsigner\fR options
420 must also be present.
421 .IP "\fB\-CA file\fR" 4
422 .IX Item "-CA file"
423 \&\s-1CA\s0 certificate corresponding to the revocation information in \fBindexfile\fR.
424 .IP "\fB\-rsigner file\fR" 4
425 .IX Item "-rsigner file"
426 The certificate to sign \s-1OCSP\s0 responses with.
427 .IP "\fB\-rother file\fR" 4
428 .IX Item "-rother file"
429 Additional certificates to include in the \s-1OCSP\s0 response.
430 .IP "\fB\-resp_no_certs\fR" 4
431 .IX Item "-resp_no_certs"
432 Don't include any certificates in the \s-1OCSP\s0 response.
433 .IP "\fB\-resp_key_id\fR" 4
434 .IX Item "-resp_key_id"
435 Identify the signer certificate using the key \s-1ID,\s0 default is to use the
436 subject name.
437 .IP "\fB\-rkey file\fR" 4
438 .IX Item "-rkey file"
439 The private key to sign \s-1OCSP\s0 responses with: if not present the file
440 specified in the \fBrsigner\fR option is used.
441 .IP "\fB\-rsigopt nm:v\fR" 4
442 .IX Item "-rsigopt nm:v"
443 Pass options to the signature algorithm when signing \s-1OCSP\s0 responses.
444 Names and values of these options are algorithm-specific.
445 .IP "\fB\-port portnum\fR" 4
446 .IX Item "-port portnum"
447 Port to listen for \s-1OCSP\s0 requests on. The port may also be specified
448 using the \fBurl\fR option.
449 .IP "\fB\-ignore_err\fR" 4
450 .IX Item "-ignore_err"
451 Ignore malformed requests or responses: When acting as an \s-1OCSP\s0 client, retry if
452 a malformed response is received. When acting as an \s-1OCSP\s0 responder, continue
453 running instead of terminating upon receiving a malformed request.
454 .IP "\fB\-nrequest number\fR" 4
455 .IX Item "-nrequest number"
456 The \s-1OCSP\s0 server will exit after receiving \fBnumber\fR requests, default unlimited.
457 .IP "\fB\-nmin minutes\fR, \fB\-ndays days\fR" 4
458 .IX Item "-nmin minutes, -ndays days"
459 Number of minutes or days when fresh revocation information is available:
460 used in the \fBnextUpdate\fR field. If neither option is present then the
461 \&\fBnextUpdate\fR field is omitted meaning fresh revocation information is
462 immediately available.
463 .SH "OCSP Response verification."
464 .IX Header "OCSP Response verification."
465 \&\s-1OCSP\s0 Response follows the rules specified in \s-1RFC2560.\s0
466 .PP
467 Initially the \s-1OCSP\s0 responder certificate is located and the signature on
468 the \s-1OCSP\s0 request checked using the responder certificate's public key.
469 .PP
470 Then a normal certificate verify is performed on the \s-1OCSP\s0 responder certificate
471 building up a certificate chain in the process. The locations of the trusted
472 certificates used to build the chain can be specified by the \fBCAfile\fR
473 and \fBCApath\fR options or they will be looked for in the standard OpenSSL
474 certificates directory.
475 .PP
476 If the initial verify fails then the \s-1OCSP\s0 verify process halts with an
477 error.
478 .PP
479 Otherwise the issuing \s-1CA\s0 certificate in the request is compared to the \s-1OCSP\s0
480 responder certificate: if there is a match then the \s-1OCSP\s0 verify succeeds.
481 .PP
482 Otherwise the \s-1OCSP\s0 responder certificate's \s-1CA\s0 is checked against the issuing
483 \&\s-1CA\s0 certificate in the request. If there is a match and the OCSPSigning
484 extended key usage is present in the \s-1OCSP\s0 responder certificate then the
485 \&\s-1OCSP\s0 verify succeeds.
486 .PP
487 Otherwise, if \fB\-no_explicit\fR is \fBnot\fR set the root \s-1CA\s0 of the \s-1OCSP\s0 responders
488 \&\s-1CA\s0 is checked to see if it is trusted for \s-1OCSP\s0 signing. If it is the \s-1OCSP\s0
489 verify succeeds.
490 .PP
491 If none of these checks is successful then the \s-1OCSP\s0 verify fails.
492 .PP
493 What this effectively means if that if the \s-1OCSP\s0 responder certificate is
494 authorised directly by the \s-1CA\s0 it is issuing revocation information about
495 (and it is correctly configured) then verification will succeed.
496 .PP
497 If the \s-1OCSP\s0 responder is a \*(L"global responder\*(R" which can give details about
498 multiple CAs and has its own separate certificate chain then its root
499 \&\s-1CA\s0 can be trusted for \s-1OCSP\s0 signing. For example:
500 .PP
501 .Vb 1
502 \& openssl x509 \-in ocspCA.pem \-addtrust OCSPSigning \-out trustedCA.pem
503 .Ve
504 .PP
505 Alternatively the responder certificate itself can be explicitly trusted
506 with the \fB\-VAfile\fR option.
507 .SH "NOTES"
508 .IX Header "NOTES"
509 As noted, most of the verify options are for testing or debugging purposes.
510 Normally only the \fB\-CApath\fR, \fB\-CAfile\fR and (if the responder is a 'global
511 \&\s-1VA\s0') \fB\-VAfile\fR options need to be used.
512 .PP
513 The \s-1OCSP\s0 server is only useful for test and demonstration purposes: it is
514 not really usable as a full \s-1OCSP\s0 responder. It contains only a very
515 simple \s-1HTTP\s0 request handling and can only handle the \s-1POST\s0 form of \s-1OCSP\s0
516 queries. It also handles requests serially meaning it cannot respond to
517 new requests until it has processed the current one. The text index file
518 format of revocation is also inefficient for large quantities of revocation
519 data.
520 .PP
521 It is possible to run the \fBocsp\fR application in responder mode via a \s-1CGI\s0
522 script using the \fBreqin\fR and \fBrespout\fR options.
523 .SH "EXAMPLES"
524 .IX Header "EXAMPLES"
525 Create an \s-1OCSP\s0 request and write it to a file:
526 .PP
527 .Vb 1
528 \& openssl ocsp \-issuer issuer.pem \-cert c1.pem \-cert c2.pem \-reqout req.der
529 .Ve
530 .PP
531 Send a query to an \s-1OCSP\s0 responder with \s-1URL\s0 http://ocsp.myhost.com/ save the
532 response to a file, print it out in text form, and verify the response:
533 .PP
534 .Vb 2
535 \& openssl ocsp \-issuer issuer.pem \-cert c1.pem \-cert c2.pem \e
536 \&     \-url http://ocsp.myhost.com/ \-resp_text \-respout resp.der
537 .Ve
538 .PP
539 Read in an \s-1OCSP\s0 response and print out text form:
540 .PP
541 .Vb 1
542 \& openssl ocsp \-respin resp.der \-text \-noverify
543 .Ve
544 .PP
545 \&\s-1OCSP\s0 server on port 8888 using a standard \fBca\fR configuration, and a separate
546 responder certificate. All requests and responses are printed to a file.
547 .PP
548 .Vb 2
549 \& openssl ocsp \-index demoCA/index.txt \-port 8888 \-rsigner rcert.pem \-CA demoCA/cacert.pem
550 \&        \-text \-out log.txt
551 .Ve
552 .PP
553 As above but exit after processing one request:
554 .PP
555 .Vb 2
556 \& openssl ocsp \-index demoCA/index.txt \-port 8888 \-rsigner rcert.pem \-CA demoCA/cacert.pem
557 \&     \-nrequest 1
558 .Ve
559 .PP
560 Query status information using an internally generated request:
561 .PP
562 .Vb 2
563 \& openssl ocsp \-index demoCA/index.txt \-rsigner rcert.pem \-CA demoCA/cacert.pem
564 \&     \-issuer demoCA/cacert.pem \-serial 1
565 .Ve
566 .PP
567 Query status information using request read from a file, and write the response
568 to a second file.
569 .PP
570 .Vb 2
571 \& openssl ocsp \-index demoCA/index.txt \-rsigner rcert.pem \-CA demoCA/cacert.pem
572 \&     \-reqin req.der \-respout resp.der
573 .Ve
574 .SH "HISTORY"
575 .IX Header "HISTORY"
576 The \-no_alt_chains option was added in OpenSSL 1.1.0.
577 .SH "COPYRIGHT"
578 .IX Header "COPYRIGHT"
579 Copyright 2001\-2020 The OpenSSL Project Authors. All Rights Reserved.
580 .PP
581 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
582 this file except in compliance with the License.  You can obtain a copy
583 in the file \s-1LICENSE\s0 in the source distribution or at
584 <https://www.openssl.org/source/license.html>.