OCSP APIs for node.js

Various OCSP-related APIs to be used with node.js.

This package is a maintained fork of indutny/ocsp, which incorporates fixes and improvements from across the GitHub fork network. See [CHANGELOG.md] for the full history.

Installing

$ npm install @haraka/ocsp

Parts

1. Agent
2. Cache
3. Server
4. check()/verify()
5. request.generate()
6. getOCSPURI()

Agent

Usage:

var agent = new ocsp.Agent();

https.request({
  method: ...,
  host: ...,
  port: ...,
  path: ...,
  // Other options

  agent: agent
}, function(res) {
  // ...
});

The following code snippet will perform a request to the specified server and verify the server's certificate using OCSP (either stapling or a response from the CA). If the certificate does not advertise an OCSP URL, the connection is allowed to proceed.

NOTE: You may pass an options object to new ocsp.Agent(options). It may have the following properties:

• CACacheSize: number of CA certificates to keep in the cache. (Default: 1024)

Cache

Usage:

var cache = new ocsp.Cache();

var server = https.createServer({
  cert: cert,
  key: key
}, function(req, res) {
  res.end('hello world');
});

server.on('OCSPRequest', function(cert, issuer, cb) {
  ocsp.getOCSPURI(cert, function(err, uri) {
    if (err) return cb(err);
    if (uri === null) return cb();

    var req = ocsp.request.generate(cert, issuer);
    cache.probe(req.id, function(err, cached) {
      if (err) return cb(err);
      if (cached !== false) return cb(null, cached.response);

      var options = {
        url: uri,
        ocsp: req.data
      };

      cache.request(req.id, options, cb);
    });
  });
});

Cache should be used to provide OCSP Stapling responses to the client.

NOTE: Constructor accepts an options object with the following properties:

• probe: override .probe() method
• store: override .store() method
• filter: filter(url, callback) to whitelist CA URLs to request

Server

Usage:

const server = ocsp.Server.create({
  caCert: cacert, // optional, defaults to `cert` if not supplied
  cert: cert,
  key: key
})

server.addCert(43, 'good');
server.addCert(44, 'revoked', {
  revocationTime: new Date(),
  revocationReason: 'CACompromise'
})

server.listen(8000);

OCSP Server, i.e. an HTTP server providing OCSP responses for supplied OCSP requests.

Has the following methods:

• .addCert(serialNumber, status, info), where:
  • serialNumber can be either a plain number or an instance of bn.js
  • status is one of good, revoked
  • info should be empty for good and should contain an object for revoked (see example above; revocationReason is one of: unspecified, keyCompromise, CACompromise, affiliationChanged, superseded, cessationOfOperation, certificateHold, removeFromCRL, privelegeWithdrawn, AACompromise)
• All of http.Server methods!

.check()

Usage:

ocsp.check({
  cert: cert,
  issuer: issuerCert
}, function(err, res) {
  if (err)
    throw err

  console.log(res)
})

Send an OCSP request to the CA and ask if the cert is still valid. res contains the info.

Options:

• requestByGet: if true, the OCSP request is sent via HTTP GET instead of POST (default: false)

.verify()

Usage:

ocsp.verify({
  request: request,
  // Optional, `issuer: issuerCert,`
  response: response
}, function(err, res) {
})

Verify that response matches the request and is signed by the CA.

request.generate()

Usage:

var req = ocsp.request.generate(cert, issuerCert);

Generate an OCSP request for .verify() or for sending manually to an OCSP server.

getOCSPURI()

Usage:

ocsp.getOCSPURI(cert, function(err, uri) {
})

Get the URI of the OCSP server from a certificate.

Attribution

Originally authored by Fedor Indutny as indutny/ocsp. Continued by TechTeamer, Ranieri Mazili, and Matt Simerson, incorporating fixes from across the GitHub fork network.

LICENSE

This software is licensed under the MIT License.

Copyright Fedor Indutny, 2015.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.