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