lake/larke-auth

An authorization library that supports access control models like ACL, RBAC, ABAC in Laravel.

1.3.0 2023-02-15 09:49 UTC

This package is auto-updated.

Last update: 2024-02-19 11:44:02 UTC


README

larke-auth is an authorization library for the laravel framework.

The code is from laravel-authz

It's based on Casbin, an authorization library that supports access control models like ACL, RBAC, ABAC.

All you need to learn to use Casbin first.

Installation

Require this package in the composer.json of your Laravel project. This will download the package.

composer require lake/larke-auth

The Larke\Auth\ServiceProvider is auto-discovered and registered by default, but if you want to register it yourself:

Add the ServiceProvider in config/app.php

'providers' => [
    /*
     * Package Service Providers...
     */
    Larke\Auth\ServiceProvider::class,
]

The Enforcer facade is also auto-discovered, but if you want to add it manually:

Add the Facade in config/app.php

'aliases' => [
    // ...
    'Enforcer' => Larke\Auth\Facades\Enforcer::class,
]

To publish the config, run the vendor publish command:

php artisan vendor:publish --tag=larke-auth-config

This will create a new model config file named config/larkeauth-rbac-model.conf.bak and a new larkeauth config file named config/larkeauth.php.bak.

You need copy the file config/larkeauth-rbac-model.conf.larkeauth to file config/larkeauth-rbac-model.conf

and copy the file config/larkeauth.php.larkeauth to file config/larkeauth.php

To install auth:

php artisan larke-auth:install

This will create a new table named rules

Usage

Quick start

Once installed you can do stuff like this:

use Enforcer;

// adds permissions to a user
Enforcer::addPermissionForUser('eve', 'articles', 'read');
// adds a role for a user.
Enforcer::addRoleForUser('eve', 'writer');
// adds permissions to a rule
Enforcer::addPolicy('writer', 'articles','edit');

You can check if a user has a permission like this:

// to check if a user has permission
if (Enforcer::enforce("eve", "articles", "edit")) {
    // permit eve to edit articles
} else {
    // deny the request, show an error
}

Using Enforcer Api

It provides a very rich api to facilitate various operations on the Policy:

Gets all roles:

Enforcer::getAllRoles(); // ['writer', 'reader']

Gets all the authorization rules in the policy.:

Enforcer::getPolicy();

Gets the roles that a user has.

Enforcer::getRolesForUser('eve'); // ['writer']

Gets the users that has a role.

Enforcer::getUsersForRole('writer'); // ['eve']

Determines whether a user has a role.

Enforcer::hasRoleForUser('eve', 'writer'); // true or false

Adds a role for a user.

Enforcer::addRoleForUser('eve', 'writer');

Adds a permission for a user or role.

// to user
Enforcer::addPermissionForUser('eve', 'articles', 'read');
// to role
Enforcer::addPermissionForUser('writer', 'articles','edit');

Deletes a role for a user.

Enforcer::deleteRoleForUser('eve', 'writer');

Deletes all roles for a user.

Enforcer::deleteRolesForUser('eve');

Deletes a role.

Enforcer::deleteRole('writer');

Deletes a permission.

Enforcer::deletePermission('articles', 'read'); // returns false if the permission does not exist (aka not affected).

Deletes a permission for a user or role.

Enforcer::deletePermissionForUser('eve', 'articles', 'read');

Deletes permissions for a user or role.

// to user
Enforcer::deletePermissionsForUser('eve');
// to role
Enforcer::deletePermissionsForUser('writer');

Gets permissions for a user or role.

Enforcer::getPermissionsForUser('eve'); // return array

Determines whether a user has a permission.

Enforcer::hasPermissionForUser('eve', 'articles', 'read');  // true or false

See Casbin API for more APIs.

Using a middleware

Before,you need create a file:

<?php

namespace App\Auth;

use Larke\Auth\Contracts\AuthUser;

class YourAuthUser extends AuthUser
{
    /**
     * @return string|int
     */
    public function getIdentifier()
    {
        $id = ...;
        return $id;
    }
}

Then, you need bind YourAuthUser class:

$this->app->bind(
    \Larke\Auth\Contracts\AuthUser::class, 
    \App\Auth\YourAuthUser:class
);

This package comes with EnforcerMiddleware, RequestMiddleware middlewares. You can add them inside your app/Http/Kernel.php file.

protected $routeMiddleware = [
    // ...
    // a basic Enforcer Middleware
    'enforcer' => \Larke\Auth\Middlewares\EnforcerMiddleware::class,
    // an HTTP Request Middleware
    'http_request' => \Larke\Auth\Middlewares\RequestMiddleware::class,
];

basic Enforcer Middleware

Then you can protect your routes using middleware rules:

Route::group(['middleware' => ['enforcer:articles,read']], function () {
    // pass
});

HTTP Request Middleware ( RESTful is also supported )

If you need to authorize a Request, you need to define the model configuration first in config/larkeauth-rbac-model.conf:

[request_definition]
r = sub, obj, act

[policy_definition]
p = sub, obj, act

[role_definition]
g = _, _

[policy_effect]
e = some(where (p.eft == allow))

[matchers]
m = g(r.sub, p.sub) && keyMatch2(r.obj, p.obj) && regexMatch(r.act, p.act)

Then, using middleware rules:

Route::group(['middleware' => ['http_request']], function () {
    Route::resource('photo', 'PhotoController');
});

Multiple enforcers

If you need multiple permission controls in your project, you can configure multiple enforcers.

In the larkeauth file, it should be like this:

return [
    'default' => 'basic',
    
    'guards' => [
        'basic' => [
            'model' => [
                // ...
            ],

            'adapter' => Larke\Auth\Adapters\DatabaseAdapter::class,
            // ...
        ],

        'second' => [
            'model' => [
                // ...
            ],

            'adapter' => Larke\Auth\Adapters\DatabaseAdapter::class,
            // ...
        ],
    ],
    
];

Then you can choose which enforcers to use.

Enforcer::guard('second')->enforce("eve", "articles", "edit");

Using artisan commands

You can create a policy from a console with artisan commands.

To user:

php artisan policy:add eve,articles,read

To Role:

php artisan policy:add writer,articles,edit

Adds a role for a user:

php artisan role:assign eve writer

Using cache

Authorization rules are cached to speed up performance. The default is off.

Sets your own cache configs in Laravel's config/larkeauth.php.

'cache' => [
    // changes whether larkeauth will cache the rules.
    'enabled' => false,

    // cache store
    'store' => 'default',

    // cache Key
    'key' => 'rules',

    // ttl \DateTimeInterface|\DateInterval|int|null
    'ttl' => 24 * 60,
],

Thinks

Casbin in Laravel. You can find the full documentation of Casbin on the website.

License

This project is licensed under the Apache 2.0 license.