PyCasbin安装与使用指南

PyCasbin安装与使用指南

pycasbinAn authorization library that supports access control models like ACL, RBAC, ABAC in Python项目地址:https://gitcode.com/gh_mirrors/py/pycasbin

引言

本文档旨在指导您快速上手并熟练掌握PyCasbin的安装与基本使用流程。PyCasbin是一款用Python编写的轻量级访问控制框架，它支持ACL、RBAC、ABAC等多种访问控制模型。

1. 项目的目录结构及介绍

典型的PyCasbin项目结构如下所示：

pycasbin_project/
├── conf/
│   ├── model.conf          # 模型配置文件
│   └── policy.csv          # 策略文件
├── src/
│   └── main.py             # 主启动文件
└── README.md               # 项目说明文件

conf/ 目录

model.conf

这是PyCasbin的核心配置文件，用于定义访问控制模型。模型包含了规则和策略的匹配逻辑，是权限管理的基础。

policy.csv

存储具体的权限策略。这是一个CSV文件，每一行代表一条策略记录，通常包含主题(subject)，对象(object)，动作(action)等字段。

src/ 目录

main.py

这是项目的入口文件，用于初始化PyCasbin实例并对请求进行权限检查。在这个文件中，你可以调用PyCasbin提供的API对权限进行管理。

2. 项目的启动文件介绍

main.py

主启动文件主要用于创建Enforcer实例，加载模型配置和策略文件，并提供接口对外部请求进行权限验证。

示例代码如下：

import casbin

def init_enforcer(model_path, policy_path):
    """
    初始化Enforcer实例
    :param model_path: 模型配置文件路径
    :param policy_path: 策略文件路径
    :return: Enforcer实例
    """
    return casbin.Enforcer(model_path, policy_path)

def check_permission(enforcer, subject, object, action):
    """
    验证主体是否有权对指定目标执行特定的操作
    :param enforcer: Enforcer实例
    :param subject: 请求的主体
    :param object: 请求的目标对象
    :param action: 请求的动作
    :return: True表示允许，False表示拒绝
    """
    return enforcer.enforce(subject, object, action)

if __name__ == '__main__':
    enforcer = init_enforcer('conf/model.conf', 'conf/policy.csv')
    
    # 示例：检查用户是否具有读取数据的权限
    if check_permission(enforcer, 'alice', 'data1', 'read'):
        print('Alice can read data1.')
    else:
        print('Access denied.')

3. 项目的配置文件介绍

模型配置文件 model.conf

模型配置文件定义了一组规则，这些规则描述了何时、何人能够访问何种资源。例如，以下是一份model.conf的简化示例：

[request_definition]
r = subj, obj, act

[policy_definition]
p = sub, obj, act

[role_definition]
g = _, _

[policy_effect]
e = some(where (p.eft == allow))

[matchers]
m = g(r.sub, p.sub) && r.obj == p.obj && r.act == p.act

这份配置定义了一个基于角色的访问控制系统(RBAC)，其中sub代表角色，obj代表资源，act代表操作。

策略文件 policy.csv

策略文件存储具体的权限分配。例如：

p, admin, /admin/*, *
p, guest, /public/*
g, alice, admin

这里的每条记录都对应着模型文件中的规则，定义了权限的分配情况。例如，“alice”作为“admin”角色的一部分，拥有对/admin/*路径下所有操作的权限。 请注意，在实际部署时，您可能需要根据具体的应用环境调整上述目录和文件名。此外，策略文件的来源也可以更改为数据库或其他持久化存储方式，以适应不同的应用场景。

pycasbinAn authorization library that supports access control models like ACL, RBAC, ABAC in Python项目地址:https://gitcode.com/gh_mirrors/py/pycasbin