doc/apps/ocsp.pod

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