对于最新的稳定版本,请使用 Spring Security 6.5.3spring-doc.cadn.net.cn

方法安全性

除了在请求级别对授权进行建模外,Spring Security 还支持在方法级别进行建模。spring-doc.cadn.net.cn

您可以通过注释任何@Configuration类与@EnableMethodSecurity或添加<method-security>添加到任何 XML 配置文件,如下所示:spring-doc.cadn.net.cn

@EnableMethodSecurity
@EnableMethodSecurity
<sec:method-security/>

然后,您可以立即使用@PreAuthorize,@PostAuthorize,@PreFilter@PostFilter授权方法调用,包括输入参数和返回值。spring-doc.cadn.net.cn

默认情况下,Spring Boot Starter Security 不激活方法级授权。

方法安全性还支持许多其他用例,包括 AspectJ 支持自定义注释和多个配置点。 考虑了解以下用例:spring-doc.cadn.net.cn

方法安全性的工作原理

Spring Security 的方法授权支持适用于:spring-doc.cadn.net.cn

由于 Method Security 是使用 Spring AOP 构建的,因此您可以根据需要访问其所有表达能力来覆盖 Spring Security 的默认值。spring-doc.cadn.net.cn

如前所述,您首先添加@EnableMethodSecurity设置为@Configurationclass 或<sec:method-security/>在 Spring XML 配置文件中。spring-doc.cadn.net.cn

此注释和 XML 元素取代@EnableGlobalMethodSecurity<sec:global-method-security/>分别。 它们提供了以下改进:spring-doc.cadn.net.cn

  1. 使用简化的AuthorizationManagerAPI 而不是元数据源、配置属性、决策管理器和投票者。 这简化了重用和定制。spring-doc.cadn.net.cn

  2. 支持基于 bean 的直接配置,而不是要求扩展GlobalMethodSecurityConfiguration自定义 Beanspring-doc.cadn.net.cn

  3. 使用原生 Spring AOP 构建,删除抽象并允许您使用 Spring AOP 构建块进行自定义spring-doc.cadn.net.cn

  4. 检查冲突的注释以确保安全配置明确spring-doc.cadn.net.cn

  5. 符合 JSR-250 标准spring-doc.cadn.net.cn

  6. 使@PreAuthorize,@PostAuthorize,@PreFilter@PostFilter默认情况下spring-doc.cadn.net.cn

如果您正在使用@EnableGlobalMethodSecurity<global-method-security/>,这些现已弃用,建议您迁移。spring-doc.cadn.net.cn

方法授权是方法授权之前和之后的组合。 考虑一个以以下方式注释的服务 Bean:spring-doc.cadn.net.cn

@Service
public class MyCustomerService {
    @PreAuthorize("hasAuthority('permission:read')")
    @PostAuthorize("returnObject.owner == authentication.name")
    public Customer readCustomer(String id) { ... }
}
@Service
open class MyCustomerService {
    @PreAuthorize("hasAuthority('permission:read')")
    @PostAuthorize("returnObject.owner == authentication.name")
    fun readCustomer(val id: String): Customer { ... }
}

给定的调用MyCustomerService#readCustomer激活方法安全性时,可能如下所示:spring-doc.cadn.net.cn

方法安全
  1. Spring AOP 调用其代理方法readCustomer.在代理的其他顾问中,它调用AuthorizationManagerBeforeMethodInterceptor匹配@PreAuthorize切入点spring-doc.cadn.net.cn

  2. 拦截器调用PreAuthorizeAuthorizationManager#checkspring-doc.cadn.net.cn

  3. 授权管理器使用MethodSecurityExpressionHandler解析注释的 SpEL 表达式并构造相应的EvaluationContextMethodSecurityExpressionRoot一个Supplier<Authentication>MethodInvocation.spring-doc.cadn.net.cn

  4. 拦截器使用此上下文来评估表达式;具体来说,它写道AuthenticationSupplier并检查它是否具有permission:read在其权威的集合中spring-doc.cadn.net.cn

  5. 如果评估通过,则 Spring AOP 将继续调用该方法。spring-doc.cadn.net.cn

  6. 如果没有,拦截器会发布一个AuthorizationDeniedEvent并抛出一个AccessDeniedExceptionExceptionTranslationFilter捕获并返回响应的 403 状态代码spring-doc.cadn.net.cn

  7. 方法返回后,Spring AOP 调用AuthorizationManagerAfterMethodInterceptor匹配@PostAuthorize切入点,作方式与上述相同,但与PostAuthorizeAuthorizationManagerspring-doc.cadn.net.cn

  8. 如果评估通过(在本例中,返回值属于登录用户),则处理将正常继续spring-doc.cadn.net.cn

  9. 如果没有,拦截器会发布一个AuthorizationDeniedEvent并抛出一个AccessDeniedExceptionExceptionTranslationFilter捕获并返回响应的 403 状态代码spring-doc.cadn.net.cn

如果该方法未在 HTTP 请求的上下文中调用,则可能需要处理AccessDeniedException你自己

多个注释是串联计算的

如上所述,如果方法调用涉及多个方法安全注释,则每次处理一个注释。 这意味着它们可以统称为“和”在一起。 换句话说,要授权调用,所有注释检查都需要通过授权。spring-doc.cadn.net.cn

不支持重复注释

也就是说,不支持在同一方法上重复相同的注释。 例如,您不能放置@PreAuthorize在同一方法上两次。spring-doc.cadn.net.cn

相反,请使用 SpEL 的布尔支持或其对委托给单独 bean 的支持。spring-doc.cadn.net.cn

每个注释都有自己的切入点

每个注解都有自己的切入点实例,用于在整个对象层次结构中查找该注解或其元注解对应项,从方法及其封闭类开始。spring-doc.cadn.net.cn

您可以在以下位置查看其具体内容AuthorizationMethodPointcuts.spring-doc.cadn.net.cn

每个注解都有自己的方法拦截器

每个注释都有自己的专用方法拦截器。 这样做的原因是让事情更具可组合性。 例如,如果需要,您可以禁用 Spring Security 默认值和仅发布@PostAuthorize方法拦截器.spring-doc.cadn.net.cn

方法拦截器如下:spring-doc.cadn.net.cn

一般来说,您可以将以下列表视为代表 Spring Security 在添加@EnableMethodSecurity:spring-doc.cadn.net.cn

@Bean
@Role(BeanDefinition.ROLE_INFRASTRUCTURE)
static Advisor preAuthorizeMethodInterceptor() {
    return AuthorizationManagerBeforeMethodInterceptor.preAuthorize();
}

@Bean
@Role(BeanDefinition.ROLE_INFRASTRUCTURE)
static Advisor postAuthorizeMethodInterceptor() {
    return AuthorizationManagerAfterMethodInterceptor.postAuthorize();
}

@Bean
@Role(BeanDefinition.ROLE_INFRASTRUCTURE)
static Advisor preFilterMethodInterceptor() {
    return AuthorizationManagerBeforeMethodInterceptor.preFilter();
}

@Bean
@Role(BeanDefinition.ROLE_INFRASTRUCTURE)
static Advisor postFilterMethodInterceptor() {
    return AuthorizationManagerAfterMethodInterceptor.postFilter();
}

赞成授予权限而不是复杂的 SpEL 表达式

很多时候,引入如下复杂的 SpEL 表达式可能很诱人:spring-doc.cadn.net.cn

@PreAuthorize("hasAuthority('permission:read') || hasRole('ADMIN')")
Kotlin
@PreAuthorize("hasAuthority('permission:read') || hasRole('ADMIN')")

但是,您可以改为授予permission:read致那些有ROLE_ADMIN. 一种方法是使用RoleHierarchy这样:spring-doc.cadn.net.cn

@Bean
static RoleHierarchy roleHierarchy() {
    return new RoleHierarchyImpl("ROLE_ADMIN > permission:read");
}
companion object {
    @Bean
    fun roleHierarchy(): RoleHierarchy {
        return RoleHierarchyImpl("ROLE_ADMIN > permission:read")
    }
}
<bean id="roleHierarchy" class="org.springframework.security.access.hierarchicalroles.RoleHierarchyImpl">
    <constructor-arg value="ROLE_ADMIN > permission:read"/>
</bean>

然后MethodSecurityExpressionHandler实例. 这样您就可以拥有更简单的@PreAuthorize像这样的表达式:spring-doc.cadn.net.cn

@PreAuthorize("hasAuthority('permission:read')")
@PreAuthorize("hasAuthority('permission:read')")

或者,在可能的情况下,在登录时将特定于应用程序的授权逻辑调整到授予的权限中。spring-doc.cadn.net.cn

比较请求级授权与方法级授权

什么时候应该优先使用方法级授权而不是请求级授权? 其中一些归结为口味;但是,请考虑以下每种优势列表以帮助您做出决定。spring-doc.cadn.net.cn

请求级spring-doc.cadn.net.cn

方法级spring-doc.cadn.net.cn

授权类型spring-doc.cadn.net.cn

粗粒度spring-doc.cadn.net.cn

细粒度spring-doc.cadn.net.cn

配置位置spring-doc.cadn.net.cn

在配置类中声明spring-doc.cadn.net.cn

local to 方法声明spring-doc.cadn.net.cn

配置样式spring-doc.cadn.net.cn

DSL的spring-doc.cadn.net.cn

附注spring-doc.cadn.net.cn

授权定义spring-doc.cadn.net.cn

编程spring-doc.cadn.net.cn

斯佩尔spring-doc.cadn.net.cn

主要权衡似乎是您希望授权规则存在的位置。spring-doc.cadn.net.cn

请务必记住,当您使用基于注释的方法安全性时,未注释的方法不会受到保护。为了防止这种情况发生,请在HttpSecurity实例。

使用注释进行授权

Spring Security 启用方法级授权支持的主要方式是通过可以添加到方法、类和接口的注释。spring-doc.cadn.net.cn

授权方法 调用@PreAuthorize

@Component
public class BankService {
	@PreAuthorize("hasRole('ADMIN')")
	public Account readAccount(Long id) {
        // ... is only invoked if the `Authentication` has the `ROLE_ADMIN` authority
	}
}
@Component
open class BankService {
	@PreAuthorize("hasRole('ADMIN')")
	fun readAccount(val id: Long): Account {
        // ... is only invoked if the `Authentication` has the `ROLE_ADMIN` authority
	}
}

这表示只有在提供的表达式hasRole('ADMIN')通过。spring-doc.cadn.net.cn

然后,您可以测试该类以确认它正在强制执行授权规则,如下所示:spring-doc.cadn.net.cn

@Autowired
BankService bankService;

@WithMockUser(roles="ADMIN")
@Test
void readAccountWithAdminRoleThenInvokes() {
    Account account = this.bankService.readAccount("12345678");
    // ... assertions
}

@WithMockUser(roles="WRONG")
@Test
void readAccountWithWrongRoleThenAccessDenied() {
    assertThatExceptionOfType(AccessDeniedException.class).isThrownBy(
        () -> this.bankService.readAccount("12345678"));
}
@WithMockUser(roles="ADMIN")
@Test
fun readAccountWithAdminRoleThenInvokes() {
    val account: Account = this.bankService.readAccount("12345678")
    // ... assertions
}

@WithMockUser(roles="WRONG")
@Test
fun readAccountWithWrongRoleThenAccessDenied() {
    assertThatExceptionOfType(AccessDeniedException::class.java).isThrownBy {
        this.bankService.readAccount("12345678")
    }
}
@PreAuthorize也可以是元注释,在类或接口级别定义,并使用 SpEL 授权表达式

@PreAuthorize对于声明所需的权限非常有帮助,它还可用于评估涉及方法参数的更复杂的表达式spring-doc.cadn.net.cn

授权方法结果@PostAuthorize

当方法安全性处于活动状态时,您可以使用@PostAuthorize注释如下:spring-doc.cadn.net.cn

@Component
public class BankService {
	@PostAuthorize("returnObject.owner == authentication.name")
	public Account readAccount(Long id) {
        // ... is only returned if the `Account` belongs to the logged in user
	}
}
@Component
open class BankService {
	@PostAuthorize("returnObject.owner == authentication.name")
	fun readAccount(val id: Long): Account {
        // ... is only returned if the `Account` belongs to the logged in user
	}
}

这意味着该方法只能在提供的表达式returnObject.owner == authentication.name通过。returnObject表示Account对象。spring-doc.cadn.net.cn

然后,您可以测试该类以确认它正在强制执行授权规则:spring-doc.cadn.net.cn

@Autowired
BankService bankService;

@WithMockUser(username="owner")
@Test
void readAccountWhenOwnedThenReturns() {
    Account account = this.bankService.readAccount("12345678");
    // ... assertions
}

@WithMockUser(username="wrong")
@Test
void readAccountWhenNotOwnedThenAccessDenied() {
    assertThatExceptionOfType(AccessDeniedException.class).isThrownBy(
        () -> this.bankService.readAccount("12345678"));
}
@WithMockUser(username="owner")
@Test
fun readAccountWhenOwnedThenReturns() {
    val account: Account = this.bankService.readAccount("12345678")
    // ... assertions
}

@WithMockUser(username="wrong")
@Test
fun readAccountWhenNotOwnedThenAccessDenied() {
    assertThatExceptionOfType(AccessDeniedException::class.java).isThrownBy {
        this.bankService.readAccount("12345678")
    }
}
@PostAuthorize也可以是元注释,在类或接口级别定义,并使用 SpEL 授权表达式

@PostAuthorize在防御不安全的直接对象引用时特别有用。 事实上,它可以定义为如下所示的元注释spring-doc.cadn.net.cn

@Target({ ElementType.METHOD, ElementType.TYPE })
@Retention(RetentionPolicy.RUNTIME)
@PostAuthorize("returnObject.owner == authentication.name")
public @interface RequireOwnership {}
@Target(ElementType.METHOD, ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@PostAuthorize("returnObject.owner == authentication.name")
annotation class RequireOwnership

允许您通过以下方式注释服务:spring-doc.cadn.net.cn

@Component
public class BankService {
	@RequireOwnership
	public Account readAccount(Long id) {
        // ... is only returned if the `Account` belongs to the logged in user
	}
}
@Component
open class BankService {
	@RequireOwnership
	fun readAccount(val id: Long): Account {
        // ... is only returned if the `Account` belongs to the logged in user
	}
}

结果是上述方法只会返回Account如果它的owner属性与登录用户的name. 如果没有,Spring Security 将抛出一个AccessDeniedException并返回 403 状态代码。spring-doc.cadn.net.cn

过滤方法参数@PreFilter

@PreFilter尚不支持 Kotlin 特定的数据类型;因此,仅显示 Java 代码片段

当方法安全性处于活动状态时,您可以使用@PreFilter注释如下:spring-doc.cadn.net.cn

@Component
public class BankService {
	@PreFilter("filterObject.owner == authentication.name")
	public Collection<Account> updateAccounts(Account... accounts) {
        // ... `accounts` will only contain the accounts owned by the logged-in user
        return updated;
	}
}

这是为了过滤掉accounts其中表达式filterObject.owner == authentication.name失败。filterObject代表每个accountaccounts并用于测试每个account.spring-doc.cadn.net.cn

然后,您可以通过以下方式测试该类,以确认它正在强制执行授权规则:spring-doc.cadn.net.cn

@Autowired
BankService bankService;

@WithMockUser(username="owner")
@Test
void updateAccountsWhenOwnedThenReturns() {
    Account ownedBy = ...
    Account notOwnedBy = ...
    Collection<Account> updated = this.bankService.updateAccounts(ownedBy, notOwnedBy);
    assertThat(updated).containsOnly(ownedBy);
}
@PreFilter也可以是元注释,在类或接口级别定义,并使用 SpEL 授权表达式

@PreFilter支持数组、集合、映射和流(只要流仍然打开)。spring-doc.cadn.net.cn

例如,上面的updateAccounts声明的功能与以下其他四个相同:spring-doc.cadn.net.cn

@PreFilter("filterObject.owner == authentication.name")
public Collection<Account> updateAccounts(Account[] accounts)

@PreFilter("filterObject.owner == authentication.name")
public Collection<Account> updateAccounts(Collection<Account> accounts)

@PreFilter("filterObject.value.owner == authentication.name")
public Collection<Account> updateAccounts(Map<String, Account> accounts)

@PreFilter("filterObject.owner == authentication.name")
public Collection<Account> updateAccounts(Stream<Account> accounts)

结果是,上述方法将只有Account他们的实例owner属性与登录用户的name.spring-doc.cadn.net.cn

过滤方法结果@PostFilter

@PostFilter尚不支持 Kotlin 特定的数据类型;因此,仅显示 Java 代码片段

当方法安全性处于活动状态时,您可以使用@PostFilter注释如下:spring-doc.cadn.net.cn

@Component
public class BankService {
	@PostFilter("filterObject.owner == authentication.name")
	public Collection<Account> readAccounts(String... ids) {
        // ... the return value will be filtered to only contain the accounts owned by the logged-in user
        return accounts;
	}
}

这是为了从返回值中过滤掉任何值,其中表达式filterObject.owner == authentication.name失败。filterObject代表每个accountaccounts并用于测试每个account.spring-doc.cadn.net.cn

然后,您可以像这样测试类,以确认它正在强制执行授权规则:spring-doc.cadn.net.cn

@Autowired
BankService bankService;

@WithMockUser(username="owner")
@Test
void readAccountsWhenOwnedThenReturns() {
    Collection<Account> accounts = this.bankService.updateAccounts("owner", "not-owner");
    assertThat(accounts).hasSize(1);
    assertThat(accounts.get(0).getOwner()).isEqualTo("owner");
}
@PostFilter也可以是元注释,在类或接口级别定义,并使用 SpEL 授权表达式

@PostFilter支持数组、集合、映射和流(只要流仍然打开)。spring-doc.cadn.net.cn

例如,上面的readAccounts声明的功能与以下三个相同:spring-doc.cadn.net.cn

@PostFilter("filterObject.owner == authentication.name")
public Account[] readAccounts(String... ids)

@PostFilter("filterObject.value.owner == authentication.name")
public Map<String, Account> readAccounts(String... ids)

@PostFilter("filterObject.owner == authentication.name")
public Stream<Account> readAccounts(String... ids)

结果是,上述方法将返回Account他们的实例owner属性与登录用户的name.spring-doc.cadn.net.cn

内存中过滤显然可能很昂贵,因此请考虑是否最好在数据层中过滤数据

授权方法 调用@Secured

@Secured是授权调用的旧版选项。@PreAuthorize取代它,建议改为。spring-doc.cadn.net.cn

要使用@Secured注释,您应该首先更改方法安全声明以启用它,如下所示:spring-doc.cadn.net.cn

@EnableMethodSecurity(securedEnabled = true)
@EnableMethodSecurity(securedEnabled = true)
<sec:method-security secured-enabled="true"/>

这将导致 Spring Security 发布相应的方法拦截器,该拦截器授权方法、类和带有@Secured.spring-doc.cadn.net.cn

使用 JSR-250 Comments 授权方法调用

如果您想使用 JSR-250 注释,Spring Security 也支持它。@PreAuthorize具有更强的表现力,因此被推荐。spring-doc.cadn.net.cn

要使用 JSR-250 注解,您应该首先更改方法安全声明以启用它们,如下所示:spring-doc.cadn.net.cn

@EnableMethodSecurity(jsr250Enabled = true)
@EnableMethodSecurity(jsr250Enabled = true)
<sec:method-security jsr250-enabled="true"/>

这将导致 Spring Security 发布相应的方法拦截器,该拦截器授权方法、类和带有@RolesAllowed,@PermitAll@DenyAll.spring-doc.cadn.net.cn

在类或接口级别声明注释

还支持在类和接口级别使用方法安全注释。spring-doc.cadn.net.cn

如果它是在类级别,如下所示:spring-doc.cadn.net.cn

@Controller
@PreAuthorize("hasAuthority('ROLE_USER')")
public class MyController {
    @GetMapping("/endpoint")
    public String endpoint() { ... }
}
@Controller
@PreAuthorize("hasAuthority('ROLE_USER')")
open class MyController {
    @GetMapping("/endpoint")
    fun endpoint(): String { ... }
}

则所有方法都继承类级行为。spring-doc.cadn.net.cn

或者,如果它在类和方法级别都声明如下:spring-doc.cadn.net.cn

@Controller
@PreAuthorize("hasAuthority('ROLE_USER')")
public class MyController {
    @GetMapping("/endpoint")
    @PreAuthorize("hasAuthority('ROLE_ADMIN')")
    public String endpoint() { ... }
}
@Controller
@PreAuthorize("hasAuthority('ROLE_USER')")
open class MyController {
    @GetMapping("/endpoint")
    @PreAuthorize("hasAuthority('ROLE_ADMIN')")
    fun endpoint(): String { ... }
}

然后声明注释的方法会覆盖类级注释。spring-doc.cadn.net.cn

接口也是如此,但如果一个类从两个不同的接口继承了注释,则启动将失败。 这是因为 Spring Security 无法判断您要使用哪一个。spring-doc.cadn.net.cn

在这种情况下,您可以通过将注释添加到具体方法来解决歧义。spring-doc.cadn.net.cn

使用元注释

方法安全支持元注释。 这意味着您可以根据特定于应用程序的用例获取任何注释并提高可读性。spring-doc.cadn.net.cn

例如,您可以简化@PreAuthorize("hasRole('ADMIN')")@IsAdmin这样:spring-doc.cadn.net.cn

@Target({ ElementType.METHOD, ElementType.TYPE })
@Retention(RetentionPolicy.RUNTIME)
@PreAuthorize("hasRole('ADMIN')")
public @interface IsAdmin {}
@Target(ElementType.METHOD, ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@PreAuthorize("hasRole('ADMIN')")
annotation class IsAdmin

结果是,在安全方法上,您现在可以执行以下作:spring-doc.cadn.net.cn

@Component
public class BankService {
	@IsAdmin
	public Account readAccount(Long id) {
        // ... is only returned if the `Account` belongs to the logged in user
	}
}
@Component
open class BankService {
	@IsAdmin
	fun readAccount(val id: Long): Account {
        // ... is only returned if the `Account` belongs to the logged in user
	}
}

这导致方法定义更具可读性。spring-doc.cadn.net.cn

启用某些注释

您可以关闭@EnableMethodSecurity的预配置,并将其替换为您自己的。 如果您愿意,可以选择这样做自定义AuthorizationManagerPointcut. 或者您可能只想启用特定的注释,例如@PostAuthorize.spring-doc.cadn.net.cn

您可以通过以下方式执行此作:spring-doc.cadn.net.cn

仅@PostAuthorize配置
@Configuration
@EnableMethodSecurity(prePostEnabled = false)
class MethodSecurityConfig {
	@Bean
	@Role(BeanDefinition.ROLE_INFRASTRUCTURE)
	Advisor postAuthorize() {
		return AuthorizationManagerAfterMethodInterceptor.postAuthorize();
	}
}
@Configuration
@EnableMethodSecurity(prePostEnabled = false)
class MethodSecurityConfig {
	@Bean
	@Role(BeanDefinition.ROLE_INFRASTRUCTURE)
	fun postAuthorize() : Advisor {
		return AuthorizationManagerAfterMethodInterceptor.postAuthorize()
	}
}
<sec:method-security pre-post-enabled="false"/>

<aop:config/>

<bean id="postAuthorize"
	class="org.springframework.security.authorization.method.AuthorizationManagerBeforeMethodInterceptor"
	factory-method="postAuthorize"/>

上面的代码段通过首先禁用 Method Security 的预配置,然后发布@PostAuthorize拦截 器本身。spring-doc.cadn.net.cn

授权<intercept-methods>

虽然对于方法安全性来说,首选使用 Spring Security 基于 Comments 的支持,但您也可以使用 XML 来声明 bean 授权规则。spring-doc.cadn.net.cn

如果您需要在 XML 配置中声明它,您可以使用<intercept-methods>这样:spring-doc.cadn.net.cn

<bean class="org.mycompany.MyController">
    <intercept-methods>
        <protect method="get*" access="hasAuthority('read')"/>
        <protect method="*" access="hasAuthority('write')"/>
    </intercept-methods>
</bean>
这仅支持按前缀或名称匹配方法。 如果您的需求比这更复杂,请改用注释支持

以编程方式授权方法

如您所见,有几种方法可以使用方法安全 SpEL 表达式指定重要的授权规则。spring-doc.cadn.net.cn

有多种方法可以让你的逻辑基于 Java 而不是基于 SpEL。 这提供了对整个 Java 语言的访问,以提高可测试性和流控制。spring-doc.cadn.net.cn

在 SpEL 中使用自定义 Bean

以编程方式授权方法的第一种方法是两步过程。spring-doc.cadn.net.cn

首先,声明一个 bean,该 bean 具有一个方法,该方法采用MethodSecurityExpressionOperations实例如下所示:spring-doc.cadn.net.cn

@Component("authz")
public class AuthorizationLogic {
    public boolean decide(MethodSecurityExpressionOperations operations) {
        // ... authorization logic
    }
}
@Component("authz")
open class AuthorizationLogic {
    fun decide(val operations: MethodSecurityExpressionOperations): boolean {
        // ... authorization logic
    }
}

然后,通过以下方式在注释中引用该 bean:spring-doc.cadn.net.cn

@Controller
public class MyController {
    @PreAuthorize("@authz.decide(#root)")
    @GetMapping("/endpoint")
    public String endpoint() {
        // ...
    }
}
@Controller
open class MyController {
    @PreAuthorize("@authz.decide(#root)")
    @GetMapping("/endpoint")
    fun String endpoint() {
        // ...
    }
}

Spring Security 将为每个方法调用在该 bean 上调用给定的方法。spring-doc.cadn.net.cn

这样做的好处是,您的所有授权逻辑都在一个单独的类中,可以独立地进行单元测试和验证正确性。 它还可以访问完整的 Java 语言。spring-doc.cadn.net.cn

使用自定义授权管理器

以编程方式授权方法的第二种方法是创建自定义AuthorizationManager.spring-doc.cadn.net.cn

首先,声明一个授权管理器实例,可能像这样:spring-doc.cadn.net.cn

@Component
public class MyAuthorizationManager implements AuthorizationManager<MethodInvocation>, AuthorizationManager<MethodInvocationResult> {
    @Override
    public AuthorizationDecision check(Supplier<Authentication> authentication, MethodInvocation invocation) {
        // ... authorization logic
    }

    @Override
    public AuthorizationDecision check(Supplier<Authentication> authentication, MethodInvocationResult invocation) {
        // ... authorization logic
    }
}
@Component
class MyAuthorizationManager : AuthorizationManager<MethodInvocation>, AuthorizationManager<MethodInvocationResult> {
    override fun check(authentication: Supplier<Authentication>, invocation: MethodInvocation): AuthorizationDecision {
        // ... authorization logic
    }

    override fun check(authentication: Supplier<Authentication>, invocation: MethodInvocationResult): AuthorizationDecision {
        // ... authorization logic
    }
}

然后,发布方法拦截器,并发布与所需时间相对应的切入点AuthorizationManager运行。 例如,您可以将@PreAuthorize@PostAuthorize工作方式如下:spring-doc.cadn.net.cn

仅@PreAuthorize和@PostAuthorize配置
@Configuration
@EnableMethodSecurity(prePostEnabled = false)
class MethodSecurityConfig {
    @Bean
	@Role(BeanDefinition.ROLE_INFRASTRUCTURE)
	Advisor preAuthorize(MyAuthorizationManager manager) {
		return AuthorizationManagerBeforeMethodInterceptor.preAuthorize(manager);
	}

	@Bean
	@Role(BeanDefinition.ROLE_INFRASTRUCTURE)
	Advisor postAuthorize(MyAuthorizationManager manager) {
		return AuthorizationManagerAfterMethodInterceptor.postAuthorize(manager);
	}
}
@Configuration
@EnableMethodSecurity(prePostEnabled = false)
class MethodSecurityConfig {
   	@Bean
	@Role(BeanDefinition.ROLE_INFRASTRUCTURE)
	fun preAuthorize(val manager: MyAuthorizationManager) : Advisor {
		return AuthorizationManagerBeforeMethodInterceptor.preAuthorize(manager)
	}

	@Bean
	@Role(BeanDefinition.ROLE_INFRASTRUCTURE)
	fun postAuthorize(val manager: MyAuthorizationManager) : Advisor {
		return AuthorizationManagerAfterMethodInterceptor.postAuthorize(manager)
	}
}
<sec:method-security pre-post-enabled="false"/>

<aop:config/>

<bean id="preAuthorize"
	class="org.springframework.security.authorization.method.AuthorizationManagerBeforeMethodInterceptor"
	factory-method="preAuthorize">
    <constructor-arg ref="myAuthorizationManager"/>
</bean>

<bean id="postAuthorize"
	class="org.springframework.security.authorization.method.AuthorizationManagerAfterMethodInterceptor"
	factory-method="postAuthorize">
    <constructor-arg ref="myAuthorizationManager"/>
</bean>

您可以使用AuthorizationInterceptorsOrder.spring-doc.cadn.net.cn

自定义表达式处理

或者,第三,您可以自定义每个 SpEL 表达式的处理方式。 为此,您可以公开自定义MethodSecurityExpressionHandler这样:spring-doc.cadn.net.cn

自定义 MethodSecurityExpressionHandler
@Bean
static MethodSecurityExpressionHandler methodSecurityExpressionHandler(RoleHierarchy roleHierarchy) {
	DefaultMethodSecurityExpressionHandler handler = new DefaultMethodSecurityExpressionHandler();
	handler.setRoleHierarchy(roleHierarchy);
	return handler;
}
companion object {
	@Bean
	fun methodSecurityExpressionHandler(val roleHierarchy: RoleHierarchy) : MethodSecurityExpressionHandler {
		val handler = DefaultMethodSecurityExpressionHandler()
		handler.setRoleHierarchy(roleHierarchy)
		return handler
	}
}
<sec:method-security>
	<sec:expression-handler ref="myExpressionHandler"/>
</sec:method-security>

<bean id="myExpressionHandler"
		class="org.springframework.security.messaging.access.expression.DefaultMessageSecurityExpressionHandler">
	<property name="roleHierarchy" ref="roleHierarchy"/>
</bean>

我们揭露MethodSecurityExpressionHandler使用static方法来确保 Spring 在初始化 Spring Security 的方法之前发布它安全性@Configurationspring-doc.cadn.net.cn

您还可以亚纲DefaultMessageSecurityExpressionHandler以添加超出默认值的自定义授权表达式。spring-doc.cadn.net.cn

使用 AspectJ 进行授权

使用自定义切入进行匹配方法

基于 Spring AOP 构建,您可以声明与 Comments 无关的模式,类似于请求级授权。 这具有集中方法级授权规则的潜在优势。spring-doc.cadn.net.cn

例如,您可以使用发布自己的Advisor或使用<protect-pointcut>将 AOP 表达式与服务层的授权规则进行匹配,如下所示:spring-doc.cadn.net.cn

import static org.springframework.security.authorization.AuthorityAuthorizationManager.hasRole

@Bean
@Role(BeanDefinition.ROLE_INFRASTRUCTURE)
static Advisor protectServicePointcut() {
    AspectJExpressionPointcut pattern = new AspectJExpressionPointcut()
    pattern.setExpression("execution(* com.mycompany.*Service.*(..))")
    return new AuthorizationManagerBeforeMethodInterceptor(pattern, hasRole("USER"))
}
import static org.springframework.security.authorization.AuthorityAuthorizationManager.hasRole

companion object {
    @Bean
    @Role(BeanDefinition.ROLE_INFRASTRUCTURE)
    fun protectServicePointcut(): Advisor {
        val pattern = AspectJExpressionPointcut()
        pattern.setExpression("execution(* com.mycompany.*Service.*(..))")
        return new AuthorizationManagerBeforeMethodInterceptor(pattern, hasRole("USER"))
    }
}
<sec:method-security>
    <protect-pointcut expression="execution(* com.mycompany.*Service.*(..))" access="hasRole('USER')"/>
</sec:method-security>

与 AspectJ 字节编织集成

有时可以通过使用 AspectJ 将 Spring Security 建议编织到 bean 的字节码中来提高性能。spring-doc.cadn.net.cn

设置 AspectJ 后,您可以非常简单地在@EnableMethodSecurity注释或<method-security>元素:spring-doc.cadn.net.cn

@EnableMethodSecurity(mode=AdviceMode.ASPECTJ)
@EnableMethodSecurity(mode=AdviceMode.ASPECTJ)
<sec:method-security mode="aspectj"/>

结果将是 Spring Security 将发布其顾问作为 AspectJ 建议,以便可以相应地融入其中。spring-doc.cadn.net.cn

指定顺序

如前所述,每个注解都有一个 Spring AOP 方法拦截器,并且每个注解在 Spring AOP 顾问链中都有一个位置。spring-doc.cadn.net.cn

即,@PreFilter方法拦截器的阶数为 100,@PreAuthorize的为 200,依此类推。spring-doc.cadn.net.cn

值得注意的是,还有其他基于 AOP 的注释,例如@EnableTransactionManagement的顺序为Integer.MAX_VALUE. 换句话说,默认情况下,它们位于顾问链的末端。spring-doc.cadn.net.cn

有时,在 Spring Security 之前执行其他建议可能很有价值。 例如,如果您有一个用@Transactional@PostAuthorize时,您可能希望交易在以下情况下仍处于打开状态@PostAuthorize运行,以便AccessDeniedException将导致回滚。spring-doc.cadn.net.cn

获取@EnableTransactionManagement要在方法授权通知运行之前打开事务,您可以将@EnableTransactionManagement的顺序是这样的:spring-doc.cadn.net.cn

@EnableTransactionManagement(order = 0)
@EnableTransactionManagement(order = 0)
<tx:annotation-driven ref="txManager" order="0"/>

由于最早的方法拦截器(@PreFilter)设置为100的阶数,设置为零意味着事务通知将在所有Spring Security通知之前运行。spring-doc.cadn.net.cn

使用 SpEL 表达授权

您已经看到了几个使用 SpEL 的示例,所以现在让我们更深入地介绍一下 API。spring-doc.cadn.net.cn

Spring Security 将其所有授权字段和方法封装在一组根对象中。 最通用的根对象称为SecurityExpressionRoot它构成了MethodSecurityExpressionRoot. Spring Security 将此根对象提供给MethodSecurityEvaluationContext准备计算授权表达式时。spring-doc.cadn.net.cn

使用授权表达式字段和方法

首先,它为您的 SpEL 表达式提供了一组增强的授权字段和方法。 以下是最常见方法的快速概述:spring-doc.cadn.net.cn

以下是最常见的字段的简要介绍:spring-doc.cadn.net.cn

现在已经了解了模式、规则以及如何将它们配对在一起,您应该能够理解这个更复杂的示例中发生了什么:spring-doc.cadn.net.cn

授权请求
@Component
public class MyService {
    @PreAuthorize("denyAll") (1)
    MyResource myDeprecatedMethod(...);

    @PreAuthorize("hasRole('ADMIN')") (2)
    MyResource writeResource(...)

    @PreAuthorize("hasAuthority('db') and hasRole('ADMIN')") (3)
    MyResource deleteResource(...)

    @PreAuthorize("principal.claims['aud'] == 'my-audience'") (4)
    MyResource readResource(...);

	@PreAuthorize("@authz.check(authentication, #root)")
    MyResource shareResource(...);
}
@Component
open class MyService {
    @PreAuthorize("denyAll") (1)
    fun myDeprecatedMethod(...): MyResource

    @PreAuthorize("hasRole('ADMIN')") (2)
    fun writeResource(...): MyResource

    @PreAuthorize("hasAuthority('db') and hasRole('ADMIN')") (3)
    fun deleteResource(...): MyResource

    @PreAuthorize("principal.claims['aud'] == 'my-audience'") (4)
    fun readResource(...): MyResource

    @PreAuthorize("@authz.check(#root)")
    fun shareResource(...): MyResource
}
<sec:method-security>
    <protect-pointcut expression="execution(* com.mycompany.*Service.myDeprecatedMethod(..))" access="denyAll"/> (1)
    <protect-pointcut expression="execution(* com.mycompany.*Service.writeResource(..))" access="hasRole('ADMIN')"/> (2)
    <protect-pointcut expression="execution(* com.mycompany.*Service.deleteResource(..))" access="hasAuthority('db') and hasRole('ADMIN')"/> (3)
    <protect-pointcut expression="execution(* com.mycompany.*Service.readResource(..))" access="principal.claims['aud'] == 'my-audience'"/> (4)
    <protect-pointcut expression="execution(* com.mycompany.*Service.shareResource(..))" access="@authz.check(#root)"/> (5)
</sec:method-security>
1 任何人都不得出于任何原因调用此方法
2 此方法只能由Authentication授予ROLE_ADMIN
3 此方法只能由Authentication授予dbROLE_ADMIN当局
4 此方法只能由Princpals 与aud声明等于“my-audience”
5 只有当 beanauthzcheck方法返回true

使用方法参数

此外,Spring Security 提供了一种发现方法参数的机制,因此也可以在 SpEL 表达式中访问它们。spring-doc.cadn.net.cn

作为完整的参考,Spring Security 使用DefaultSecurityParameterNameDiscoverer以发现参数名称。 默认情况下,将为方法尝试以下选项。spring-doc.cadn.net.cn

  1. 如果 Spring Security 的@P注释存在于方法的单个参数上,则使用该值。 以下示例使用@P注解:spring-doc.cadn.net.cn

    import org.springframework.security.access.method.P;
    
    ...
    
    @PreAuthorize("hasPermission(#c, 'write')")
    public void updateContact(@P("c") Contact contact);
    import org.springframework.security.access.method.P
    
    ...
    
    @PreAuthorize("hasPermission(#c, 'write')")
    fun doSomething(@P("c") contact: Contact?)

    此表达式的目的是要求当前Authenticationwrite专门为此提供的许可Contact实例。spring-doc.cadn.net.cn

    在幕后,这是通过使用AnnotationParameterNameDiscoverer,您可以自定义它以支持任何指定注释的 value 属性。spring-doc.cadn.net.cn

    • 如果 Spring Data 的 @Param注释存在于该方法的至少一个参数上,则使用该值。 以下示例使用@Param注解:spring-doc.cadn.net.cn

      import org.springframework.data.repository.query.Param;
      
      ...
      
      @PreAuthorize("#n == authentication.name")
      Contact findContactByName(@Param("n") String name);
      import org.springframework.data.repository.query.Param
      
      ...
      
      @PreAuthorize("#n == authentication.name")
      fun findContactByName(@Param("n") name: String?): Contact?

      此表达式的目的是要求name等于Authentication#getName以授权调用。spring-doc.cadn.net.cn

      在幕后,这是通过使用AnnotationParameterNameDiscoverer,您可以自定义它以支持任何指定注释的 value 属性。spring-doc.cadn.net.cn

    • 如果使用-parameters参数,则使用标准 JDK 反射 API 来发现参数名称。 这适用于类和接口。spring-doc.cadn.net.cn

    • 最后,如果使用调试符号编译代码,则使用调试符号发现参数名称。 这不适用于接口,因为它们没有有关参数名称的调试信息。 对于接口,注释或-parameters必须使用方法。spring-doc.cadn.net.cn

@EnableGlobalMethodSecurity

如果您正在使用@EnableGlobalMethodSecurity,您应该迁移到@EnableMethodSecurity.spring-doc.cadn.net.cn

全局方法安全性替换为方法安全性

@EnableGlobalMethodSecurity<global-method-security>被弃用,取而代之的是@EnableMethodSecurity<method-security>分别。 新的 Comments 和 XML 元素默认激活 Spring 的 pre-post Comments,并使用AuthorizationManager内部。spring-doc.cadn.net.cn

这意味着以下两个列表在功能上是等效的:spring-doc.cadn.net.cn

@EnableGlobalMethodSecurity(prePostEnabled = true)
@EnableGlobalMethodSecurity(prePostEnabled = true)
<global-method-security pre-post-enabled="true"/>
@EnableMethodSecurity
@EnableMethodSecurity
<method-security/>

对于不使用前置注释的应用程序,请确保将其关闭以避免激活不需要的行为。spring-doc.cadn.net.cn

例如,列表如下:spring-doc.cadn.net.cn

@EnableGlobalMethodSecurity(securedEnabled = true)
@EnableGlobalMethodSecurity(securedEnabled = true)
<global-method-security secured-enabled="true"/>

应更改为:spring-doc.cadn.net.cn

@EnableMethodSecurity(securedEnabled = true, prePostEnabled = false)
@EnableMethodSecurity(securedEnabled = true, prePostEnabled = false)
<method-security secured-enabled="true" pre-post-enabled="false"/>

使用自定义@Bean而不是子类化DefaultMethodSecurityExpressionHandler

作为性能优化,引入了一种新方法MethodSecurityExpressionHandler这需要一个Supplier<Authentication>而不是Authentication.spring-doc.cadn.net.cn

这允许 Spring Security 延迟查找Authentication,并在您使用@EnableMethodSecurity而不是@EnableGlobalMethodSecurity.spring-doc.cadn.net.cn

但是,假设您的代码扩展了DefaultMethodSecurityExpressionHandler和覆盖createSecurityExpressionRoot(Authentication, MethodInvocation)返回自定义SecurityExpressionRoot实例。 这将不再有效,因为安排@EnableMethodSecurity设置通话createEvaluationContext(Supplier<Authentication>, MethodInvocation)相反。spring-doc.cadn.net.cn

令人高兴的是,这种程度的定制通常是不必要的。 相反,您可以使用所需的授权方法创建自定义 Bean。spring-doc.cadn.net.cn

例如,假设您想要自定义评估@PostAuthorize("hasAuthority('ADMIN')"). 您可以创建自定义@Bean像这个:spring-doc.cadn.net.cn

class MyAuthorizer {
	boolean isAdmin(MethodSecurityExpressionOperations root) {
		boolean decision = root.hasAuthority("ADMIN");
		// custom work ...
        return decision;
	}
}
class MyAuthorizer {
	fun isAdmin(val root: MethodSecurityExpressionOperations): boolean {
		val decision = root.hasAuthority("ADMIN");
		// custom work ...
        return decision;
	}
}

然后在注解中引用它,如下所示:spring-doc.cadn.net.cn

@PreAuthorize("@authz.isAdmin(#root)")
@PreAuthorize("@authz.isAdmin(#root)")

我还是更愿意子类DefaultMethodSecurityExpressionHandler

如果必须继续子类化DefaultMethodSecurityExpressionHandler,您仍然可以这样做。 相反,请覆盖createEvaluationContext(Supplier<Authentication>, MethodInvocation)方法如下:spring-doc.cadn.net.cn

@Component
class MyExpressionHandler extends DefaultMethodSecurityExpressionHandler {
    @Override
    public EvaluationContext createEvaluationContext(Supplier<Authentication> authentication, MethodInvocation mi) {
		StandardEvaluationContext context = (StandardEvaluationContext) super.createEvaluationContext(authentication, mi);
        MethodSecurityExpressionOperations delegate = (MethodSecurityExpressionOperations) context.getRootObject().getValue();
        MySecurityExpressionRoot root = new MySecurityExpressionRoot(delegate);
        context.setRootObject(root);
        return context;
    }
}
@Component
class MyExpressionHandler: DefaultMethodSecurityExpressionHandler {
    override fun createEvaluationContext(val authentication: Supplier<Authentication>,
        val mi: MethodInvocation): EvaluationContext {
		val context = super.createEvaluationContext(authentication, mi) as StandardEvaluationContext
        val delegate = context.getRootObject().getValue() as MethodSecurityExpressionOperations
        val root = MySecurityExpressionRoot(delegate)
        context.setRootObject(root)
        return context
    }
}

延伸阅读

现在,您已经保护了应用程序的请求,如果您尚未保护其请求,请保护其请求。 您还可以进一步阅读有关测试应用程序或将 Spring Security 与应用程序的其他方面(如数据层跟踪和指标)集成的信息。spring-doc.cadn.net.cn