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