An authorization system non-intrusive inspired by express-authorization, Apache's Shiro project and XACML acl rules.
npm install null-authorization``js
var express = require('express');
var authorization = require('express-authorization');
var app = express();
// Consider an authenticated user in the express session:
// req.session.user.permissions = ["restricted:*"]
app.get('/restricted',
authorization.ensureRequest.isPermitted("restricted:view"),
function(req, res) {
...
});
`
$ npm install express-authorization
* Easy integration into your express or connect based code
* Permission claim evaluation in the browser
* Expressive permissions inspired by Apache Shiro
* Customizable to fit your application needs
* High test coverage
In __express-authorization__, a permission is a statement that defines access to an explicit activity, behavior or action.
Subjects, usually website users, are assigned permissions to enable access to sets of activities, behaviors, or actions.
To practically assign sets of permissions to subjects, __express-authorization__ supports a wildcard enabled permission statement
syntax that closely follows the syntax used by Apache Shiro.
A collection of permissions assigned to a subject are compiled by the system into a regular expression referred to as a claim.
Claims are then queried regarding whether or not they permit permissions that gate activities, behaviors, or actions.
__express-authorization__ uses the Apache Shiro wildcard permission syntax directly.
* Permission statements are composed of from parts delimited by colons (:).
* Permission parts can contain lists delimited by commas (,).
Wildcard ? and can be used to match one or more chataters within an expression part.
Examples: system: | activity:create,update,delete
Permissions statements are strings that can be specified in parameter lists that may include arrays of composited permissions.
A subject, usually a user, is expected to be represented by an object with a permissions property refering to either
a single permission or an array of permissions.
In the permission query API, a permission source is placed under consideration and compiled into a claim that is
queries to confirm permitted permissions.
`js`
authorization
.considerSubject(user)
.isPermitted("express:coding")
authorization
.considerPermissions("source:edit", "express:*")
.isPermitted("express:coding")
#### From subject or permission list -> claim -> isPermitted
`js`
authorization.considerSubject | authorization.considerPermissions -> claim
The __considerSubject__ and __considerPermissions__ methods are used to generate a claim object.
A claim object is litterly a regular expression that matches any permissions that are permitted by the
subject, user, or permission list under consideration. In addition, an __isPermitted__ method is exposed on
the claim for checking if one or more permissions are supported. See the __consider__ test cases in the code
for more examples.
__express-authorization__ uses a fluent API to generate express middleware for enforcing permissions.
`js`
authorization.ensureRequest.isPermitted("restricted:view")
To generate an express middleware, you write a call chain starting with a reference to __authenticate.ensureRequest__
and ending in a call to __isPermitted__. The call to __isPermitted__ returns a connect/express compliant middleware function.
By default, __ensureRequest__ sources permissions from the session through references to session.user.permissions or session.permissions.
To consider alternative permission sources, __withSubject__ or __withPermissions__ callbacks (asynchronous or immediate) are used.
`js``
authorization.ensureRequest
.withPermissions(function (req, res, done) { done(["identity:*"]); })
.isPermitted("identity:edit");
__ensureRequest__ redirects to __/login__ by default when a request is denied.
__redirectTo__ can be used to specify an alternate redirect url.
__onDenied__ can be used to prived a custom response function.
All of these options (__withSubject__, __withPermissions__, __redirectTo__, and __onDenied__)
can be set either through chained API calls, or on the __ensureRequest.options__ object.
When set on the global __authorization.ensureRequest.options__, these establish new defaults.
A custom __new authorization.EnsureRequest()__ object can be constructed for use if required.
The __dist__ directory includes a version of the permission query API that can be used in your web pages. See __dist/authorization.js__.
MIT License
Copyright (c) 2013 Support.com, Inc.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.