본문으로 건너뛰기

Spring Boot RBAC Tutorial: Role-Based Access Control with jCasbin

이 튜토리얼은 Spring Boot와 jCasbin으로 구축된 REST API에 역할 기반 접근 제어(RBAC)를 추가합니다. 최종적으로 세 가지 역할(admin, editor, viewer)이 서로 다른 경로에서 서로 다른 HTTP 메서드를 허용받으며, 규칙은 컨트롤러를 수정하지 않고 변경할 수 있는 정책 파일에 저장됩니다.

동일한 모델과 정책은 모든 Casbin 구현체에서 작동하므로, 이 튜토리얼의 Go, Node.js, Python 및 Rust 버전에서도 재사용할 수 있습니다.

1. 의존성 추가​

이미 spring-boot-starter-web이 포함된 Spring Boot 3 프로젝트에서 pom.xml에 jCasbin을 추가하세요. 최신 버전은 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를 사용하면 하나의 규칙으로 여러 메서드를 나열할 수 있습니다. 다른 내장 매처는 Functions를 참조하세요.

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 외부에 보관하거나, 어댑터를 사용하여 데이터베이스에서 정책을 로드하십시오.

X-User 헤더는 예제를 간결하게 유지하기 위해 사용됩니다. Casbin은 권한 부여(authorization)만 처리합니다. 실제 애플리케이션에서는 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 빈을 주입합니다:

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 등을 위한 어댑터로 policy.csv를 교체합니다. API를 통해 이루어진 정책 변경 사항은 자동으로 저장됩니다.
  • Spring Boot 스타터 사용. casbin-spring-boot-starter는 application.yml로부터 Enforcer와 JDBC 어댑터를 생성합니다.
  • 다중 인스턴스 실행. 하나의 인스턴스가 정책을 변경할 때 모든 인스턴스가 정책을 다시 로드하도록 워처(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.