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

Spring MVC 集成

Spring Security 提供了许多与 Spring MVC 的可选集成。本节将更详细地介绍集成。spring-doc.cadn.net.cn

@EnableWebMvcSecurity

从 Spring Security 4.0 开始，@EnableWebMvcSecurity已弃用。替代是@EnableWebSecurity这将决定根据 Classpath 添加 Spring MVC 功能。

要启用 Spring Security 与 Spring MVC 的集成，请添加@EnableWebSecurity注释添加到您的配置中。spring-doc.cadn.net.cn

Spring Security 使用 Spring MVC 的WebMvcConfigurer提供配置。这意味着，如果您使用的是更高级的选项，例如与WebMvcConfigurationSupport直接提供，则需要手动提供 Spring Security 配置。

MvcRequestMatcher

Spring Security 提供了与 Spring MVC 在 URL 上的匹配方式的深度集成MvcRequestMatcher. 这有助于确保您的 Security 规则与用于处理请求的逻辑匹配。spring-doc.cadn.net.cn

为了使用MvcRequestMatcher您必须将 Spring Security Configuration 放在相同的ApplicationContext作为您的DispatcherServlet. 这是必要的，因为 Spring Security 的MvcRequestMatcher期望HandlerMappingIntrospectorbean 的名称为mvcHandlerMappingIntrospector由用于执行匹配的 Spring MVC 配置注册。spring-doc.cadn.net.cn

对于web.xml这意味着您应该将配置放在DispatcherServlet.xml.spring-doc.cadn.net.cn

<listener>
  <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
</listener>

<!-- All Spring Configuration (both MVC and Security) are in /WEB-INF/spring/ -->
<context-param>
  <param-name>contextConfigLocation</param-name>
  <param-value>/WEB-INF/spring/*.xml</param-value>
</context-param>

<servlet>
  <servlet-name>spring</servlet-name>
  <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
  <!-- Load from the ContextLoaderListener -->
  <init-param>
    <param-name>contextConfigLocation</param-name>
    <param-value></param-value>
  </init-param>
</servlet>

<servlet-mapping>
  <servlet-name>spring</servlet-name>
  <url-pattern>/</url-pattern>
</servlet-mapping>

下面WebSecurityConfigurationin 放置在DispatcherServletsApplicationContext.spring-doc.cadn.net.cn

Javaspring-doc.cadn.net.cn
Kotlinspring-doc.cadn.net.cn

public class SecurityInitializer extends
    AbstractAnnotationConfigDispatcherServletInitializer {

  @Override
  protected Class<?>[] getRootConfigClasses() {
    return null;
  }

  @Override
  protected Class<?>[] getServletConfigClasses() {
    return new Class[] { RootConfiguration.class,
        WebMvcConfiguration.class };
  }

  @Override
  protected String[] getServletMappings() {
    return new String[] { "/" };
  }
}

class SecurityInitializer : AbstractAnnotationConfigDispatcherServletInitializer() {
    override fun getRootConfigClasses(): Array<Class<*>>? {
        return null
    }

    override fun getServletConfigClasses(): Array<Class<*>> {
        return arrayOf(
            RootConfiguration::class.java,
            WebMvcConfiguration::class.java
        )
    }

    override fun getServletMappings(): Array<String> {
        return arrayOf("/")
    }
}

始终建议通过匹配HttpServletRequest和方法安全性。spring-doc.cadn.net.cn

通过匹配HttpServletRequest很好，因为它发生在代码路径的早期，有助于减少攻击面。方法安全性可确保在有人绕过 Web 授权规则的情况下，您的应用程序仍然受到保护。这就是所谓的深度防御spring-doc.cadn.net.cn

考虑一个映射如下的控制器：spring-doc.cadn.net.cn

Javaspring-doc.cadn.net.cn
Kotlinspring-doc.cadn.net.cn

@RequestMapping("/admin")
public String admin() {

@RequestMapping("/admin")
fun admin(): String {

如果我们想将对此控制器方法的访问限制为管理员用户，开发人员可以通过匹配HttpServletRequest替换为以下内容：spring-doc.cadn.net.cn

Javaspring-doc.cadn.net.cn
Kotlinspring-doc.cadn.net.cn

@Bean
public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
	http
		.authorizeHttpRequests(authorize -> authorize
			.antMatchers("/admin").hasRole("ADMIN")
		);
	return http.build();
}

@Bean
open fun filterChain(http: HttpSecurity): SecurityFilterChain {
    http {
        authorizeRequests {
            authorize(AntPathRequestMatcher("/admin"), hasRole("ADMIN"))
        }
    }
    return http.build()
}

或 XML 格式spring-doc.cadn.net.cn

<http>
	<intercept-url pattern="/admin" access="hasRole('ADMIN')"/>
</http>

无论使用哪种配置，URL/admin将要求经过身份验证的用户是管理员用户。但是，根据我们的 Spring MVC 配置，URL/admin.html也会映射到我们的admin()方法。此外，根据我们的 Spring MVC 配置，URL/admin/也会映射到我们的admin()方法。spring-doc.cadn.net.cn

问题在于，我们的安全规则只是保护/admin. 我们可以为 Spring MVC 的所有排列添加额外的规则，但这将非常冗长和乏味。spring-doc.cadn.net.cn

相反，我们可以利用 Spring Security 的MvcRequestMatcher. 以下配置将使用 Spring MVC 匹配 URL 来保护 Spring MVC 将匹配的相同 URL。spring-doc.cadn.net.cn

Javaspring-doc.cadn.net.cn
Kotlinspring-doc.cadn.net.cn

@Bean
public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
	http
		.authorizeHttpRequests(authorize -> authorize
			.mvcMatchers("/admin").hasRole("ADMIN")
		);
	// ...
}

@Bean
open fun filterChain(http: HttpSecurity): SecurityFilterChain {
    http {
        authorizeRequests {
            authorize("/admin", hasRole("ADMIN"))
        }
    }
    // ...
}

或 XML 格式spring-doc.cadn.net.cn

<http request-matcher="mvc">
	<intercept-url pattern="/admin" access="hasRole('ADMIN')"/>
</http>

@AuthenticationPrincipal

Spring Security 提供AuthenticationPrincipalArgumentResolver可以自动解析当前的Authentication.getPrincipal()对于 Spring MVC 参数。通过使用@EnableWebSecurity你会自动将其添加到你的 Spring MVC 配置中。如果使用基于 XML 的配置，则必须自行添加此配置。例如：spring-doc.cadn.net.cn

<mvc:annotation-driven>
		<mvc:argument-resolvers>
				<bean class="org.springframework.security.web.method.annotation.AuthenticationPrincipalArgumentResolver" />
		</mvc:argument-resolvers>
</mvc:annotation-driven>

一次AuthenticationPrincipalArgumentResolver正确配置后，您可以在 Spring MVC 层中与 Spring Security 完全解耦。spring-doc.cadn.net.cn

考虑自定义UserDetailsService返回一个Object实现UserDetails和你自己的CustomUser Object.这CustomUser可以使用以下代码访问当前经过身份验证的用户：spring-doc.cadn.net.cn

Javaspring-doc.cadn.net.cn
Kotlinspring-doc.cadn.net.cn

@RequestMapping("/messages/inbox")
public ModelAndView findMessagesForUser() {
	Authentication authentication =
	SecurityContextHolder.getContext().getAuthentication();
	CustomUser custom = (CustomUser) authentication == null ? null : authentication.getPrincipal();

	// .. find messages for this user and return them ...
}

@RequestMapping("/messages/inbox")
open fun findMessagesForUser(): ModelAndView {
    val authentication: Authentication = SecurityContextHolder.getContext().authentication
    val custom: CustomUser? = if (authentication as CustomUser == null) null else authentication.principal

    // .. find messages for this user and return them ...
}

从 Spring Security 3.2 开始，我们可以通过添加 Comments 来更直接地解决参数。例如：spring-doc.cadn.net.cn

Javaspring-doc.cadn.net.cn
Kotlinspring-doc.cadn.net.cn

import org.springframework.security.core.annotation.AuthenticationPrincipal;

// ...

@RequestMapping("/messages/inbox")
public ModelAndView findMessagesForUser(@AuthenticationPrincipal CustomUser customUser) {

	// .. find messages for this user and return them ...
}

@RequestMapping("/messages/inbox")
open fun findMessagesForUser(@AuthenticationPrincipal customUser: CustomUser?): ModelAndView {

    // .. find messages for this user and return them ...
}

有时可能需要以某种方式转换主体。例如，如果CustomUser需要是最终的，它不能延长。在这种情况下，UserDetailsServicemight 会返回一个Object实现UserDetails并提供了一个名为getCustomUser访问CustomUser. 例如，它可能看起来像：spring-doc.cadn.net.cn

Javaspring-doc.cadn.net.cn
Kotlinspring-doc.cadn.net.cn

public class CustomUserUserDetails extends User {
		// ...
		public CustomUser getCustomUser() {
				return customUser;
		}
}

class CustomUserUserDetails(
    username: String?,
    password: String?,
    authorities: MutableCollection<out GrantedAuthority>?
) : User(username, password, authorities) {
    // ...
    val customUser: CustomUser? = null
}

然后，我们可以访问CustomUser使用使用Authentication.getPrincipal()作为根对象：spring-doc.cadn.net.cn

Javaspring-doc.cadn.net.cn
Kotlinspring-doc.cadn.net.cn

import org.springframework.security.core.annotation.AuthenticationPrincipal;

// ...

@RequestMapping("/messages/inbox")
public ModelAndView findMessagesForUser(@AuthenticationPrincipal(expression = "customUser") CustomUser customUser) {

	// .. find messages for this user and return them ...
}

import org.springframework.security.core.annotation.AuthenticationPrincipal

// ...

@RequestMapping("/messages/inbox")
open fun findMessagesForUser(@AuthenticationPrincipal(expression = "customUser") customUser: CustomUser?): ModelAndView {

    // .. find messages for this user and return them ...
}

我们也可以在 SPEL 表达式中引用 Beans。例如，如果我们使用 JPA 来管理我们的 User，并且我们想修改并保存当前 User 的属性，则可以使用以下内容。spring-doc.cadn.net.cn

Javaspring-doc.cadn.net.cn
Kotlinspring-doc.cadn.net.cn

import org.springframework.security.core.annotation.AuthenticationPrincipal;

// ...

@PutMapping("/users/self")
public ModelAndView updateName(@AuthenticationPrincipal(expression = "@jpaEntityManager.merge(#this)") CustomUser attachedCustomUser,
		@RequestParam String firstName) {

	// change the firstName on an attached instance which will be persisted to the database
	attachedCustomUser.setFirstName(firstName);

	// ...
}

import org.springframework.security.core.annotation.AuthenticationPrincipal

// ...

@PutMapping("/users/self")
open fun updateName(
    @AuthenticationPrincipal(expression = "@jpaEntityManager.merge(#this)") attachedCustomUser: CustomUser,
    @RequestParam firstName: String?
): ModelAndView {

    // change the firstName on an attached instance which will be persisted to the database
    attachedCustomUser.setFirstName(firstName)

    // ...
}

我们可以通过使@AuthenticationPrincipal我们自己的注解上的 meta 注解。下面我们演示了如何在名为@CurrentUser.spring-doc.cadn.net.cn

重要的是要认识到，为了消除对 Spring Security 的依赖，消费应用程序将创建@CurrentUser. 此步骤并非严格要求，但有助于将您对 Spring Security 的依赖关系隔离到更中心的位置。

Javaspring-doc.cadn.net.cn
Kotlinspring-doc.cadn.net.cn

@Target({ElementType.PARAMETER, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@AuthenticationPrincipal
public @interface CurrentUser {}

@Target(AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.TYPE)
@Retention(AnnotationRetention.RUNTIME)
@MustBeDocumented
@AuthenticationPrincipal
annotation class CurrentUser

既然@CurrentUser已经指定，我们可以使用它来发出信号，以解析我们的CustomUser当前经过身份验证的用户。我们还将对 Spring Security 的依赖隔离到单个文件中。spring-doc.cadn.net.cn

Javaspring-doc.cadn.net.cn
Kotlinspring-doc.cadn.net.cn

@RequestMapping("/messages/inbox")
public ModelAndView findMessagesForUser(@CurrentUser CustomUser customUser) {

	// .. find messages for this user and return them ...
}

@RequestMapping("/messages/inbox")
open fun findMessagesForUser(@CurrentUser customUser: CustomUser?): ModelAndView {

    // .. find messages for this user and return them ...
}

Spring MVC 异步集成

Spring Web MVC 3.2+ 对异步请求处理有很好的支持。无需额外配置，Spring Security 将自动设置SecurityContext到Thread这会调用Callable由您的控制器返回。例如，以下方法将自动具有其Callable使用SecurityContext当Callable创建时间：spring-doc.cadn.net.cn

Javaspring-doc.cadn.net.cn
Kotlinspring-doc.cadn.net.cn

@RequestMapping(method=RequestMethod.POST)
public Callable<String> processUpload(final MultipartFile file) {

return new Callable<String>() {
	public Object call() throws Exception {
	// ...
	return "someView";
	}
};
}

@RequestMapping(method = [RequestMethod.POST])
open fun processUpload(file: MultipartFile?): Callable<String> {
    return Callable {
        // ...
        "someView"
    }
}

将 SecurityContext 与 Callable 的

更从技术上讲，Spring Security 与WebAsyncManager. 这SecurityContext用于处理Callable是SecurityContext存在于SecurityContextHolder当时startCallableProcessing被调用。spring-doc.cadn.net.cn

没有与DeferredResult由 Controller 返回。这是因为DeferredResult由用户处理，因此无法自动与其集成。但是，您仍然可以使用并发支持来提供与 Spring Security 的透明集成。spring-doc.cadn.net.cn

Spring MVC 和 CSRF 集成

自动 Token 包含

Spring Security 将自动将 CSRF Tokens包含在使用 Spring MVC 表单标签的表单中。例如，以下 JSP：spring-doc.cadn.net.cn

<jsp:root xmlns:jsp="http://java.sun.com/JSP/Page"
	xmlns:c="http://java.sun.com/jsp/jstl/core"
	xmlns:form="http://www.springframework.org/tags/form" version="2.0">
	<jsp:directive.page language="java" contentType="text/html" />
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
	<!-- ... -->

	<c:url var="logoutUrl" value="/logout"/>
	<form:form action="${logoutUrl}"
		method="post">
	<input type="submit"
		value="Log out" />
	<input type="hidden"
		name="${_csrf.parameterName}"
		value="${_csrf.token}"/>
	</form:form>

	<!-- ... -->
</html>
</jsp:root>

将输出类似于以下内容的 HTML：spring-doc.cadn.net.cn

<!-- ... -->

<form action="/context/logout" method="post">
<input type="submit" value="Log out"/>
<input type="hidden" name="_csrf" value="f81d4fae-7dec-11d0-a765-00a0c91e6bf6"/>
</form>

<!-- ... -->

解析 CsrfToken

Spring Security 提供CsrfTokenArgumentResolver可以自动解析当前的CsrfToken对于 Spring MVC 参数。通过使用 @EnableWebSecurity 你会自动将其添加到你的 Spring MVC 配置中。如果使用基于 XML 的配置，则必须自行添加此配置。spring-doc.cadn.net.cn

一次CsrfTokenArgumentResolver正确配置后，您可以公开CsrfToken添加到基于静态 HTML 的应用程序。spring-doc.cadn.net.cn

Javaspring-doc.cadn.net.cn
Kotlinspring-doc.cadn.net.cn

@RestController
public class CsrfController {

	@RequestMapping("/csrf")
	public CsrfToken csrf(CsrfToken token) {
		return token;
	}
}

@RestController
class CsrfController {
    @RequestMapping("/csrf")
    fun csrf(token: CsrfToken): CsrfToken {
        return token
    }
}

保持CsrfToken来自其他域的密钥。这意味着，如果您使用的是跨源共享（CORS），则不应公开CsrfToken添加到任何外部域。spring-doc.cadn.net.cn