Add missing colon in manpage
[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<-out file>]
11 [B<-issuer file>]
12 [B<-cert file>]
13 [B<-serial n>]
14 [B<-signer file>]
15 [B<-signkey file>]
16 [B<-sign_other file>]
17 [B<-no_certs>]
18 [B<-req_text>]
19 [B<-resp_text>]
20 [B<-text>]
21 [B<-reqout file>]
22 [B<-respout file>]
23 [B<-reqin file>]
24 [B<-respin file>]
25 [B<-nonce>]
26 [B<-no_nonce>]
27 [B<-url URL>]
28 [B<-host host:n>]
29 [B<-path>]
30 [B<-CApath dir>]
31 [B<-CAfile file>]
32 [B<-VAfile file>]
33 [B<-validity_period n>]
34 [B<-status_age n>]
35 [B<-noverify>]
36 [B<-verify_other file>]
37 [B<-trust_other>]
38 [B<-no_intern>]
39 [B<-no_signature_verify>]
40 [B<-no_cert_verify>]
41 [B<-no_chain>]
42 [B<-no_cert_checks>]
43 [B<-port num>]
44 [B<-index file>]
45 [B<-CA file>]
46 [B<-rsigner file>]
47 [B<-rkey file>]
48 [B<-rother file>]
49 [B<-resp_no_certs>]
50 [B<-nmin n>]
51 [B<-ndays n>]
52 [B<-resp_key_id>]
53 [B<-nrequest n>]
54 [B<-md5|-sha1|...>]
55
56 =head1 DESCRIPTION
57
58 The Online Certificate Status Protocol (OCSP) enables applications to
59 determine the (revocation) state of an identified certificate (RFC 2560).
60
61 The B<ocsp> command performs many common OCSP tasks. It can be used
62 to print out requests and responses, create requests and send queries
63 to an OCSP responder and behave like a mini OCSP server itself.
64
65 =head1 OCSP CLIENT OPTIONS
66
67 =over 4
68
69 =item B<-out filename>
70
71 specify output filename, default is standard output.
72
73 =item B<-issuer filename>
74
75 This specifies the current issuer certificate. This option can be used
76 multiple times. The certificate specified in B<filename> must be in
77 PEM format.
78
79 =item B<-cert filename>
80
81 Add the certificate B<filename> to the request. The issuer certificate
82 is taken from the previous B<issuer> option, or an error occurs if no
83 issuer certificate is specified.
84
85 =item B<-serial num>
86
87 Same as the B<cert> option except the certificate with serial number
88 B<num> is added to the request. The serial number is interpreted as a
89 decimal integer unless preceded by B<0x>. Negative integers can also
90 be specified by preceding the value by a B<-> sign.
91
92 =item B<-signer filename>, B<-signkey filename>
93
94 Sign the OCSP request using the certificate specified in the B<signer>
95 option and the private key specified by the B<signkey> option. If
96 the B<signkey> option is not present then the private key is read
97 from the same file as the certificate. If neither option is specified then
98 the OCSP request is not signed.
99
100 =item B<-sign_other filename>
101
102 Additional certificates to include in the signed request.
103
104 =item B<-nonce>, B<-no_nonce>
105
106 Add an OCSP nonce extension to a request or disable OCSP nonce addition.
107 Normally if an OCSP request is input using the B<respin> option no
108 nonce is added: using the B<nonce> option will force addition of a nonce.
109 If an OCSP request is being created (using B<cert> and B<serial> options)
110 a nonce is automatically added specifying B<no_nonce> overrides this.
111
112 =item B<-req_text>, B<-resp_text>, B<-text>
113
114 print out the text form of the OCSP request, response or both respectively.
115
116 =item B<-reqout file>, B<-respout file>
117
118 write out the DER encoded certificate request or response to B<file>.
119
120 =item B<-reqin file>, B<-respin file>
121
122 read OCSP request or response file from B<file>. These option are ignored
123 if OCSP request or response creation is implied by other options (for example
124 with B<serial>, B<cert> and B<host> options).
125
126 =item B<-url responder_url>
127
128 specify the responder URL. Both HTTP and HTTPS (SSL/TLS) URLs can be specified.
129
130 =item B<-host hostname:port>, B<-path pathname>
131
132 if the B<host> option is present then the OCSP request is sent to the host
133 B<hostname> on port B<port>. B<path> specifies the HTTP path name to use
134 or "/" by default.
135
136 =item B<-CAfile file>, B<-CApath pathname>
137
138 file or pathname containing trusted CA certificates. These are used to verify
139 the signature on the OCSP response.
140
141 =item B<-verify_other file>
142
143 file containing additional certificates to search when attempting to locate
144 the OCSP response signing certificate. Some responders omit the actual signer's
145 certificate from the response: this option can be used to supply the necessary
146 certificate in such cases.
147
148 =item B<-trust_other>
149
150 the certificates specified by the B<-verify_certs> option should be explicitly
151 trusted and no additional checks will be performed on them. This is useful
152 when the complete responder certificate chain is not available or trusting a
153 root CA is not appropriate.
154
155 =item B<-VAfile file>
156
157 file containing explicitly trusted responder certificates. Equivalent to the
158 B<-verify_certs> and B<-trust_other> options.
159
160 =item B<-noverify>
161
162 don't attempt to verify the OCSP response signature or the nonce values. This
163 option will normally only be used for debugging since it disables all verification
164 of the responders certificate.
165
166 =item B<-no_intern>
167
168 ignore certificates contained in the OCSP response when searching for the
169 signers certificate. With this option the signers certificate must be specified
170 with either the B<-verify_certs> or B<-VAfile> options.
171
172 =item B<-no_signature_verify>
173
174 don't check the signature on the OCSP response. Since this option tolerates invalid
175 signatures on OCSP responses it will normally only be used for testing purposes.
176
177 =item B<-no_cert_verify>
178
179 don't verify the OCSP response signers certificate at all. Since this option allows
180 the OCSP response to be signed by any certificate it should only be used for
181 testing purposes.
182
183 =item B<-no_chain>
184
185 do not use certificates in the response as additional untrusted CA
186 certificates.
187
188 =item B<-no_cert_checks>
189
190 don't perform any additional checks on the OCSP response signers certificate.
191 That is do not make any checks to see if the signers certificate is authorised
192 to provide the necessary status information: as a result this option should
193 only be used for testing purposes.
194
195 =item B<-validity_period nsec>, B<-status_age age>
196
197 these options specify the range of times, in seconds, which will be tolerated
198 in an OCSP response. Each certificate status response includes a B<notBefore> time and
199 an optional B<notAfter> time. The current time should fall between these two values, but
200 the interval between the two times may be only a few seconds. In practice the OCSP
201 responder and clients clocks may not be precisely synchronised and so such a check
202 may fail. To avoid this the B<-validity_period> option can be used to specify an
203 acceptable error range in seconds, the default value is 5 minutes.
204
205 If the B<notAfter> time is omitted from a response then this means that new status
206 information is immediately available. In this case the age of the B<notBefore> field
207 is checked to see it is not older than B<age> seconds old. By default this additional
208 check is not performed.
209
210 =item B<-md5|-sha1|-sha256|-ripemod160|...>
211
212 this option sets digest algorithm to use for certificate identification
213 in the OCSP request. By default SHA-1 is used. 
214
215 =back
216
217 =head1 OCSP SERVER OPTIONS
218
219 =over 4
220
221 =item B<-index indexfile>
222
223 B<indexfile> is a text index file in B<ca> format containing certificate revocation
224 information.
225
226 If the B<index> option is specified the B<ocsp> utility is in responder mode, otherwise
227 it is in client mode. The request(s) the responder processes can be either specified on
228 the command line (using B<issuer> and B<serial> options), supplied in a file (using the
229 B<respin> option) or via external OCSP clients (if B<port> or B<url> is specified).
230
231 If the B<index> option is present then the B<CA> and B<rsigner> options must also be
232 present.
233
234 =item B<-CA file>
235
236 CA certificate corresponding to the revocation information in B<indexfile>.
237
238 =item B<-rsigner file>
239
240 The certificate to sign OCSP responses with.
241
242 =item B<-rother file>
243
244 Additional certificates to include in the OCSP response.
245
246 =item B<-resp_no_certs>
247
248 Don't include any certificates in the OCSP response.
249
250 =item B<-resp_key_id>
251
252 Identify the signer certificate using the key ID, default is to use the subject name.
253
254 =item B<-rkey file>
255
256 The private key to sign OCSP responses with: if not present the file specified in the
257 B<rsigner> option is used.
258
259 =item B<-port portnum>
260
261 Port to listen for OCSP requests on. The port may also be specified using the B<url>
262 option.
263
264 =item B<-nrequest number>
265
266 The OCSP server will exit after receiving B<number> requests, default unlimited. 
267
268 =item B<-nmin minutes>, B<-ndays days>
269
270 Number of minutes or days when fresh revocation information is available: used in the
271 B<nextUpdate> field. If neither option is present then the B<nextUpdate> field is 
272 omitted meaning fresh revocation information is immediately available.
273
274 =back
275
276 =head1 OCSP Response verification.
277
278 OCSP Response follows the rules specified in RFC2560.
279
280 Initially the OCSP responder certificate is located and the signature on
281 the OCSP request checked using the responder certificate's public key.
282
283 Then a normal certificate verify is performed on the OCSP responder certificate
284 building up a certificate chain in the process. The locations of the trusted
285 certificates used to build the chain can be specified by the B<CAfile>
286 and B<CApath> options or they will be looked for in the standard OpenSSL
287 certificates directory.
288
289 If the initial verify fails then the OCSP verify process halts with an
290 error.
291
292 Otherwise the issuing CA certificate in the request is compared to the OCSP
293 responder certificate: if there is a match then the OCSP verify succeeds.
294
295 Otherwise the OCSP responder certificate's CA is checked against the issuing
296 CA certificate in the request. If there is a match and the OCSPSigning
297 extended key usage is present in the OCSP responder certificate then the
298 OCSP verify succeeds.
299
300 Otherwise the root CA of the OCSP responders CA is checked to see if it
301 is trusted for OCSP signing. If it is the OCSP verify succeeds.
302
303 If none of these checks is successful then the OCSP verify fails.
304
305 What this effectively means if that if the OCSP responder certificate is
306 authorised directly by the CA it is issuing revocation information about
307 (and it is correctly configured) then verification will succeed.
308
309 If the OCSP responder is a "global responder" which can give details about
310 multiple CAs and has its own separate certificate chain then its root
311 CA can be trusted for OCSP signing. For example:
312
313  openssl x509 -in ocspCA.pem -addtrust OCSPSigning -out trustedCA.pem
314
315 Alternatively the responder certificate itself can be explicitly trusted
316 with the B<-VAfile> option.
317
318 =head1 NOTES
319
320 As noted, most of the verify options are for testing or debugging purposes.
321 Normally only the B<-CApath>, B<-CAfile> and (if the responder is a 'global
322 VA') B<-VAfile> options need to be used.
323
324 The OCSP server is only useful for test and demonstration purposes: it is
325 not really usable as a full OCSP responder. It contains only a very
326 simple HTTP request handling and can only handle the POST form of OCSP
327 queries. It also handles requests serially meaning it cannot respond to
328 new requests until it has processed the current one. The text index file
329 format of revocation is also inefficient for large quantities of revocation
330 data.
331
332 It is possible to run the B<ocsp> application in responder mode via a CGI
333 script using the B<respin> and B<respout> options.
334
335 =head1 EXAMPLES
336
337 Create an OCSP request and write it to a file:
338
339  openssl ocsp -issuer issuer.pem -cert c1.pem -cert c2.pem -reqout req.der
340
341 Send a query to an OCSP responder with URL http://ocsp.myhost.com/ save the 
342 response to a file and print it out in text form
343
344  openssl ocsp -issuer issuer.pem -cert c1.pem -cert c2.pem \
345      -url http://ocsp.myhost.com/ -resp_text -respout resp.der
346
347 Read in an OCSP response and print out text form:
348
349  openssl ocsp -respin resp.der -text
350
351 OCSP server on port 8888 using a standard B<ca> configuration, and a separate
352 responder certificate. All requests and responses are printed to a file.
353
354  openssl ocsp -index demoCA/index.txt -port 8888 -rsigner rcert.pem -CA demoCA/cacert.pem
355         -text -out log.txt
356
357 As above but exit after processing one request:
358
359  openssl ocsp -index demoCA/index.txt -port 8888 -rsigner rcert.pem -CA demoCA/cacert.pem
360      -nrequest 1
361
362 Query status information using internally generated request:
363
364  openssl ocsp -index demoCA/index.txt -rsigner rcert.pem -CA demoCA/cacert.pem
365      -issuer demoCA/cacert.pem -serial 1
366
367 Query status information using request read from a file, write response to a
368 second file.
369
370  openssl ocsp -index demoCA/index.txt -rsigner rcert.pem -CA demoCA/cacert.pem
371      -reqin req.der -respout resp.der