SpringBoot-SpringSecurity

SpringSecurity官网:https://spring.io/projects/spring-security

帮助文档:https://docs.spring.io/spring-security/site/docs/5.3.0.RELEASE/reference/html5

1. SpringSecurity概述

Spring Security是一个能够为基于Spring的企业应用系统提供声明式的安全访问控制解决方案的安全框架。它提供了一组可以在Spring应用上下文中配置的Bean,充分利用了Spring IoC,DI(控制反转Inversion of Control ,DI:Dependency Injection 依赖注入)和AOP(面向切面编程)功能,为应用系统提供声明式的安全访问控制功能,减少了为企业系统安全控制编写大量重复代码的工作。

Spring Security 是针对Spring项目的安全框架,也是Spring Boot底层安全模块默认的技术选型,他可以实现强大的Web安全控制,对于安全控制,仅需要引入 spring-boot-starter-security 模块,进行少量的配置,即可实现强大的安全管理。

三个常用类:

  • WebSecurityConfigurerAdapter:自定义Security策略
  • AuthenticationManagerBuilder:自定义认证策略
  • @EnableWebSecurity:开启WebSecurity模式

Spring Security的两个主要目标是 “认证” 和 “授权”(访问控制)。

“认证”(Authentication)

身份验证是关于验证您的凭据,如用户名/用户ID和密码,以验证您的身份。

身份验证通常通过用户名和密码完成,有时与身份验证因素结合使用。

“授权” (Authorization)

授权发生在系统成功验证您的身份后,最终会授予您访问资源(如信息,文件,数据库,资金,位置,几乎任何内容)的完全权限。

这个概念是通用的,而不是只在Spring Security 中存在。

2. 环境搭建

  1. 新建一个初始的springboot项目,导入web模块、thymeleaf模块

  2. 导入静态资源

  3. 编写controller,实现页面跳转

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    import org.springframework.stereotype.Controller;
    import org.springframework.web.bind.annotation.PathVariable;
    import org.springframework.web.bind.annotation.RequestMapping;

    @Controller
    public class RouterController {

    @RequestMapping({"/","/index"})
    public String index(){
    return "index";
    }

    @RequestMapping("/toLogin")
    public String toLogin(){
    return "views/login";
    }

    @RequestMapping("/level1/{id}")
    public String level1(@PathVariable("id") int id){
    return "views/level1/"+id;
    }

    @RequestMapping("/level2/{id}")
    public String level2(@PathVariable("id") int id){
    return "views/level2/"+id;
    }

    @RequestMapping("/level3/{id}")
    public String level3(@PathVariable("id") int id){
    return "views/level3/"+id;
    }

    }
  4. 测试环境是否成功

3. 用户认证和授权

测试环境是谁都可以访问的,使用 Spring Security 增加上认证和授权的功能

实现步骤:

  1. 引入 Spring Security 模块

    1
    2
    3
    4
    <dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-security</artifactId>
    </dependency>
  2. 编写 Spring Security 配置类

  3. 编写基础配置类

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    import org.springframework.security.config.annotation.web.builders.HttpSecurity;
    import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
    import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;

    @EnableWebSecurity // 开启WebSecurity模式
    public class SecurityConfig extends WebSecurityConfigurerAdapter {

    @Override
    protected void configure(HttpSecurity http) throws Exception {

    }
    }
  4. 定制请求的授权规则

    1
    2
    3
    4
    5
    6
    7
    8
    9
    @Override
    protected void configure(HttpSecurity http) throws Exception {
    // 定制请求的授权规则
    // 首页所有人可以访问
    http.authorizeRequests().antMatchers("/").permitAll()
    .antMatchers("/level1/**").hasRole("vip1")
    .antMatchers("/level2/**").hasRole("vip2")
    .antMatchers("/level3/**").hasRole("vip3");
    }
  5. 测试:除了首页都进不去了,因为目前没有登录的角色,请求需要登录的角色拥有对应的权限才可以

  6. 在configure()方法中加入以下配置,开启自动配置的登录功能

    1
    2
    3
    4
    // 开启自动配置的登录功能
    // /login 请求来到登录页
    // /login?error 重定向到这里表示登录失败
    http.formLogin();
  7. 测试:发现没有权限的时候,会跳转到登录的页面

  8. 定义认证规则

    重写configure(AuthenticationManagerBuilder auth)方法

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    //定义认证规则
    @Override
    protected void configure(AuthenticationManagerBuilder auth) throws Exception {

    //在内存中定义,也可以在jdbc中去拿....
    auth.inMemoryAuthentication()
    .withUser("kuangshen").password("123456").roles("vip2","vip3")
    .and()
    .withUser("root").password("123456").roles("vip1","vip2","vip3")
    .and()
    .withUser("guest").password("123456").roles("vip1","vip2");
    }
  9. 测试

    使用这些账号登录会报错:There is no PasswordEncoder mapped for the id “null”

  10. 密码加密

    报错原因:要将前端传过来的密码进行某种方式加密,否则就无法登录

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    //定义认证规则
    @Override
    protected void configure(AuthenticationManagerBuilder auth) throws Exception {
    //在内存中定义,也可以在jdbc中去拿....
    //Spring security 5.0中新增了多种加密方式,也改变了密码的格式。
    //要想我们的项目还能够正常登陆,需要修改一下configure中的代码。我们要将前端传过来的密码进行某种方式加密
    //spring security 官方推荐的是使用bcrypt加密方式。

    auth.inMemoryAuthentication().passwordEncoder(new BCryptPasswordEncoder())
    .withUser("kuangshen").password(new BCryptPasswordEncoder().encode("123456")).roles("vip2","vip3")
    .and()
    .withUser("root").password(new BCryptPasswordEncoder().encode("123456")).roles("vip1","vip2","vip3")
    .and()
    .withUser("guest").password(new BCryptPasswordEncoder().encode("123456")).roles("vip1","vip2");
    }
  11. 测试

    登录成功,并且每个角色只能访问自己认证下的规则

4. 注销和权限控制

4.1 注销

实现步骤:

  1. 开启自动配置的注销的功能

    1
    2
    3
    4
    5
    6
    7
    8
    //定制请求的授权规则
    @Override
    protected void configure(HttpSecurity http) throws Exception {
    //....
    //开启自动配置的注销的功能
    // /logout 注销请求
    http.logout();
    }
  2. 在前端index.html 导航栏中增加一个注销的按钮

    1
    2
    3
    <a class="item" th:href="@{/logout}">
    <i class="address card icon"></i> 注销
    </a>
  3. 测试

    登录成功后点击注销,发现注销完毕会跳转到登录页面

    想实现注销后跳转首页功能

  4. 注销后跳转首页

    1
    2
    // .logoutSuccessUrl("/"); 注销成功来到首页
    http.logout().logoutSuccessUrl("/");
  5. 测试成功,注销后跳转首页

4.2 权限控制

需求:用户没有登录的时候,导航栏上只显示登录按钮,用户登录之后,导航栏可以显示登录的用户信息及注销按钮。

实现步骤:

  1. 导入依赖

    需要结合thymeleaf中的一些功能

    sec:authorize=”isAuthenticated()”:判断是否认证登录来显示不同的页面

    导入依赖:

    1
    2
    3
    4
    5
    6
    <!-- https://mvnrepository.com/artifact/org.thymeleaf.extras/thymeleaf-extras-springsecurity4 -->
    <dependency>
    <groupId>org.thymeleaf.extras</groupId>
    <artifactId>thymeleaf-extras-springsecurity5</artifactId>
    <version>3.0.4.RELEASE</version>
    </dependency>
  2. 修改前端页面

    导入命名空间:

    1
    xmlns:sec="http://www.thymeleaf.org/thymeleaf-extras-springsecurity5"

    修改导航栏,增加认证判断

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    <!--登录注销-->
    <div class="right menu">

    <!--如果未登录-->
    <div sec:authorize="!isAuthenticated()">
    <a class="item" th:href="@{/login}">
    <i class="address card icon"></i> 登录
    </a>
    </div>

    <!--如果已登录-->
    <div sec:authorize="isAuthenticated()">
    <a class="item">
    <i class="address card icon"></i>
    用户名:<span sec:authentication="principal.username"></span>
    角色:<span sec:authentication="principal.authorities"></span>
    </a>
    </div>

    <div sec:authorize="isAuthenticated()">
    <a class="item" th:href="@{/logout}">
    <i class="address card icon"></i> 注销
    </a>
    </div>
    </div>
  3. 测试成功

  4. 解决安全问题

    如果注销404了,就是因为它默认防止csrf跨站请求伪造,因为会产生安全问题,我们可以将请求改为post表单提交,或者在spring security中关闭csrf功能。

    在配置中增加 http.csrf().disable();

    1
    2
    http.csrf().disable();//关闭csrf功能:跨站请求伪造,默认只能通过post方式提交logout请求
    http.logout().logoutSuccessUrl("/");
  5. 实现角色功能块认证

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    <!-- sec:authorize="hasRole('vip1')" -->
    <div class="column" sec:authorize="hasRole('vip1')">
    <div class="ui raised segment">
    <div class="ui">
    <div class="content">
    <h5 class="content">Level 1</h5>
    <hr>
    <div><a th:href="@{/level1/1}"><i class="bullhorn icon"></i> Level-1-1</a></div>
    <div><a th:href="@{/level1/2}"><i class="bullhorn icon"></i> Level-1-2</a></div>
    <div><a th:href="@{/level1/3}"><i class="bullhorn icon"></i> Level-1-3</a></div>
    </div>
    </div>
    </div>
    </div>

    <div class="column" sec:authorize="hasRole('vip2')">
    <div class="ui raised segment">
    <div class="ui">
    <div class="content">
    <h5 class="content">Level 2</h5>
    <hr>
    <div><a th:href="@{/level2/1}"><i class="bullhorn icon"></i> Level-2-1</a></div>
    <div><a th:href="@{/level2/2}"><i class="bullhorn icon"></i> Level-2-2</a></div>
    <div><a th:href="@{/level2/3}"><i class="bullhorn icon"></i> Level-2-3</a></div>
    </div>
    </div>
    </div>
    </div>

    <div class="column" sec:authorize="hasRole('vip3')">
    <div class="ui raised segment">
    <div class="ui">
    <div class="content">
    <h5 class="content">Level 3</h5>
    <hr>
    <div><a th:href="@{/level3/1}"><i class="bullhorn icon"></i> Level-3-1</a></div>
    <div><a th:href="@{/level3/2}"><i class="bullhorn icon"></i> Level-3-2</a></div>
    <div><a th:href="@{/level3/3}"><i class="bullhorn icon"></i> Level-3-3</a></div>
    </div>
    </div>
    </div>
    </div>
  6. 测试

    测试成功,实现了权限控制

5. 记住我及首页定制

5.1 记住我

需求:让网站实现记住用户和密码的功能

实现步骤:

  1. 开启记住我功能

    1
    2
    3
    4
    5
    6
    //定制请求的授权规则
    @Override
    protected void configure(HttpSecurity http) throws Exception {
    //记住我
    http.rememberMe();
    }
  2. 测试

    登录页多了一个记住我功能,我们登录之后关闭浏览器,然后重新打开浏览器访问,发现用户依旧存在。

    实现原理:SpringSecurity保存了浏览器的cookie;点击注销的时候,可以发现 SpringSecurity 自动删除了浏览器中的这个 cookie

    结论:网站登录成功后,将cookie发送给浏览器保存,以后登录带上这个cookie,只要通过检查就可以免登录了。如果点击注销,则会删除这个cookie。

5.2 首页定制

需求:网站登录页面都是SpringSecurity 默认的,需要实现自定义的 login 页面

实现步骤:

  1. 在刚才的登录页配置后面指定 loginpage

    1
    http.formLogin().loginPage("/toLogin");
  2. 前端指向自定义的 login 请求

    1
    2
    3
    <a class="item" th:href="@{/toLogin}">
    <i class="address card icon"></i> 登录
    </a>
  3. 配置提交请求及方式

    需要将这些信息发送到哪里也需要配置,login.html 配置提交请求及方式,方式必须为post。

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    <form th:action="@{/login}" method="post">
    <div class="field">
    <label>Username</label>
    <div class="ui left icon input">
    <input type="text" placeholder="Username" name="username">
    <i class="user icon"></i>
    </div>
    </div>
    <div class="field">
    <label>Password</label>
    <div class="ui left icon input">
    <input type="password" name="password">
    <i class="lock icon"></i>
    </div>
    </div>
    <input type="submit" class="ui blue submit button"/>
    </form>
  4. 验证处理

    请求提交上来还需要验证处理,可以查看formLogin()方法的源码配置接收登录的用户名和密码的参数

    1
    2
    3
    4
    5
    http.formLogin()
    .usernameParameter("username")
    .passwordParameter("password")
    .loginPage("/toLogin")
    .loginProcessingUrl("/login"); // 登陆表单提交请求
  5. 在登录页增加记住我的多选框

    1
    <input type="checkbox" name="remember"> 记住我
  6. 后端验证处理

    1
    2
    //定制记住我的参数!
    http.rememberMe().rememberMeParameter("remember");
  7. 测试

6. 完整配置代码

SecurityConfig.java

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
package com.study.config;

import org.springframework.security.config.annotation.authentication.builders.AuthenticationManagerBuilder;
import org.springframework.security.config.annotation.web.builders.HttpSecurity;
import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;
import org.springframework.security.crypto.bcrypt.BCryptPasswordEncoder;

@EnableWebSecurity
public class SecurityConfig extends WebSecurityConfigurerAdapter {

//定制请求的授权规则
@Override
protected void configure(HttpSecurity http) throws Exception {

http.authorizeRequests().antMatchers("/").permitAll()
.antMatchers("/level1/**").hasRole("vip1")
.antMatchers("/level2/**").hasRole("vip2")
.antMatchers("/level3/**").hasRole("vip3");


//开启自动配置的登录功能:如果没有权限,就会跳转到登录页面!
// /login 请求来到登录页
// /login?error 重定向到这里表示登录失败
http.formLogin()
.usernameParameter("username")
.passwordParameter("password")
.loginPage("/toLogin")
.loginProcessingUrl("/login"); // 登陆表单提交请求

//开启自动配置的注销的功能
// /logout 注销请求
// .logoutSuccessUrl("/"); 注销成功来到首页

http.csrf().disable();//关闭csrf功能:跨站请求伪造,默认只能通过post方式提交logout请求
http.logout().logoutSuccessUrl("/");

//记住我
http.rememberMe().rememberMeParameter("remember");
}

//定义认证规则
@Override
protected void configure(AuthenticationManagerBuilder auth) throws Exception {
//在内存中定义,也可以在jdbc中去拿....
//Spring security 5.0中新增了多种加密方式,也改变了密码的格式。
//要想我们的项目还能够正常登陆,需要修改一下configure中的代码。我们要将前端传过来的密码进行某种方式加密
//spring security 官方推荐的是使用bcrypt加密方式。

auth.inMemoryAuthentication().passwordEncoder(new BCryptPasswordEncoder())
.withUser("kuangshen").password(new BCryptPasswordEncoder().encode("123456")).roles("vip2","vip3")
.and()
.withUser("root").password(new BCryptPasswordEncoder().encode("123456")).roles("vip1","vip2","vip3")
.and()
.withUser("guest").password(new BCryptPasswordEncoder().encode("123456")).roles("vip1","vip2");
}
}

SpringBoot-SpringSecurity
https://yiqiangshiyia.cn/2022/10/17/SpringBoot-SpringSecurity/
作者
一腔诗意啊
发布于
2022年10月17日
许可协议