Nocturnal Programmer's Machine
    Have ideas to improve npm?Join in the discussion! »

    micro-secret
    TypeScript icon, indicating that this package has built-in type declarations

    1.2.8 • Public • Published

    npm

    Use case

    For when you want simple secret authentication of a micro service or vercel node.js lambda.

    What it does

    Wraps a vercel node.js lambda with authentication. By default, takes a secret passed as either an Authorization Bearer secret or as apiSecret URL parameter or a header key you configure.

    If you pass a custom header key, it expects the header value to be just the secret, with no Bearer prefix.

    Configuration

    Requires first argument of an array of secrets. An array is handy for allowing secret rotation. Takes an optional second configuration object argument:

    • whitelist: an optional whitelist of paths.
    • resAuthMissing: Optional string for use when Authentication is missing from request.
    • resAuthInvalid: Optional string for use when request not authorized.
    • headerKey: Optional request header key for getting request secret. If passed, the header value must be exactly the secret, with no Bearer prefix.

    Usage

    Wrap your lambda as in the examples below. Then pass the configured secret string as an Authorization header:

    Authorization Bearer <your secret here>

    Or, pass as a query parameter:

    https://my-protected-service.vercel.app/?apiSecret=<your secret here>

    Examples

    Simple

    const withAuth = require('micro-secret');
    const MY_SECRETS = ['parrots'];
     
    module.exports = withAuth(MY_SECRETS)(async (req, res) => {
      return `Hey sailor!`;
    });

    With whitelist

    const withApiAuth = require('micro-secret');
    const MY_SECRETS = ['parrots'];
    const WHITELIST = ['pirates'];
     
    module.exports = withAuth(MY_SECRETS, { whitelist: WHITELIST })(
      async (req, res) => {
        return `Hey sailor!`;
      }
    );

    With custom header key

    const withAuth = require('micro-secret');
    const MY_SECRETS = ['parrots'];
    const WHITELIST = ['pirates'];
    const MY_SECRET_HEADER_KEY = ['x-marks-the-spot'];
     
    module.exports = withAuth(MY_SECRETS, {
      whitelist: WHITELIST,
      headerKey: MY_SECRET_HEADER_KEY,
    })(async (req, res) => {
      return `Hey sailor!`;
    });

    With multiple wrappers

    const withAuth = require('micro-secret');
    const withPirateShip = require('with-trusty-pirate-ship');
     
    const MY_SECRETS = ['parrots'];
    const WHITELIST = ['pirates'];
     
    const compose = (...fns) => fns.reduce((f, g) => (...args) => f(g(...args)));
     
    module.exports = compose(
      withAuth(MY_SECRETS, { whitelist: WHITELIST }),
      withPirateShip
    )(async (req, res) => {
      return `Hey sailor!`;
    });

    Previously known as..

    ... now-secret.

    Alternatives

    This module is a fork of micro-jwt-auth which provides similar functionality with a JWT token.

    Install

    npm i micro-secret

    DownloadsWeekly Downloads

    63

    Version

    1.2.8

    License

    MIT

    Unpacked Size

    9.25 kB

    Total Files

    8

    Last publish

    Collaborators

    • avatar