Spring Security 是 Spring 框架中的安全框架,整个 Spring Security 在学习起来都是比较复杂的。这也是因为 Spring Security 在设计上所需要的组件比较多,所以比较难以理解。本文将尝试通过组成 Spring Securit 功能的常用功能组件以图的形式进行说明,以方便对于 Spring Security 能有一个比较清楚直观的理解。
本篇关于 Spring Security 的文章主要由三部分组成,分别是:
基础组成
SecurityContextHolder
在 Spring Security 中,SecurityContextHolder
是 Spring Security 记录认证结果的核心。所有已经被认证过的用户都将被保存在SecurityContextHolder
中。每个SecurityContextHolder
实例中会利用一个SecurityContextHolderStrategy
实例来保存已经完成验证的SecurityContext
实例。
所以,在 Spring Security 中,每一个非空的SecurityContextHolder
就代表着一个已经被认证过的用户,而且在 Spring Security 中,非空的SecurityContextHolder
实例也常常被用来表示当前已经被认证过的用户。
以下是SecurityContextHolder
系列接口的构成示意图。
从这张图上可以看出,SecurityContextHolder
中主要是利用其中的SecurityContextHolderStrategy
实例来管理其中持有的SecurityContext
实例。但是在实际使用时,我们并不需要直接调用SecurityContextHolderStrategy
实例,只需要利用SecurityContextHolder
来完成操作即可。
SecurityContextHolder
中使用不同的策略实例,可以在配置文件中设定spring.security.strategy
的值,这一配置项可以取以下三个值:MODE_THREADLOCAL
、MODE_INHERITABLETHREADLOCAL
、MODE_GLOBAL
。在没有设置所需要使用的策略时,会默认采用MODE_THREADLOCAL
。
SpringContext
SpringContext
类就比较简单了,根据上图描述,SpringContext
里就是包含了一个Authentication
接口实例。
Authentication
Authentication
接口是Spring Security中的认证功能核心,在Spring Security中主要执行以下两个功能:
- 作为
AuthenticationManager
的输入数据来对用户进行认证。 - 代表一个目前已经被认证的用户,在这种情况下,
Authentication
实例可以从SecurityContext
中获得。
Authentication
中通常会包含三种内容:Principal、Credentials、Authorities。虽然在上图中,Principal和Credentials都是Object
类型的,但Principal通常都是以UserDetails
接口实例的形式出现,而Credentials通常都是字符串。Authorities在上图中表示是一组GrantedAuthority
实例,但是大部分情况下都是采用SimpleGrantedAuthority
类包装的字符串组成Authorites集合。
AuthenticationManager
AuthenticationManager
在Spring Security中定义了如何执行用户身份验证,经过AuthenticationManager
的执行以后,Spring Security即可以向SecurityContextHolder
中写入被返回的验证信息。
AuthenticationManager
通常会被应用成一个Servlet Filter,而这也是Spring MVC基于Servlet的处理流程。
由于AuthenticationManager
只是一个接口,所以在实际使用时通常都使用ProviderManager
类来实现其所定义的功能。常用的基于AuthenticationManager
接口的类结构图如下。
从这张图上可以看出来,平时在使用ProviderManager
的时候,实际上是在构建认证所需要的AuthenticationProvider
。Spring Security提供了多个实现了AuthenticationProvider
接口的抽象类,例如AbstractUserDetailsAuthenticationProvider
,这些抽象类中实现了很多常用的功能,如果需要实现一个自定义AuthenticationProvider
,可以直接继承这些抽象类。Spring Security中也是基于这些抽象类提供了许多常见的认证场景支持。这些常用的认证类主要有以下几个。
DaoAuthenticationProvider
,提供基于用户名和密码的认证。JwtAuthenticationProvider
,提供基于JWT的认证。AnonymousAuthenticationProvider
,提供基于AnonymousAuthenticationToken
的匿名用户认证。JaasAuthenticationProvider
,提供基于Java认证与授权的认证。RemoteAuthenticationProvider
,提供远程认证。LdapAuthenticationProvider
,提供基于LDAP的认证。OAuth2AuthenticationCodeAuthenticationProvider
,提供基于授权码的OAuth 2.0认证。OAuth2LoginAuthenticationProvider
,提供基于登录的OAuth 2.0认证。OpenIDAuthenticationProvider
,提供基于OpenID授权的认证。PreAuthenticatedAuthenticationProvider
,提供基于预认证的授权认证。CasAuthenticationProvider
,提供基于JA-SIG中央认证服务的授权认证。OpaqueTokenAuthenticationProvider
,提供基于不透明令牌的授权认证。JwtAuthenticationProvider
,提供基于JWT的授权认证。
DaoAuthenticationProvider
DaoAuthenticationProvider
是Spring Security中最常用的Authentication Provider,因为大部分认证场景都是基于用户名和密码的。DaoAuthenticationProvider
进行认证功能的核心就是一个UserDetailsService
实例,通过UserDetailsService
可以完成用户提供的用户名和密码的验证,并且可以返回一个可供Authentication
保存用户信息的UserDetails
。
以下是DaoAuthenticationProvider
的类结构图,在构建基于用户名和密码的认证过程中参考使用。
AbstractAuthenticationProcessingFilter
AbstractAuthenticationProcessingFilter
继承了GenericFilterBean
,是Spring Servlet应用中Security相关过滤器定义的抽象类。基于Servlet的Web应用中,一个请求在到达负责响应的Controller Bean之前,需要经过数层过滤器的处理。AbstractAuthenticationProcessingFilter
所执行的功能就是把Spring Security的认证与授权功能以过滤器的形式插入到Web请求的处理流程之中。
DelegatingFilterProxy
和FilterChainProxy
,这两个代理类主要是用于在Servlet处理流程中插入Filter组合的,在绝大多数情况下都不需要手动控制。在使用过程中一般只需要定义所需要使用的Filter即可。
对于SecurityFilterChain
在整个Servlet请求处理流程中插入的Filter的先后顺序,Spring Security官方文档是给了一个列表的,可以直接参考使用。我们在日常使用过程中所需要关注的Filter主要有以下几个(按调用顺序排列,不一定全都使用)。
CorsFilter
CsrfFilter
LogoutFilter
OAuth2AuthorizationRequestRedirectFilter
OAuth2LoginAuthenticationFilter
UsernamePasswordAuthenticationFilter
OpenIDAuthenticationFilter
BearerTokenAuthenticationFilter
RememberMeAuthenticationFilter
AnonymousAuthenticationFilter
OAuth2AuthorizationCodeGrantFilter
SessionManagementFilter
ExceptionTranslationFilter
UsernamePasswordAuthenticationFilter
以UsernamePasswordAuthenticationFilter
为例,它会将请求传入的用户名和密码整合放入UsernamePasswordAuthenticationToken
中,这是一个实现了Authentication
接口的类,主要用途就是存放用户认证信息。之后,UsernamePasswordAuthenticaitonToken
实例就会被放入AuthenticationManager
实例中进行认证。
所以在认证过程中所获取的Authentication
接口实例,一般都是UsernamePasswordAuthenticationToken
类的实例。
RememberMeAuthenticationFilter
RememberMeAuthenticationFilter
可以主要用来提供已经完成认证的用户自动登录功能的过滤器,通过定义一个RememberMeServices
接口或者AbstractRememberMeServices
抽象类的实例,可以利用其中的loginSuccess()
方法生成一个针对于已经完成认证的用户的记录,这种记录可以是Token、Cookie或者其他任何形式。所生成的用户记录可以在下一次请求的autoLogin()
方法中使用,并在请求中恢复认证记录。
BearerTokenAuthenticationFilter
BearerTokenAuthenticaitonFilter
的主要功能就是解析HTTP请求头中的Authorization
,并将其中所携带的Token内容解析出来,形成一个BearerTokenAuthenticationToken
实例,然后放入AuthenticationManager
中进行认证,最后将认证结果放入SecurityContextHolder
中。这里出现的BearerTokenAuthenticationToken
也是一个AbstractAuthenticationToken
抽象类的子类,其中也包含了认证所需要使用的用户名、认证资料等。
Spring MVC中的认证流程
Spring MVC中主要是依赖于Servlet Filter组成的管道来对HTTP请求中携带的认证消息进行处理。下面借用一个伪数据流图来简单示意一下在一次Web请求中认证信息的处理过程。
从这个图上可以看出来,在Spring MVC中,这些实现了javax.servlet.Filter
的认证过滤器才是才是真正启动认证过程执行的起点。而我们在使用时大多只需要为它们提供它们所依赖的工作实例即可,例如UserDetailsService
、PasswordEncoder
等。
Spring WebFlux中的认证流程
Spring WebFlux中的依赖的是WebFilter组成的过滤器管道来对HTTP请求中携带的认证消息进行处理。这里同样借用一个伪数据流图来进行简单的示意。
Spring WebFlux中的认证流程和参与组件要比Spring MVC少很多。从上图可以看出来,启动认证过程的起点依旧是实现了WebFilter
接口的过滤器,但是不同的认证过滤器开始使用不同的AuthenticationManager
实例。但是整个流程中不变的是,所有已经完成认证的结果还都将保存到SecurityContext
实例中。