Casbin

Описание

Casbin — это мощный и эффективный открытый фреймворк для управления доступом, который поддерживает различные модели управления доступом.

Адрес проекта

https://github.com/teamones-open/casbin

Установка

composer require teamones/casbin

Официальный сайт Casbin

Для подробного использования можно обратиться к официальной китайской документации, здесь мы рассмотрим, как настроить и использовать в webman.

https://casbin.org/docs/zh-CN/overview

Структура каталогов

.
├── config                        Директория конфигурации
│   ├── casbin-restful-model.conf Файл конфигурации используемой модели доступа
│   ├── casbin.php                Конфигурация casbin
......
├── database                      Файлы базы данных
│   ├── migrations                Файлы миграции
│   │   └── 20210218074218_create_rule_table.php
......

Файл миграции базы данных

<?php

use Phinx\Migration\AbstractMigration;

class CreateRuleTable extends AbstractMigration
{
    /**
     * Метод Change.
     *
     * Напишите свои обратимые миграции с помощью этого метода.
     *
     * Более подробную информацию о написании миграций можно найти здесь:
     * http://docs.phinx.org/en/latest/migrations.html#the-abstractmigration-class
     *
     * Следующие команды могут быть использованы в этом методе, и Phinx
     * автоматически отменит их при откате:
     *
     *    createTable
     *    renameTable
     *    addColumn
     *    addCustomColumn
     *    renameColumn
     *    addIndex
     *    addForeignKey
     *
     * Любые другие разрушительные изменения приведут к ошибке при попытке
     * откатить миграцию.
     *
     * Не забудьте вызвать "create()" или "update()" и НЕ "save()", когда работаете
     * с классом Table.
     */
    public function change()
    {
        $table = $this->table('rule', ['id' => false, 'primary_key' => ['id'], 'engine' => 'InnoDB', 'collation' => 'utf8mb4_general_ci', 'comment' => 'Таблица правил']);

        // Добавление полей данных
        $table->addColumn('id', 'integer', ['identity' => true, 'signed' => false, 'limit' => 11, 'comment' => 'ID основного ключа'])
            ->addColumn('ptype', 'char', ['default' => '', 'limit' => 8, 'comment' => 'Тип правила'])
            ->addColumn('v0', 'string', ['default' => '', 'limit' => 128])
            ->addColumn('v1', 'string', ['default' => '', 'limit' => 128])
            ->addColumn('v2', 'string', ['default' => '', 'limit' => 128])
            ->addColumn('v3', 'string', ['default' => '', 'limit' => 128])
            ->addColumn('v4', 'string', ['default' => '', 'limit' => 128])
            ->addColumn('v5', 'string', ['default' => '', 'limit' => 128]);

        // Выполнение создания
        $table->create();
    }
}

Конфигурация casbin

Синтаксис конфигурации модели правил доступа можно найти по адресу: https://casbin.org/docs/zh-CN/syntax-for-models

<?php

return [
    'default' => [
        'model' => [
            'config_type' => 'file',
            'config_file_path' => config_path() . '/casbin-restful-model.conf', // Файл конфигурации модели правил доступа
            'config_text' => '',
        ],
        'adapter' => [
            'type' => 'model', // model или adapter
            'class' => \app\model\Rule::class,
        ],
    ],
    // Можно настроить несколько моделей доступа
    'rbac' => [
        'model' => [
            'config_type' => 'file',
            'config_file_path' => config_path() . '/casbin-rbac-model.conf', // Файл конфигурации модели правил доступа
            'config_text' => '',
        ],
        'adapter' => [
            'type' => 'model', // model или adapter
            'class' => \app\model\RBACRule::class,
        ],
    ],
];

Адаптер

В текущей упаковке composer адаптирована модель think-orm, для других ORM смотрите vendor/teamones/src/adapters/DatabaseAdapter.php

Затем измените конфигурацию

return [
    'default' => [
        'model' => [
            'config_type' => 'file',
            'config_file_path' => config_path() . '/casbin-restful-model.conf', // Файл конфигурации модели правил доступа
            'config_text' => '',
        ],
        'adapter' => [
            'type' => 'adapter', // Здесь тип настроен в адаптерный режим
            'class' => \app\adapter\DatabaseAdapter::class,
        ],
    ],
];

Инструкция по использованию

Подключение

# Подключение
use teamones\casbin\Enforcer;

Два способа использования

# 1. По умолчанию используется конфигурация default
Enforcer::addPermissionForUser('user1', '/user', 'read');

# 1. Использование пользовательской конфигурации rbac
Enforcer::instance('rbac')->addPermissionForUser('user1', '/user', 'read');

Описание основных API

Для получения дополнительной информации о использовании API вы можете обратиться к официальной документации

• Управляющий API: https://casbin.org/docs/zh-CN/management-api
• RBAC API: https://casbin.org/docs/zh-CN/rbac-api

# Добавить разрешение для пользователя

Enforcer::addPermissionForUser('user1', '/user', 'read');

# Удалить разрешение у пользователя

Enforcer::deletePermissionForUser('user1', '/user', 'read');

# Получить все разрешения пользователя

Enforcer::getPermissionsForUser('user1'); 

# Добавить роль пользователю

Enforcer::addRoleForUser('user1', 'role1');

# Добавить разрешение роли

Enforcer::addPermissionForUser('role1', '/user', 'edit');

# Получить все роли

Enforcer::getAllRoles();

# Получить все роли пользователя

Enforcer::getRolesForUser('user1');

# Получить пользователей по роли

Enforcer::getUsersForRole('role1');

# Проверить, принадлежит ли пользователь к роли

Enforcer::hasRoleForUser('use1', 'role1');

# Удалить роль пользователя

Enforcer::deleteRoleForUser('use1', 'role1');

# Удалить все роли пользователя

Enforcer::deleteRolesForUser('use1');

# Удалить роль

Enforcer::deleteRole('role1');

# Удалить разрешение

Enforcer::deletePermission('/user', 'read');

# Удалить все разрешения пользователя или роли

Enforcer::deletePermissionsForUser('user1');
Enforcer::deletePermissionsForUser('role1');

# Проверить разрешение, вернуть true или false

Enforcer::enforce("user1", "/user", "edit");