Перейти к основному содержимому

ABAC в Python с Flask

Контроль доступа на основе ролей отвечает на вопрос «что может делать редактор?». Однако многие реальные правила требуют большего, чем просто роль: авторы могут редактировать свои черновики, редакторы могут редактировать статьи своего отдела, любой пользователь может читать опубликованную статью. Эти правила зависят от атрибутов пользователя и ресурса, что является сутью контроля доступа на основе атрибутов (ABAC).

В этом руководстве мы создадим небольшое API для статей на Flask и поместим все эти правила в файл политики Casbin. Та же модель и политика работают без изменений в версиях этого руководства для Go и Node.js. Для правил на основе ролей в Python см. руководство по RBAC для FastAPI. Если вы еще выбираете между 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'. Двойная кавычка в середине поля нарушает разбор CSV. Если условие требует запятой, заключите всё поле в двойные кавычки.

4. Написание приложения​

Для ABAC нужен сам ресурс, а не только его URL, поэтому проверка выполняется после загрузки статьи. Вспомогательная функция authorize загружает статью, запрашивает решение у Casbin и прерывает выполнение с соответствующим кодом статуса, если ответ отрицательный. Каждая view вызывает её первой.

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 — её опубликованная статья, обе находятся в отделе engineering.

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, когда разрешения зависят от должностных функций и не зависят от того, к какой записи осуществляется доступ. Это проще для аудита: «перечислить все действия редактора» — это простой запрос. См. учебник по RBAC на Python.
  • Используйте ABAC, когда ответ зависит от самой записи: её владельца, отдела, статуса или уровня конфиденциальности.
  • Большинство приложений комбинируют оба подхода: роли определяют, какие функции доступны пользователю, а атрибуты сужают этот набор до записей, к которым у него есть доступ. В сравнении моделей контроля доступа показана комбинированная модель.

Следующие шаги​

  • Полное справочное руководство по ABAC. В разделе ABAC подробно описаны параметры JSON-запросов, правила цитирования и функция eval().
  • Готовая интеграция с Flask. В списке middleware есть flask-authz, который проверяет правила на уровне маршрутов для каждого запроса; проверки на уровне записей, подобные описанным выше, оставьте в ваших представлениях (views).
  • Несколько воркеров. Используйте watcher, чтобы каждый воркер Gunicorn или uWSGI перезагружал политику при её изменении одним из них.
  • Эксперименты в браузере. Онлайн-редактор может вычислять запросы ABAC с JSON-атрибутами.

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