自动登录是将用户的登录信息保存在用户浏览器的 cookie 中,当用户下次访问时,自动实现校验并建立登录态的一种机制。
Spring Security 提供了两种非常好的令牌:

  • 散列算法加密用户必要的登录信息并生成令牌
  • 数据库等持久性数据存储机制用的持久化令牌
    (三)Spring Security rememberMe实现自动登录 - 图1
    (三)Spring Security rememberMe实现自动登录 - 图2

散列加密方案

在 Spring Security 中加入自动登录的功能非常简单:

  1. @Override
  2. protected void configure(HttpSecurity http) throws Exception {
  3. http.authorizeRequests()
  4. .antMatchers("/api/user/**").hasRole("user") //user 角色访问/api/user/开头的路由
  5. .antMatchers("/api/admin/**").hasRole("admin") //admin 角色访问/api/admin/开头的路由
  6. .antMatchers("/api/public/**").permitAll() //允许所有可以访问/api/public/开头的路由
  7. .and()
  8. .formLogin()
  9. .and()
  10. .rememberMe().userDetailsService(userDetailsService()); //记住密码
  11. }

重启服务后访问受限 API,这次在表单登录页中多了一个可选框:

(三)Spring Security rememberMe实现自动登录 - 图3
勾选 “Remember me on this computer” 可选框(简写为 Remember-me),按照正常的流程登录,并在开发者工具中查看浏览器 cookie,可以看到除 JSESSIONID 外多了一个值:
(三)Spring Security rememberMe实现自动登录 - 图4

这是 Spring Security 默认自动登录的 cookie 字段。在不配置的情况下,过期时间是两个星期:
(三)Spring Security rememberMe实现自动登录 - 图5

Spring Security 会在每次表单登录成功之后更新此令牌,具体处理方式在源码中:

(三)Spring Security rememberMe实现自动登录 - 图6
(三)Spring Security rememberMe实现自动登录 - 图7
RememberConfigurer:
(三)Spring Security rememberMe实现自动登录 - 图8

(三)Spring Security rememberMe实现自动登录 - 图9

持久化令牌方案

在持久化令牌方案中,最核心的是 series 和 token 两个值,它们都是用 MD5 散列过的随机字符串。不同的是,series 仅在用户使用密码重新登录时更新,而 token 会在每一个新的 session 中都重新生成。
解决了散列加密方案中一个令牌可以同时在多端登录的问题。每个会话都会引发 token 的更
新,即每个 token 仅支持单实例登录。
自动登录不会导致 series 变更,而每次自动登录都需要同时验证 series 和 token 两个值,当该
令牌还未使用过自动登录就被盗取时,系统会在非法用户验证通过后刷新 token 值,此时在合法用户
的浏览器中,该 token 值已经失效。当合法用户使用自动登录时,由于该 series 对应的 token 不同,系统
可以推断该令牌可能已被盗用,从而做一些处理。例如,清理该用户的所有自动登录令牌,并通知该
用户可能已被盗号等
Spring Security 使用 PersistentRememberMeToken 来表明一个验证实体:

  1. public class PersistentRememberMeToken {
  2. private final String username;
  3. private final String series;
  4. private final String tokenValue;
  5. private final Date date;
  6. public PersistentRememberMeToken(String username, String series, String tokenValue, Date date) {
  7. this.username = username;
  8. this.series = series;
  9. this.tokenValue = tokenValue;
  10. this.date = date;
  11. }
  12. public String getUsername() {
  13. return this.username;
  14. }
  15. public String getSeries() {
  16. return this.series;
  17. }
  18. public String getTokenValue() {
  19. return this.tokenValue;
  20. }
  21. public Date getDate() {
  22. return this.date;
  23. }
  24. }

需要使用持久化令牌方案, 需要传入 PersistentTokenRepository 的实例:
(三)Spring Security rememberMe实现自动登录 - 图10

PersistentTokenRepository 接口主要涉及 token 的增删查改四个接口:
(三)Spring Security rememberMe实现自动登录 - 图11

MyPersistentTokenRepositoryImpl 使我们实现 PersistentTokenRepository 接口:

  1. @Service
  2. public class MyPersistentTokenRepositoryImpl implements PersistentTokenRepository {
  3. @Autowired
  4. private JPAPersistentTokenRepository repository;
  5. @Override
  6. public void createNewToken(PersistentRememberMeToken persistentRememberMeToken) {
  7. MyPersistentToken myPersistentToken = new MyPersistentToken();
  8. myPersistentToken.setSeries(persistentRememberMeToken.getSeries());
  9. myPersistentToken.setUsername(persistentRememberMeToken.getUsername());
  10. myPersistentToken.setTokenValue(persistentRememberMeToken.getTokenValue());
  11. myPersistentToken.setUser_last(persistentRememberMeToken.getDate());
  12. repository.save(myPersistentToken);
  13. }
  14. @Override
  15. public void updateToken(String series, String tokenValue, Date lastUsed) {
  16. MyPersistentToken myPersistentToken = repository.findBySeries(series);
  17. myPersistentToken.setUser_last(lastUsed);
  18. myPersistentToken.setTokenValue(tokenValue);
  19. repository.save(myPersistentToken);
  20. }
  21. @Override
  22. public PersistentRememberMeToken getTokenForSeries(String series) {
  23. MyPersistentToken myPersistentToken = repository.findBySeries(series);
  24. PersistentRememberMeToken persistentRememberMeToken = new PersistentRememberMeToken(myPersistentToken.getUsername(), myPersistentToken.getSeries(), myPersistentToken.getTokenValue(), myPersistentToken.getUser_last());
  25. return persistentRememberMeToken;
  26. }
  27. @Override
  28. @Transactional
  29. public void removeUserTokens(String username) {
  30. repository.deleteByUsername(username);
  31. }
  32. }
  1. public interface JPAPersistentTokenRepository extends JpaRepository<MyPersistentToken,Long> {
  2. MyPersistentToken findBySeries(String series);
  3. void deleteByUsername(String username);
  4. }
  1. @Entity
  2. @Table(name = "persistent_token")
  3. public class MyPersistentToken {
  4. @Id
  5. @GeneratedValue(strategy = GenerationType.SEQUENCE)
  6. private Long id;
  7. private String username;
  8. @Column(unique = true)
  9. private String series;
  10. private String tokenValue;
  11. private Date user_last;
  12. public Long getId() {
  13. return id;
  14. }
  15. public void setId(Long id) {
  16. this.id = id;
  17. }
  18. public String getUsername() {
  19. return username;
  20. }
  21. public void setUsername(String username) {
  22. this.username = username;
  23. }
  24. public String getSeries() {
  25. return series;
  26. }
  27. public void setSeries(String series) {
  28. this.series = series;
  29. }
  30. public String getTokenValue() {
  31. return tokenValue;
  32. }
  33. public void setTokenValue(String tokenValue) {
  34. this.tokenValue = tokenValue;
  35. }
  36. public Date getUser_last() {
  37. return user_last;
  38. }
  39. public void setUser_last(Date user_last) {
  40. this.user_last = user_last;
  41. }
  42. }

当自动登录认证时,Spring Security 通过 series 获取用户名、token 以及上一次自动登录时间三个信息,通过用户名确认该令牌的身份,通过对比 token 获知该令牌是否有效,通过上一次自动登录时间获知该令牌是否已过期,并在完整校验通过之后生成新的 token。