方法安全

除了在请求级别建模授权之外,Spring Security 还支持在方法级别建模。

您可以通过用@EnableMethodSecurity注解任何@Configuration类或向任何XML配置文件添加<method-security>来在您的应用程序中激活它,如下所示

  • Java

  • Kotlin

  • Xml

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

然后,您可以立即使用@PreAuthorize@PostAuthorize@PreFilter@PostFilter注解任何Spring管理的类或方法,以授权方法调用,包括输入参数和返回值。

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

方法安全还支持许多其他用例,包括AspectJ 支持自定义注解和几个配置点。考虑学习以下用例:

方法安全的工作原理

Spring Security 的方法授权支持对于以下情况非常有用:

  • 提取细粒度的授权逻辑;例如,当方法参数和返回值有助于授权决策时。

  • 在服务层强制执行安全策略

  • 在风格上更倾向于基于注解的配置而不是基于HttpSecurity的配置

并且由于方法安全是使用Spring AOP构建的,因此您可以访问其所有表达能力,以根据需要覆盖 Spring Security 的默认值。

如前所述,您可以通过向@Configuration类添加@EnableMethodSecurity或在 Spring XML 配置文件中添加<sec:method-security/>来开始。

此注解和 XML 元素分别取代了@EnableGlobalMethodSecurity<sec:global-method-security/>。它们提供了以下改进:

  1. 使用简化的AuthorizationManager API,而不是元数据源、配置属性、决策管理器和投票器。这简化了重用和自定义。

  2. 更倾向于直接基于 Bean 的配置,而不是需要扩展GlobalMethodSecurityConfiguration来定制 Bean。

  3. 使用原生 Spring AOP 构建,去除了抽象层,允许你使用 Spring AOP 的构建块进行自定义。

  4. 检查冲突的注解,以确保安全配置的明确性。

  5. 符合 JSR-250 规范。

  6. 默认启用@PreAuthorize@PostAuthorize@PreFilter@PostFilter

如果你正在使用@EnableGlobalMethodSecurity<global-method-security/>,这些现在已弃用,建议你迁移。

方法授权是方法授权前和授权后的组合。考虑一个以如下方式注解的服务 Bean:

  • Java

  • Kotlin

@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的调用可能如下所示:

methodsecurity
  1. Spring AOP 调用其针对readCustomer的代理方法。在其代理的其他顾问中,它调用一个AuthorizationManagerBeforeMethodInterceptor,该顾问匹配@PreAuthorize切点

  2. 拦截器调用PreAuthorizeAuthorizationManager#check

  3. 授权管理器使用MethodSecurityExpressionHandler来解析注解的SpEL表达式,并从包含Supplier<Authentication>MethodInvocationMethodSecurityExpressionRoot构建相应的EvaluationContext

  4. 拦截器使用此上下文来评估表达式;具体来说,它从Supplier读取Authentication,并检查其权限集合authorities中是否包含permission:read

  5. 如果评估通过,则 Spring AOP 继续调用该方法。

  6. 如果没有通过,拦截器将发布AuthorizationDeniedEvent事件并抛出一个AccessDeniedException异常,该异常将被ExceptionTranslationFilter捕获并返回 403 状态码给响应。

  7. 方法返回后,Spring AOP 调用一个AuthorizationManagerAfterMethodInterceptor,该拦截器匹配@PostAuthorize切点,其操作方式与上述相同,但使用PostAuthorizeAuthorizationManager

  8. 如果评估通过(在这种情况下,返回值属于登录用户),则处理正常继续。

  9. 如果没有通过,拦截器将发布AuthorizationDeniedEvent事件并抛出一个AccessDeniedException异常,该异常将被ExceptionTranslationFilter捕获并返回 403 状态码给响应。

如果该方法不是在 HTTP 请求的上下文中被调用的,你可能需要自己处理AccessDeniedException异常。

多个注解按顺序计算

如上所示,如果方法调用涉及多个方法安全注解,则每个注解将逐个处理。这意味着它们可以被认为是“与”在一起的。换句话说,为了授权调用,所有注解检查都需要通过授权。

不支持重复注解

也就是说,不支持在同一方法上重复相同的注解。例如,你不能在同一方法上放置两次@PreAuthorize

请改用 SpEL 的布尔支持或其对委托给单独 Bean 的支持。

每个注解都有其自己的切点

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

你可以在AuthorizationMethodPointcuts中看到这方面的细节。

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

每个注解都有其自己的专用方法拦截器。这样做的原因是为了使事情更易于组合。例如,如果需要,你可以禁用 Spring Security 的默认设置并仅发布@PostAuthorize方法拦截器

方法拦截器如下所示:

一般来说,你可以将以下列表视为 Spring Security 在添加@EnableMethodSecurity时发布的拦截器的代表。

  • Java

@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 表达式,例如:

  • Java

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

但是,你可以改为向具有ROLE_ADMIN的角色授予permission:read权限。一种方法是使用RoleHierarchy,如下所示:

  • Java

  • Kotlin

  • Xml

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

然后MethodSecurityExpressionHandler实例中设置它。这允许你使用更简单的@PreAuthorize表达式,例如:

  • Java

  • Kotlin

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

或者,在可能的情况下,在登录时将应用程序特定的授权逻辑调整为授予的权限。

比较请求级与方法级授权

何时应优先选择方法级授权而不是请求级授权?部分取决于个人喜好;但是,请考虑以下各项的优势列表,以帮助你做出决定。

请求级

方法级

授权类型

粗粒度

细粒度

配置位置

在配置类中声明

局部于方法声明

配置风格

DSL

注解

授权定义

编程的

SpEL

主要权衡似乎在于你希望授权规则位于何处。

重要的是要记住,当你使用基于注解的方法安全时,未注解的方法是不安全的。为防止这种情况,请在你的HttpSecurity实例中声明一个通用的授权规则

使用注解进行授权

Spring Security 启用方法级授权支持的主要方式是通过可以添加到方法、类和接口的注解。

使用@PreAuthorize授权方法调用

方法安全处于活动状态时,你可以使用@PreAuthorize注解注解方法,如下所示:

  • Java

  • Kotlin

@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')通过时才能调用该方法。

然后你可以测试该类以确认它正在执行授权规则,如下所示:

  • Java

  • Kotlin

@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对于声明所需的权限非常有用,但它也可以用于评估更复杂的涉及方法参数的表达式

使用@PostAuthorize授权方法结果

当方法安全处于活动状态时,你可以使用@PostAuthorize注解注解方法,如下所示:

  • Java

  • Kotlin

@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对象。

然后你可以测试该类以确认它正在执行授权规则。

  • Java

  • Kotlin

@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在防御不安全的直接对象引用方面特别有用。事实上,它可以定义为元注解,如下所示:

  • Java

  • Kotlin

@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

允许你以如下方式注解服务:

  • Java

  • Kotlin

@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
	}
}

结果是,只有当Accountowner属性与登录用户的name匹配时,上述方法才会返回该Account。否则,Spring Security 将抛出AccessDeniedException异常并返回 403 状态码。

使用@PreFilter过滤方法参数

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

当方法安全处于活动状态时,你可以使用@PreFilter注解注解方法,如下所示:

  • Java

@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表示accounts中的每个account,并用于测试每个account

然后你可以通过以下方式测试该类,以确认它正在执行授权规则:

  • Java

@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支持数组、集合、映射和流(只要流仍然打开)。

例如,上述updateAccounts声明的功能与以下另外四个相同:

  • Java

@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)

结果是,上述方法将只包含其owner属性与登录用户的name匹配的Account实例。

使用@PostFilter过滤方法结果

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

启用方法安全后,您可以使用@PostFilter 注解来注解方法,如下所示

  • Java

@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代表accounts中的每个account,并用于测试每个account

然后,您可以像这样测试类,以确认它正在强制执行授权规则

  • Java

@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 支持数组、集合、映射和流(只要流仍然打开)。

例如,上面的readAccounts声明的功能与以下另外三个相同

@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)

结果是,上述方法将返回其owner属性与登录用户的name匹配的Account实例。

内存过滤显然可能代价高昂,因此请考虑是否最好在数据层过滤数据

使用@Secured授权方法调用

@Secured是授权调用的传统选项。@PreAuthorize取代了它,建议使用它。

要使用@Secured注解,您应该首先更改方法安全声明以启用它,如下所示

  • Java

  • Kotlin

  • Xml

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

这将导致 Spring Security 发布相应的授权方法拦截器,该拦截器授权使用@Secured注解的方法、类和接口。

使用 JSR-250 注解授权方法调用

如果您想使用JSR-250注解,Spring Security 也支持。 @PreAuthorize 具有更强大的表达能力,因此建议使用它。

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

  • Java

  • Kotlin

  • Xml

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

这将导致 Spring Security 发布相应的拦截器,该拦截器授权使用@RolesAllowed@PermitAll@DenyAll注解的方法、类和接口。

在类或接口级别声明注解

在类和接口级别使用方法安全注解也是受支持的。

如果它在类级别,如下所示

  • Java

  • Kotlin

@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 { ... }
}

则所有方法都继承类级别的行为。

或者,如果它在类和方法级别都声明如下

  • Java

  • Kotlin

@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 Security 无法判断您想使用哪个。

在这种情况下,您可以通过向具体方法添加注解来解决歧义。

使用元注解

方法安全支持元注解。这意味着您可以采用任何注解,并根据您的应用程序特定用例提高可读性。

例如,您可以将@PreAuthorize("hasRole('ADMIN')")简化为@IsAdmin,如下所示

  • Java

  • Kotlin

@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

结果是,您现在可以在受保护的方法上执行以下操作

  • Java

  • Kotlin

@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
	}
}

这使得方法定义更具可读性。

元注解表达式的模板化

您还可以选择使用元注解模板,这允许更强大的注解定义。

首先,发布以下 Bean

  • Java

  • Kotlin

@Bean
static PrePostTemplateDefaults prePostTemplateDefaults() {
	return new PrePostTemplateDefaults();
}
companion object {
    @Bean
    fun prePostTemplateDefaults(): PrePostTemplateDefaults {
        return PrePostTemplateDefaults()
    }
}

现在,您可以创建比@IsAdmin更强大的内容,例如@HasRole,如下所示

  • Java

  • Kotlin

@Target({ ElementType.METHOD, ElementType.TYPE })
@Retention(RetentionPolicy.RUNTIME)
@PreAuthorize("hasRole('{value}')")
public @interface HasRole {
	String value();
}
@Target(ElementType.METHOD, ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@PreAuthorize("hasRole('{value}')")
annotation class HasRole(val value: String)

结果是,您现在可以在受保护的方法上执行以下操作

  • Java

  • Kotlin

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

请注意,这也可以与方法变量和所有注解类型一起使用,但是您需要小心正确处理引号,以便生成的 SpEL 表达式正确。

例如,考虑以下@HasAnyRole注解

  • Java

  • Kotlin

@Target({ ElementType.METHOD, ElementType.TYPE })
@Retention(RetentionPolicy.RUNTIME)
@PreAuthorize("hasAnyRole({roles})")
public @interface HasAnyRole {
	String[] roles();
}
@Target(ElementType.METHOD, ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@PreAuthorize("hasAnyRole({roles})")
annotation class HasAnyRole(val roles: Array<String>)

在这种情况下,您会注意到不应在表达式中使用引号,而应在参数值中使用引号,如下所示

  • Java

  • Kotlin

@Component
public class BankService {
	@HasAnyRole(roles = { "'USER'", "'ADMIN'" })
	public Account readAccount(Long id) {
        // ... is only returned if the `Account` belongs to the logged in user
	}
}
@Component
open class BankService {
	@HasAnyRole(roles = arrayOf("'USER'", "'ADMIN'"))
	fun readAccount(val id: Long): Account {
        // ... is only returned if the `Account` belongs to the logged in user
	}
}

这样,替换后,表达式将变为@PreAuthorize("hasAnyRole('USER', 'ADMIN')")

启用特定注解

您可以关闭@EnableMethodSecurity的预配置并替换为您自己的配置。如果您想自定义AuthorizationManagerPointcut,可以选择这样做。或者您可能只想启用特定注解,例如@PostAuthorize

您可以通过以下方式执行此操作

仅@PostAuthorize 配置
  • Java

  • Kotlin

  • Xml

@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"/>

上面的代码片段通过首先禁用方法安全的预配置,然后发布@PostAuthorize拦截器本身来实现这一点。

使用<intercept-methods>进行授权

虽然建议使用方法安全功能的基于注解的支持,但您也可以使用 XML 来声明 Bean 授权规则。

如果需要在 XML 配置中声明它,可以使用<intercept-methods>,如下所示

  • Xml

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

以编程方式授权方法

正如您已经看到的,您可以使用方法安全 SpEL 表达式指定非平凡的授权规则。

您可以通过多种方式允许您的逻辑基于 Java 而不是基于 SpEL。这使您可以访问整个 Java 语言以提高可测试性和流程控制。

在 SpEL 中使用自定义 Bean

以编程方式授权方法的第一种方法是一个两步过程。

首先,声明一个具有一个方法的 Bean,该方法接受一个MethodSecurityExpressionOperations实例,如下所示

  • Java

  • Kotlin

@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

  • Java

  • Kotlin

@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 上的给定方法。

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

除了返回Boolean之外,您还可以返回null以指示代码避免做出决定。

如果您想包含有关决策性质的更多信息,您可以改为返回自定义AuthorizationDecision,如下所示

  • Java

  • Kotlin

@Component("authz")
public class AuthorizationLogic {
    public AuthorizationDecision decide(MethodSecurityExpressionOperations operations) {
        // ... authorization logic
        return new MyAuthorizationDecision(false, details);
    }
}
@Component("authz")
open class AuthorizationLogic {
    fun decide(val operations: MethodSecurityExpressionOperations): AuthorizationDecision {
        // ... authorization logic
        return MyAuthorizationDecision(false, details)
    }
}

或者抛出一个自定义AuthorizationDeniedException实例。但是,请注意,返回对象是更好的选择,因为这不会产生生成堆栈跟踪的开销。

然后,当您自定义授权结果的处理方式时,可以访问自定义详细信息。

使用自定义授权管理器

以编程方式授权方法的第二种方法是创建一个自定义AuthorizationManager

首先,声明一个授权管理器实例,也许是这样的

  • Java

  • Kotlin

@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的工作方式,如下所示

仅@PreAuthorize 和 @PostAuthorize 配置
  • Java

  • Kotlin

  • Xml

@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 Security 方法拦截器之间。

自定义表达式处理

或者,第三,您可以自定义如何处理每个 SpEL 表达式。为此,您可以公开自定义MethodSecurityExpressionHandler,如下所示

自定义MethodSecurityExpressionHandler
  • Java

  • Kotlin

  • Xml

@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>

我们使用static方法公开MethodSecurityExpressionHandler,以确保 Spring 在初始化 Spring Security 的方法安全@Configuration类之前发布它

您还可以继承DefaultMessageSecurityExpressionHandler以添加您自己的自定义授权表达式,超越默认值。

使用 AspectJ 进行授权

使用自定义切入点匹配方法

基于 Spring AOP 构建,您可以声明与注解无关的模式,类似于请求级授权。这具有集中方法级授权规则的潜在优势。

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

  • Java

  • Kotlin

  • Xml

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 的字节码来增强性能。

设置 AspectJ 后,您可以非常简单地在@EnableMethodSecurity注解或<method-security>元素中声明您正在使用 AspectJ

  • Java

  • Kotlin

  • Xml

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

结果是 Spring Security 将其顾问发布为 AspectJ 建议,以便可以相应地织入它们。

指定顺序

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

即,@PreFilter方法拦截器的顺序为 100,@PreAuthorize的顺序为 200,依此类推。

需要注意这一点的原因是,还有其他基于 AOP 的注解,例如@EnableTransactionManagement,其顺序为Integer.MAX_VALUE。换句话说,默认情况下,它们位于顾问链的末尾。

有时,让其他建议在 Spring Security 之前执行可能很有价值。例如,如果您有一个使用@Transactional@PostAuthorize注解的方法,您可能希望在@PostAuthorize运行时事务仍然打开,以便AccessDeniedException将导致回滚。

要使@EnableTransactionManagement在方法授权建议运行之前打开事务,您可以像这样设置@EnableTransactionManagement的顺序

  • Java

  • Kotlin

  • Xml

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

由于最早的方法拦截器 (@PreFilter) 的顺序设置为 100,因此设置为零意味着事务建议将在所有 Spring Security 建议之前运行。

使用 SpEL 表达授权

您已经看到了几个使用 SpEL 的示例,现在让我们更深入地了解一下 API。

Spring Security 将其所有授权字段和方法封装在一组根对象中。最通用的根对象称为SecurityExpressionRoot,它是MethodSecurityExpressionRoot的基础。Spring Security 在准备评估授权表达式时,会将此根对象提供给MethodSecurityEvaluationContext

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

首先,这为您的 SpEL 表达式提供了一组增强的授权字段和方法。以下是几种最常用方法的快速概述

  • permitAll - 该方法不需要任何授权即可调用;请注意,在这种情况下,Authentication 永远不会从会话中检索

  • denyAll - 在任何情况下都不允许使用该方法;请注意,在这种情况下,Authentication 永远不会从会话中检索

  • hasAuthority - 该方法要求Authentication 具有与给定值匹配的GrantedAuthority

  • hasRole - hasAuthority 的快捷方式,它会在前面添加ROLE_或配置为默认前缀的任何内容

  • hasAnyAuthority - 该方法要求Authentication 具有与任何给定值匹配的GrantedAuthority

  • hasAnyRole - hasAnyAuthority 的快捷方式,它会在前面添加ROLE_或配置为默认前缀的任何内容

  • hasPermission - 用于进行对象级授权的PermissionEvaluator 实例的钩子

以下是几种最常见的字段的简要介绍

  • authentication - 与此方法调用关联的Authentication 实例

  • principal - 与此方法调用关联的Authentication#getPrincipal

现在您已经了解了模式、规则以及它们如何组合在一起,您应该能够理解这个更复杂的示例中发生了什么

授权请求
  • Java

  • Kotlin

  • Xml

@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 此方法只能由被授予ROLE_ADMIN 权限的Authentication 调用
3 此方法只能由被授予dbROLE_ADMIN 权限的Authentication 调用
4 只有Principalaud声明等于“my-audience”时才能调用此方法
5 只有当 bean authzcheck 方法返回true 时,才能调用此方法

您可以使用像上面authz这样的 bean 来添加程序化授权

使用方法参数

此外,Spring Security 提供了一种发现方法参数的机制,以便也可以在 SpEL 表达式中访问它们。

作为完整参考,Spring Security 使用DefaultSecurityParameterNameDiscoverer 来发现参数名称。默认情况下,会针对方法尝试以下选项。

  1. 如果 Spring Security 的@P 注解存在于方法的单个参数上,则使用该值。以下示例使用了@P 注解

    • Java

    • Kotlin

    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?)

    此表达式的目的是要求当前Authentication 对此Contact 实例具有write 权限。

    在幕后,这是通过使用AnnotationParameterNameDiscoverer 实现的,您可以自定义它以支持任何指定注解的值属性。

    • 如果Spring Data 的@Param 注解存在于方法的至少一个参数上,则使用该值。以下示例使用了@Param 注解

      • Java

      • Kotlin

      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,才能授权调用。

      在幕后,这是通过使用AnnotationParameterNameDiscoverer 实现的,您可以自定义它以支持任何指定注解的值属性。

    • 如果使用-parameters 参数编译代码,则使用标准 JDK 反射 API 来发现参数名称。这适用于类和接口。

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

授权任意对象

Spring Security 还支持包装任何在其方法安全注解上进行注解的对象。

实现此目的最简单的方法是用@AuthorizeReturnObject 注解标记任何返回要授权的对象的方法。

例如,考虑以下User

  • Java

  • Kotlin

public class User {
	private String name;
	private String email;

	public User(String name, String email) {
		this.name = name;
		this.email = email;
	}

	public String getName() {
		return this.name;
	}

    @PreAuthorize("hasAuthority('user:read')")
    public String getEmail() {
		return this.email;
    }
}
class User (val name:String, @get:PreAuthorize("hasAuthority('user:read')") val email:String)

给定这样的接口

  • Java

  • Kotlin

public class UserRepository {
	@AuthorizeReturnObject
    Optional<User> findByName(String name) {
		// ...
    }
}
class UserRepository {
    @AuthorizeReturnObject
    fun findByName(name:String?): Optional<User?>? {
        // ...
    }
}

那么从findById 返回的任何User 都将像其他受 Spring Security 保护的组件一样受到保护

  • Java

  • Kotlin

@Autowired
UserRepository users;

@Test
void getEmailWhenProxiedThenAuthorizes() {
    Optional<User> securedUser = users.findByName("name");
    assertThatExceptionOfType(AccessDeniedException.class).isThrownBy(() -> securedUser.get().getEmail());
}
import jdk.incubator.vector.VectorOperators.Test
import java.nio.file.AccessDeniedException
import java.util.*

@Autowired
var users:UserRepository? = null

@Test
fun getEmailWhenProxiedThenAuthorizes() {
    val securedUser: Optional<User> = users.findByName("name")
    assertThatExceptionOfType(AccessDeniedException::class.java).isThrownBy{securedUser.get().getEmail()}
}

在类级别使用@AuthorizeReturnObject

@AuthorizeReturnObject 可以放在类级别。但是请注意,这意味着 Spring Security 将尝试代理任何返回的对象,包括StringInteger 和其他类型。这通常不是您想要做的。

如果要在其方法返回值类型(如intStringDouble 或这些类型的集合)的类或接口上使用@AuthorizeReturnObject,则还应发布相应的AuthorizationAdvisorProxyFactory.TargetVisitor,如下所示

  • Java

  • Kotlin

@Bean
static Customizer<AuthorizationAdvisorProxyFactory> skipValueTypes() {
    return (factory) -> factory.setTargetVisitor(TargetVisitor.defaultsSkipValueTypes());
}
@Bean
open fun skipValueTypes() = Customizer<AuthorizationAdvisorProxyFactory> {
    it.setTargetVisitor(TargetVisitor.defaultsSkipValueTypes())
}

您可以设置自己的AuthorizationAdvisorProxyFactory.TargetVisitor 来自定义任何类型的代理。

以编程方式代理

您也可以以编程方式代理给定对象。

为此,您可以自动装配提供的AuthorizationProxyFactory 实例,该实例基于您已配置的哪些方法安全拦截器。如果您使用的是@EnableMethodSecurity,则这意味着默认情况下它将具有@PreAuthorize@PostAuthorize@PreFilter@PostFilter 的拦截器。

您可以通过以下方式代理 user 实例

  • Java

  • Kotlin

@Autowired
AuthorizationProxyFactory proxyFactory;

@Test
void getEmailWhenProxiedThenAuthorizes() {
    User user = new User("name", "email");
    assertThat(user.getEmail()).isNotNull();
    User securedUser = proxyFactory.proxy(user);
    assertThatExceptionOfType(AccessDeniedException.class).isThrownBy(securedUser::getEmail);
}
@Autowired
var proxyFactory:AuthorizationProxyFactory? = null

@Test
fun getEmailWhenProxiedThenAuthorizes() {
    val user: User = User("name", "email")
    assertThat(user.getEmail()).isNotNull()
    val securedUser: User = proxyFactory.proxy(user)
    assertThatExceptionOfType(AccessDeniedException::class.java).isThrownBy(securedUser::getEmail)
}

手动构建

如果您需要与 Spring Security 默认值不同的内容,也可以定义自己的实例。

例如,如果您这样定义一个AuthorizationProxyFactory 实例

  • Java

  • Kotlin

import org.springframework.security.authorization.method.AuthorizationAdvisorProxyFactory.TargetVisitor;
import static org.springframework.security.authorization.method.AuthorizationManagerBeforeMethodInterceptor.preAuthorize;
// ...

AuthorizationProxyFactory proxyFactory = AuthorizationAdvisorProxyFactory.withDefaults();
// and if needing to skip value types
proxyFactory.setTargetVisitor(TargetVisitor.defaultsSkipValueTypes());
import org.springframework.security.authorization.method.AuthorizationAdvisorProxyFactory.TargetVisitor;
import org.springframework.security.authorization.method.AuthorizationManagerBeforeMethodInterceptor.preAuthorize

// ...

val proxyFactory: AuthorizationProxyFactory = AuthorizationProxyFactory(preAuthorize())
// and if needing to skip value types
proxyFactory.setTargetVisitor(TargetVisitor.defaultsSkipValueTypes())

然后您可以包装任何User 实例,如下所示

  • Java

  • Kotlin

@Test
void getEmailWhenProxiedThenAuthorizes() {
	AuthorizationProxyFactory proxyFactory = AuthorizationAdvisorProxyFactory.withDefaults();
    User user = new User("name", "email");
    assertThat(user.getEmail()).isNotNull();
    User securedUser = proxyFactory.proxy(user);
    assertThatExceptionOfType(AccessDeniedException.class).isThrownBy(securedUser::getEmail);
}
@Test
fun getEmailWhenProxiedThenAuthorizes() {
    val proxyFactory: AuthorizationProxyFactory = AuthorizationAdvisorProxyFactory.withDefaults()
    val user: User = User("name", "email")
    assertThat(user.getEmail()).isNotNull()
    val securedUser: User = proxyFactory.proxy(user)
    assertThatExceptionOfType(AccessDeniedException::class.java).isThrownBy(securedUser::getEmail)
}

此功能尚不支持 Spring AOT

代理集合

AuthorizationProxyFactory 通过代理元素类型支持 Java 集合、流、数组、可选和迭代器,并通过代理值类型支持映射。

这意味着当代理对象的List 时,以下方法也适用

  • Java

@Test
void getEmailWhenProxiedThenAuthorizes() {
	AuthorizationProxyFactory proxyFactory = AuthorizationAdvisorProxyFactory.withDefaults();
    List<User> users = List.of(ada, albert, marie);
    List<User> securedUsers = proxyFactory.proxy(users);
	securedUsers.forEach((securedUser) ->
        assertThatExceptionOfType(AccessDeniedException.class).isThrownBy(securedUser::getEmail));
}

代理类

在有限的情况下,代理Class 本身可能很有价值,AuthorizationProxyFactory 也支持此功能。这大致相当于在 Spring Framework 支持创建代理时调用ProxyFactory#getProxyClass

在一个方便的地方是,当您需要提前构建代理类时,例如使用 Spring AOT。

对所有方法安全注解的支持

AuthorizationProxyFactory 支持在您的应用程序中启用的任何方法安全注解。它基于作为 bean 发布的任何AuthorizationAdvisor 类。

由于@EnableMethodSecurity 默认发布@PreAuthorize@PostAuthorize@PreFilter@PostFilter 顾问,因此您通常无需执行任何操作即可激活此功能。

使用returnObjectfilterObject 的 SpEL 表达式位于代理的后面,因此可以完全访问该对象。

自定义建议

如果您也有要应用的安全建议,您可以像这样发布您自己的AuthorizationAdvisor

  • Java

  • Kotlin

@EnableMethodSecurity
class SecurityConfig {
    @Bean
    static AuthorizationAdvisor myAuthorizationAdvisor() {
        return new AuthorizationAdvisor();
    }
}
@EnableMethodSecurity
internal class SecurityConfig {
    @Bean
    fun myAuthorizationAdvisor(): AuthorizationAdvisor {
        return AuthorizationAdvisor()
    }
]

Spring Security 会将该顾问添加到AuthorizationProxyFactory 在代理对象时添加的建议集中。

与 Jackson 协同工作

此功能的一个强大用途是从控制器返回受保护的值,如下所示

  • Java

  • Kotlin

@RestController
public class UserController {
	@Autowired
    AuthorizationProxyFactory proxyFactory;

	@GetMapping
    User currentUser(@AuthenticationPrincipal User user) {
        return this.proxyFactory.proxy(user);
    }
}
@RestController
class UserController  {
    @Autowired
    var proxyFactory: AuthorizationProxyFactory? = null

    @GetMapping
    fun currentUser(@AuthenticationPrincipal user:User?): User {
        return proxyFactory.proxy(user)
    }
}

但是,如果您使用的是 Jackson,这可能会导致以下序列化错误

com.fasterxml.jackson.databind.exc.InvalidDefinitionException: Direct self-reference leading to cycle

这是由于 Jackson 如何处理 CGLIB 代理。要解决此问题,请将以下注解添加到User 类的顶部

  • Java

  • Kotlin

@JsonSerialize(as = User.class)
public class User {

}
@JsonSerialize(`as` = User::class)
class User

最后,您需要发布一个自定义拦截器 来捕获为每个字段抛出的AccessDeniedException,您可以这样做

  • Java

  • Kotlin

@Component
public class AccessDeniedExceptionInterceptor implements AuthorizationAdvisor {
    private final AuthorizationAdvisor advisor = AuthorizationManagerBeforeMethodInterceptor.preAuthorize();

	@Override
	public Object invoke(MethodInvocation invocation) throws Throwable {
		try {
			return invocation.proceed();
		} catch (AccessDeniedException ex) {
			return null;
		}
	}

	@Override
	public Pointcut getPointcut() {
		return this.advisor.getPointcut();
	}

	@Override
	public Advice getAdvice() {
		return this;
	}

	@Override
	public int getOrder() {
		return this.advisor.getOrder() - 1;
	}
}
@Component
class AccessDeniedExceptionInterceptor: AuthorizationAdvisor {
    var advisor: AuthorizationAdvisor = AuthorizationManagerBeforeMethodInterceptor.preAuthorize()

    @Throws(Throwable::class)
    fun invoke(invocation: MethodInvocation): Any? {
        return try  {
            invocation.proceed()
        } catch (ex:AccessDeniedException) {
            null
        }
    }

     val pointcut: Pointcut
     get() = advisor.getPointcut()

     val advice: Advice
     get() = this

     val order: Int
     get() = advisor.getOrder() - 1
}

然后,您将看到基于用户授权级别的不同 JSON 序列化。如果他们没有user:read 权限,他们将看到

{
    "name" : "name",
    "email" : null
}

如果他们确实拥有该权限,他们将看到

{
    "name" : "name",
    "email" : "email"
}

如果您也不想向未经授权的用户显示 JSON 密钥,则还可以添加 Spring Boot 属性spring.jackson.default-property-inclusion=non_null 来排除空值。

在授权被拒绝时提供回退值

在某些情况下,您可能不希望在没有所需权限的情况下调用方法时抛出AuthorizationDeniedException。相反,您可能希望返回一个后处理的结果,例如屏蔽的结果,或者在授权拒绝发生在调用方法之前的情况下的默认值。

Spring Security 通过使用@HandleAuthorizationDenied 提供了对处理方法调用中授权被拒绝的支持。该处理程序适用于在@PreAuthorize@PostAuthorize 注解 中发生的被拒绝授权以及从方法调用本身抛出的AuthorizationDeniedException

让我们考虑一下上一节中的示例,但是我们不创建AccessDeniedExceptionInterceptorAccessDeniedException 转换为null 返回值,而是使用@HandleAuthorizationDeniedhandlerClass 属性

  • Java

  • Kotlin

public class NullMethodAuthorizationDeniedHandler implements MethodAuthorizationDeniedHandler { (1)

    @Override
    public Object handleDeniedInvocation(MethodInvocation methodInvocation, AuthorizationResult authorizationResult) {
        return null;
    }

}

@Configuration
@EnableMethodSecurity
public class SecurityConfig {

    @Bean (2)
    public NullMethodAuthorizationDeniedHandler nullMethodAuthorizationDeniedHandler() {
        return new NullMethodAuthorizationDeniedHandler();
    }

}

public class User {
    // ...

    @PreAuthorize(value = "hasAuthority('user:read')")
    @HandleAuthorizationDenied(handlerClass = NullMethodAuthorizationDeniedHandler.class)
    public String getEmail() {
        return this.email;
    }
}
class NullMethodAuthorizationDeniedHandler : MethodAuthorizationDeniedHandler { (1)

    override fun handleDeniedInvocation(methodInvocation: MethodInvocation, authorizationResult: AuthorizationResult): Any {
        return null
    }

}

@Configuration
@EnableMethodSecurity
class SecurityConfig {

    @Bean (2)
    fun nullMethodAuthorizationDeniedHandler(): NullMethodAuthorizationDeniedHandler {
        return MaskMethodAuthorizationDeniedHandler()
    }

}

class User (val name:String, @PreAuthorize(value = "hasAuthority('user:read')") @HandleAuthorizationDenied(handlerClass = NullMethodAuthorizationDeniedHandler::class) val email:String) (3)
1 创建一个返回`null`值的MethodAuthorizationDeniedHandler实现
2 NullMethodAuthorizationDeniedHandler注册为bean
3 使用@HandleAuthorizationDenied注解方法,并将NullMethodAuthorizationDeniedHandler传递给handlerClass属性

然后,您可以验证返回的是`null`值而不是AccessDeniedException

您也可以使用@Component注解您的类,而不是创建一个@Bean方法

  • Java

  • Kotlin

@Autowired
UserRepository users;

@Test
void getEmailWhenProxiedThenNullEmail() {
    Optional<User> securedUser = users.findByName("name");
    assertThat(securedUser.get().getEmail()).isNull();
}
@Autowired
var users:UserRepository? = null

@Test
fun getEmailWhenProxiedThenNullEmail() {
    val securedUser: Optional<User> = users.findByName("name")
    assertThat(securedUser.get().getEmail()).isNull()
}

使用方法调用中拒绝的结果

在某些情况下,您可能希望返回从拒绝结果派生的安全结果。例如,如果用户无权查看电子邮件地址,您可能希望对原始电子邮件地址应用一些屏蔽,即[email protected]将变为use******@example.com

对于这些场景,您可以覆盖MethodAuthorizationDeniedHandler中的handleDeniedInvocationResult方法,该方法将MethodInvocationResult作为参数。让我们继续之前的示例,但不是返回`null`,我们将返回电子邮件的掩码值

  • Java

  • Kotlin

public class EmailMaskingMethodAuthorizationDeniedHandler implements MethodAuthorizationDeniedHandler { (1)

    @Override
    public Object handleDeniedInvocation(MethodInvocation methodInvocation, AuthorizationResult authorizationResult) {
        return "***";
    }

    @Override
    public Object handleDeniedInvocationResult(MethodInvocationResult methodInvocationResult, AuthorizationResult authorizationResult) {
        String email = (String) methodInvocationResult.getResult();
        return email.replaceAll("(^[^@]{3}|(?!^)\\G)[^@]", "$1*");
    }

}

@Configuration
@EnableMethodSecurity
public class SecurityConfig {

    @Bean (2)
    public EmailMaskingMethodAuthorizationDeniedHandler emailMaskingMethodAuthorizationDeniedHandler() {
        return new EmailMaskingMethodAuthorizationDeniedHandler();
    }

}

public class User {
    // ...

    @PostAuthorize(value = "hasAuthority('user:read')")
    @HandleAuthorizationDenied(handlerClass = EmailMaskingMethodAuthorizationDeniedHandler.class)
    public String getEmail() {
        return this.email;
    }
}
class EmailMaskingMethodAuthorizationDeniedHandler : MethodAuthorizationDeniedHandler {

    override fun handleDeniedInvocation(methodInvocation: MethodInvocation, authorizationResult: AuthorizationResult): Any {
        return "***"
    }

    override fun handleDeniedInvocationResult(methodInvocationResult: MethodInvocationResult, authorizationResult: AuthorizationResult): Any {
        val email = methodInvocationResult.result as String
        return email.replace("(^[^@]{3}|(?!^)\\G)[^@]".toRegex(), "$1*")
    }

}

@Configuration
@EnableMethodSecurity
class SecurityConfig {

    @Bean
    fun emailMaskingMethodAuthorizationDeniedHandler(): EmailMaskingMethodAuthorizationDeniedHandler {
        return EmailMaskingMethodAuthorizationDeniedHandler()
    }

}

class User (val name:String, @PostAuthorize(value = "hasAuthority('user:read')") @HandleAuthorizationDenied(handlerClass = EmailMaskingMethodAuthorizationDeniedHandler::class) val email:String) (3)
1 创建一个MethodAuthorizationDeniedHandler实现,返回未授权结果值的掩码值
2 EmailMaskingMethodAuthorizationDeniedHandler注册为bean
3 使用@HandleAuthorizationDenied注解方法,并将EmailMaskingMethodAuthorizationDeniedHandler传递给handlerClass属性

然后,您可以验证返回的是屏蔽的电子邮件而不是AccessDeniedException

由于您可以访问原始拒绝值,请确保正确处理它,不要将其返回给调用者。

  • Java

  • Kotlin

@Autowired
UserRepository users;

@Test
void getEmailWhenProxiedThenMaskedEmail() {
    Optional<User> securedUser = users.findByName("name");
    // email is [email protected]
    assertThat(securedUser.get().getEmail()).isEqualTo("use******@example.com");
}
@Autowired
var users:UserRepository? = null

@Test
fun getEmailWhenProxiedThenMaskedEmail() {
    val securedUser: Optional<User> = users.findByName("name")
    // email is [email protected]
    assertThat(securedUser.get().getEmail()).isEqualTo("use******@example.com")
}

在实现MethodAuthorizationDeniedHandler时,您可以返回几种类型的返回值

  • `null`值。

  • 非空值,遵循方法的返回类型。

  • 抛出异常,通常是AuthorizationDeniedException的实例。这是默认行为。

  • 对于响应式应用程序,返回Mono类型。

请注意,由于处理程序必须在您的应用程序上下文中注册为bean,因此如果您需要更复杂的逻辑,可以向其中注入依赖项。除此之外,您还可以使用MethodInvocationMethodInvocationResult以及AuthorizationResult来获取与授权决策相关的更多详细信息。

根据可用参数决定返回什么

考虑这样一种情况:可能有多个用于不同方法的掩码值,如果我们必须为每种方法创建一个处理程序,那效率不高,尽管这样做完全没问题。在这种情况下,我们可以使用通过参数传递的信息来决定该做什么。例如,我们可以创建一个自定义的@Mask注解和一个检测该注解以决定返回哪个掩码值的处理程序

  • Java

  • Kotlin

import org.springframework.core.annotation.AnnotationUtils;

@Target({ ElementType.METHOD, ElementType.TYPE })
@Retention(RetentionPolicy.RUNTIME)
public @interface Mask {

    String value();

}

public class MaskAnnotationDeniedHandler implements MethodAuthorizationDeniedHandler {

    @Override
    public Object handleDeniedInvocation(MethodInvocation methodInvocation, AuthorizationResult authorizationResult) {
        Mask mask = AnnotationUtils.getAnnotation(methodInvocation.getMethod(), Mask.class);
        return mask.value();
    }

}

@Configuration
@EnableMethodSecurity
public class SecurityConfig {

    @Bean
    public MaskAnnotationDeniedHandler maskAnnotationDeniedHandler() {
        return new MaskAnnotationDeniedHandler();
    }

}

@Component
public class MyService {

    @PreAuthorize(value = "hasAuthority('user:read')")
    @HandleAuthorizationDenied(handlerClass = MaskAnnotationDeniedHandler.class)
    @Mask("***")
    public String foo() {
        return "foo";
    }

    @PreAuthorize(value = "hasAuthority('user:read')")
    @HandleAuthorizationDenied(handlerClass = MaskAnnotationDeniedHandler.class)
    @Mask("???")
    public String bar() {
        return "bar";
    }

}
import org.springframework.core.annotation.AnnotationUtils

@Target(AnnotationTarget.FUNCTION, AnnotationTarget.CLASS)
@Retention(AnnotationRetention.RUNTIME)
annotation class Mask(val value: String)

class MaskAnnotationDeniedHandler : MethodAuthorizationDeniedHandler {

    override fun handleDeniedInvocation(methodInvocation: MethodInvocation, authorizationResult: AuthorizationResult): Any {
        val mask = AnnotationUtils.getAnnotation(methodInvocation.method, Mask::class.java)
        return mask.value
    }

}

@Configuration
@EnableMethodSecurity
class SecurityConfig {

    @Bean
    fun maskAnnotationDeniedHandler(): MaskAnnotationDeniedHandler {
        return MaskAnnotationDeniedHandler()
    }

}

@Component
class MyService {

    @PreAuthorize(value = "hasAuthority('user:read')")
    @HandleAuthorizationDenied(handlerClass = MaskAnnotationDeniedHandler::class)
    @Mask("***")
    fun foo(): String {
        return "foo"
    }

    @PreAuthorize(value = "hasAuthority('user:read')")
    @HandleAuthorizationDenied(handlerClass = MaskAnnotationDeniedHandler::class)
    @Mask("???")
    fun bar(): String {
        return "bar"
    }

}

现在,拒绝访问时的返回值将根据@Mask注解决定

  • Java

  • Kotlin

@Autowired
MyService myService;

@Test
void fooWhenDeniedThenReturnStars() {
    String value = this.myService.foo();
    assertThat(value).isEqualTo("***");
}

@Test
void barWhenDeniedThenReturnQuestionMarks() {
    String value = this.myService.foo();
    assertThat(value).isEqualTo("???");
}
@Autowired
var myService: MyService

@Test
fun fooWhenDeniedThenReturnStars() {
    val value: String = myService.foo()
    assertThat(value).isEqualTo("***")
}

@Test
fun barWhenDeniedThenReturnQuestionMarks() {
    val value: String = myService.foo()
    assertThat(value).isEqualTo("???")
}

与元注解支持结合使用

您还可以将@HandleAuthorizationDenied与其他注解结合使用,以减少和简化方法中的注解。让我们考虑上一节中的示例,并将@HandleAuthorizationDenied@Mask合并

  • Java

  • Kotlin

@Target({ ElementType.METHOD, ElementType.TYPE })
@Retention(RetentionPolicy.RUNTIME)
@HandleAuthorizationDenied(handlerClass = MaskAnnotationDeniedHandler.class)
public @interface Mask {

    String value();

}

@Mask("***")
public String myMethod() {
    // ...
}
@Target(AnnotationTarget.FUNCTION, AnnotationTarget.CLASS)
@Retention(AnnotationRetention.RUNTIME)
@HandleAuthorizationDenied(handlerClass = MaskAnnotationDeniedHandler::class)
annotation class Mask(val value: String)

@Mask("***")
fun myMethod(): String {
    // ...
}

现在,当您需要在方法中使用掩码行为时,不必记住添加这两个注解。请务必阅读元注解支持部分,以了解有关用法的更多详细信息。

@EnableGlobalMethodSecurity迁移

如果您正在使用@EnableGlobalMethodSecurity,则应迁移到@EnableMethodSecurity

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

@EnableGlobalMethodSecurity<global-method-security>已弃用,建议使用@EnableMethodSecurity<method-security>。新的注解和XML元素默认情况下会激活Spring的前置/后置注解,并在内部使用AuthorizationManager

这意味着以下两个列表在功能上是等效的

  • Java

  • Kotlin

  • Xml

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

  • Java

  • Kotlin

  • Xml

@EnableMethodSecurity
@EnableMethodSecurity
<method-security/>

对于不使用前置/后置注解的应用程序,请确保将其关闭以避免激活不需要的行为。

例如,像这样的列表

  • Java

  • Kotlin

  • Xml

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

应该更改为

  • Java

  • Kotlin

  • Xml

@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 Security延迟查找Authentication,当您使用@EnableMethodSecurity而不是@EnableGlobalMethodSecurity时,会自动利用此优势。

但是,假设您的代码扩展了DefaultMethodSecurityExpressionHandler并覆盖了createSecurityExpressionRoot(Authentication, MethodInvocation)以返回自定义的SecurityExpressionRoot实例。这将不再有效,因为@EnableMethodSecurity设置的安排调用createEvaluationContext(Supplier<Authentication>, MethodInvocation)

幸运的是,这种级别的自定义通常是不必要的。您可以创建包含所需授权方法的自定义bean。

例如,假设您希望自定义@PostAuthorize("hasAuthority('ADMIN')")的评估。您可以创建一个像这样的自定义@Bean

  • Java

  • Kotlin

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;
	}
}

然后像这样在注解中引用它

  • Java

  • Kotlin

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

我仍然更喜欢子类化DefaultMethodSecurityExpressionHandler

如果您必须继续子类化DefaultMethodSecurityExpressionHandler,您仍然可以这样做。相反,请覆盖createEvaluationContext(Supplier<Authentication>, MethodInvocation)方法,如下所示

  • Java

  • Kotlin

@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与应用程序的其他方面(如数据层跟踪和指标)集成。