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