Laravel Authorization：支持 ACL、RBAC、ABAC 等模型的受權庫

Laravel Authorization 基於 Casbin ，是一個支持訪問多種訪問控制模型（如ACL，RBAC，ABAC等）的受權庫。
在這以前，你須要先了解 Casbin 。

安裝

使用 Composer 安裝：

composer require casbin/laravel-authz

Lauthz\LauthzServiceProvider 是 auto-discovered 的，而且默認狀況下已註冊，可是若是您想本身註冊，能夠在 config/app.php 中添加 ServiceProvider:

'providers' => [
    /*
     * Package Service Providers...
     */
    Lauthz\LauthzServiceProvider::class,
]

Enforcer facade 也是 auto-discovered，可是若是您想手動添加它，在 config/app.php添加：

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

要發佈配置，請運行 vendor:publish 命令:

php artisan vendor:publish

這就自動建立 Model 配置文件 config/lauthz-rbac-model.conf 和 一個新的 Lauthz 配置文件 config/lauthz.php。

要遷移遷移，請運行migrate命令：

php artisan migrate

這將建立一個 rules 數據表。

用法

快速開始

安裝後，您能夠執行如下操做：

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');

您能夠校驗用戶的權限，以下：

// 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
}

使用 Enforcer Api

它提供了很是豐富的 API，以促進對 Policy 的各類操做：

獲取全部角色:

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

獲取全部的角色的受權規則：

Enforcer::getPolicy();

獲取某個用戶的全部角色：

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

獲取某個角色的全部用戶：

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

決定用戶是否擁有某個角色：

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

給用戶添加角色：

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

賦予權限給某個用戶或角色：

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

刪除用戶的角色：

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

刪除某個用戶的全部角色：

Enforcer::deleteRolesForUser('eve');

刪除單個角色：

Enforcer::deleteRole('writer');

刪除某個權限：

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

刪除某個用戶或角色的權限：

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

刪除某個用戶或角色的全部權限：

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

獲取用戶或角色的全部權限：

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

以爲某個用戶是否擁有某個權限：

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

更多 API 參考 Casbin API 。

使用中間件

該擴展包帶有 EnforcerMiddleware 和 RequestMiddleware 中間件。 您能夠將它們添加到您的app/Http/Kernel.php文件中:

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

基本 Enforcer 中間件

而後就可使用它們來保護路由了：

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

HTTP 請求中間件 ( 支持RESTful )

若是須要受權一個請求，則須要首先在 config/lauthz-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)

而後，使用中間件規則:

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

多個決策器

若是您的項目中須要多個權限控制，則能夠配置多個 決策器 。

在 lauthz 配置文件中， 應該這樣配置:

return [
    'default' => 'basic',

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

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

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

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

而後選擇使用哪個決策器：

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

Artisan 命令行

你能夠在 控制檯 使用 artisan 命令建立策略：

給用戶添加策略：

php artisan policy:add eve,articles,read

給角色添加策略：

php artisan policy:add writer,articles,edit

給用戶賦予角色：

php artisan role:assign eve writer

緩存

緩存 受權 規則能夠提高性能，默認是關閉的。

在 Laravel 的 config/lauthz.php 中設置本身的緩存配置：

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

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

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

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

最後

Casbin 項目地址：https://github.com/php-casbin/php-casbin

Laravel Authorization 項目地址：https://github.com/php-casbin/laravel-authz

你能夠查看 Casbin 的完整文檔 Casbin Docs.