Skip to content

Latest commit

 

History

History
90 lines (62 loc) · 4.45 KB

README.md

File metadata and controls

90 lines (62 loc) · 4.45 KB

node-Casbin

NPM version NPM download codebeat badge Build Status Coverage Status Release Gitter

News: still worry about how to write the correct node-Casbin policy? Casbin online editor is coming to help! Try it at: http://casbin.org/en/editor/

casbin Logo

node-Casbin is a powerful and efficient open-source access control library for Node.JS projects. It provides support for enforcing authorization based on various access control models.

All the languages supported by Casbin:

golang java nodejs php
Casbin jCasbin node-Casbin PHP-Casbin
production-ready production-ready production-ready production-ready
python dotnet delphi rust
PyCasbin Casbin.NET Casbin4D Casbin-RS
production-ready production-ready experimental WIP

Installation

npm install casbin --save

Get started

  1. Initialize a new node-Casbin enforcer with a model file and a policy file:

    import casbin from 'casbin';
    const enforcer = await casbin.newEnforcer('path/to/model.conf', 'path/to/policy.csv');

    Note: you can also initialize an enforcer with policy in DB instead of file, see Persistence section for details.

  2. Add an enforcement hook into your code right before the access happens:

    const sub = 'alice'; // the user that wants to access a resource.
    const obj = 'data1'; // the resource that is going to be accessed.
    const act = 'read'; // the operation that the user performs on the resource.
    
    const res = await enforcer.enforce(sub, obj, act);
    if (res) {
      // permit alice to read data1
    } else {
      // deny the request, show an error
    }
  3. Besides the static policy file, node-Casbin also provides API for permission management at run-time. For example, You can get all the roles assigned to a user as below:

    const roles = enforcer.getRolesForUser('alice');

    See Policy management APIs for more usage.

  4. Please refer to the src/test package for more usage.

Documentation

https://casbin.org/docs/en/overview

License

This project is licensed under the Apache 2.0 license.

Contact

If you have any issues or feature requests, please contact us. PR is welcomed.