New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More
Socket
Sign inDemoInstall
Socket

simple-hmac-auth-express

Package Overview
Dependencies
Maintainers
1
Versions
9
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

simple-hmac-auth-express

Express middleware that implements simple-hmac-auth

  • 1.3.0
  • latest
  • Source
  • npm
  • Socket score

Version published
Maintainers
1
Created
Source

simple-hmac-auth-express

Express middleware for creating APIs that implement simple-hmac-auth.

ci coverage npm license

Usage

Two parameters are required. secretForKey must be a function that returns a promise with the secret for a specified API key, and onRejected must be a function that handles requests that have failed authentication.

const auth = require('simple-hmac-auth-express')

app.use(auth({

  // Return a promise that resolves with the secret for the specified API key
  secretForKey: async (apiKey) => {
    return 'SECRET';
  },

  // Handle requests that have failed authentication
  onRejected: (error, request, response, next) => {
    console.log(`"${request.apiKey}" failed authentication: ${request.method} ${request.url}`);
    response.status(401).json({
      error: {
        message: error.message
      }
    });
  },
  
  // Optional
  onAccepted: (request, response) => {
    console.log(`"${request.apiKey}" authenticated request to ${request.method} ${request.url} with signature "${request.signature}"`);
  }
}));

Because the unparsed body of the request must be loaded and hashed to authenticate, the included middleware also handles parsing the request body. If you would like to parse the contents of the request body, use the same parameters as body-parser in the body node:

const auth = require('simple-hmac-auth-express')

app.use(auth({

  // Required
  secretForKey: (apiKey, callback) => callback(null, 'secret'),
  onRejected: (error, request, response, next) => response.status(401).end('401'),
  onAccepted: (request, response) => console.log(`authenticated ${request.method} ${request.url}`)

  // Body-parser options. All optional.
  body: {
    json: { strict: false, limit: '1mb' }
    urlencoded: { extended: true, limit: '5mb' },
    text: { type: 'application/octet-stream' }
  }
}));

License

MIT © Jesse Youngblood

FAQs

Package last updated on 21 Aug 2022

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc