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