uzzal/acl

Basic access control list

, _(*1)

ACL

Upgraded to support Laravel 8 and latest versions, _(*2)

Dynamically configurable access control for Laravel. One user can have multiple roles., _(*3)

Install

composer require uzzal/acl

Configuration

In your laravel config/app.php under providers add, _(*4)

Uzzal\Acl\AclServiceProvider::class

Publish

artisan vendor:publish

This command will publish view files inside views/vendor/acl, seed files inside the databases/seed and a config file config/acl.php., _(*5)

Database seed

At your DatabaseSeeder.php under database/seeds add the following lines, _(*6)

$this->call(UserTableSeeder::class); //optional
$this->call(RoleTableSeeder::class);
$this->call(ResourceTableSeeder::class);
$this->call(PermissionTableSeeder::class);
$this->call(UserRoleTableSeeder::class);

NOTE: If you see any kind of class not found type error try running composer dump-autoload, _(*7)

Artisan command

This library comes with an artisan command acl:resource to automatically create all the resources (_controller@action_) available in your project under app/Http/Controllers directory. To activate this command you need to add these following lines to your app/Console/Kernel.php file., _(*8)

protected $commands = [
    Uzzal\Acl\Commands\AclResource::class
];

Modify the User model

In your User model add the following trait, _(*9)

use Uzzal\Acl\Traits\AccessControlled;

class User extends Authenticatable
{
    use AccessControlled;
    ...
}

#[Attribute]

Acl library now has two attribute support #Resource, and #Authorize to be used with controller action, _(*10)

#[Authorize('Admin, Default')] // string
#[Resource('able to see home')]
public function index()
{
    return view('home');
}

// or alternatively

#[Authorize('Admin', 'Default')] // array
#[Resource('able to see home')]
public function index()
{
    return view('home');
}

Role names are not case sensitive. But use Capitalized word for better readability., _(*11)

NOTE: by default developer role has the highest permission level, and it doesn't need to be mentioned in the #Authorize attribute. If you remove the #Authorize attribute it won't delete the permissions from the database, but if you change the role list in the annotation then it will update the databased accordingly., _(*12)

Middleware

This ACL library comes with two middleware as shown below. AuthenticateWithAcl is the middleware you need. The other ResourceMaker middle ware is just a helper to create resource dynamically if it doesn't exists in the first place and assign permission for it to the developer role., _(*13)

In your kernal.php file add this lines, _(*14)

'auth.acl' => \Uzzal\Acl\Middleware\AuthenticateWithAcl::class,
'resource.maker' => \Uzzal\Acl\Middleware\ResourceMaker::class,

In your route/web.php file add this lines, _(*15)

Route::group(['middleware' => ['resource.maker','auth.acl']], function () {
    Route::get('/home', 'HomeController@index');
});

IMPORTANT: resource.maker must have to be placed before auth.acl. In production you can remove resource.maker once you have all the resource generated., _(*16)

Role & Resource UI

To access role visit YOUR-HOST/role url, _(*17)

To access resource UI visit YOUR-HOST/resource url, _(*18)

Access check

There are several ways to check for access, _(*19)

By route name here home.index is the name of the route., _(*20)

if (allowed('home.index')) {
    echo "will allow here if the user has access";
}

// alternatively in blade template

@allowed('home.index')


Will be visible if the user has permission


@endallowed

By controller's action name, _(*21)

if (allowed([\App\Http\Controllers\HomeController::class, 'index'])) {
    echo "will allow here if the user has access";
}

// alternatively in blade template

@allowed([\App\Http\Controllers\HomeController::class, 'index'])


Will be visible if the user has permission


@endallowed

Checking for controller level access

Suppose you have two controllers named HomeController and ProfileController now you want to check if the user has any access to both of the controller then use the following code, _(*22)

if (allowedAny(['Home','Profile'])) {
    echo "Will be visible if the user has permission for any action of Home and Profile controller";
}

// alternatively in blade template

@allowedAny(['Home','Profile'])


Will be visible if the user has permission for any action of Home and Profile controller


@endallowedAny

// for single controller it can be written like this

@allowedAny('Home')


Will be visible if the user has permission for any action of Home Controller


@endallowedAny

Checking access by Role name

if (hasRole(['Admin','Editor'])) {
    echo "Will be visible if the user has Admin or Editor or both roles";
}

// alternatively in blade template

@hasRole(['Admin','Editor'])


Will be visible if the user has Admin or Editor or both roles


@endhasRole

// for single Role it can be written like this

@hasRole('Admin')


Will be visible if the user has Admin roles


@endhasRole

Contribution

composer update
vendor/bin/testbench workbench:install # not required
vendor/bin/testbench workbench:create-sqlite-db
vendor/bin/testbench migrate
vendor/bin/testbench db:seed --class=Workbench\Database\Seeders\DatabaseSeeder

vendor/bin/testbench package:test