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