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

Руководство по RBAC в Spring Boot: управление доступом на основе ролей с jCasbin

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

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

1. Добавьте зависимость​

В проекте Spring Boot 3, который уже содержит spring-boot-starter-web, добавьте jCasbin в pom.xml. Используйте последнюю версию с Maven Central.

<dependency>
<groupId>org.casbin</groupId>
<artifactId>jcasbin</artifactId>
<version>1.81.0</version>
</dependency>

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 рядом с model.conf:

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. Добавьте перехватчик (interceptor)​

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

AuthorizationInterceptor.java
package com.example.rbac;

import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import org.casbin.jcasbin.main.Enforcer;
import org.springframework.web.servlet.HandlerInterceptor;

public class AuthorizationInterceptor implements HandlerInterceptor {

private final Enforcer enforcer;

public AuthorizationInterceptor(Enforcer enforcer) {
this.enforcer = enforcer;
}

@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
// Replace this with the user from your session or JWT.
String user = request.getHeader("X-User");
if (user == null) {
user = "";
}

if (enforcer.enforce(user, request.getRequestURI(), request.getMethod())) {
return true;
}
response.sendError(HttpServletResponse.SC_FORBIDDEN, "forbidden");
return false;
}
}

Создайте Enforcer как bean и зарегистрируйте перехватчик для маршрутов API:

CasbinConfig.java
package com.example.rbac;

import org.casbin.jcasbin.main.Enforcer;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Configuration
public class CasbinConfig implements WebMvcConfigurer {

@Bean
public Enforcer enforcer() {
return new Enforcer("model.conf", "policy.csv");
}

@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(new AuthorizationInterceptor(enforcer())).addPathPatterns("/api/**");
}
}

Контроллер для защиты:

ArticleController.java
package com.example.rbac;

import java.util.List;
import java.util.Map;
import org.springframework.http.HttpStatus;
import org.springframework.web.bind.annotation.*;

@RestController
@RequestMapping("/api/articles")
public class ArticleController {

@GetMapping
public Map<String, Object> list() {
return Map.of("articles", List.of());
}

@PostMapping
@ResponseStatus(HttpStatus.CREATED)
public Map<String, Object> create() {
return Map.of("created", true);
}

@PutMapping("/{id}")
public Map<String, Object> update(@PathVariable long id) {
return Map.of("updated", id);
}

@DeleteMapping("/{id}")
public Map<String, Object> delete(@PathVariable long id) {
return Map.of("deleted", id);
}
}
примечание

new Enforcer("model.conf", "policy.csv") считывает два файла из рабочей директории. Файлы, упакованные внутри JAR-приложения в src/main/resources, нельзя открыть как файловые пути; храните файлы вне JAR или загружайте политику из базы данных с помощью адаптера.

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

5. Попробуйте​

mvn spring-boot:run
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. Изменяйте роли во время выполнения​

Роли и разрешения — это данные, поэтому вы можете изменять их, пока сервер работает. Внедрите bean Enforcer туда, где вы управляете пользователями:

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

List<String> roles = enforcer.getRolesForUser("alice"); // [admin]

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

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

  • Храните политику в базе данных. Замените policy.csv на адаптер для JDBC, MyBatis, Hibernate, MongoDB и других. Изменения политики, выполненные через API, сохраняются автоматически.
  • Используйте стартер Spring Boot. casbin-spring-boot-starter создает Enforcer и адаптер JDBC из application.yml.
  • Запустите несколько экземпляров приложения. Используйте наблюдателя (watcher), чтобы каждый экземпляр перезагружал политику, когда один из них ее изменяет.
  • Многопользовательские приложения (Multi-tenant). RBAC с доменами позволяет назначать пользователю разные роли в разных тенантах.
  • Правила на основе атрибутов. Комбинируйте роли с ABAC, например: «редакторы могут обновлять только свои статьи». В статье Выбор модели контроля доступа показана комбинированная модель.
  • Другие фреймворки. Список промежуточного ПО (middleware) содержит плагины для Spring Boot, Apache Shiro, JFinal, Nutz и других фреймворков.

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