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