一、Spring Security引入
Spring Security 是一个功能强大且高度可定制的身份验证和访问控制(认证和授权)框架。它是保护基于 Spring 应用程序的事实标准。
2. 认证授权
-
认证授权实现平台所有用户的身份认证与用户授权功能。
2.1 什么是用户认证
-
认证:Authentication
验证某个用户能否访问该系统。一般要求用户提供用户名和密码,手机号验证码等,系统通过校验来完成认证过程。
2.2 什么是用户授权
-
授权:Authorization
用户认证通过后去访问系统的资源,系统会判断用户是否拥有访问资源的权限,只允许访问有权限的系统资源,没有权限的资源将无法访问。
3. 常见认证方式
3.1 Http basic 认证
http basic auth 通过使用Restful风格开发,每次请求服务器都携带用户名和密码。这种方式使用越来越少,因为不安全。
3.2 Session 认证
会话认证就是为一次请求认证在服务端创建一个Session对象,同时在客户端的浏览器段创建了一个Cookie对象(保存sessionID),通过客户端带上来Cookie对象来与服务器端Session对象匹配实现用户状态管理的。
3.3 Token 认证
使用基于Token的身份验证方法,在服务端不需要存储用户的登录记录。大概流程如下:
客户端使用用户名和密码请求登录
服务端收到请求,去验证用户名与密码
验证成功后,服务器颁发一个Token,再把这个Token发送给客户端
客户端收到Token以后把它存储起来
客户端每次向服务器端请求资源的时候需要带着Token
服务端收到请求,然后去验证客户端请求里面带着的Token,如果验证成功,就向客户端返回请求的数据。
3.4 OAuth2 认证
例如:微信扫码认证,这是一种第三方认证的方式,这种认证方式是基于OAuth2协议实现。
OAUTH协议为用户资源的授权提供了一个安全的、开放而又简易的标准。同时,任何第三方都可以使用OAUTH认证服务,任何服务提供商都可以实现自身的OAUTH认证服务。
二、Spring Security介绍
- 两个主要区域是“认证(authentication)”和“授权(authorization)”。这两点也是Spring Security重要核心功能。
- Spring Security 是一个功能强大且高度可定制的身份验证和访问控制框架,它是一个专注于为 Java 应用程序提供身份验证和授权的框架。
Spring Security项目主页:Spring Security
Spring cloud Security: Spring Cloud Security
三、认证快速入门
1. 引入依赖
<!-- 引入web项目启动器 -->
<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!-- 引入Spring Security启动器 -->
<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-security</artifactId>
</dependency>
2. 创建控制器
@RestController
public class UserController {@RequestMapping("show")public String show(){return "Hello World!";}
}
3. 访问资源
导入spring-boot-starter-security启动器后,Spring Security已经生效,默认拦截全部请求,如果用户没有登录,跳转到内置登录页面。
4. 完成登录
5. 自定义登录用户名和密码
spring:security:user:name: rootpassword: root
四、自定义认证逻辑(重要)
1. UserDetailsService接口
当什么也没有配置的时候,账号和密码是由Spring Security定义生成的,存储在内存中。
而在实际项目中账号和密码都是从数据库中查询出来的。 所以我们需要通过自定义逻辑控制认证(登录)逻辑。
如果需要自定义逻辑时,只需要实现UserDetailsService接口即可。
接口定义如下:
-
默认策略:浏览器发起请求,经过拦截器:
-
没有认证(没有登录),执行UserDetailsService接口实现类InMemoryUserDetailsManager中loadUserByUsername()方法,将输入的用户名和内存中用户名完成比较,用户名比较通过后,再比较输入的密码和内存中的密码。
-
-
如果用户名和密码需要从数据库查询后再完成比较,重写UserDetailsService接口中的loadUserByUsername()方法即可。
-
思路分析:
没有认证(没有登录),执行UserDetailsService接口自定义实现类中loadUserByUsername()方法,根据用户名在数据库中查询数据,查询到了数据,再完成密码的比较。
-
1.2 返回值UserDetails
1.2.1 UserDetails接口
1.2.2 User实现类
- User的全限定路径:
org.springframework.security.core.userdetails.User 此处经常和系统中自己开发的User类弄混。
- 构造方法:
构造方法有两个。三个参数的构造方法实际上也是调用7个参数的构造方法。
3.自定义认证准备
2.1 准备流程
- 创建数据库表。
- 引入mybatis-plus,mysql,Spring Security相关依赖。
- 在配置文件中配置数据源和mybatis-plus相关配置。
- 创建实体类。
- UserServiceImp实现UserDetailsService接口,并重写loadUserByUsername方法。
- 创建配置类。将BCryptPasswordEncoder(实现PasswordEncoder接口 )交由Spring容器管理。
2.2 UserServiceImpl的编写
@Service
public class UserServiceImpl implements UserDetailsService {@Autowiredprivate UserMapper userMapper;/*** @param username 前端登录时提交的用户名* @return 用户的认证信息,要求必须为UserDetails接口的实现类* @throws UsernameNotFoundException 用户名没有找到时的异常*/@Overridepublic UserDetails loadUserByUsername(String username) throws UsernameNotFoundException {LambdaQueryWrapper<User> wrapper = new LambdaQueryWrapper<>();wrapper.eq(User::getUsername, username);User myUser = userMapper.selectOne(wrapper);if (myUser == null){throw new UsernameNotFoundException("用户名不存在");}/** org.springframework.security.core.userdetails.User为UserDetails接口的实现类。* 也可以自定义的User实现UserDetail接口提供对应的属性。* *///参数一:用户名 参数二:密码 参数三:权限(暂时不授权,创建个没有元素集合。不能指定null)ArrayList<GrantedAuthority> list = new ArrayList<>();org.springframework.security.core.userdetails.User user = new org.springframework.security.core.userdetails.User(myUser.getUsername(), myUser.getPassword(), list);return user;}
}
2.3 PasswordEncoder接口实现类
@Configuration
public class SecurityConfig {//密码比较,加密器@Beanpublic PasswordEncoder getPwdEncoder() {return new BCryptPasswordEncoder();}
}
2.PasswordEncoder接口
Spring Security要求容器中必须有PasswordEncoder接口实现类对象。进行密码校验和密码加密。
2.1 介绍
encode() | 将密码进行加密。可以用在注册用户中,将用户提交的密码加密后再存储到数据库中。 |
matches() | 用户登录时,将新提交的密码进行加密,加密后和数据库中存储的已经加密的密码进行校验。密码匹配,返回true;不匹配,返回false。 第1个参数:新提交的密码。第2个参数:数据库中存储的已经加密的密码。 |
upgradeEncoding() | 用于判断是否需要对密码进行再次加密,以使得密码更加安全, 默认:false不需要。 |
2.2 接口实现类
Spring security中有多种实现类完成密码加密:
- MD5算法的Md5PasswordEncoder(不再被广泛使用 )。
- SHA 算法的ShaPasswordEncoder。
- BCrypt算法的BCryptPasswordEncoder。BCryptPasswordEncoder是Spring Security官方推荐的密码解析器
2.3 实现类BCryptPasswordEncoder
@SpringBootTest
class SpringsecurityApplicationTests {@Testvoid contextLoads() {BCryptPasswordEncoder bpe = new BCryptPasswordEncoder();String encode = bpe.encode("123456");System.out.println(encode); boolean matches = bpe.matches("123456", encode);System.out.println(matches); }
}
2.4创建配置类
-
创建配置类,将BCryptPasswordEncoder交由Spring容器管理。
@Configuration
public class SecurityConfig {//密码比较,加密器@Beanpublic PasswordEncoder getPwdEncoder() {return new BCryptPasswordEncoder();}
}
五、自定义登录页面(重点)
1. 创建登录页面
pring Security中不仅仅提供了登录页面,还支持用户自定义登录页面。
2. 修改配置类
-
修改过滤器链中的配置
-
请求授权设置
-
login.html 没有认证,可以被访问
-
其它请求没有认证,不可以被访问
-
-
自定义的登录的请求能够被拦截
-
登录请求被拦截后,Spring Security会获取登录请求的用户名和密码,获取后调用自定义UserDetailsService接口实现类UserServiceImpl,从数据库中根据获取的用户名进行查询和后续的密码校验。
-
注意:此过程不经过控制器。
-
设置登录页面的访问路径
-
设置登录请求的访问路径
-
也可以设置登录成功后请求的资源
-
也可以设置登录失败后请求的资源
-
-
自定义登录请求需要关闭CSRF。
@Configuration
public class SecurityConfig {//滤器链的相关设置@Beanpublic SecurityFilterChain filterChain(HttpSecurity http) throws Exception {//请求授权设置。/** antMatchers():对指定的请求url进行控制* permitAll():允许访问* anyRequest():任意一个请求url的控制* authenticated():认证后便可以访问* */http.authorizeRequests().antMatchers("/login.html").permitAll() //login.html不需要被认证.anyRequest().authenticated(); //其它任意的请求都必须被认证,必须认证(登录成功)后就可以直接访问//Form表单提交请求的处理。(可以为传统form表单提交,ajax提交)http.formLogin().loginPage("/login.html") //登录页面对应的地址,退出登录功能时会使用.loginProcessingUrl("/user/login") //登录的url,SpringSecurity会拦截该请求,执行登录的处理.successForwardUrl("/user/ok") //登录成功跳转的资源。默认只接收post请求.failureForwardUrl("/user/err"); //登录失败跳转的资源.usernameParameter("uname") //自定义用户名参数名.passwordParameter("pwd"); //自定义密码参数名//关闭csrf防护http.csrf().disable();return http.build();}//密码比较,加密器@Beanpublic PasswordEncoder getPwdEncoder() {return new BCryptPasswordEncoder();}
}
六、认证流程源码分析
1. UsernamePasswordAuthenticationFilter
-
用户提交登录请求后执行UsernamePasswordAuthenticationFilter
2 . AuthenticationManager
-
ProviderManager为AuthenticationManager接口的实现类实现了authenticate方法
3. DaoAuthenticationProvider
-
调用父类AbstractUserDetailsAuthenticationProvider中的authenticate方法
-
接收到UserDetails接口实现类User对象后,继续进行相关验证
-
认证通过后会调用createSuccessAuthentication方法,在该方法中new 了一个 UsernamePasswordAuthenticationToken,因为到这里认证已经通过了,所以将 authorities(授权数据) 注入进去,并设置 authenticated 为 true,已经被认证。
4. AbstractAuthenticationProcessingFilter
5. 流程总结
用户在浏览器中随意输入一个URL。
Spring Security 会判断当前是否已经被认证(登录)如果已经认证,正常访问URL。如果没有被认证跳转到loginPage()对应的URL中,显示登录页面。
用户输入用户名和密码点击登录按钮后,发起请求。
如果url和loginProcessingUrl()一样才执行登录流程。否则需要重新认证。
执行登录流程时首先被UsernamePasswordAuthenticationFilter进行过滤,取出用户名和密码,放入到容器(UsernamePasswordAuthenticationToken)中。根据usernameParameter和passwordParameter获取用户名和密码,如果没有配置这两个方法,默认为请求参数名username和password,把UsernamePasswordAuthenticationToken 交给 AuthenticationManager对象进行匹配管理,在当前方法中会进行认证方式匹配(AuthenticationProvider )
我们使用表单是AbstractUserDetailsAuthenticationProvider,再次调用retrieveUser()执行自定义登录逻辑UserDetailsService的实现类。返回数据库中保存当前用户信息,然后调用三次检查方法
preAuthenticationChecks.check(user);(账号是否锁定,账号是否启用,账号是否过期)
additionalAuthenticationChecks(user,authentication);(密码是否为null,密码是否正确)
postAuthenticationChecks.check(user);(密码是否过期)
经过AbstractAuthenticationProcessingFilter中doFliter()进行跳转:
登录成功,执行onAuthenticationSuccess方法,重定向到指定的资源。
通过session存储用户的认证信息。一个客户端会分配一个线程,在seesion中存储时为了保证线程安全,使用ThreadLocal存储认证信息。
ThreadLocal:
存储在ThreadLocal中的数据可以保证线程安全。
登录失败,执行onAuthenticationFailure方法,请求转发到指定的资源。
注意:如果没有配置成功和失败转发URL,会跳转到用户访问的URL。
七、退出登录
1. 创建退出登录
-
退出登录的请求路径为logout,会被过滤器拦截,拦截后会跳转到登录页面。
<!DOCTYPE html>
<html lang="en">
<head><meta charset="UTF-8"><title>Title</title>
</head>
<body><a href="/logout">退出登录</a>
</body>
</html>
2. 设置退出登录
-
注意:退出登录后会清除认证信息,只有配置了放行的资源才能够跳转。
//退出登录相关自定义(可以不用定义)
http.logout().logoutUrl("/mylogout") //自定义退出访问的路径.logoutSuccessUrl("/user/login.html"); //自定义退出成功后跳转的资源
3. logout流程源码分析
八、Remember Me
-
Spring Security 中Remember Me为 "记住我" 功能,Spring Security会自动把用户信息存储到数据源中,以后就可以不登录进行访问。
-
用户只需要在登录表单中添加复选框,并且name="remember-me" value="true"。
1. 修改登录页面
<!DOCTYPE html>
<html lang="en">
<head><meta charset="UTF-8"><title>Title</title>
</head>
<body>
<form action="user/login" method="post">用户名:<input type="text" name="uname"> <br>密码:<input type="text" name="pwd"> <br>记住我:<input type="checkbox" name="remember-me" value="true"> <br><input type="submit">
</form>
</body>
</html>
2. 添加配置类
@Configuration
public class RememberMeConfig {@Autowiredprivate DataSource dataSource;@Beanpublic PersistentTokenRepository getPersistentTokenRepository() {JdbcTokenRepositoryImpl jdbcTokenRepositoryImpl=new JdbcTokenRepositoryImpl();jdbcTokenRepositoryImpl.setDataSource(dataSource);// 自动建表,第一次启动时需要,第二次启动时注释掉//jdbcTokenRepositoryImpl.setCreateTableOnStartup(true);return jdbcTokenRepositoryImpl;}
}
3. 修改SecurityConfig配置类
@Configuration
public class SecurityConfig {//注入UserDetailsService@Autowiredprivate UserDetailsService userDetailsService;//滤器链的相关设置@Bean //新添加,令牌库public SecurityFilterChain filterChain(HttpSecurity http, PersistentTokenRepository tokenRepository) throws Exception {// 其它配置需要添加 ...//remember Mehttp.rememberMe()// .tokenValiditySeconds(120) //单位:秒。默认2周// .rememberMeCookieDomain("/") //设置cookie的域.tokenRepository(tokenRepository).userDetailsService(userDetailsService);return http.build();}//密码比较,加密器@Beanpublic PasswordEncoder getPwdEncoder() {return new BCryptPasswordEncoder();}
}