Giter VIP home page Giter VIP logo

auth-rbac's Introduction

auth-rbac

RBAC-based authorization library for node

Build Status Dependencies Coverage Status

Installation

$ npm install auth-rbac

Sample usage

var authRbac = require('auth-rbac');
authRbac.mongoose = require('auth-rbac-mongoose');
authRbac.httpBasic = require('auth-rbac-http-basic');

var User = require('./models/users');
var Group = require('./models/groups');

var Route = authRbac.mongoose.Route;
var credRoute = new Route({ name: String, pass: String });
var userRoute = credRoute.field('user').linkWith('name').gives(User);
var roleRoute = userRoute.field('group_id').dbRef.gives(Group);
var privRoute = roleRoute.field('privs').gives([String]);
var auth = authRbac.mongoose(userRoute, roleRoute, privRoute);

var express = require('express');
var app = express();

app.use(authRbac.httpBasic(auth, 'example'));
app.get('/resources', authRbac.requirePrivilege(auth, 'resource-list', {
	onAccessGranted: function(req, res) {
		res.send('Access granted');
	}
}));

Tips

For a better experience, you should make use of auth-rbac plugins, such as:

You are enticed to contribute with your own plugins. If you do so, make me know so that I can list it here with the others.

Raw interface (for plugin developers)

var auth = authRbac({
	authenticateUser: function(creds, cb) {
		// return user info or null
	},

	userGetRole: function(user, cb) {
		// return user role info or null
	},

	roleHasPrivilege: function(role, priv, cb) {
		// return whether role has privilege
	}
});
app.use(authRbac.authenticate(auth, {
	extractCredentials: function(req) {
		// return credentials in request or null
	},

	askForCredentials: function(res) {
		// ask for credentials, ie: res.sendStatus(401)
	}
}));

auth-rbac's People

Contributors

alex94cp avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.