Spring Security 源码解读（一）概述

955次阅读
没有评论

共计 11074 个字符，预计需要花费 28 分钟才能阅读完成。

内容目录

Spring Security概述

博客中涉及到的所有源码均可前往Github下载：https://github.com/NingNing0111/spring-security-study

官网介绍：Spring Security is a powerful and highly customizable authentication and access-control framework. It is the de-facto standard for securing Spring-based applications.

 Spring Security 是一个功能强大且高度可定制的身份验证和访问控制框架。它是保护Spring应用的事实标准。

1. 特点

  • 为身份验证和授权提供全面、可扩展的支持；
  • 可以防止会话固定、点击劫持、跨站请求伪造等攻击；
  • 集成了 Servlet API；
  • 可选择与 Spring Web MVC 集成；

2. 架构

 Spring Security的本质就是一堆的Filter(过滤器)，这对其它身份校验、授权的框架也是一样的。这里根据我的理解记录下Spring Security的实现架构。

2.1 Filter (过滤器)

 Filter一般是指Java Servlet的过滤器。Filter可以动态地拦截请求和响应，以变换或使用包含在请求或响应中的信息。

 在Java Servlet中，可以将一个或多个Filter附加到一个Servlet或一组Servlet中去。Filter也可以附加到JSP文件或HTML页面中去。调用Servlet前会调用所有附加的Servlet Filter。

 Servlet Filter是可用于Servlet编程的Java类，它可以实现以下目的：

  • 在客户端的请求访问后端资源之前，拦截这些请求。
  • 在服务端的响应发送回客户端之前，处理这些响应。

 多个Filter会构成处理请求的过滤器链（FilterChain）

Spring Security 源码解读（一）概述

 客户端向服务器应用发送请求时，服务端会根据请求路径创建一个FilterChain,在FilterChain中包含一组过滤器的实例和处理该请求的Servlet。在Spring MVC中，一个Servlet只能处理一个请求(HttpServletRequest)和一个响应(HttpServletResponse)。但是一个Servlet可以被一组过滤器处理。并且使用Filter可以实现如下需求：

  • 防止下游的 Filter 实例或 Servlet 被调用。在这种情况下，Filter 通常会使用 HttpServletResponse 对客户端写入响应。

  • 修改下游的 Filter 实例和 Servlet 所使用的 HttpServletRequest 或 HttpServletResponse。

 过滤器是通过实现javax.servlet.Filter接口定义的三个方法实现的。代码模板如下：

package com.ningning0111.test;

import javax.servlet.*;
import java.io.IOException;

public class MyFilter implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        // 过滤器初始化时调用
    }

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        // 过滤器处理的业务

        // 将请求传回过滤链去
        filterChain.doFilter(servletRequest,servletResponse);
    }

    @Override
    public void destroy() {
        // Filter被Web移除之前调用
    }
}

由于一个Filter只会影响下一个Filter实例和Servlet，因此每一个Filter的调用顺序是十分重要的。

2.2 DelegatingFilterProxy (委托过滤代理)

 Spring Web提供了一个名为DelegatingFilterProxy的Filter实现,它将原生态的Servlet的生命周期与Spring的ApplicationContext联系了起来。

通俗点就是在原生态的Servlet Filter Chain中添加了一个Filter的实现，这个实现便于Spring应用定义的Filter与Servlet连接起来。

 Servlet容器允许使用自己的标准创建Filter实例，但它不知道Spring 所定义的Bean。因此，你可以通过标准的Servlet容器机制来注册DelegatingFilterProxy,并将所有的工作，委托给实现了Filter的Spring Bean。

Spring Security 源码解读（一）概述

 DelegatingFilterProxy继承了一个抽象类GenericFilterBean,该抽象类实现了Filter接口。

Spring Security 源码解读（一）概述

Spring Security 源码解读（一）概述

 DelegatingFilterProxy会从WebApplication中延迟加载Filter Bean，然后调用Filter Bean。

Spring Security 源码解读（一）概述

 中间调用的findWebApplicationContext()方法，该方法就会返回WebApplication的Context，然后将该Context传给initDelegate方法，该方法的功能是从WebApplication中找得到Filter Bean，并将Filter Bean返回。

Spring Security 源码解读（一）概述

 因此DelegatingFilterProxy的doFilter的流程就两步：

  • 从WebApplication中延迟加载定义的Filter Bean;
  • 调用获取的Filter Bean

 而委托执行Filter体现在下面几段源码:

1. Filter delegateToUse = this.delegate;
2. delegateToUse = initDelegate(wac);
3. this.delegate = delegateToUse;
4. invokeDelegate(delegateToUse,...);

 上面提到DelegatingFilterProxy会延时从WebApplication中加载Filter Bean。这是因为容器在启动前，容器需要注册Filter实例，而Spring通常使用ContextLoaderListener来加载Spring Bean,这会在需要注册Filter实例之后才会完成。因此我们需要延时，等Filter Bean注册完成后再从WebApplicatio中加载。

2.3 FilterChainProxy (过滤链代理)

 Spring Security的Servlet支持在FilterChainProxy中。

 FilterChainProxy是Spring Security提供的一个特殊Filter.它允许通过SecurityFilterChain委托给许多的Filter实例。

 因为FilterChainProxy是一个Spring Bean，所以它会被DelegatingFilterProxy调用。

Spring Security 源码解读（一）概述

 在Spring Security源码中可以知道，FilterChainProxy也继承了Spring Web中的GenericFilterBean。

Spring Security 源码解读（一）概述

 源码中可以看到FilterChainProxy的doFilter方法执行了其内部实现的一个doFilterInternal方法，该方法其实就是用来处理多个Spring Security的SecurityFilterChain。

Spring Security 源码解读（一）概述

Spring Security 源码解读（一）概述

 getFilters方法如下：

Spring Security 源码解读（一）概述

 在该方法中，通过调用SecurityFilterChain的getFilters方法获取Security Filter列表。

2.4 SecurityFilterChain

 SecurityFilterChain是多个SecurityFilter组成的FilterChain。它被FilterChainProxy用来确定当前请求应该调用哪些Spring Security Filter。

Spring Security 源码解读（一）概述

 SecurityFilterChain中的Security Filter通常是Bean，它们是用FilterChainProxy注册的，而不是DelegatingFilterProxy注册的。与直接向Servlet容器或DelegatingFilterProxy注册相比，FilterChainProxy有很多的优势。

  • 它为Spring Security的所有Servlet提供了一个起点。因此，当你想要对Spring Security的Servlet进行Debug时，在FilterChainProxy添加一个调试点就是一个不错的选择。
  • FilterChainProxy是Spring Security的核心，它可以执行一些不被视为可有可无的任务。例如：清除SecurityContext以避免内存泄漏，应用Spring Security的HttpFirewall来保护应用程序免受某些攻击。
  • FilterChainProxy在确定何时应该调用SecurityFilterChain方面提供了更大的灵活性。在Servlet容器中，Filter实例仅基于URL被调用。然而，FilterChainProxy可以通过使用RequestMatcher接口，根据HttpServletRequest中的任何内容确定调用。

Spring Security 源码解读（一）概述

 FilterChainProxy决定应该使用哪个SecurityFilterChain。当然，它需要对每个SecurityFilterChain中的第一个Security Filter进行匹配。

 比如，请求路径为/api/v1/users,那么它会首先与/api/**模式匹配上，并执行对应的SecurityFilterChain。若请求路径为/users,那么它与/api/**模式不匹配，而是与/**模式匹配，从而执行/**对应的SecurityFilterChain。

对于每一个SecurityFilterChain,它是唯一的，但它可以配置任意多个SecurityFilter。

2.5 SecurityFilter

 SecurityFilter是Spring Security提供的用于认证、授权、漏洞保护等等功能的Filter统称。

 这些Security Filter有一个共同的抽象父类OncePerRequestFilter。该类保证在任何Servlet容器上每个请求分派单次执行。它提供了带有HttpServletRequest和HttpServletResponse参数的doFilterInternal方法。SecurityFilter通过继承该抽象类，重写doFilterInternal方法即可实现各种Filter功能。

 Filter是按照特定顺序执行的，这样才能保证它们在正确的时间点上被调用。比如在执行认证Filter时，需要先执行授权Filter。但一般来说，我们是不需要知道Spring Security的Filter执行顺序。不过我们可以从FilterOrderRegistration类中了解到Spring Security的Filter执行顺序，它在org.springframework.security.config.annotation.web.builders包下。

Spring Security 源码解读（一）概述

3. 第一个Hello Spring Security程序

 这里演示第一个Hello Spring Security的Spring Security程序。环境要求如下：

  • JDK >= 17
  • Spring 3.x

3.1 构建Spring项目

Spring Security 源码解读（一）概述

3.2 创建Controller

 这里创建一个IndexController类，用于处理首页请求。

package com.ningning0111.springsecuritydemo1.controller;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class IndexController {
    @GetMapping("/")
    public String rootPath(){
        return "Spring Application";
    }
    @GetMapping("/index")
    public String index(){
        return "Hello Spring Security!";
    }
}

3.3 创建SecurityConfig

 创建SecurityConfig类用来配置SpringSecurity，在这里先不进行任何配置，就简单的加入一个@EnableWebSecurity注解，该注解表示开启SpringSecurity。

package com.ningning0111.springsecuritydemo1.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
import org.springframework.security.core.userdetails.User;
import org.springframework.security.core.userdetails.UserDetails;
import org.springframework.security.core.userdetails.UserDetailsService;
import org.springframework.security.crypto.password.NoOpPasswordEncoder;
import org.springframework.security.crypto.password.PasswordEncoder;
import org.springframework.security.provisioning.InMemoryUserDetailsManager;

@Configuration
@EnableWebSecurity
public class SecurityConfig {
}

3.4 启动Spring容器

 启动Spring容器后，控制台会打印出下述内容：

Spring Security 源码解读（一）概述

 意思就是你没有设置相关的用户信息，SpringSecurity为你生成了一个密码，该密码仅用于开发环境，当你要进行项目部署时，请更新该密码。

 我们可以将密码复制一下，然后通过浏览器访问localhost:8080/index,你会发现浏览器默认给你跳转到了localhost:8080/login页面。

Spring Security 源码解读（一）概述

若无法出现Login页面，请通过使用的浏览器打开一个隐私窗口，通过隐私窗口访问。

 这里的密码就是刚刚控制台输出的Spring Security为你生成的密码，而用户名呢?通过控制台输出的信息，可以发现这个包含密码的日志是从UserDetailsServiceAutoConfiguration类输出的。我们可以连续按两次Shift,搜索该类。

Spring Security 源码解读（一）概述

 再次追根溯源下，进入getName()方法，它跳转到了一个User类，从该类就可以发现name被默认设置了user，密码是通过UUID生成的。

Spring Security 源码解读（一）概述

 知道这些后，我们就能顺利登陆了。

Spring Security 源码解读（一）概述

登陆之后，访问index即可。

4. 配置自定义用户名和密码

 如果我们不配置用户名和密码，每次启动Spring项目时，都需要从控制台复制Security提供的密码进行验证登陆，这是非常繁琐的。这里我将介绍两种设置自定义密码的方式。

4.1 配置文件设置自定义用户名和密码

 我们找到登录用户名的那个类SecurityProperties，它是一个配置类，通过配置文件设置自定义用户名和密码就可以修改默认用户名和密码，这是最简单的实现方式。

Spring Security 源码解读（一）概述

Spring Security 源码解读（一）概述

 但是我们无法通过配置文件配置多个账户。

4.2 通过配置类配置自定义用户名和密码

 通过配置类配置自定义用户名和密码其实在上面3.4中已经提到过的，我们可以从UserDetailsServiceAutoConfiguration类中了解到SpringSecurity是如何为我们提供默认用户名和密码的。关键地方就在于返回InMemoryUserDetailsManager实例，因此我们依葫芦画瓢实现自定义配置。

Spring Security 源码解读（一）概述

 配置类

package com.ningning0111.springsecuritydemo1.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
import org.springframework.security.core.userdetails.User;
import org.springframework.security.core.userdetails.UserDetails;
import org.springframework.security.core.userdetails.UserDetailsService;
import org.springframework.security.crypto.password.NoOpPasswordEncoder;
import org.springframework.security.crypto.password.PasswordEncoder;
import org.springframework.security.provisioning.InMemoryUserDetailsManager;

@Configuration
@EnableWebSecurity
public class SecurityConfig {
    @Bean
    public UserDetailsService initUsers(){
        UserDetails admin = User.withUsername("admin").password("123456").build();
        UserDetails user = User.withUsername("user").password("11111").build();
        UserDetails visitor = User.withUsername("visitor").password("333333").build();

        InMemoryUserDetailsManager inMemoryUserDetailsManager = new InMemoryUserDetailsManager();
        inMemoryUserDetailsManager.createUser(admin);
        inMemoryUserDetailsManager.createUser(user);
        inMemoryUserDetailsManager.createUser(visitor);
        return inMemoryUserDetailsManager;
    }
}

 不过这里还是会有一个问题。我们启动Spring容器后，通过设置的用户名和密码登录，会发现无法登录成功，并且控制台会报如下错误信息。

Spring Security 源码解读（一）概述

 它提示我们PasswordEncoder(密码编码器)实例为null。这里的PasswordEncoder是SpringSecurity为我们提供的一个密码加密接口，SpringSecurity要求开发者必须对密码进行加密，这就要求我们提供一个PasswordEncoder的实现类的实例。

Spring Security 源码解读（一）概述

该接口中定义了两个重要的方法，分别是encode和matches,encode方法用于将密码进行加密，matches方法用于对比明文密码和加密后的暗文是否一致。而另外一个upgradeEncoding方法则是用来判断是否对密码进行再次加密。

 这里为了简单起见，我们可以返回一个NoOpPasswordEncoder实例，这是SpringSecurity为我们提供的不对密码进行任何操作的PasswordEncoder。因此，完整的配置类如下：

package com.ning.springsecuritystudydemo.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
import org.springframework.security.core.userdetails.User;
import org.springframework.security.crypto.password.NoOpPasswordEncoder;
import org.springframework.security.crypto.password.PasswordEncoder;
import org.springframework.security.provisioning.InMemoryUserDetailsManager;

@EnableWebSecurity
@Configuration
public class SecurityConfig {

    @Bean
    public PasswordEncoder definePasswordEncoder(){
        return NoOpPasswordEncoder.getInstance();
    }

    @Bean
    public InMemoryUserDetailsManager init(){

        return new InMemoryUserDetailsManager(
                User.withUsername("admin").password("123456").roles("admin","user").build()
        );
    }
}

对于没有配置密码加密器而报错这个问题，我们还可以设置密码的时候，在密码的前面添加前缀{noop}指示该密码不需要进行加密,这样即使没有配置PasswordEncoder，SpringSecurity也能正常认证。

 配置多个用户的配置如下:

package com.ningning0111.springsecuritydemo1.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
import org.springframework.security.core.userdetails.User;
import org.springframework.security.core.userdetails.UserDetails;
import org.springframework.security.core.userdetails.UserDetailsService;
import org.springframework.security.crypto.password.NoOpPasswordEncoder;
import org.springframework.security.crypto.password.PasswordEncoder;
import org.springframework.security.provisioning.InMemoryUserDetailsManager;

@Configuration
@EnableWebSecurity
public class SecurityConfig {
    @Bean
    public UserDetailsService initUsers(){
        UserDetails admin = User.withUsername("admin").password("123456").build();
        UserDetails user = User.withUsername("user").password("11111").build();
        UserDetails visitor = User.withUsername("visitor").password("333333").build();

        InMemoryUserDetailsManager inMemoryUserDetailsManager = new InMemoryUserDetailsManager();
        inMemoryUserDetailsManager.createUser(admin);
        inMemoryUserDetailsManager.createUser(user);
        inMemoryUserDetailsManager.createUser(visitor);
        return inMemoryUserDetailsManager;
    }

   @Bean
   public PasswordEncoder initPasswordEncoder(){
       return NoOpPasswordEncoder.getInstance();
   }
}

 然后我们再通过我们设置的任意用户的用户名和密码进行登录就行啦。

5. 关于默认登录的小Tip

 当我们没有自定义登录页面时，SpringSecurity默认会使用DefaultLoginPageGeneratingFilter过滤器生成登录页面,它在org.springframework.security.web.authentication.ui包下，源码中，登录接口默认为/login,因此，如果我们想自定义登录页面，只需通过controller类配置/login映射即可。

正文完
java Spring 学习笔记
发表至： Spring
2023-12-20
 0
PG Thinker
版权声明：本站原创文章，由 PG Thinker 于2023-12-20发表，共计11074字。
转载说明：除特殊说明外本站文章皆由CC-4.0协议发布，转载请注明出处。
Spring AI教程（二）Chat API之快速入门
Spring AI教程（三）Image API之AI自查实现对话和绘图
Spring AI教程（二）Chat API之基于数据库的多Key轮询
Spring AI教程（二）Chat API之上下文对话
评论（没有评论）
热评文章
Milvus 稀疏/稠密向量检索及混合检索

Milvus 稀疏/稠密向量检索及混合检索

内容目录 当前大模型落地应用的主要技术是RAG(检索增强生成)，它是一种结合知识检索和生成模型的架构，其核心思...