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

Учебник по RBAC в Node.js: управление доступом на основе ролей в Express

В этом руководстве мы добавим управление доступом на основе ролей (RBAC) в REST API, построенный на Express. В итоге три роли (admin, editor, viewer) получат разные права на выполнение различных HTTP-методов для разных маршрутов, а правила будут храниться в файле политики, который можно изменять без правки обработчиков маршрутов.

Та же самая модель и политика работают во всех реализациях Casbin, поэтому вы можете повторно использовать их в версиях этого руководства для Go, Python, Java и Rust. Если вы используете NestJS, см. RBAC в NestJS.

1. Установка​

npm init -y
npm install express casbin

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 позволяет одному правилу перечислять несколько методов. Другие встроенные матчеры описаны в разделе Функции.

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. Добавление middleware​

Middleware вызывает enforce с пользователем, путем и методом и возвращает 403 Forbidden, если Casbin запрещает доступ.

server.js
const express = require("express");
const { newEnforcer } = require("casbin");

// authorize asks Casbin whether the current user may call this route.
function authorize(enforcer) {
return async (req, res, next) => {
// Replace this with the user from your session or JWT.
const user = req.get("X-User") || "";

try {
const allowed = await enforcer.enforce(user, req.baseUrl + req.path, req.method);
if (!allowed) {
return res.status(403).json({ error: "forbidden" });
}
next();
} catch (err) {
next(err);
}
};
}

async function main() {
const enforcer = await newEnforcer("model.conf", "policy.csv");

const app = express();
const api = express.Router();
api.get("/articles", (req, res) => res.json({ articles: [] }));
api.post("/articles", (req, res) => res.status(201).json({ created: true }));
api.put("/articles/:id", (req, res) => res.json({ updated: req.params.id }));
api.delete("/articles/:id", (req, res) => res.json({ deleted: req.params.id }));

app.use("/api", authorize(enforcer), api);
app.listen(8080, () => console.log("listening on :8080"));
}

main();
примечание

Внутри подключенного роутера req.path не включает точку монтирования. Выражение req.baseUrl + req.path дает полный путь (/api/articles), на который ссылается политика.

Заголовок X-User используется для упрощения примера. Casbin занимается только авторизацией; в реальном приложении имя пользователя поступает из вашего слоя аутентификации, например, из проверенного JWT или сессии.

5. Попробуйте сами​

node server.js
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. Изменение ролей во время выполнения​

Роли и разрешения являются данными, поэтому вы можете изменять их во время работы сервера:

await enforcer.addRoleForUser("dave", "editor"); // dave becomes an editor
await enforcer.deleteRoleForUser("bob", "editor"); // bob is no longer an editor
await enforcer.addPolicy("editor", "/api/comments", "POST"); // editors may now post comments

const roles = await enforcer.getRolesForUser("alice"); // ["admin"]

Полный список доступен в RBAC API и Management API.

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

  • Хранение политики в базе данных. Замените policy.csv на адаптер для Sequelize, TypeORM, Prisma, Mongoose и других. Изменения политики, внесенные через API, будут сохраняться автоматически.
  • Запуск нескольких экземпляров. Используйте watcher, чтобы каждый экземпляр перезагружал политику, когда один из них изменяет её.
  • Отображение или скрытие элементов интерфейса. В разделе Использование во фронтенде объясняется, как передавать разрешения пользователя в браузер с помощью casbin.js.
  • Мультиарендные приложения. RBAC с доменами позволяет назначать пользователю разные роли в разных арендаторах.
  • Правила на основе атрибутов. Совместите роли с ABAC, например: «редакторы могут обновлять только свои статьи». В руководстве по ABAC это реализуется пошагово.
  • Готовые middleware. В списке middleware есть плагины для Express, Koa, NestJS, Fastify и других фреймворков.

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