Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pktharindu/nova-permissions
Add Permissions based authorization for your Nova installation via User-based Roles and Permissions. Roles are defined in the database whereas Permissions are defined in the code base.
https://github.com/pktharindu/nova-permissions
access-control acl authentication authorization gates hacktoberfest laravel nova permissions policies roles tool
Last synced: 21 days ago
JSON representation
Add Permissions based authorization for your Nova installation via User-based Roles and Permissions. Roles are defined in the database whereas Permissions are defined in the code base.
- Host: GitHub
- URL: https://github.com/pktharindu/nova-permissions
- Owner: pktharindu
- License: mit
- Created: 2019-03-23T11:25:33.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-09-25T03:07:29.000Z (about 2 months ago)
- Last Synced: 2024-10-04T10:55:17.947Z (about 1 month ago)
- Topics: access-control, acl, authentication, authorization, gates, hacktoberfest, laravel, nova, permissions, policies, roles, tool
- Language: PHP
- Homepage: https://www.pktharindu.com/projects/nova-permissions
- Size: 4.82 MB
- Stars: 135
- Watchers: 5
- Forks: 19
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# Laravel Nova Grouped Permissions (RBAC)
  
Add Permissions based authorization for your Nova installation via Role-Based Access Control (RBAC). Roles are defined in the database whereas Permissions are defined in the code base. It allows you to group your Permissions into Groups and attach it to Users.
| Nova 4 | v3.x |
|-----------|------|
| <= Nova 3 | v2.x |
If you like this package, show some love by starring the repo. 🙏
This package is inspired by [Silvanite\Brandenburg](https://github.com/Silvanite/brandenburg) as it has clear separation of concerns.
> _Roles_ are defined in the _Database_
and
> _Permissions_ are defined in the _Codebase_
As a result, you won't see any _Permissions_ resource. The _Roles_ resource will get the permissions from the Gates defined in your code.
- [Laravel Nova Grouped Permissions (RBAC)](#laravel-nova-grouped-permissions-rbac)
- [Installation](#installation)
- [Permissions with Groups](#permissions-with-groups)
- [Index View](#index-view)
- [Detail View](#detail-view)
- [Edit View](#edit-view)
- [Usage](#usage)
- [Create a Model Policy](#create-a-model-policy)
- [Customization](#customization)
- [Use your own Resources](#use-your-own-resources)
- [Support](#support)
- [Credits](#credits)
- [License](#license)
## Installation
You can install the package in to a Laravel app that uses [Nova](https://nova.laravel.com) via composer:
```bash
composer require pktharindu/nova-permissions
```
Publish the Configuration with the following command:
```bash
php artisan vendor:publish --provider="Pktharindu\NovaPermissions\ToolServiceProvider" --tag="config"
```
Configuration file includes some dummy permissions for your refference. Feel free to remove them and add your own permissions.
```php
// in config/nova-permissions.php
'App\User',
/*
|--------------------------------------------------------------------------
| Nova User resource tool class
|--------------------------------------------------------------------------
*/
'user_resource' => 'App\Nova\User',
/*
|--------------------------------------------------------------------------
| The group associated with the resource
|--------------------------------------------------------------------------
*/
'role_resource_group' => 'Other',
/*
|--------------------------------------------------------------------------
| Database table names
|--------------------------------------------------------------------------
| When using the "HasRoles" trait from this package, we need to know which
| table should be used to retrieve your roles. We have chosen a basic
| default value but you may easily change it to any table you like.
*/
'table_names' => [
'roles' => 'roles',
'role_permission' => 'role_permission',
'role_user' => 'role_user',
'users' => 'users',
],
/*
|--------------------------------------------------------------------------
| Application Permissions
|--------------------------------------------------------------------------
*/
'permissions' => [
'view users' => [
'display_name' => 'View users',
'description' => 'Can view users',
'group' => 'User',
],
'create users' => [
'display_name' => 'Create users',
'description' => 'Can create users',
'group' => 'User',
],
// ...
],
];
```
Publish the Migration with the following command:
```bash
php artisan vendor:publish --provider="Pktharindu\NovaPermissions\ToolServiceProvider" --tag="migrations"
```
Migrate the Database:
```bash
php artisan migrate
```
Next up, you must register the tool with Nova. This is typically done in the `tools` method of the `NovaServiceProvider`.
```php
// in app/Providers/NovaServiceProvider.php
public function tools()
{
return [
// ...
new \Pktharindu\NovaPermissions\NovaPermissions(),
];
}
```
Create a new policy:
```bash
php artisan make:policy RolePolicy --model=\Pktharindu\NovaPermissions\Role
```
After that, register the `RolePolicy` along with any other policies you may have and define the gates in the `boot` method of the `AuthServiceProvider` like below.
```php
// in app/Providers/AuthServiceProvider.php
use Illuminate\Support\Facades\Gate;
use Pktharindu\NovaPermissions\Traits\ValidatesPermissions;
use Illuminate\Foundation\Support\Providers\AuthServiceProvider as ServiceProvider;
class AuthServiceProvider extends ServiceProvider
{
use ValidatesPermissions;
protected $policies = [
\Pktharindu\NovaPermissions\Role::class => \App\Policies\RolePolicy::class,
];
public function boot()
{
$this->registerPolicies();
foreach (config('nova-permissions.permissions') as $key => $permissions) {
Gate::define($key, function (User $user) use ($key) {
if ($this->nobodyHasAccess($key)) {
return true;
}
return $user->hasPermissionTo($key);
});
}
}
}
```
Then, use `HasRoles` Traits in your `User` model.
```php
// in app/User.php
use Illuminate\Notifications\Notifiable;
use Pktharindu\NovaPermissions\Traits\HasRoles;
use Illuminate\Foundation\Auth\User as Authenticatable;
class User extends Authenticatable
{
use HasRoles,
Notifiable;
// ...
}
```
Finally, add `BelongsToMany` fields to you `app/Nova/User` resource:
```php
use Laravel\Nova\Fields\BelongsToMany;
public function fields(Request $request)
{
return [
// ...
BelongsToMany::make('Roles', 'roles', \Pktharindu\NovaPermissions\Nova\Role::class),
];
}
```
A new resource called **Roles** will appear in your Nova app after installing this package.
## Permissions with Groups
### Index View
### Detail View
### Edit View
## Usage
### Create a Model Policy
To check permissions, you can create `Model Policies` that works with Laravel Nova.
> **Note**: This package doesn't come with any `Model Policies` built-in. The dummy permissions defined in the config are for your reference only. For each `Nova Resource` including the `Role` and `User` resources, that you want to authorize user actions against, you need to create a Model Policy. Please refer to the [Laravel Docs](https://laravel.com/docs/7.x/authorization#creating-policies) and [Laravel Nova Docs](https://nova.laravel.com/docs/3.0/resources/authorization.html#policies) for additional information.
For Example: Create a new Post Policy with `php artisan make:policy PostPolicy` with the following code:
```php
hasPermissionTo('view own posts')) {
return $user->id === $post->user_id;
}
return $user->hasPermissionTo('view posts');
}
public function create(User $user)
{
return $user->hasAnyPermission(['manage posts', 'manage own posts']);
}
public function update(User $user, Post $post)
{
if ($user->hasPermissionTo('manage own posts')) {
return $user->id == $post->user_id;
}
return $user->hasPermissionTo('manage posts');
}
public function delete(User $user, Post $post)
{
if ($user->hasPermissionTo('manage own posts')) {
return $user->id === $post->user_id;
}
return $user->hasPermissionTo('manage posts');
}
}
```
It should now work as exptected. Just create a Role, modify its Permissions and the Policy should take care of the rest.
> **Note**: Don't forget to add your Policy to your `$policies` in `App\Providers\AuthServiceProvider` and define the permissions in `config\nova-permissions.php`.
> `hasPermissionTo()` method determine if any of the assigned roles to this user have a specific permission.
> `hasAnyPermission()` method determine if the model has any of the given permissions.
> `hasAllPermissions()` method determine if the model has all of the given permissions.
> `view own posts` is superior to `view posts` and allows the User to only view his own posts.
> `manage own posts` is superior to `manage posts` and allows the User to only manage his own posts.
## Customization
### Use your own Resources
If you want to use your own role resource, you can define it when you register the tool:
```php
// in app/Providers/NovaServiceProvider.php
// ...
use App\Nova\Role;
public function tools()
{
return [
// ...
\Pktharindu\NovaPermissions\NovaPermissions::make()
->roleResource(Role::class),
];
}
```
Then extend the `Pktharindu\NovaPermissions\Nova\Role` in your role resource:
```php
// in app/Nova/Role.php
use Pktharindu\NovaPermissions\Nova\Role as RoleResource;
class Role extends RoleResource
{
// ...
}
```
## Support
If you require any support please contact me on [Twitter](https://twitter.com/CallMeTharindu) or open an issue on this repository.
## Credits
This Package is inspired by [eminiarts/nova-permissions](https://novapackages.com/packages/eminiarts/nova-permissions) and [silvanite/novatoolpermissions](https://novapackages.com/packages/silvanite/novatoolpermissions). I wanted to have a combination of both. Thanks to both authors.
## License
Copyright © 2018-2020 P. K. Tharindu and contributors
Licensed under the MIT license, see [LICENSE](https://github.com/pktharindu/nova-permissions/blob/master/LICENSE.md) for details.