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