Spring Security 5 基础教程之一快速入门

发表于 更新于 阅读次数： 评论数： 本文字数： 3.8k 阅读时长 ≈ 3 分钟

大纲

前言

学习资料

版本说明

组件版本
SpringBoot2.2.1.RELEASE
Spring Security5.2.1.RELEASE

Spring Security 介绍

框架简介

Spring Security 基于 Spring 框架，提供了一套 Web 应用安全性的完整解决方案。关于安全方面的两个主要区域是 “认证” 和 “授权”(或者访问控制)， 一般来说，Web 应用的安全性包括用户认证 (Authentication) 和用户授权 (Authorization) 两个部分，这两点也是 Spring Security 重要核心功能。

  • 用户认证：验证某个用户是否为系统中的合法主体，也就是说用户能否访问该系统。用户认证一般要求用户提供用户名和密码，系统通过校验用户名和密码来完成认证过程。通俗点说就是系统判断用户是否能登录。

  • 用户授权：验证某个用户是否有权限执行某个操作。在一个系统中，不同用户所具有的权限是不同的。一般来说，系统会为不同的用户分配不同的角色，而每个角色则对应一系列的权限。通俗点讲就是系统判断用户是否有权限去做某些事情。

模块划分

Spring Security 划分了以下模块：

  • spring-security-core.jar：包含身份验证、访问控制类和接口，远程支持和基本配置 API，使用 Spring Security 的任何应用程序都需要此模块。支持独立的应用程序，远程客户端，方法 (服务层) 安全性和 JDBC 用户配置等。
  • spring-security-remoting.jar：提供与 Spring Remoting 的集成，除非非要编写使用 Spring Remoting 的远程客户端，否则不需引入它。
  • spring-security-web.jar：包含过滤器和相关的 Web 安全基础结构代码。任何与 Servlet API 依赖的东西。如果需要 Spring Security Web 认证服务和基于 URL 的访问控制，则需要它。
  • spring-security-config.jar：包含安全名称空间解析代码和 Java 配置代码。如果使用 Spring Security XML 名称空间进行配置或者 Spring Security 的 Java 配置支持，则需要它。
  • spring-security-ldap.jar：LDAP 身份验证和配置代码，如果需要使用 LDAP 用户条目，则必须引入它。
  • spring-security-acl.jar：专门的域对象 ACL 实现，用于将安全性应用于应用程序中的特定域对象实例。
  • spring-security-cas.jar：Spring Security 的 CAS 客户端集成。如果想通过 CAS 单点登录服务器使用 Spring Security Web 认证，则需要它。
  • spring-security-openid.jar：OpenID web 身份验证支持。用于根据外部 OpenID 服务器对用户进行身份验证。
  • spring-security-test.jar：支持对 Spring security 进行测试。

框架对比

实际上，在 Spring Boot 出现之前，Spring Security 就已经发展了多年了，但是使用的并不多，安全管理这个领域，一直都是 Shiro 的天下。相对于 Shiro，在 SSM 中整合 Spring Security 是比较麻烦的操作，所以，Spring Security 虽然功能比 Shiro 强大，但是使用的开发者数量反而没有 Shiro 多 (Shiro 虽然功能没有 Spring Security 多，但是对于大部分项目而言，Shiro 也足够用了)。自从有了 Spring Boot 之后，Spring Boot 对 Spring Security 提供了自动化配置方案，可以使用更少的配置来使用 Spring Security。随着时间的推移，Spring Security 的市场占有率越来越高。

Apache Shiro

  • 通用性

    • 优势：不依赖于 Spring 和 Web 环境，可以脱离 Web 环境使用
    • 缺点：在 Web 环境下一些特定的需求，需要手动编写代码定制实现

  • 轻量级：Shiro 主张的理念是把复杂的事情变简单，针对对性能有更高要求的互联网应用有更好表现

Spring Security

  • 优点

    • 全面的权限控制
    • 和 Spring 无缝整合
    • 专门为 Web 开发而设计
    • 旧版本不能脱离 Web 环境使用
    • 新版本对整个框架进行了分层抽取，分成了核心模块和 Web 模块，单独引入核心模块就可以脱离 Web 环境使用

  • 缺点

    • 严重依赖 Spring 框架

企业常见的安全管理技术组合推荐

  • SSM + Shiro
  • SpringBoot/SpringCloud + Spring Security
  • 以上只是一个推荐的技术组合而已，如果单纯从技术上来说，无论怎么组合，项目都是可以正常运行的

Spring Security 使用

入门案例

代码下载

本章节完整的案例代码可以直接从 GitHub 下载对应章节 spring-security5-01。

  • 引入依赖
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.2.1.RELEASE</version>
    <relativePath/>
</parent>

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-security</artifactId>
    </dependency>
</dependencies>
  • 控制器类
1
2
3
4
5
6
7
8
9
@RestController
public class HelloController {

    @RequestMapping("/hello")
    public String hello() {
        return "Hello Spring Security";
    }

}
  • 主启动类
1
2
3
4
5
6
7
8
@SpringBootApplication
public class MainApplication {

    public static void main(String[] args) {
        SpringApplication.run(MainApplication.class, args);
    }

}
  • 启动应用后，浏览器访问 http://127.0.0.1:8080/hello，会自动跳转到 Spring Security 的默认登录页面

  • 默认登录的用户名是 user，而登录密码会在应用启动时通过日志的方式打印到控制台（如下），而且登录密码在每次应用启动后都会动态改变
1
Using generated security password: 82c5e18a-81e8-4b94-bbea-c202b6210012

常用方法

方法名称说明
permitAll() 永远返回 true
denyAll() 永远返回 false
anonymous() 当前用户是 anonymous 时返回 true
rememberMe() 当前用户是 rememberMe 用户时返回 true
authenticated() 当前用户不是 anonymous 时返回 true
fullAuthenticated() 当前用户既不是 anonymous 也不是 rememberMe 用户时返回 true
hasRole(“role”) 用户拥有指定的角色时返回 true
hasAnyRole(“role1”, “role2”) 用户拥有任意一个指定的角色时返回 true
hasAuthority(“authority”) 用户拥有指定的权限时返回 true
hasAnyAuthority(“authority1”, “authority2”) 用户拥有任意一个指定的权限时返回 true
hasIpAddress (“127.0.0.1”) 请求来源的 IP 匹配时返回 true

基本原理

Spring Security 的本质是一个过滤器链，从应用启动的过程里获取到的过滤器链如下：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
org.springframework.security.web.context.request.async.WebAsyncManagerIntegrationFilter
org.springframework.security.web.context.SecurityContextPersistenceFilter
org.springframework.security.web.header.HeaderWriterFilter
org.springframework.security.web.csrf.CsrfFilter
org.springframework.security.web.authentication.logout.LogoutFilter
org.springframework.security.web.authentication.UsernamePasswordAuthenticationFilter
org.springframework.security.web.authentication.ui.DefaultLoginPageGeneratingFilter
org.springframework.security.web.authentication.ui.DefaultLogoutPageGeneratingFilter
org.springframework.security.web.savedrequest.RequestCacheAwareFilter
org.springframework.security.web.servletapi.SecurityContextHolderAwareRequestFilter
org.springframework.security.web.authentication.AnonymousAuthenticationFilter
org.springframework.security.web.session.SessionManagementFilter
org.springframework.security.web.access.ExceptionTranslationFilter
org.springframework.security.web.access.intercept.FilterSecurityInterceptor

底层的三个基础过滤器：

  • FilterSecurityInterceptor：是一个方法级的权限过滤器，基本位于过滤链的最底部。
  • ExceptionTranslationFilter：是个异常过滤器，用来处理在认证授权过程中抛出的异常。
  • UsernamePasswordAuthenticationFilter：针对 /login 的 POST 请求做拦截，校验登录表单中的用户名和密码。

过滤器加载过程涉及的核心类：

  • DelegatingFilterProxy
  • FilterChainProxy

两个重要接口

UserDetailsService 接口

当什么也没有配置的时候，登录的账号和密码是由 Spring Security 定义生成的，而在实际项目中账号和密码都是从数据库中查询出来的，所以一般需要通过自定义逻辑控制身份认证。如果有自定义逻辑的需求时，只需要实现 UserDetailsService 接口即可。

  • UserDetailsService 接口的源码
1
2
3
4
5
public interface UserDetailsService {

	UserDetails loadUserByUsername(String username) throws UsernameNotFoundException;

}
  • UserDetails 接口的源码
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
public interface UserDetails extends Serializable {

	Collection<? extends GrantedAuthority> getAuthorities();

	String getPassword();

	String getUsername();

	boolean isAccountNonExpired();

	boolean isAccountNonLocked();

	boolean isCredentialsNonExpired();

	boolean isEnabled();
}

以下是 UserDetails 接口的实现类，一般只需要使用 User 这个实体类即可

  • UserDetails 类的源码
1
2
3
4
5
6
7
8
9
10
11
public class User implements UserDetails, CredentialsContainer {

	private String password;
	private final String username;
	private final Set<GrantedAuthority> authorities;
	private final boolean accountNonExpired;
	private final boolean accountNonLocked;
	private final boolean credentialsNonExpired;
	private final boolean enabled;

}

User 类的 username 属性表示用户名，它的值是前端表单传递过来的数据。默认情况下必须叫 username，否则 Spring Security 无法接收到对应的参数值。

PasswordEncoder 接口

如果需要自定义登录密码的解析方式，只需要实现 PasswordEncoder 接口即可。

  • PasswordEncoder 接口的源码
1
2
3
4
5
6
7
8
9
10
11
public interface PasswordEncoder {

	String encode(CharSequence rawPassword);

	boolean matches(CharSequence rawPassword, String encodedPassword);

	default boolean upgradeEncoding(String encodedPassword) {
		return false;
	}

}
  • encode()：表示把参数按照特定的解析规则进行解析
  • upgradeEncoding()：表示如果解析的密码能够再次进行解析，且达到更安全的结果则返回 true， 否则返回 false，默认返回 false
  • matches()：表示验证从存储中获取的编码密码与编码后提交的原始密码是否匹配。如果密码匹配，则返回 true； 如果不匹配，则返回 false。第一个参数表示需要被解析的密码，第二个参数表示存储的密码

以下是 PasswordEncoder 接口的实现类，一般只需要使用 BCryptPasswordEncoder 这个类即可

BCryptPasswordEncoder 是 Spring Security 官方默认使用的密码解析器，平时推荐使用这个解析器。BCryptPasswordEncoder 是对 Bcrypt 强散列方法的具体实现，是基于 Hash 算法实现的单向加密，可以通过 strength 参数控制加密强度，默认 10。