跳到主要内容

Python Flask 中的 ABAC

基于角色的访问控制回答了“编辑者可以做什么?”这个问题。许多实际规则需要的不仅仅是角色:作者可以编辑自己的草稿,编辑者可以编辑自己部门的文章,任何人都可以阅读已发布的文章。这些取决于用户和资源本身的属性,这正是基于属性的访问控制 (ABAC) 的用武之地。

本教程将构建一个小型文章 API,使用 Flask,并将上述所有规则放入 Casbin 策略文件中。相同的模型和策略在本教程的 Go 和 Node.js 版本中无需修改即可直接使用。有关 Python 中的基于角色的规则,请参阅 FastAPI RBAC 教程。如果您仍在 RBAC 和 ABAC 之间犹豫不决,请先阅读选择访问控制模型。

1. 安装​

pip install pycasbin flask

2. 编写模型​

将其保存为 model.conf:

[request_definition]
r = sub, obj, act

[policy_definition]
p = sub_rule, obj_type, act

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

[matchers]
m = r.obj.Type == p.obj_type && r.act == p.act && eval(p.sub_rule)
  • r.sub 和 r.obj 是 Python 对象。匹配器读取它们的属性,例如 r.obj.Type。
  • 每个策略规则都在 sub_rule 中携带一个条件。eval(p.sub_rule) 会根据请求评估该条件,因此规则存在于策略中,而不是模型中。

3. 编写策略​

将其保存为 policy.csv:

p, r.obj.Status == 'published', article, read
p, r.sub.Name == r.obj.Owner, article, read
p, r.sub.Name == r.obj.Owner && r.obj.Status == 'draft', article, update
p, r.sub.Role == 'editor' && r.sub.Department == r.obj.Department, article, update
p, r.sub.Role == 'editor' && r.sub.Department == r.obj.Department, article, publish

将每一行理解为“当条件为真时,允许对文章执行此操作”:

  1. 任何人都可以阅读已发布的文章。
  2. 作者可以阅读自己的文章,包括草稿。
  3. 作者可以在文章处于草稿状态时编辑自己的文章。
  4. 编辑者可以编辑自己部门的任何文章。
  5. 编辑者可以发布自己部门的文章。

条件在所有 Casbin 实现中都使用相同的语法;PyCasbin 会将 && 和 || 转换为 Python 的 and 和 or。

提示

在条件中使用单引号书写字符串字面量,如 'published'。字段中间的 double quote(双引号)会破坏 CSV 解析。如果条件需要逗号,请用双引号包裹整个字段。

4. 编写应用程序​

ABAC 需要资源本身,而不仅仅是其 URL,因此检查是在加载文章之后进行的。authorize 辅助函数加载文章,询问 Casbin,并在结果为否定时以正确的状态代码中止。每个视图都会首先调用它。

app.py
from dataclasses import asdict, dataclass

import casbin
from flask import Flask, abort, request

enforcer = casbin.Enforcer("model.conf", "policy.csv")
app = Flask(__name__)


@dataclass
class User:
Name: str
Role: str
Department: str


@dataclass
class Article:
Id: str
Title: str
Owner: str
Department: str
Status: str
Type: str = "article"


# In a real application these come from your database.
users = {
"alice": User("alice", "author", "engineering"),
"bob": User("bob", "editor", "engineering"),
"carol": User("carol", "editor", "sales"),
"dave": User("dave", "author", "engineering"),
}

articles = {
"1": Article("1", "Draft by alice", "alice", "engineering", "draft"),
"2": Article("2", "Published by alice", "alice", "engineering", "published"),
}


def authorize(article_id: str, action: str) -> Article:
"""Load the article and abort unless the current user may perform the action on it."""
# Replace this with the user from your session or JWT.
user = users.get(request.headers.get("X-User", ""))
if user is None:
abort(401)
article = articles.get(article_id)
if article is None:
abort(404)
if not enforcer.enforce(user, article, action):
abort(403)
return article


@app.get("/articles/<article_id>")
def read_article(article_id):
return asdict(authorize(article_id, "read"))


@app.put("/articles/<article_id>")
def update_article(article_id):
article = authorize(article_id, "update")
article.Title = (request.get_json(silent=True) or {}).get("title", article.Title)
return asdict(article)


@app.post("/articles/<article_id>/publish")
def publish_article(article_id):
article = authorize(article_id, "publish")
article.Status = "published"
return asdict(article)

Dataclasses 使示例保持简短;任何对象都可以工作,包括 SQLAlchemy 或 Django 模型,只要策略中命名的属性存在即可。

备注

X-User 头信息使示例保持简短。Casbin 仅处理授权;在实际应用中,用户来自您的身份验证层,例如 Flask-Login 或经过验证的 JWT。

5. 试一试​

flask --app app run --port 5000

文章 1 是 alice 的草稿,文章 2 是她已发布的文章,两者都属于工程部门。

curl -i -H "X-User: dave" http://localhost:5000/articles/1 # 403, someone else's draft
curl -i -H "X-User: dave" http://localhost:5000/articles/2 # 200, published
curl -i -X PUT -H "X-User: alice" -H "Content-Type: application/json" -d '{"title":"New title"}' http://localhost:5000/articles/1 # 200, her own draft
curl -i -X PUT -H "X-User: alice" http://localhost:5000/articles/2 # 403, no longer a draft
curl -i -X PUT -H "X-User: bob" http://localhost:5000/articles/2 # 200, editor in engineering
curl -i -X PUT -H "X-User: carol" http://localhost:5000/articles/2 # 403, editor in sales
curl -i -X POST -H "X-User: alice" http://localhost:5000/articles/1/publish # 403, authors cannot publish
curl -i -X POST -H "X-User: bob" http://localhost:5000/articles/1/publish # 200
curl -i -H "X-User: dave" http://localhost:5000/articles/1 # 200, now published

6. 在运行时更改规则​

条件就是策略行,因此可以在服务器运行时添加和删除它们,并通过 适配器(如 SQLAlchemy 适配器)保存到数据库中:

# Admins may edit any article.
enforcer.add_policy("r.sub.Role == 'admin'", "article", "update")

# Which rule allowed this request? Useful for audit logs.
enforcer.enforce_ex(users["bob"], articles["2"], "update")
# (True, ["r.sub.Role == 'editor' && r.sub.Department == r.obj.Department", 'article', 'update'])

ABAC 还是 RBAC?​

  • 当权限遵循职位职能且不依赖于正在访问的具体记录时,请使用 RBAC。它更易于审计:“列出编辑人员可以执行的所有操作”是一个简单的查询。请参阅 Python 中的 RBAC 教程。
  • 当答案取决于记录本身时(例如所有者、部门、状态或敏感度),请使用 ABAC。
  • 大多数应用程序将两者结合使用:角色决定用户可以访问哪些功能,而属性则进一步缩小范围,确定他们可以接触哪些记录。访问控制模型比较展示了一个组合模型。

下一步​

  • 完整的 ABAC 参考。 ABAC 详细涵盖了 JSON 请求参数、引用规则和 eval()。
  • 现成的 Flask 集成。 中间件列表中包含 flask-authz,它为每个请求检查路由级规则;请将上述记录级检查保留在你的视图中。
  • 多个工作进程。 使用 监视器,以便当一个 Gunicorn 或 uWSGI 工作进程更改策略时,其他所有工作进程都能重新加载策略。
  • 在浏览器中实验。 在线编辑器可以使用 JSON 属性评估 ABAC 请求。

Comments are powered by giscus and GitHub Discussions. They load from giscus.app and GitHub only after you click the button below.