doc/man1/openssl-ocsp.pod.in

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