Introducing Socket Firewall: Free, Proactive Protection for Your Software Supply Chain.Learn More
Socket
Book a DemoInstallSign in
Socket

@ryanburnette/authorization

Package Overview
Dependencies
Maintainers
1
Versions
5
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@ryanburnette/authorization

An excruciatingly simple authorization strategy for Node.js http apps.

latest
Source
npmnpm
Version
6.0.0
Version published
Maintainers
1
Created
Source

authorization

repo npm

A stupid simple authorization strategy for APIs.

Installation

npm install --save @ryanburnette/authorization

Usage

This strategy makes a couple assumptions.

  • req.user is an object that describes this user
  • req.user.roles is an array of strings that describes the roles this user has

A basic implementation looks something like this.

import Authorization from '@ryanburnette/authorization';

// use it on a group of endpoints
app.use(
  '/api/widgets',
  Authorization.middleware({ methods: ['GET', 'POST'], roles: ['user', 'admin'] }),
  Authorization.middleware({ methods: ['DELETE'], roles: ['admin'] }),
  function (req, res) {
    res.statusCode = 200;
    res.end();
    return;
  }
);

// use it on a single endpoint
app.get(
  '/api/employees',
  Authorization.middleware({ roles: ['user', 'admin'] }),
  function (req, res) {
    res.statusCode = 200;
    res.end();
    return;
  }
);

app.use(function (err, req, res, next) {
  // catch errors from this strategy
  if (err.code === 'E_FORBIDDEN') {
    res.statusCode = 403;
    res.end();
    return;
  }
  console.error(err);
  res.statusCode = 500;
  res.end();
});

Test

npm install --no-save express
npm test

FAQs

Package last updated on 17 Dec 2024

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