Casbin
说明
Casbin es un potente y eficiente marco de control de acceso de código abierto, cuyo mecanismo de gestión de permisos admite diversos modelos de control de acceso.
项目地址
https://github.com/teamones-open/casbin
安装
composer require teamones/casbin
Casbin官网
Para un uso detallado, puede consultar la documentación oficial en chino. Aquí solo se explica cómo configurarlo en webman.
https://casbin.org/docs/zh-CN/overview
目录结构
.
├── config Directorio de configuración
│ ├── casbin-restful-model.conf Archivo de configuración del modelo de permisos utilizado
│ ├── casbin.php Configuración de casbin
......
├── database Archivos de base de datos
│ ├── migrations Archivos de migración
│ │ └── 20210218074218_create_rule_table.php
......
数据库迁移文件
<?php
use Phinx\Migration\AbstractMigration;
class CreateRuleTable extends AbstractMigration
{
/**
* Change Method.
*
* Escriba sus migraciones reversibles usando este método.
*
* Más información sobre la escritura de migraciones está disponible aquí:
* http://docs.phinx.org/en/latest/migrations.html#the-abstractmigration-class
*
* Los siguientes comandos se pueden usar en este método y Phinx
* los revertirá automáticamente al deshacer:
*
* createTable
* renameTable
* addColumn
* addCustomColumn
* renameColumn
* addIndex
* addForeignKey
*
* Cualquier otro cambio destructivo resultará en un error al intentar
* deshacer la migración.
*
* Recuerde llamar a "create()" o "update()" y NO "save()" al trabajar
* con la clase Table.
*/
public function change()
{
$table = $this->table('rule', ['id' => false, 'primary_key' => ['id'], 'engine' => 'InnoDB', 'collation' => 'utf8mb4_general_ci', 'comment' => 'Tabla de reglas']);
// Agregar campos de datos
$table->addColumn('id', 'integer', ['identity' => true, 'signed' => false, 'limit' => 11, 'comment' => 'ID de clave primaria'])
->addColumn('ptype', 'char', ['default' => '', 'limit' => 8, 'comment' => 'Tipo de regla'])
->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]);
// Ejecutar creación
$table->create();
}
}
casbin 配置
La sintaxis de configuración del modelo de reglas de permisos se puede ver en: 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', // Archivo de configuración del modelo de reglas de permisos
'config_text' => '',
],
'adapter' => [
'type' => 'model', // model o adapter
'class' => \app\model\Rule::class,
],
],
// Se pueden configurar múltiples modelos de permisos
'rbac' => [
'model' => [
'config_type' => 'file',
'config_file_path' => config_path() . '/casbin-rbac-model.conf', // Archivo de configuración del modelo de reglas de permisos
'config_text' => '',
],
'adapter' => [
'type' => 'model', // model o adapter
'class' => \app\model\RBACRule::class,
],
],
];
适配器
El paquete actual de composer está adaptado al método model de think-orm. Por favor, consulte vendor/teamones/src/adapters/DatabaseAdapter.php para otros ORM.
Luego modifique la configuración.
return [
'default' => [
'model' => [
'config_type' => 'file',
'config_file_path' => config_path() . '/casbin-restful-model.conf', // Archivo de configuración del modelo de reglas de permisos
'config_text' => '',
],
'adapter' => [
'type' => 'adapter', // Cambie el tipo aquí a modo de adaptador
'class' => \app\adapter\DatabaseAdapter::class,
],
],
];
使用说明
引入
# Importar
use teamones\casbin\Enforcer;
两种用法
# 1. Usar la configuración por defecto
Enforcer::addPermissionForUser('user1', '/user', 'read');
# 2. Usar la configuración rbac personalizada
Enforcer::instance('rbac')->addPermissionForUser('user1', '/user', 'read');
常用API介绍
Para más detalles sobre el uso de la API, consulte la documentación oficial.
- API de gestión: https://casbin.org/docs/zh-CN/management-api
- API de RBAC: https://casbin.org/docs/zh-CN/rbac-api
# Agregar permiso a un usuario
Enforcer::addPermissionForUser('user1', '/user', 'read');
# Eliminar un permiso de un usuario
Enforcer::deletePermissionForUser('user1', '/user', 'read');
# Obtener todos los permisos de un usuario
Enforcer::getPermissionsForUser('user1');
# Agregar rol a un usuario
Enforcer::addRoleForUser('user1', 'role1');
# Agregar permiso a un rol
Enforcer::addPermissionForUser('role1', '/user', 'edit');
# Obtener todos los roles
Enforcer::getAllRoles();
# Obtener todos los roles de un usuario
Enforcer::getRolesForUser('user1');
# Obtener usuarios por rol
Enforcer::getUsersForRole('role1');
# Verificar si un usuario pertenece a un rol
Enforcer::hasRoleForUser('use1', 'role1');
# Eliminar rol de un usuario
Enforcer::deleteRoleForUser('use1', 'role1');
# Eliminar todos los roles de un usuario
Enforcer::deleteRolesForUser('use1');
# Eliminar rol
Enforcer::deleteRole('role1');
# Eliminar permiso
Enforcer::deletePermission('/user', 'read');
# Eliminar todos los permisos de un usuario o rol
Enforcer::deletePermissionsForUser('user1');
Enforcer::deletePermissionsForUser('role1');
# Verificar permiso, devuelve true o false
Enforcer::enforce("user1", "/user", "edit");