Casbin

Descrizione

Casbin è un potente ed efficiente framework di controllo accessi open source, la cui gestione dei permessi supporta vari modelli di controllo accessi.

Indirizzo del progetto

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

Installazione

composer require teamones/casbin

Sito ufficiale di Casbin

Per dettagli sull'utilizzo, puoi consultare la documentazione ufficiale in cinese. Qui parleremo solo di come configurarlo in webman.

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

Struttura delle directory

.
├── config                        Directory di configurazione
│   ├── casbin-restful-model.conf File di configurazione del modello di permessi utilizzato
│   ├── casbin.php                Configurazione di casbin
......
├── database                      File di database
│   ├── migrations                File di migrazione
│   │   └── 20210218074218_create_rule_table.php
......

File di migrazione del database

<?php

use Phinx\Migration\AbstractMigration;

class CreateRuleTable extends AbstractMigration
{
    /**
     * Change Method.
     *
     * Scrivi le tue migrazioni reversibili usando questo metodo.
     *
     * Maggiori informazioni su come scrivere migrazioni sono disponibili qui:
     * http://docs.phinx.org/en/latest/migrations.html#the-abstractmigration-class
     *
     * I seguenti comandi possono essere utilizzati in questo metodo e Phinx
     * li invertirà automaticamente quando si annullerà:
     *
     *    createTable
     *    renameTable
     *    addColumn
     *    addCustomColumn
     *    renameColumn
     *    addIndex
     *    addForeignKey
     *
     * Qualsiasi altro cambiamento distruttivo risulterà in un errore quando si
     * tenterà di annullare la migrazione.
     *
     * Ricorda di chiamare "create()" o "update()" e NON "save()" quando lavori
     * con la classe Table.
     */
    public function change()
    {
        $table = $this->table('rule', ['id' => false, 'primary_key' => ['id'], 'engine' => 'InnoDB', 'collation' => 'utf8mb4_general_ci', 'comment' => 'Tabella delle regole']);

        // Aggiungi i campi dei dati
        $table->addColumn('id', 'integer', ['identity' => true, 'signed' => false, 'limit' => 11, 'comment' => 'ID principale'])
            ->addColumn('ptype', 'char', ['default' => '', 'limit' => 8, 'comment' => 'Tipo di regola'])
            ->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]);

        // Esegui la creazione
        $table->create();
    }
}

Configurazione di casbin

Per la sintassi di configurazione del modello di regole di permesso vedi: 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', // File di configurazione del modello di regole di permesso
            'config_text' => '',
        ],
        'adapter' => [
            'type' => 'model', // model o adapter
            'class' => \app\model\Rule::class,
        ],
    ],
    // Puoi configurare più modelli di permesso
    'rbac' => [
        'model' => [
            'config_type' => 'file',
            'config_file_path' => config_path() . '/casbin-rbac-model.conf', // File di configurazione del modello di regole di permesso
            'config_text' => '',
        ],
        'adapter' => [
            'type' => 'model', // model o adapter
            'class' => \app\model\RBACRule::class,
        ],
    ],
];

Adattatore

L'attuale pacchetto composer utilizza il metodo model di think-orm; per altri ORM, consultare vendor/teamones/src/adapters/DatabaseAdapter.php.

Quindi modifica la configurazione

return [
    'default' => [
        'model' => [
            'config_type' => 'file',
            'config_file_path' => config_path() . '/casbin-restful-model.conf', // File di configurazione del modello di regole di permesso
            'config_text' => '',
        ],
        'adapter' => [
            'type' => 'adapter', // Qui imposta il tipo in modalità adattatore
            'class' => \app\adapter\DatabaseAdapter::class,
        ],
    ],
];

Istruzioni per l'uso

Inclusione

# Inclusione
use teamones\casbin\Enforcer;

Due usi

# 1. Usa il default
Enforcer::addPermissionForUser('user1', '/user', 'read');

# 1. Usa la configurazione rbc personalizzata
Enforcer::instance('rbac')->addPermissionForUser('user1', '/user', 'read');

Introduzione alle API comuni

Per maggiori informazioni sull'uso delle API, consulta la documentazione ufficiale.

# Aggiungi permesso per l'utente

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

# Rimuovi un permesso per un utente

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

# Ottieni tutti i permessi dell'utente

Enforcer::getPermissionsForUser('user1'); 

# Aggiungi ruolo per l'utente

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

# Aggiungi permesso per il ruolo

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

# Ottieni tutti i ruoli

Enforcer::getAllRoles();

# Ottieni tutti i ruoli dell'utente

Enforcer::getRolesForUser('user1');

# Ottieni utenti per ruolo

Enforcer::getUsersForRole('role1');

# Verifica se l'utente appartiene a un ruolo

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

# Rimuovi ruolo per utente

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

# Rimuovi tutti i ruoli per l'utente

Enforcer::deleteRolesForUser('use1');

# Rimuovi ruolo

Enforcer::deleteRole('role1');

# Rimuovi permesso

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

# Rimuovi tutti i permessi per utente o ruolo

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

# Controlla permesso, restituisce true o false

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