🍃【Spring 专题】「技术原理」Spring Security 的核心功能和加载运行流程的原理分析
SpringSecurity 的架构总览
Spring Security 的简介说明
Spring Security 对认证、授权和常见漏洞保护提供了全方位支持。使用的版本为:Spring Security 5.5.2。
概念释义
认证(Authentication):认证就是对试图访问资源的用户进行验证。
认证的场景就是 登录 流程,常见的方式就是要求提供用户名和密码,当验证通过的时候,就可以执行授权操作。
授权(Authority):授权就是对资源进行权限设置,只有用户具备相应权限才能访问。
技术原理
Spring Security 在基于 Servlet 应用中,其底层是采用了 Filter 机制实现了对请求的认证、授权和漏洞防御等功能。
简单来说,可以理解为给 Servlet 设置一些 Filters,这些 Filters 就构成了一个 FilterChain。
请求拦截处理
每次当请求进来时,首先会被 FilterChain 中的 Filters 依次捕获得到,每个 Filter 可以对请求进行一些预处理或对响应进行一些后置处理,最后才会到达 Servlet。具体流程如下图所示:
FilterChain 的实例对象
FilterChain 中的 Filter 主要有两方面作用:
修改 HttpServletRequest 或 HttpServletResponse,这样 FilterChain 后续的 Filters 或 Servlet 得到的就是被修改后的请求和响应内容。
Filter 可以拦截请求,自己作出响应,相当于断开了 FilterChain,导致后续的 Filters 和 Servlet 无法接收到该请求。
DelegatingFilterProxy
基于 Servlet 规范,我们可以为 Servlet 容器 注入一些自定义 Filters,但是在 Spring 应用中,实现了 Filter 接口的 Bean 无法被 Servlet 容器 感知到,没有调用 ServletContext#addFilter 方法注册到 FilterChain 中。
Spring 提供了一个 DelegatingFilterProxy 代理类,DelegatingFilterProxy 实现了 Filter,因此它可以被注入到 FilterChain 中,同时,当请求到来时,它会把请求转发到 Spring 容器 中实现了 Filter 接口的 Bean 实体,所以 DelegatingFilterProxy 桥接了 Servlet 容器 和 Spring 容器。
DelegatingFilterProxy 作用示意图大致如下所示:
当请求到来时,DelegatingFilterProxy 会从 ApplicationContext 中获取 FilterBean 实体,然后将请求转发给到它,伪代码如下所示:
FilterChainProxy
Spring 容器中的 Filters Bean 实体可以注入到 Servlet 容器中的 FilterChain 功能,基于此,Spring Security 向 Spring 容器提供了一个 FilterChainProxy Bean 实体,该 FilterChainProxy 实现了 Filter 接口,因此,请求就会被 FilterChainProxy 捕获到,这样 Spring Security 就可以开始工作了。
默认情况下,DelegatingFilterProxy 从 Spring 容器中获取得到的就是 FilterChainProxy 实体,而 FilterChainProxy 也是一个代理类,它最终会将请求转发到 Spring Security 提供的 SecurityFilterChain 中,流程示意图如下所示:
注:FilterChainProxy 就是 Spring Security 真正的入口起始点,调式代码时,将断点设置在 FilterChainProxy#doFilter 就可以追踪 Spring Security 完整调用流程。
SecurityFilterChain
SecurityFilterChain 作用其实跟 Servlet 的 FilterChain 一样,同样维护了很多 Filters,这些 Filters 是由 Spring Security 提供的,每个 Security Filter 都有不同的职能,比如登录认证、CSRF 防御...如下图所示:
同时,Spring Security 支持添加多个 SecurityFilterChain,每个 SecurityFilterChain 负责不同的请求(比如依据请求地址进行区分),这样可以为不同的请求设置不同的认证规则。其源码如下所示:
具体来说,当请求到达 FilterChainProxy 时,其内部会根据当前请求匹配得到对应的 SecurityFilterChain,然后将请求依次转发给到该 SecurityFilterChain 中的所有 Security Filters。如下图所示:
Security Filters
Spring Security 最终对请求进行处理的就是某个 SecurityFilterChain 中的 Security Filters,这些 Filter 都设置为 Bean 注入到 Spring 容器中,且这些 Filters 的先后顺序很重要。以下是 Spring Security 内置的完整 Security Filter 顺序列表:
ChannelProcessingFilter:确保请求投递到要求渠道。最常见的使用场景就是指定哪些请求必须使用 HTTPS 协议,哪些请求必须使用 HTTP 协议,哪些请求随便使用哪种协议均可。
WebAsyncManagerIntegrationFilter:集成 SecurityContext 到 Spring Web 异步请求机制中的 WebAsyncManager。
注:SecurityContext 就是 安全上下文,主要职能就是用于存储用户认证的一些信息。
SecurityContextPersistenceFilter:在每次请求处理之前,从 Session(默认使用 HttpSessionSecurityContextRepository)中获取 SecurityContext,然后将其设置给到 SecurityContextHolder;在请求结束后,就会将 SecurityContextHolder 中存储的 SecurityContext 重新保存到 Session 中,并且清除 SecurityContextHolder 中的 SecurityContext。
SecurityContextPersistenceFilter 可以通过 HttpSecurity#securityContext()及相关方法引入其配置对象 SecurityContextConfigurer 来进行配置。
HeaderWriterFilter:该过滤器可为响应添加一些响应头,比如添加 X-Frame-Options,X-XSS-Protection 和 X-Content-Type-Options 等响应头,让浏览器开启保护功能。
HeaderWriterFilter 可以通过 HttpSecurity#headers()来定制。
CorsFilter:处理跨域资源共享(CORS)。
CorsFilter 可以通过 HttpSecurity#cors()来定制。
CsrfFilter:处理跨站请求伪造(CSRF)。
CsrfFilter 可以通过 HttpSecurity#csrf()来开启或关闭。在前后端分离项目中,不需要使用 CSRF。
LogoutFilter:处理退出登录请求。
LogoutFilter 可以通过 HttpSecurity#logout()来定制退出逻辑。
OAuth2AuthorizationRequestRedirectFilter:用于构建 OAuth 2.0 认证请求,将用户请求重定向到该认证请求接口。
注:该过滤器需要添加 spring-security-oauth2 等相关模块。
Saml2WebSsoAuthenticationRequestFilter:基于 SAML 的 SSO 单点登录认证请求过滤器。
注:Saml2WebSsoAuthenticationRequestFilter 需要添加 Spring Security SAML 模块。
X509AuthenticationFilter:X509 认证过滤器。
X509AuthenticationFilter 可以通过 SecurityContext#X509()来启用和配置相关功能。
AbstractPreAuthenticatedProcessingFilter:认证预处理请求过滤器基类,其中认证主体已经由外部系统进行了身份验证。目的只是从传入请求中提取主体上的必要信息,而不是对它们进行身份验证。可以继承该类进行具体实现并通过 HttpSecurity#addFilter 方法来添加个性化的 AbstractPreAuthenticatedProcessingFilter。
CasAuthenticationFilter:用于处理 CAS 单点登录认证。
注: CasAuthenticationFilter 需要添加 Spring Security CAS 模块。
OAuth2LoginAuthenticationFilter:OAuth2.0 登录认证过滤器。
注: OAuth2LoginAuthenticationFilter 需要添加 spring-security-oauth2 等相关模块。
Saml2WebSsoAuthenticationFilter:基于 SAML 的 SSO 单点登录认证过滤器。
注:Saml2WebSsoAuthenticationFilter 需要添加 Spring Security SAML 模块。
UsernamePasswordAuthenticationFilter:用于处理表单登录认证。默认处理接口为/login,表单必须提供两个参数:用户名 和 密码,默认的参数名(key)为 username 和 password,可以通过 usernameParameter 和 passwordParameter 方法进行修改。
UsernamePasswordAuthenticationFilter 可以通过 HttpSecurity#formLogin()及相关方法引入其配置对象 FormLoginConfigurer 来进行配置。
OpenIDAuthenticationFilter:基于 OpenID 认证协议的认证过滤器。
DefaultLoginPageGeneratingFilter:如果没有配置登录页面,那么就会默认采用该过滤器生成一个登录表单页面。
注:默认的登录页面接口为/login
DefaultLogoutPageGeneratingFilter:生成默认退出登录页面。
注:默认的退出登录页面接口为/logout
ConcurrentSessionFilter:主要用来判断 Session 是否过期以及更新最新访问时间。该过滤器可能会被多次执行。
DigestAuthenticationFilter:用于处理 HTTP 头部显示的摘要式身份验证凭据。
DigestAuthenticationFilter 可以通过 HttpSecurity#addFilter()来启用和配置相关功能。
BearerTokenAuthenticationFilter:处理 Token 认证。
BasicAuthenticationFilter:用于检测和处理 Http Baisc 认证。
BasicAuthenticationFilter 可以通过 HttpSecurity#httpBasic()及相关方法引入其配置对象 HttpBaiscConfigurer 来进行配置。
RequestCacheAwareFilter:用于用户认证成功后,重新恢复因为登录被打断的请求。当匿名访问一个需要授权的资源时。会跳转到认证处理逻辑,此时请求被缓存。在认证逻辑处理完毕后,从缓存中获取最开始的资源请求进行再次请求。
RequestCacheAwareFilter 可以通过 HttpSecurity#requestCache()及相关方法引入其配置对象 RequestCacheConfigurer 来进行配置。
SecurityContextHolderAwareRequestFilter:对请求对象进行包装,增加了一些安全相关方法。
SecurityContextHolderAwareRequestFilter 可以通过 HttpSecurity#servletApi()及相关方法引入其配置对象 ServletApiConfigurer 来进行配置。
JaasApiIntegrationFilter:适用于 JAAS (Java 认证授权服务)。如果 SecurityContextHolder 中拥有的 Authentication 是一个 JaasAuthenticationToken,那么该 JaasApiIntegrationFilter 将使用包含在 JaasAuthenticationToken 中的 Subject 继续执行 FilterChain。
RememberMeAuthenticationFilter:当用户没有登录而直接访问资源时,从 cookie 里找出用户的信息,如果 Spring Security 能够识别出用户提供的 remember me cookie,用户将不必填写用户名和密码,而是直接登录进入系统。它先分析 SecurityContext 里有没有 Authentication 对象,如果有,则不做任何操作,直接跳到下一个过滤器;如果没有,则检查请求里有没有包含 remember-me 的 cookie 信息。如果有,则解析出 cookie 里的验证信息,判断是否有权限。
RememberMeAuthenticationFilter 可以通过 HttpSecurity#rememberMe()及相关方法引入其配置对象 RememberMeConfigurer 来进行配置。
AnonymousAuthenticationFilter:匿名认证过滤器,检测 SecurityContextHolder 中是否存在 Authentication 对象,如果不存在,就生成一个匿名 Authentication 对象。
AnonymousAuthenticationFilter 可以通过 HttpSecurity#anonymous()及相关方法引入其配置对象 AnonymousConfigurer 来进行配置。
OAuth2AuthorizationCodeGrantFilter:OAuth 2.0 授权码模式,用于处理 OAuth 2.0 授权码响应。
SessionManagementFilter:检测用户是否通过认证,如果已认证,就通过 SessionAuthenticationStrategy 进行 Session 相关管理操作。
SessionManagementFilter 可以通过 HttpSecurity#sessionManagement()及相关方法引入其配置对象 SessionManagementConfigurer 来进行配置。
ExceptionTranslationFilter:可以用于捕获 FilterChain 上所有的异常,但只处理 AccessDeniedException 和 AuthenticationException 异常。
FilterSecurityInterceptor:对 web 资源 进行一些安全保护操作。
SwitchUserFilter:主要用来作用户切换。
自动配置
依据 Spring Boot 自动配置原理,其会自动加载 spring-boot-autoconfigure.jar 中/META-INF/spring.factories 内键值 org.springframework.boot.autoconfigure.EnableAutoConfiguration 指定的自动配置类。查看该文件,可以看到,与 Spring Security 相关的自动配置类有如下几个:
每个配置类都为 Spring Security 注入不同的 Bean 到 Spring 容器中。这里我们着重介绍一下 SecurityFilterAutoConfiguration 和 SecurityAutoConfiguration 配置类,因为这两个配置类会自动装配 DelegatingFilterProxy 和 FilterChain 到 Spring 容器 中。
自动装配 FilterChainProxy
下面介绍下配置类 SecurityAutoConfiguration,具体如下:
SecurityAutoConfiguration 导入了 3 个配置类,注重看 WebSecurityEnablerConfiguration。查看 WebSecurityEnablerConfiguration 配置类,其源码如下:
当 Spring 容器 中没有名称为 springSecurityFilterChain 的 Bean 等条件时,就会加载该配置类,此时 @EnableWebSecurity 注解生效:
注解 @EnableWebSecurity 又导入了 4 个配置类,这里着重看下 WebSecurityConfiguration:
可以看到,WebSecurityConfiguration#springSecurityFilterChain()最终生成了一个名称为 springSecurityFilterChain 的 Bean 实体,该 Bean 的实际类型其实为 FilterChainProxy,是由 WebSecurity#build()方法创建的。
综上,SecurityAutoConfiguration 配置类生成了很多 Bean 实体,其中最重要的一个是名称为 springSecurityFilterChain 的 FilterChainProxy 对象。
自动装配 DelegatingFilterProxy
下面介绍下配置类 SecurityFilterAutoConfiguration,其源码如下所示:
可以看到,要加载 SecurityFilterAutoConfiguration 前,必须先加载配置类 SecurityAutoConfiguration,该配置类前面已经详细介绍了,主要功能就是注入了一个名称为 springSecurityFilterChain 的 Bean,因此,此时 SecurityFilterAutoConfiguration#securityFilterChainRegistration 就会生效,最终生成一个 DelegatingFilterProxyRegistrationBean 实体。DelegatingFilterProxyRegistrationBean 实现了 ServletContextInitializer 接口,当系统执行 ServletWebServerApplicationContext.selfInitialize()进行初始化时,会依次调用到:RegistrationBean.onStartup() --> DynamicRegistrationBean.register() --> AbstractFilterRegistrationBean.addRegistration(),其中,AbstractFilterRegistrationBean#addRegistration()源码如下:
this.getFilter()实际调用的是 DelegatingFilterProxyRegistrationBean#getFilter()方法,其内部会创建一个 DelegatingFilterProxy 实例并返回,源码如下:
因此,AbstractFilterRegistrationBean#addRegistration()最终就是通过 ServletContext#addFilter 将一个 DelegatingFilterProxy 实例注入到 Servlet 的 FilterChain 中。
以上,就是 Spring Boot 中自动装配 Spring Security 相关配置源码分析,更加详细内容,可参考:
总结
Spring Security 作用机制大致如下:
注册标准 Filter:首先,Spring 会自动注入一个 DelegatingFilterProxy 到 Servlet 的 FilterChain 中。
请求转发到 Spring Security:当请求到来时,DelegatingFilterProxy 就会自动在 Spring 容器 中搜索名称为 springSecurityFilterChain 的 Filter 实体,其实际类型为 FilterChainProxy。DelegatingFilterProxy 最终会将请求转发给到 FilterChainProxy。
找到匹配请求处理的 SecurityFilterChain:FilterChainProxy 内部维护了一系列 SecurityFilterChains,他会依据请求内容找到对应处理该请求的 SecurityFilterChain。
请求处理:找到能处理请求的第一个 SecurityFilterChain 后,就会遍历该 SecurityFilterChain 内部维护的一系列 Filters,依次让这些 Security Filter 处理该请求,完成认证、授权等功能。
Spring Security 架构简单示意图
版权声明: 本文为 InfoQ 作者【浩宇天尚】的原创文章。
原文链接:【http://xie.infoq.cn/article/e0ddb70b642bdcf4c6f84b531】。
本文遵守【CC-BY 4.0】协议,转载请保留原文出处及本版权声明。
评论