doc/man1/openssl-ocsp.pod

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