https://github.com/snowyu/loopback-component-role-user.js
User dynamic roles authorization for Loopback Component
https://github.com/snowyu/loopback-component-role-user.js
authorization loopback roles strongloop user
Last synced: 8 days ago
JSON representation
User dynamic roles authorization for Loopback Component
- Host: GitHub
- URL: https://github.com/snowyu/loopback-component-role-user.js
- Owner: snowyu
- License: mit
- Created: 2016-08-09T23:42:40.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-05-10T08:18:24.000Z (almost 7 years ago)
- Last Synced: 2025-03-27T22:13:13.241Z (26 days ago)
- Topics: authorization, loopback, roles, strongloop, user
- Language: CoffeeScript
- Homepage:
- Size: 70.3 KB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE-MIT
Awesome Lists containing this project
README
# Loopback Component user dynamic role
This loopback component add a new dynamic user role which mapping the operators of model to the role.
The role name should be '[`modelName`]' + '.' + '[`operator`]'. The role should be mapped into the ACL too.
And the role can be nested like this:
```coffee
Role1:
User.add
Role2:
Role1
Role3:
Role2
```
The Role3 should has the `User.add` role too.
The role could have multi containers of permission(aother role) or permissions.
The Permission is the model with operation. You can use the `*` to match the any model or any operation.
eg, `'*.add', 'User.*'`.
Add the `.owned` dynamical roles to `edit`, `view`, `find`, and `delete` roles as postfix.
For only edit/delete/view/find owned items.
**Note:**
* The same role could be exists in multi-roles.
* Disable batch update roles.
* The nested max level of role to limit. see config: `maxLevel`
### Installation
1. Install in you loopback project:
`npm install --save loopback-component-role-user`
2. Create a component-config.json file in your server folder (if you don't already have one)
3. Configure options inside `component-config.json`:
```json
{
"loopback-component-role-user": {
"enabled": true,
"cached": 0,
"role": "$user",
"userModel": "User",
"roleIdFieldName": "name",
"rolesFieldName": "roles",
"permsFieldName": "_perms",
"roleRefsFieldName": "_roleRefs",
"models": [],
"operations":[]
}
}
```
- `enabled` *[Boolean]*: whether enable this component. *defaults: true*
- `cached`: *[Integer]*: whether cache the perms. *defaults: 1*
* `0` 'none': no cache. you can write the custom _getPerms class method on the Role model to your cache.
* `1` 'updated': the cached perms updated when the role updated(default)
* `2` 'manual': if the _perms is not empty use the cached _perms else calc perms and update the _perms.
* NOTE: you should update the `_perms` field by yourself. just empty it for updated.
- `deleteUsedRole` *[Boolean]*: whether allow to cascade delete used roles. *defaults: false*
* only for updated `cached`: 1.
- `maxLevel` *[Integer]*: the max nested role level to limit. *defaults: 10*
- `role` *[String]* : the role name. *defaults: $user*
- `roleModel` *[string]*: The role model to inject. *defaults: Role*
* The `rolesFieldName` and `permsFieldName` fields will be added to the Model.
* The `hasPerm` method will be added to the Model.
* The `addRoles` and `removeRoles` methods will be added if the `rolesFieldName` is 'roles'.
* The `Role.addRoles` and `Role.removeRoles` permissions are added too.
- `userModel` *[string]*: The user model to inject. *defaults: User*
* The `rolesFieldName` and `permsFieldName` fields will be added to the User Model.
* The `hasPerm` method will be added to the User Model.
* The `addRoles` and `removeRoles` methods will be added if the `rolesFieldName` is 'roles'.
* The `User.addRoles` and `User.removeRoles` permissions are added too.
- `rolesFieldName` *[string]*: The roles field to define. *defaults: roles*
* The model(role) can have zero or more roles/permissions.
- `permsFieldName` *[string]*: The cached perms of this role. *defaults: _perms*
* Cache all the permissions to the roles(Readonly).
- `ownerFieldName` *[string]*: The owner id field to define. *defaults: creatorId*
- `roleRefsFieldName` *[string]*: The cached items which reference this role(Readonly). *defaults: _roleRefs*
- `models` *[Boolean|Array of string]*. *defaults: true*
* enable the user role to the models. `true` means all models in the app.models.
- `operations` *[Object]*: the mapping operations of model to the role name.
* the `key` is the operation(method), the `value` is the role name.
* Note: the operations name is the role name if no mapping operations.
* *defaults:*
```js
{
create: 'add',
upsert: 'edit',
updateAttributes: 'edit',
exists: 'view',
findById: 'view',
find: 'find',
findOne: 'find',
count: 'find',
destroyById: 'delete',
deleteById: 'delete'
}
```
### Usage
Just enable it on `component-config.json`.
set `DEBUG=loopback:security:role:user` env vaiable to show debug info.
`Model::hasPerm(perm)`
## History
### V1.3.0
+ add the `cached` to determine whether cache the perms.
### V1.2.0
+ add the `.owned` dynamical roles to `edit.owned`, `view.owned`, `find.owned`, and `delete.owned`.
Only edit/delete/view/find owned items.
### V1.1.0
* remove the limits: The same permission CAN NOT be exists in multi-roles.
* [bug] the hasPerm should use the match function instead minimatch
* [bug] updatePermsByRefs can not work properly.
* [bug] mongodb error: key can not contain "." for _perms is object
* [bug] can not change itself to roleRefs after roles changed
+ add the `maxLevel` option to limit the max nested role level to avoid recusive
* avoid exception when component not enabled.
+ add the `deleteUsedRole` option to allow or forbidden cascade delete
### V1.0.0
- remove the deprecated `adminRole` option. you can define the admin Role with `*.*` principal.
* rename the operators option to operations
* Customize the Role and User Model.
- remove `hasRole` Method.
+ add the `Roles` mxin.
* Define the `roles` and `perms` fields.
* roles: the
* Add the `hasPerm`, `addRoles` and `removeRoles` methods.
+ add the `hasPerm`, `addRoles` and `removeRoles` methods to Role and User Model.
* Performance optimization.
* cache permissions and references.
### V0.2.0
+ add the `Role::hasRole`