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