Notable Pottery Manufacturer
    Wondering what’s next for npm?Check out our public roadmap! »

    @manifoldco/signature

    1.1.0 • Public • Published

    node-signature

    Verify signed HTTP requests from Manifold

    Code of Conduct | Contribution Guidelines

    GitHub release Travis License NPM

    Install

    $ npm install @manifoldco/signature

    Usage

    var Verifier = require('@manifoldco/signature').Verifier;
    var verifier = new Verifier();
     
    // Using the promise interface
    verifier.test(req, req.rawBody).then(function() {
      // Accept and handle request
    }).catch(function(err) {
      // Deny request on error
      res.statusCode = err.statusCode || 500;
      // Respond with JSON, including a message property
      return res.json({ message: err.message });
    });
     
    // Using the callback interface
    verifier.test(req, req.rawBody, function(err) {
      if (err) {
        // Deny request on error
        res.statusCode = err.statusCode || 500;
        // Respond with JSON, including a message property
        return res.json({ message: err.message });
      }
     
      // Accept and handle request
    });

    Restify

    var Verifier = require('@manifoldco/signature').Verifier;
    var verifier = new Verifier();
     
    // The verification library expects that the req.rawBody property
    // exists so that the body dAoes not have to be read twice, this can be
    // done automaticall with restify-plugins bodyParser
    app.use(plugins.bodyParser({ mapParams: true }));
     
    // Applying the verifier middleware with default master key and options (recommended)
    app.use(function(req, res, next) {
      verifier.test(req).then(function() {
      // Accept and handle request
        next();
      }).catch(function(err) {
        // Deny request on error
        res.statusCode = err.statusCode || 500;
        // Respond with JSON, including a message property
        return res.json({ message: err.message });
      });
    });

    Express

    var verifier = require('@manifoldco/signature').express;
     
    // When using an existing body parser, we require you to add a verify step
    // which will keep track of the original request body for the verifier
    // middleware
    app.use(bodyParser.json({ verify: verifier.appendRawBody }));
     
    // Applying the verifier middleware with default master key and options (recommended)
    app.use(verifier.middleware());

    Keywords

    none

    Install

    npm i @manifoldco/signature

    DownloadsWeekly Downloads

    2

    Version

    1.1.0

    License

    BSD-3-Clause

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar