Casbin

说明

Casbin é um poderoso e eficiente framework de controle de acesso de código aberto, cuja mecânica de gerenciamento de permissões suporta vários modelos de controle de acesso.

项目地址

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

安装

composer require teamones/casbin

Casbin官网

Para um uso mais detalhado, você pode acessar a documentação oficial em chinês. Aqui, apenas explicaremos como configurar e utilizar no webman.

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

目录结构

.
├── config                        Diretório de configuração
│   ├── casbin-restful-model.conf Arquivo de configuração do modelo de permissões utilizado
│   ├── casbin.php                Configuração do casbin
......
├── database                      Arquivos de banco de dados
│   ├── migrations                Arquivos de migração
│   │   └── 20210218074218_create_rule_table.php
......

数据库迁移文件

<?php

use Phinx\Migration\AbstractMigration;

class CreateRuleTable extends AbstractMigration
{
    /**
     * Método Change.
     *
     * Escreva suas migrações reversíveis usando este método.
     *
     * Mais informações sobre como escrever migrações estão disponíveis aqui:
     * http://docs.phinx.org/en/latest/migrations.html#the-abstractmigration-class
     *
     * Os seguintes comandos podem ser usados neste método e o Phinx irá 
     * reverter automaticamente quando reverter a migração:
     *
     *    createTable
     *    renameTable
     *    addColumn
     *    addCustomColumn
     *    renameColumn
     *    addIndex
     *    addForeignKey
     *
     * Outras mudanças destrutivas resultarão em um erro ao tentar
     * reverter a migração.
     *
     * Lembre-se de chamar "create()" ou "update()" e NÃO "save()" ao trabalhar
     * com a classe Table.
     */
    public function change()
    {
        $table = $this->table('rule', ['id' => false, 'primary_key' => ['id'], 'engine' => 'InnoDB', 'collation' => 'utf8mb4_general_ci', 'comment' => 'Tabela de regras']);

        //Adicionar campos de dados
        $table->addColumn('id', 'integer', ['identity' => true, 'signed' => false, 'limit' => 11, 'comment' => 'ID da chave primária'])
            ->addColumn('ptype', 'char', ['default' => '', 'limit' => 8, 'comment' => 'Tipo de regra'])
            ->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]);

        //Executar criação
        $table->create();
    }
}

casbin 配置

A sintaxe para configuração do modelo de regras de permissão pode ser encontrada em: 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', // Arquivo de configuração do modelo de regras de permissão
            'config_text' => '',
        ],
        'adapter' => [
            'type' => 'model', // modelo ou adaptador
            'class' => \app\model\Rule::class,
        ],
    ],
    // Pode configurar vários modelos de permissão
    'rbac' => [
        'model' => [
            'config_type' => 'file',
            'config_file_path' => config_path() . '/casbin-rbac-model.conf', // Arquivo de configuração do modelo de regras de permissão
            'config_text' => '',
        ],
        'adapter' => [
            'type' => 'model', // modelo ou adaptador
            'class' => \app\model\RBACRule::class,
        ],
    ],
];

适配器

Na atual embalagem do composer, está adaptado para o método model do think-orm. Outros ORMs podem consultar vendor/teamones/src/adapters/DatabaseAdapter.php

Em seguida, modifique a configuração

return [
    'default' => [
        'model' => [
            'config_type' => 'file',
            'config_file_path' => config_path() . '/casbin-restful-model.conf', // Arquivo de configuração do modelo de regras de permissão
            'config_text' => '',
        ],
        'adapter' => [
            'type' => 'adapter', // Aqui o tipo é configurado como modo adaptador
            'class' => \app\adapter\DatabaseAdapter::class,
        ],
    ],
];

使用说明

引入

# Importar
use teamones\casbin\Enforcer;

两种用法

# 1. Usando a configuração padrão
Enforcer::addPermissionForUser('user1', '/user', 'read');

# 1. Usando a configuração rbac personalizada
Enforcer::instance('rbac')->addPermissionForUser('user1', '/user', 'read');

常用API介绍

Para mais usos da API, visite a documentação oficial

# Adicionar permissão a um usuário

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

# Remover a permissão de um usuário

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

# Obter todas as permissões de um usuário

Enforcer::getPermissionsForUser('user1'); 

# Adicionar papel a um usuário

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

# Adicionar permissão a um papel

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

# Obter todos os papéis

Enforcer::getAllRoles();

# Obter todos os papéis de um usuário

Enforcer::getRolesForUser('user1');

# Obter usuários por papel

Enforcer::getUsersForRole('role1');

# Verificar se o usuário pertence a um papel

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

# Remover papel de um usuário

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

# Remover todos os papéis de um usuário

Enforcer::deleteRolesForUser('use1');

# Remover papel

Enforcer::deleteRole('role1');

# Remover permissão

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

# Remover todas as permissões de um usuário ou papel

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

# Verificar permissão, retornando true ou false

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