Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
casbin - npm Package Compare versions
Comparing version 3.0.0-beta.1 to 3.0.0
@@ -254,3 +254,2 @@ "use strict"; | ||
| } | ||
| // @ts-ignore | ||
| const expString = this.model.model.get('m').get('m').value; | ||
@@ -263,3 +262,2 @@ if (!expString) { | ||
| let matcherResults; | ||
| // @ts-ignore | ||
| const policyLen = this.model.model.get('p').get('p').policy.length; | ||
@@ -270,12 +268,10 @@ if (policyLen !== 0) { | ||
| for (let i = 0; i < policyLen; i++) { | ||
| // @ts-ignore | ||
| const pvals = this.model.model.get('p').get('p').policy[i]; | ||
| // logPrint('Policy Rule: ', pvals); | ||
| const parameters = {}; | ||
| // @ts-ignore | ||
| this.model.model.get('r').get('r').tokens.forEach((token, j) => { | ||
| const { tokens: rTokens } = this.model.model.get('r').get('r'); | ||
| rTokens.forEach((token, j) => { | ||
| parameters[token] = rvals[j]; | ||
| }); | ||
| // @ts-ignore | ||
| this.model.model.get('p').get('p').tokens.forEach((token, j) => { | ||
| const { tokens: gTokens } = this.model.model.get('p').get('p'); | ||
| gTokens.forEach((token, j) => { | ||
| parameters[token] = pvals[j]; | ||
@@ -318,3 +314,2 @@ }); | ||
| } | ||
| // @ts-ignore | ||
| if (this.model.model.get('e').get('e').value === 'priority(p_eft) || deny') { | ||
@@ -329,12 +324,11 @@ break; | ||
| const parameters = {}; | ||
| // @ts-ignore | ||
| this.model.model.get('r').get('r').tokens.forEach((token, j) => { | ||
| const { tokens: rTokens } = this.model.model.get('r').get('r'); | ||
| rTokens.forEach((token, j) => { | ||
| parameters[token] = rvals[j]; | ||
| }); | ||
| // @ts-ignore | ||
| this.model.model.get('p').get('p').tokens.forEach((token) => { | ||
| const { tokens: pTokens } = this.model.model.get('p').get('p'); | ||
| pTokens.forEach(token => { | ||
| parameters[token] = ''; | ||
| }); | ||
| const result = yield expression(Object.assign({}, parameters, functions)); | ||
| // logPrint(`Result: ${result}`); | ||
| if (result) { | ||
@@ -347,4 +341,2 @@ policyEffects[0] = effect_1.Effect.Allow; | ||
| } | ||
| // logPrint(`Rule Results: ${policyEffects}`); | ||
| // @ts-ignore | ||
| const res = this.eft.mergeEffects(this.model.model.get('e').get('e').value, policyEffects, matcherResults); | ||
@@ -351,0 +343,0 @@ // only generate the request --> result string if the message |
@@ -25,3 +25,3 @@ import { ManagementEnforcer } from './managementEnforcer'; | ||
| */ | ||
| initWithModelAndAdapter(m: Model, adapter: Adapter): Promise<void>; | ||
| initWithModelAndAdapter(m: Model, adapter?: Adapter): Promise<void>; | ||
| /** | ||
@@ -28,0 +28,0 @@ * getRolesForUser gets the roles that a user has. |
@@ -84,3 +84,2 @@ "use strict"; | ||
| return __awaiter(this, void 0, void 0, function* () { | ||
| // @ts-ignore | ||
| const rm = this.model.model.get('g').get('g').rm; | ||
@@ -104,3 +103,2 @@ if (domain == null) { | ||
| return __awaiter(this, void 0, void 0, function* () { | ||
| // @ts-ignore | ||
| const rm = this.model.model.get('g').get('g').rm; | ||
@@ -305,3 +303,3 @@ if (domain == null) { | ||
| yield Promise.all(roles.map((n) => __awaiter(this, void 0, void 0, function* () { | ||
| res.push(...yield this.getImplicitRolesForUser(n, ...domain)); | ||
| res.push(...(yield this.getImplicitRolesForUser(n, ...domain))); | ||
| }))); | ||
@@ -324,3 +322,3 @@ return res; | ||
| return __awaiter(this, void 0, void 0, function* () { | ||
| const roles = [user, ...yield this.getImplicitRolesForUser(user)]; | ||
| const roles = [user, ...(yield this.getImplicitRolesForUser(user))]; | ||
| const res = []; | ||
@@ -385,4 +383,3 @@ roles.forEach(n => { | ||
| else { | ||
| // @ts-ignore | ||
| yield e.initWithModelAndAdapter(params[0], null); | ||
| yield e.initWithModelAndAdapter(params[0]); | ||
| } | ||
@@ -389,0 +386,0 @@ } |
@@ -150,3 +150,3 @@ "use strict"; | ||
| const policy = []; | ||
| const ast = (this.model.get(sec) || new Map()).get(key); | ||
| const ast = this.model.get(sec).get(key); | ||
| if (ast) { | ||
@@ -159,3 +159,3 @@ policy.push(...ast.policy); | ||
| hasPolicy(sec, key, rule) { | ||
| const ast = (this.model.get(sec) || new Map()).get(key); | ||
| const ast = this.model.get(sec).get(key); | ||
| if (!ast) { | ||
@@ -169,3 +169,3 @@ return false; | ||
| if (!this.hasPolicy(sec, key, rule)) { | ||
| const ast = (this.model.get(sec) || new Map()).get(key); | ||
| const ast = this.model.get(sec).get(key); | ||
| if (!ast) { | ||
@@ -182,3 +182,3 @@ return false; | ||
| if (this.hasPolicy(sec, key, rule)) { | ||
| const ast = (this.model.get(sec) || new Map()).get(key); | ||
| const ast = this.model.get(sec).get(key); | ||
| if (!ast) { | ||
@@ -195,3 +195,3 @@ return true; | ||
| const res = []; | ||
| const ast = (this.model.get(sec) || new Map()).get(key); | ||
| const ast = this.model.get(sec).get(key); | ||
| if (!ast) { | ||
@@ -219,3 +219,3 @@ return res; | ||
| let bool = false; | ||
| const ast = (this.model.get(sec) || new Map()).get(key); | ||
| const ast = this.model.get(sec).get(key); | ||
| if (!ast) { | ||
@@ -246,3 +246,3 @@ return bool; | ||
| const values = []; | ||
| const ast = (this.model.get(sec) || new Map()).get(key); | ||
| const ast = this.model.get(sec).get(key); | ||
| if (!ast) { | ||
@@ -249,0 +249,0 @@ return values; |
@@ -123,5 +123,3 @@ "use strict"; | ||
| } | ||
| let users = [...this.allRoles.values()] | ||
| .filter(n => n.hasDirectRole(name)) | ||
| .map(n => n.name); | ||
| let users = [...this.allRoles.values()].filter(n => n.hasDirectRole(name)).map(n => n.name); | ||
| if (domain.length === 1) { | ||
@@ -128,0 +126,0 @@ users = users.map(n => n.substring(domain[0].length + 2, n.length)); |
@@ -77,3 +77,3 @@ "use strict"; | ||
| return new Promise((resolve, reject) => { | ||
| fs.writeFile(path, file, encoding || 'utf8', (error) => { | ||
| fs.writeFile(path, file, encoding || 'utf8', error => { | ||
| if (error) { | ||
@@ -80,0 +80,0 @@ reject(error); |
| { | ||
| "name": "casbin", | ||
| "version": "3.0.0-beta.1", | ||
| "version": "3.0.0", | ||
| "description": "An authorization library that supports access control models like ACL, RBAC, ABAC in Node.JS", | ||
@@ -8,4 +8,5 @@ "main": "lib/index.js", | ||
| "scripts": { | ||
| "precommit": "lint-staged", | ||
| "prepublishOnly": "yarn run lint && yarn run test && yarn build", | ||
| "prepack": "yarn run lint && yarn run test && yarn build", | ||
| "postpack": "rimraf lib", | ||
| "prettier": "prettier --write **/*.{ts,js}", | ||
| "build": "rimraf lib && tsc -p tsconfig.release.json", | ||
@@ -21,5 +22,6 @@ "lint": "tslint -p . -c tslint.json", | ||
| "coveralls": "^3.0.2", | ||
| "husky": "^0.14.3", | ||
| "husky": "^2.3.0", | ||
| "jest": "^24.3.1", | ||
| "lint-staged": "^7.2.0", | ||
| "lint-staged": "^8.1.7", | ||
| "prettier": "^1.17.1", | ||
| "rimraf": "^2.6.2", | ||
@@ -50,25 +52,16 @@ "ts-jest": "^24.0.0", | ||
| ], | ||
| "husky": { | ||
| "hooks": { | ||
| "pre-commit": "lint-staged" | ||
| } | ||
| }, | ||
| "lint-staged": { | ||
| "*.{ts,js}": [ | ||
| "yarn lint", | ||
| "prettier --write", | ||
| "git add" | ||
| ] | ||
| }, | ||
| "jest": { | ||
| "testURL": "http://localhost", | ||
| "transform": { | ||
| "^.+\\.(ts|tsx)$": "ts-jest" | ||
| }, | ||
| "testMatch": [ | ||
| "**/test/**/*.+(ts|tsx)" | ||
| ], | ||
| "moduleFileExtensions": [ | ||
| "ts", | ||
| "tsx", | ||
| "js", | ||
| "jsx", | ||
| "json", | ||
| "node" | ||
| ] | ||
| "publishConfig": { | ||
| "registry": "https://registry.yarnpkg.com" | ||
| } | ||
| } |
195
README.md
@@ -1,3 +0,3 @@ | ||
| node-Casbin | ||
| ==== | ||
| # node-Casbin | ||
| [![NPM version][npm-image]][npm-url] | ||
@@ -17,3 +17,3 @@ [![NPM download][download-image]][download-url] | ||
| **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/editor/ | ||
| **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/ | ||
@@ -24,14 +24,2 @@  | ||
| ## All the languages supported by Casbin: | ||
| [](https://github.com/casbin/casbin) | [](https://github.com/casbin/jcasbin) | [](https://github.com/casbin/node-casbin) | [](https://github.com/php-casbin/php-casbin) | ||
| ----|----|----|---- | ||
| [Casbin](https://github.com/casbin/casbin) | [jCasbin](https://github.com/casbin/jcasbin) | [node-Casbin](https://github.com/casbin/node-casbin) | [PHP-Casbin](https://github.com/php-casbin/php-casbin) | ||
| production-ready | production-ready | production-ready | production-ready | ||
| [](https://github.com/casbin/pycasbin) | [](https://github.com/casbin4d/Casbin4D) | [](https://github.com/Devolutions/casbin-net) | [](https://github.com/Devolutions/casbin-rs) | ||
| ----|----|----|---- | ||
| [PyCasbin](https://github.com/casbin/pycasbin) | [Casbin4D](https://github.com/casbin4d/Casbin4D) | [Casbin-Net](https://github.com/Devolutions/casbin-net) | [Casbin-RS](https://github.com/Devolutions/casbin-rs) | ||
| production-ready | experimental | WIP | WIP | ||
| ## Installation | ||
@@ -47,113 +35,34 @@ | ||
| ```typescript | ||
| 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](#policy-persistence) section for details. | ||
| ```typescript | ||
| 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](#policy-persistence) section for details. | ||
| 2. Add an enforcement hook into your code right before the access happens: | ||
| ```typescript | ||
| 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. | ||
| ```typescript | ||
| 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. | ||
| if (enforcer.enforce(sub, obj, act) == true) { | ||
| // permit alice to read data1 | ||
| } else { | ||
| // deny the request, show an error | ||
| } | ||
| ``` | ||
| 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: | ||
| ```typescript | ||
| const roles = enforcer.getRoles('alice'); | ||
| ``` | ||
| See [Policy management APIs](#policy-management) for more usage. | ||
| ```typescript | ||
| const roles = enforcer.getRolesForUser('alice'); | ||
| ``` | ||
| See [Policy management APIs](#policy-management) for more usage. | ||
| 4. Please refer to the [src/test](https://github.com/casbin/node-casbin/tree/master/test) package for more usage. | ||
| ## Table of contents | ||
| - [Supported models](#supported-models) | ||
| - [How it works?](#how-it-works) | ||
| - [Features](#features) | ||
| - [Documentation](#documentation) | ||
| - [Online editor](#online-editor) | ||
| - [Tutorials](#tutorials) | ||
| - [Policy management](#policy-management) | ||
| - [Policy persistence](#policy-persistence) | ||
| - [Role manager](#role-manager) | ||
| - [Examples](#examples) | ||
| - [Middlewares](#middlewares) | ||
| - [Our adopters](#our-adopters) | ||
| ## Supported models | ||
| 1. [**ACL (Access Control List)**](https://en.wikipedia.org/wiki/Access_control_list) | ||
| 2. **ACL with [superuser](https://en.wikipedia.org/wiki/Superuser)** | ||
| 3. **ACL without users**: especially useful for systems that don't have authentication or user log-ins. | ||
| 3. **ACL without resources**: some scenarios may target for a type of resources instead of an individual resource by using permissions like ``write-article``, ``read-log``. It doesn't control the access to a specific article or log. | ||
| 4. **[RBAC (Role-Based Access Control)](https://en.wikipedia.org/wiki/Role-based_access_control)** | ||
| 5. **RBAC with resource roles**: both users and resources can have roles (or groups) at the same time. | ||
| 6. **RBAC with domains/tenants**: users can have different role sets for different domains/tenants. | ||
| 7. **[ABAC (Attribute-Based Access Control)](https://en.wikipedia.org/wiki/Attribute-Based_Access_Control)**: syntax sugar like ``resource.Owner`` can be used to get the attribute for a resource. | ||
| 8. **[RESTful](https://en.wikipedia.org/wiki/Representational_state_transfer)**: supports paths like ``/res/*``, ``/res/:id`` and HTTP methods like ``GET``, ``POST``, ``PUT``, ``DELETE``. | ||
| 9. **Deny-override**: both allow and deny authorizations are supported, deny overrides the allow. | ||
| 10. **Priority**: the policy rules can be prioritized like firewall rules. | ||
| ## How it works? | ||
| In node-Casbin, an access control model is abstracted into a CONF file based on the **PERM metamodel (Policy, Effect, Request, Matchers)**. So switching or upgrading the authorization mechanism for a project is just as simple as modifying a configuration. You can customize your own access control model by combining the available models. For example, you can get RBAC roles and ABAC attributes together inside one model and share one set of policy rules. | ||
| The most basic and simplest model in node-Casbin is ACL. ACL's model CONF is: | ||
| ```ini | ||
| # Request definition | ||
| [request_definition] | ||
| r = sub, obj, act | ||
| # Policy definition | ||
| [policy_definition] | ||
| p = sub, obj, act | ||
| # Policy effect | ||
| [policy_effect] | ||
| e = some(where (p.eft == allow)) | ||
| # Matchers | ||
| [matchers] | ||
| m = r.sub == p.sub && r.obj == p.obj && r.act == p.act | ||
| ``` | ||
| An example policy for ACL model is like: | ||
| ``` | ||
| p, alice, data1, read | ||
| p, bob, data2, write | ||
| ``` | ||
| It means: | ||
| - alice can read data1 | ||
| - bob can write data2 | ||
| ## Features | ||
| What node-Casbin does: | ||
| 1. enforce the policy in the classic ``{subject, object, action}`` form or a customized form as you defined, both allow and deny authorizations are supported. | ||
| 2. handle the storage of the access control model and its policy. | ||
| 3. manage the role-user mappings and role-role mappings (aka role hierarchy in RBAC). | ||
| 4. support built-in superuser like ``root`` or ``administrator``. A superuser can do anything without explict permissions. | ||
| 5. multiple built-in operators to support the rule matching. For example, ``keyMatch`` can map a resource key ``/foo/bar`` to the pattern ``/foo*``. | ||
| What node-Casbin does NOT do: | ||
| 1. authentication (aka verify ``username`` and ``password`` when a user logs in) | ||
| 2. manage the list of users or roles. I believe it's more convenient for the project itself to manage these entities. Users usually have their passwords, and node-Casbin is not designed as a password container. However, node-Casbin stores the user-role mapping for the RBAC scenario. | ||
| ## Documentation | ||
@@ -163,55 +72,2 @@ | ||
| ## Online editor | ||
| You can also use the online editor (http://casbin.org/editor/) to write your node-Casbin model and policy in your web browser. It provides functionality such as ``syntax highlighting`` and ``code completion``, just like an IDE for a programming language. | ||
| ## Tutorials | ||
| https://casbin.org/docs/en/tutorials | ||
| ## Policy management | ||
| node-Casbin provides two sets of APIs to manage permissions: | ||
| - [Management API](https://casbin.org/docs/en/management-api): the primitive API that provides full support for node-Casbin policy management. | ||
| - [RBAC API](https://casbin.org/docs/en/management-api): a more friendly API for RBAC. This API is a subset of Management API. The RBAC users could use this API to simplify the code. | ||
| We also provide a web-based UI for model management and policy management: | ||
|  | ||
|  | ||
| ## Policy persistence | ||
| https://casbin.org/docs/en/adapters | ||
| ## Role manager | ||
| https://casbin.org/docs/en/role-managers | ||
| ## Examples | ||
| Model | Model file | Policy file | ||
| ----|------|---- | ||
| ACL | [basic_model.conf](https://github.com/casbin/node-casbin/blob/master/examples/basic_model.conf) | [basic_policy.csv](https://github.com/casbin/node-casbin/blob/master/examples/basic_policy.csv) | ||
| ACL with superuser | [basic_model_with_root.conf](https://github.com/casbin/node-casbin/blob/master/examples/basic_with_root_model.conf) | [basic_policy.csv](https://github.com/casbin/node-casbin/blob/master/examples/basic_policy.csv) | ||
| ACL without users | [basic_model_without_users.conf](https://github.com/casbin/node-casbin/blob/master/examples/basic_without_users_model.conf) | [basic_policy_without_users.csv](https://github.com/casbin/node-casbin/blob/master/examples/basic_without_users_policy.csv) | ||
| ACL without resources | [basic_model_without_resources.conf](https://github.com/casbin/node-casbin/blob/master/examples/basic_without_resources_model.conf) | [basic_policy_without_resources.csv](https://github.com/casbin/node-casbin/blob/master/examples/basic_without_resources_policy.csv) | ||
| RBAC | [rbac_model.conf](https://github.com/casbin/node-casbin/blob/master/examples/rbac_model.conf) | [rbac_policy.csv](https://github.com/casbin/node-casbin/blob/master/examples/rbac_policy.csv) | ||
| RBAC with resource roles | [rbac_model_with_resource_roles.conf](https://github.com/casbin/node-casbin/blob/master/examples/rbac_with_resource_roles_model.conf) | [rbac_policy_with_resource_roles.csv](https://github.com/casbin/node-casbin/blob/master/examples/rbac_with_resource_roles_policy.csv) | ||
| RBAC with domains/tenants | [rbac_model_with_domains.conf](https://github.com/casbin/node-casbin/blob/master/examples/rbac_with_domains_model.conf) | [rbac_policy_with_domains.csv](https://github.com/casbin/node-casbin/blob/master/examples/rbac_with_domains_policy.csv) | ||
| ABAC | [abac_model.conf](https://github.com/casbin/node-casbin/blob/master/examples/abac_model.conf) | N/A | ||
| RESTful | [keymatch_model.conf](https://github.com/casbin/node-casbin/blob/master/examples/keymatch_model.conf) | [keymatch_policy.csv](https://github.com/casbin/node-casbin/blob/master/examples/keymatch_policy.csv) | ||
| Deny-override | [rbac_model_with_deny.conf](https://github.com/casbin/node-casbin/blob/master/examples/rbac_with_deny_model.conf) | [rbac_policy_with_deny.csv](https://github.com/casbin/node-casbin/blob/master/examples/rbac_with_deny_policy.csv) | ||
| Priority | [priority_model.conf](https://github.com/casbin/node-casbin/blob/master/examples/priority_model.conf) | [priority_policy.csv](https://github.com/casbin/node-casbin/blob/master/examples/priority_policy.csv) | ||
| ## Middlewares | ||
| Authz middlewares for web frameworks: https://casbin.org/docs/en/middlewares | ||
| ## Our adopters | ||
| https://casbin.org/docs/en/adopters | ||
| ## License | ||
@@ -224,4 +80,5 @@ | ||
| If you have any issues or feature requests, please contact us. PR is welcomed. | ||
| - https://github.com/casbin/node-casbin/issues | ||
| - hsluoyz@gmail.com | ||
| - Tencent QQ group: [546057381](//shang.qq.com/wpa/qunwpa?idkey=8ac8b91fc97ace3d383d0035f7aa06f7d670fd8e8d4837347354a31c18fac885) |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
No v1
QualityPackage is not semver >=1. This means it is not stable and does not support ^ ranges.
Found 1 instance in 1 package
Improved metrics
- Number of low quality alerts
- decreased by-100%
0
Worsened metrics
- Total package byte prevSize
- decreased by-5.49%
163994
- Dev dependency count
- increased by8.33%
13
- Lines of code
- decreased by-0.34%
3804
- Number of lines in readme file
- decreased by-64.13%
80
No dependency changes