跳到主要内容

Spring Boot RBAC 教程:使用 jCasbin 实现基于角色的访问控制

本教程使用 Spring Boot 和 jCasbin 为 REST API 添加基于角色的访问控制 (RBAC)。最终,三个角色 (admin, editor, viewer) 在不同的路由上被允许不同的 HTTP 方法,并且规则位于策略文件中,您可以更改它而无需修改控制器。

相同的 Model 和策略适用于所有 Casbin 实现,因此您可以在本教程的 Go、Node.js、Python 和 Rust 版本中复用它们。

1. 添加依赖项​

在已经包含 spring-boot-starter-web 的 Spring Boot 3 项目中,将 jCasbin 添加到 pom.xml。请使用 Maven Central 上的最新版本。

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

2. 编写 Model​

Model 定义了请求的结构以及如何将其与策略进行匹配。将此内容保存为您启动应用程序所在目录下的 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. 编写策略​

将其保存为 model.conf 旁边的 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. 添加拦截器​

拦截器调用 enforce,传入用户、路径和方法,当 Casbin 拒绝请求时响应 403 Forbidden。

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 外部,或使用 adapter 从数据库加载策略。

X-User header 旨在保持示例简洁。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. 运行时更改角色​

角色和权限是数据,因此您可以在服务器运行时更改它们。在您管理用户的地方注入 Enforcer bean:

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。

下一步​

  • 将策略存储在数据库中。 使用针对 JDBC、MyBatis、Hibernate、MongoDB 等的 adapter 替换 policy.csv。通过 API 进行的策略更改随后会自动保存。
  • 使用 Spring Boot starter。 casbin-spring-boot-starter 根据 application.yml 创建 Enforcer 和 JDBC adapter。
  • 运行多个实例。 使用 watcher,以便当其中一个实例更改策略时,所有实例都会重新加载策略。
  • 多租户应用。 带域名的 RBAC 允许用户在不同的租户中拥有不同的角色。
  • 基于属性的规则。 将角色与 ABAC 结合使用,例如“编辑者只能更新他们自己的文章”。选择访问控制模型 展示了一个组合模型。
  • 其他框架。 中间件列表 包含适用于 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.