Skip to content

Commit 27aedbf

Browse files
authored
docs: add Spring Security request process analysis (doocs#93)
* 提交SpringSecurity模块 * 修改文档 * 修改文档 * Update SpringSecurity请求全过程解析.md
1 parent 05e905d commit 27aedbf

22 files changed

+143
-0
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,9 @@
112112
- [SpringBoot 日志系统](/docs/SpringBoot/SpringBoot-LogSystem.md)
113113
- [SpringBoot ConditionalOnBean](/docs/SpringBoot/SpringBoot-ConditionalOnBean.md)
114114

115+
### SpringSecurity
116+
- [SpringSecurity请求全过程解析](/docs/SpringSecurity/SpringSecurity请求全过程解析.md)
117+
115118
## MyBatis
116119

117120
### 基础支持层
Lines changed: 140 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
1+
# Spring Security请求全过程解析
2+
3+
Spring Security是一款基于Spring的安全框架,主要包含认证和授权两大安全模块,和另外一款流行的安全框架Apache Shiro相比,它拥有更为强大的功能。Spring Security也可以轻松的自定义扩展以满足各种需求,并且对常见的Web安全攻击提供了防护支持。如果你的Web框架选择的是Spring,那么在安全方面Spring Security会是一个不错的选择。
4+
5+
这里我们使用Spring Boot来集成Spring Security,Spring Boot版本为***2.5.3***,Spring Security版本为***5.5.1***
6+
7+
## 开启Spring Security
8+
9+
使用IDEA创建一个Spring Boot项目,然后引入***spring-boot-starter-security***
10+
11+
```java
12+
dependencies {
13+
implementation 'org.springframework.boot:spring-boot-starter-security'
14+
implementation 'org.springframework.boot:spring-boot-starter-web'
15+
implementation 'org.projectlombok:lombok:1.18.8'
16+
annotationProcessor 'org.projectlombok:lombok:1.18.8'
17+
providedRuntime 'org.springframework.boot:spring-boot-starter-tomcat'
18+
testImplementation 'org.springframework.boot:spring-boot-starter-test'
19+
testImplementation 'org.springframework.security:spring-security-test'
20+
}
21+
```
22+
23+
接下来我们创建一个***HelloController***,对外提供一个<strong><i>/hello</i></strong>服务:
24+
25+
```java
26+
@RestController
27+
public class HelloController {
28+
@GetMapping("hello")
29+
public String hello() {
30+
return "hello world";
31+
}
32+
}
33+
```
34+
35+
这时候我们直接启动项目,访问<strong><i>http://localhost:8080/hello</i></strong>,可以看到页面跳转到一个登陆页面:
36+
37+
![image-20210811091508157](../../images/SpringSecurity/image-20210811091508157.png)
38+
39+
默认的用户名为user,密码由Sping Security自动生成,回到IDEA的控制台,可以找到密码信息:
40+
41+
```java
42+
Using generated security password: 4f06ba04-37e9-4bdd-a085-3305260da0d6
43+
```
44+
45+
输入用户名user,密码4f06ba04-37e9-4bdd-a085-3305260da0d6后,我们便可以成功访问<strong><i>/hello</i></strong>接口。
46+
47+
## 基本原理
48+
49+
Spring Security默认为我们开启了一个简单的安全配置,下面让我们来了解其原理。
50+
51+
当Spring Boot项目配置了Spring Security后,Spring Security的整个加载过程如下图所示:
52+
53+
![image-20210811091633434](../../images/SpringSecurity/image-20210811091633434.png)
54+
55+
而当我们访问<strong><i>http://localhost:8080/hello</i></strong>时,代码的整个执行过程如下图所示:
56+
57+
![image-20210811091659121](../../images/SpringSecurity/image-20210811091659121.png)
58+
59+
如上图所示,Spring Security包含了众多的过滤器,这些过滤器形成了一条链,所有请求都必须通过这些过滤器后才能成功访问到资源。
60+
61+
下面我们通过debug来验证这个过程:
62+
63+
首先,通过前面可以知道,当有请求来到时,最先由***DelegatingFilterProxy***负责接收,因此在***DelegatingFilterProxy***的<strong><i>doFilter()</i></strong>的首行打上断点:
64+
65+
![image-20210811091719470](../../images/SpringSecurity/image-20210811091719470.png)
66+
67+
接着***DelegatingFilterProxy***会将请求委派给***FilterChainProxy***进行处理,在***FilterChainProxy***的首行打上断点:
68+
69+
![img](../../images/SpringSecurity/56ac5128-eab7-4b92-912f-ff50bac68a4f.png)
70+
71+
***FilterChainProxy***会在<strong><i>doFilterInternal()</i></strong>中生成一个内部类***VirtualFilterChain***的实例,以此来调用Spring Security的整条过滤器链,在***VirtualFilterChain***的<strong><i>doFilter()</i></strong>首行打上断点:
72+
73+
![image-20210811091755498](../../images/SpringSecurity/image-20210811091755498.png)
74+
75+
接下来***VirtualFilterChain***会通过***currentPosition***依次调用存在***additionalFilters***中的过滤器,其中比较重要的几个过滤器有:***UsernamePasswordAuthenticationFilter******DefaultLoginPageGeneratingFilter******AnonymousAuthenticationFilter******ExceptionTranslationFilter******FilterSecurityInterceptor***,我们依次在这些过滤器的<strong><i>doFilter()</i></strong>的首行打上断点:
76+
77+
![image-20210811091815473](../../images/SpringSecurity/image-20210811091815473.png)
78+
79+
准备完毕后,我们启动项目,然后访问<strong><i>http://localhost:8080/hello</i></strong>,程序首先跳转到***DelegatingFilterProxy***的断点上:
80+
81+
![image-20210811091833065](../../images/SpringSecurity/image-20210811091833065.png)
82+
83+
此时***delegate***还是null的,接下来依次执行代码,可以看到***delegate***最终被赋值一个***FilterChainProxy***的实例:
84+
85+
![img](../../images/SpringSecurity/f045b025-bd97-4222-8a02-51634be6745b.png)
86+
87+
接下来程序依次跳转到***FilterChainProxy***的<strong><i>doFilter()</i></strong>和***VirtualFilterChain***的<strong><i>doFilter()</i></strong>中:
88+
89+
![img](../../images/SpringSecurity/90d3e369-510f-45cb-982d-241d2eedb55c.png)
90+
91+
![image-20210811092048784](../../images/SpringSecurity/image-20210811092048784.png)
92+
93+
接着程序跳转到***AbstractAuthenticationProcessingFilter******UsernamePasswordAuthenticationFilter***的父类)的<strong><i>doFilter()</i></strong>中,通过<strong><i>requiresAuthentication()</i></strong>判定为false(是否是POST请求):
94+
95+
![img](../../images/SpringSecurity/2e5440bc-9488-4213-a030-0d25153bb2ea.png)
96+
97+
接着程序跳转到***DefaultLoginPageGeneratingFilter***的<strong><i>doFilter()</i></strong>中,通过<strong><i>isLoginUrlRequest()</i></strong>判定为false(请求路径是否是<strong><i>/login</i></strong>):
98+
99+
![img](../../images/SpringSecurity/47a7bca4-d858-4cb1-b126-347805b74053.png)
100+
101+
接着程序跳转到***AnonymousAuthenticationFilter***的<strong><i>doFilter()</i></strong>中,由于是首次请求,此时<strong><i>SecurityContextHolder.getContext().getAuthentication()</i></strong>为null,因此会生成一个***AnonymousAuthenticationToken***的实例:
102+
103+
![img](../../images/SpringSecurity/6b1aded6-5229-47ba-b192-78a7c2622b8c.png)
104+
105+
接着程序跳转到***ExceptionTranslationFilter***的<strong><i>doFilter()</i></strong>中,***ExceptionTranslationFilter***负责处理***FilterSecurityInterceptor***抛出的异常,我们在catch代码块的首行打上断点:
106+
107+
**![img](../../images/SpringSecurity/8efa0b1c-2b32-4d5b-9655-985374326e10.png)**
108+
109+
接着程序跳转到***FilterSecurityInterceptor***的<strong><i>doFilter()</i></strong>中,依次执行代码后程序停留在其父类(***AbstractSecurityInterceptor***)的<strong><i>attemptAuthorization()</i></strong>中:
110+
111+
![img](../../images/SpringSecurity/d6e99143-6207-43a5-8d04-f0c81baa11b4.png)
112+
113+
***accessDecisionManager******AccessDecisionManager***(访问决策器)的实例,***AccessDecisionManager***主要有3个实现类:***AffirmativeBased***(一票通过),**ConsensusBased**(少数服从多数)、UnanimousBased(一票否决),此时***AccessDecisionManager***的的实现类是***AffirmativeBased***,我们可以看到程序进入***AffirmativeBased***的<strong><i>decide()</i></strong>中:
114+
115+
![img](../../images/SpringSecurity/6724647c-34ee-4a57-8cfa-b46f57400d14.png)
116+
117+
从上图可以看出,决策的关键在<strong><i>voter.vote(authentication, object, configAttributes)</i></strong>这句代码上,通过跟踪调试,程序最终进入***AuthenticationTrustResolverImpl***的<strong><i>isAnonymous()</i></strong>中:
118+
119+
![img](../../images/SpringSecurity/4beaa02f-a93d-4d95-9ad1-0d7213cb0e46.png)
120+
121+
<strong><i>isAssignableFrom()</i></strong>判断前者是否是后者的父类,而***anonymousClass***被固定为***AnonymousAuthenticationToken.class***,参数***authentication***由前面***AnonymousAuthenticationFilter***可以知道是***AnonymousAuthenticationToken***的实例,因此<strong><i>isAnonymous()</i></strong>返回true,***FilterSecurityInterceptor***抛出***AccessDeniedException***异常,程序返回***ExceptionTranslationFilter***的catch块中:
122+
123+
![img](../../images/SpringSecurity/8e1ac9db-5987-484d-abf4-4c6535c60cc6.png)
124+
125+
接着程序会依次进入***DelegatingAuthenticationEntryPoint******LoginUrlAuthenticationEntryPoint***中,最后由***LoginUrlAuthenticationEntryPoint***的<strong><i>commence()</i></strong>决定重定向到<strong><i>/login</i></strong>:
126+
127+
![img](../../images/SpringSecurity/1b03bdd4-6773-4b39-a664-fdf65d104403.png)
128+
129+
后续对<strong><i>/login</i></strong>的请求同样会经过之前的执行流程,在***DefaultLoginPageGeneratingFilter***的<strong><i>doFilter()</i></strong>中,通过<strong><i>isLoginUrlRequest()</i></strong>判定为true(请求路径是否是<strong><i>/login</i></strong>),直接返回***login.html***,也就是我们开头看到的登录页面。
130+
131+
当我们输入用户名和密码,点击***Sign in***,程序来到***AbstractAuthenticationProcessingFilter***的<strong><i>doFilter()</i></strong>中,通过<strong><i>requiresAuthentication()</i></strong>判定为true(是否是POST请求),因此交给其子类***UsernamePasswordAuthenticationFilter***进行处理,***UsernamePasswordAuthenticationFilter***会将用户名和密码封装成一个***UsernamePasswordAuthenticationToken***的实例并进行校验,当校验通过后会将请求重定向到我们一开始请求的路径:<strong><i>/hello</i></strong>。
132+
133+
后续对<strong><i>/hello</i></strong>的请求经过过滤器链时就可以一路开绿灯直到最终交由***HelloController***返回"Hello World"。
134+
135+
## 参考
136+
137+
1. [Spring Security Reference](https://docs.spring.io/spring-security/site/docs/current/reference/html5/)
138+
139+
2. [Spring Boot中开启Spring Security](https://mrbird.cc/Spring-Boot&Spring-Security.html)
140+
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading

0 commit comments

Comments
 (0)