Учебник по RBAC на Python: управление доступом на основе ролей в FastAPI
В этом руководстве добавляется управление доступом на основе ролей (RBAC) к REST API, созданному с помощью FastAPI и PyCasbin. В итоге три роли (admin, editor, viewer) получают разные права на выполнение HTTP-методов для различных маршрутов, а правила хранятся в файле политики, который можно изменять без правки функций маршрутизации.
Одна и та же модель и политика работают во всех реализациях Casbin, поэтому вы можете использовать их в версиях этого руководства для Go, Node.js, Java и Rust.
1. Установка
pip install casbin fastapi uvicorn
2. Написание модели
Модель описывает структуру запроса и способ его сопоставления с политикой. Сохраните следующий код как model.conf:
[request_definition]
r = sub, 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) && keyMatch2(r.obj, p.obj) && regexMatch(r.act, p.act)
r = sub, obj, act: каждый запрос состоит из пользователя, пути URL и HTTP-метода.g = _, _: пользователям могут быть назначены роли.g(r.sub, p.sub): пользователь запроса должен иметь роль, указанную в правиле политики.keyMatch2сопоставляет пу ти вида/api/articles/:id, аregexMatchпозволяет одному правилу перечислять несколько методов. См. раздел Functions для получения информации о других встроенных матчерах.
3. Написание политики
Сохраните следующий код как policy.csv:
p, admin, /api/*, (GET)|(POST)|(PUT)|(DELETE)
p, editor, /api/articles, (GET)|(POST)
p, editor, /api/articles/:id, (GET)|(PUT)
p, viewer, /api/articles, GET
p, viewer, /api/articles/:id, GET
g, alice, admin
g, bob, editor
g, carol, viewer
Строки, начинающиеся с p, предоставляют роли доступ к пути и набору методов. Строки, начинающиеся с g, назначают пользователей ролям.
4. Добавление зависимости
Зависимость FastAPI вызывает метод enforce с пользователем, путем и методом, и выбрасывает ошибку 403 Forbidden, если Casbin запрещает доступ. Регистрация этой зависимости на уровне приложения применяет её ко всем маршрутам.
import casbin
from fastapi import Depends, FastAPI, HTTPException, Request
enforcer = casbin.Enforcer("model.conf", "policy.csv")
def authorize(request: Request) -> None:
"""Ask Casbin whether the current user may call this route."""
# Replace this with the user from your session or JWT.
user = request.headers.get("X-User", "")
if not enforcer.enforce(user, request.url.path, request.method):
raise HTTPException(status_code=403, detail="forbidden")
app = FastAPI(dependencies=[Depends(authorize)])
@app.get("/api/articles")
def list_articles():
return {"articles": []}
@app.post("/api/articles", status_code=201)
def create_article():
return {"created": True}
@app.put("/api/articles/{article_id}")
def update_article(article_id: int):
return {"updated": article_id}
@app.delete("/api/articles/{article_id}")
def delete_article(article_id: int):
return {"deleted": article_id}
Заголовок X-User используется для краткости примера. Casbin отвечает только за авторизацию; в реальном приложении имя пользователя получается из вашего слоя аутентификации, например, из проверенного JWT или сессии.
5. Тестирование
uvicorn main:app --port 8080
curl -i -X POST -H "X-User: bob" http://localhost:8080/api/articles # 201, editors can create
curl -i -X DELETE -H "X-User: bob" http://localhost:8080/api/articles/1 # 403, editors cannot delete
curl -i -X DELETE -H "X-User: alice" http://localhost:8080/api/articles/1 # 200, admins can
curl -i -X POST -H "X-User: carol" http://localhost:8080/api/articles # 403, viewers are read-only
6. Изменение ролей во время выпол нения
Роли и разрешения являются данными, поэтому их можно изменять во время работы сервера:
enforcer.add_role_for_user("dave", "editor") # dave becomes an editor
enforcer.delete_role_for_user("bob", "editor") # bob is no longer an editor
enforcer.add_policy("editor", "/api/comments", "POST") # editors may now post comments
enforcer.get_roles_for_user("alice") # ['admin']
Полный список доступен в справочнике по RBAC API и Management API.
Следующие шаги
- Хранение политики в базе данных. Замените
policy.csvна adapter для SQLAlchemy, Django ORM, MongoDB, Redis и других систем. Изменения политики, внесенные через API, будут сохраняться автоматически. - Запуск нескольких воркеров. Используйте watcher, чтобы все процессы перезагружали политику при её изменении одним из них.
- Многопользовательские приложения. RBAC с доменами позволяет пользователю иметь разные роли в разных арендаторах.
- Правила на основе атрибутов. Комбинируйте роли с ABAC, например, «редакторы могут обновлять только свои статьи». Руководство по ABAC показывает это пошагово.
- Готовые middleware. В списке middleware есть плагины для FastAPI, Django, Flask и других фреймворков.
- Эксперименты в браузер е. Вставьте модель и политику в онлайн-редактор, чтобы тестировать запросы без запуска кода.
Comments are powered by giscus and GitHub Discussions. They load from giscus.app and GitHub only after you click the button below.