Casbin

Beschreibung

Casbin ist ein leistungsstarkes, effizientes Open-Source-Zugriffskontroll-Framework, dessen Berechtigungsmanagement-Mechanismus mehrere Zugriffskontrollmodelle unterstützt.

Projektadresse

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

Installation

composer require teamones/casbin

Casbin-Website

Detaillierte Anweisungen zur Verwendung finden Sie in der offiziellen deutschen Dokumentation. Hier wird nur erklärt, wie man es in webman konfiguriert.

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

Verzeichnisstruktur

.
├── config                        Konfigurationsverzeichnis
│   ├── casbin-restful-model.conf Konfigurationsdatei des verwendeten Berechtigungsmodells
│   ├── casbin.php                casbin-Konfiguration
......
├── database                      Datenbankdateien
│   ├── migrations                Migrationsdateien
│   │   └── 20210218074218_create_rule_table.php
......

Datenbank-Migrationsdatei

<?php

use Phinx\Migration\AbstractMigration;

class CreateRuleTable extends AbstractMigration
{
    /**
     * Change-Methode.
     *
     * Schreiben Sie Ihre umkehrbaren Migrationen mit dieser Methode.
     *
     * Weitere Informationen zum Schreiben von Migrationen sind hier verfügbar:
     * http://docs.phinx.org/en/latest/migrations.html#the-abstractmigration-class
     *
     * Die folgenden Befehle können in dieser Methode verwendet werden, und Phinx wird
     * sie automatisch umkehren, wenn die Migration zurückgerollt wird:
     *
     *    createTable
     *    renameTable
     *    addColumn
     *    addCustomColumn
     *    renameColumn
     *    addIndex
     *    addForeignKey
     *
     * Alle anderen destruktiven Änderungen führen zu einem Fehler, wenn versucht wird,
     * die Migration zurückzurollen.
     *
     * Denken Sie daran, "create()" oder "update()" und NICHT "save()" zu verwenden,
     * wenn Sie mit der Table-Klasse arbeiten.
     */
    public function change()
    {
        $table = $this->table('rule', ['id' => false, 'primary_key' => ['id'], 'engine' => 'InnoDB', 'collation' => 'utf8mb4_general_ci', 'comment' => 'Regel Tabelle']);

        //Fügen Sie Datenfelder hinzu
        $table->addColumn('id', 'integer', ['identity' => true, 'signed' => false, 'limit' => 11, 'comment' => 'Primärschlüssel-ID'])
            ->addColumn('ptype', 'char', ['default' => '', 'limit' => 8, 'comment' => 'Regeltyp'])
            ->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]);

        //Ausführung der Erstellung
        $table->create();
    }
}

casbin Konfiguration

Die Syntax für die Berechtigungsregelmodellkonfiguration finden Sie unter: 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', // Berechtigungsregelmodellkonfigurationsdatei
            'config_text' => '',
        ],
        'adapter' => [
            'type' => 'model', // model oder adapter
            'class' => \app\model\Rule::class,
        ],
    ],
    // Es können mehrere Berechtigungsmodelle konfiguriert werden
    'rbac' => [
        'model' => [
            'config_type' => 'file',
            'config_file_path' => config_path() . '/casbin-rbac-model.conf', // Berechtigungsregelmodellkonfigurationsdatei
            'config_text' => '',
        ],
        'adapter' => [
            'type' => 'model', // model oder adapter
            'class' => \app\model\RBACRule::class,
        ],
    ],
];

Adapter

Aktuell wird im Composer-Paket die Model-Methode von think-orm unterstützt. Für andere ORMs siehe vendor/teamones/src/adapters/DatabaseAdapter.php.

Ändern Sie dann die Konfiguration.

return [
    'default' => [
        'model' => [
            'config_type' => 'file',
            'config_file_path' => config_path() . '/casbin-restful-model.conf', // Berechtigungsregelmodellkonfigurationsdatei
            'config_text' => '',
        ],
        'adapter' => [
            'type' => 'adapter', // Hier den Typ auf Adaptermodus setzen
            'class' => \app\adapter\DatabaseAdapter::class,
        ],
    ],
];

Benutzungsanleitung

Einbindung

# Einbindung
use teamones\casbin\Enforcer;

Zwei Anwendungsarten

# 1. Standardmäßig die default-Konfiguration verwenden
Enforcer::addPermissionForUser('user1', '/user', 'read');

# 1. Benutzerdefinierte rbac-Konfiguration verwenden
Enforcer::instance('rbac')->addPermissionForUser('user1', '/user', 'read');

Einführung in gängige APIs

Für weitere API-Verwendungen besuchen Sie bitte die offizielle Webseite.

# Berechtigung für Benutzer hinzufügen

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

# Berechtigung eines Benutzers löschen

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

# Alle Berechtigungen eines Benutzers abrufen

Enforcer::getPermissionsForUser('user1'); 

# Rolle für Benutzer hinzufügen

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

# Berechtigung für Rolle hinzufügen

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

# Alle Rollen abrufen

Enforcer::getAllRoles();

# Alle Rollen eines Benutzers abrufen

Enforcer::getRolesForUser('user1');

# Benutzer anhand der Rolle abrufen

Enforcer::getUsersForRole('role1');

# Überprüfen, ob ein Benutzer zu einer Rolle gehört

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

# Benutzerrolle löschen

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

# Alle Rollen eines Benutzers löschen

Enforcer::deleteRolesForUser('use1');

# Rolle löschen

Enforcer::deleteRole('role1');

# Berechtigung löschen

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

# Alle Berechtigungen eines Benutzers oder einer Rolle löschen

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

# Berechtigung überprüfen, gibt true oder false zurück

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