diff --git a/README.md b/README.md index 7a21a464..9fbdb4b6 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@

logo

-

Sa-Token v1.28.0

+

Sa-Token v1.29.0

一个轻量级 Java 权限认证框架，让鉴权变得简单、优雅！

@@ -18,13 +18,10 @@ ## 前言： - [在线文档：http://sa-token.dev33.cn/](http://sa-token.dev33.cn/) -- 我们将会尽力讲解每个功能的设计原因、应用场景，用心阅读文档，你学习到的将不止是 `Sa-Token` 框架本身，更是绝大多数场景下权限设计的最佳实践。 - - 注：学习测试请拉取 master 分支，dev 为正在开发的分支，有很多特性并不稳定。 - 开源不易，点个 star 鼓励一下吧！ -- QQ交流群：1群 1002350610 (已满)、**2群 614714762 [点击加入](https://jq.qq.com/?_wv=1027&k=b759RZrL)** ## Sa-Token 介绍 @@ -88,7 +85,6 @@ StpUtil.switchTo(10044); // 将当前会话身份临时切换为其它账号 即使不运行测试，相信您也能意会到绝大多数 API 的用法。 - ## Sa-Token 功能一览 - **登录认证** —— 单端登录、多端登录、同端互斥登录、七天内免登录 @@ -123,7 +119,7 @@ StpUtil.switchTo(10044); // 将当前会话身份临时切换为其它账号 ## Sa-Token-SSO 单点登录 -对于单点登录，网上教程大多以CAS模式为主，其实对于不同的系统架构，实现单点登录的步骤也大为不同，Sa-Token由简入难将其划分为三种模式： +网上的单点登录教程大多以CAS流程为主，其实对于不同的系统架构，实现单点登录的步骤也大为不同，Sa-Token由简入难将其划分为三种模式： | 系统架构 | 采用模式 | 简介 | 文档链接 | | :-------- | :-------- | :-------- | :-------- | @@ -133,34 +129,27 @@ StpUtil.switchTo(10044); // 将当前会话身份临时切换为其它账号 1. 前端同域：就是指多个系统可以部署在同一个主域名之下，比如：`c1.domain.com`、`c2.domain.com`、`c3.domain.com` -2. 后端同Redis：就是指多个系统可以连接同一个Redis，其它的缓存数据中心亦可。PS：这里并不需要把所有项目的数据都放在同一个Redis中，Sa-Token提供了 **`[权限缓存与业务缓存分离]`** 的解决方案，详情戳：[Alone独立Redis插件](http://sa-token.dev33.cn/doc/index.html#/plugin/alone-redis) +2. 后端同Redis：就是指多个系统可以连接同一个Redis。PS：这里并不需要把所有项目的数据都放在同一个Redis中，Sa-Token提供了 **`[权限缓存与业务缓存分离]`** 的解决方案，详情戳：[Alone独立Redis插件](http://sa-token.dev33.cn/doc/index.html#/plugin/alone-redis) 3. 如果既无法做到前端同域，也无法做到后端同Redis，那么只能走模式三，Http请求获取会话（Sa-Token对SSO提供了完整的封装，你只需要按照示例从文档上复制几段代码便可以轻松集成） 4. 技术选型一定要根据系统架构对症下药，切不可胡乱选择 -## Sa-Token-SSO 特性 -1. API简单易用，文档介绍详细，且提供直接可用的集成示例 -2. 支持三种模式，不论是否跨域、是否共享Redis、是否前后端分离，都可以完美解决 -3. 安全性高：内置域名校验、Ticket校验、秘钥校验等，杜绝`Ticket劫持`、`Token窃取`等常见攻击手段（文档讲述攻击原理和防御手段） -4. 不丢参数：笔者曾试验多个单点登录框架，均有参数丢失的情况，比如重定向之前是：`http://a.com?id=1&name=2`，登录成功之后就变成了：`http://a.com?id=1`，Sa-Token-SSO内有专门的算法保证了参数不丢失，登录成功之后原路返回页面 -5. 无缝集成：由于Sa-Token本身就是一个权限认证框架，因此你可以只用一个框架同时解决`权限认证` + `单点登录`问题，让你不再到处搜索：xxx单点登录与xxx权限认证如何整合…… -6. 高可定制：Sa-Token-SSO模块对代码架构侵入性极低，结合Sa-Token本身的路由拦截特性，你可以非常轻松的定制化开发 - - ## Sa-Token-OAuth2.0 授权登录 Sa-OAuth2 模块基于 [RFC-6749 标准](https://tools.ietf.org/html/rfc6749) 编写，通过Sa-OAuth2你可以非常轻松的实现系统的OAuth2.0授权认证 -1. 授权码（Authorization Code）：OAuth2.0标准授权步骤，Server端向Client端下放Code码，Client端再用Code码换取授权Token -2. 隐藏式（Implicit）：无法使用授权码模式时的备用选择，Server端使用URL重定向方式直接将Token下放到Client端页面 -3. 密码式（Password）：Client直接拿着用户的账号密码换取授权Token -4. 客户端凭证（Client Credentials）：Server端针对Client级别的Token，代表应用自身的资源授权 +| 授权模式 | 简介 | +| :-------- | :-------- | +| 授权码（Authorization Code） | OAuth2.0 标准授权步骤，Server 端向 Client 端下放 Code 码，Client 端再用 Code 码换取授权 Token | +| 隐藏式（Implicit） | 无法使用授权码模式时的备用选择，Server 端使用 URL 重定向方式直接将 Token 下放到 Client 端页面 | +| 密码式（Password） | Client直接拿着用户的账号密码换取授权 Token | +| 客户端凭证（Client Credentials）| Server 端针对 Client 级别的 Token，代表应用自身的资源授权 | 详细参考文档：[http://sa-token.dev33.cn/doc/index.html#/oauth2/readme](http://sa-token.dev33.cn/doc/index.html#/oauth2/readme) ## Sa-Token 功能结构图 -![sa-token-js](https://color-test.oss-cn-qingdao.aliyuncs.com/sa-token/x/sa-token-js3.png 's-w') +![sa-token-js](https://color-test.oss-cn-qingdao.aliyuncs.com/sa-token/x/sa-token-js4.png 's-w') ![sa-token-rz](https://color-test.oss-cn-qingdao.aliyuncs.com/sa-token/x/sa-token-rz2.png 's-w') @@ -178,7 +167,7 @@ Sa-OAuth2 模块基于 [RFC-6749 标准](https://tools.ietf.org/html/rfc6749) - **[ dcy-fast ]**：[ 一个基于 SpringBoot + Sa-Token + Mybatis-Plus 的后台管理系统，前端vue-element-admin，并且内置代码生成器](https://gitee.com/dcy421/dcy-fast) -- **[ helio-starters ]**：[ 基于JDK15 + Spring Boot 2.4 + Sa-Token + Mybatis-Plus的单体Boot版脚手架和微服务Cloud版脚手架，带有配套后台管理前端模板及代码生成器](https://gitee.com/uncarbon97/helio-starters) +- **[ helio-starters ]**：[ 单体 Boot 版脚手架 + 微服务 Cloud 版脚手架，带有配套后台管理前端模板及代码生成器](https://gitee.com/uncarbon97/helio-starters) - **[ sa-token-plugin ]**：[Sa-Token第三方插件实现，基于Sa-Token-Core，提供一些与官方不同实现机制的的插件集合，作为Sa-Token开源生态的补充](https://gitee.com/bootx/sa-token-plugin) @@ -186,6 +175,13 @@ Sa-OAuth2 模块基于 [RFC-6749 标准](https://tools.ietf.org/html/rfc6749) - **[ RuoYi-Vue-Plus ]**：[基于 RuoYi-Vue 集成 SaToken + Lombok + Mybatis-Plus + Undertow + knife4j + Hutool + Feign 重写所有原生业务 定期与 RuoYi-Vue 同步](https://gitee.com/JavaLionLi/RuoYi-Vue-Plus/tree/satoken/) +- **[ falser-cloud ]**: [基于 SpringCloud Alibaba + SpringCloud gateway + SpringBoot + Sa-Token + vue-admin-template + Nacos + Rabbit MQ + Redis 的一个后台管理系统，前后端分离，权限管理，菜单管理，数据字典，停车场系统管理等功能](https://gitee.com/falser/falser-cloud) + +- **[ bootx-platform ]**：[集成sa-token和sa-token-plugin并深度定制认证模块，包含多级别数据范围权限、数据自动加解密、数据脱敏、超级查询器、以及支付收单、消息通知等准商用功能的开源免费开发脚手架项目](https://gitee.com/bootx/bootx-platform) + +- **[ QForum-Core ]**：[QForum 论坛系统官方核心，可拓展性强、轻量级、高性能、前后端分离，基于 SpringBoot2 + Sa-Token + Mybatis-Plus](https://github.com/Project-QForum/QForum-Core/) + +- **[ ExciteCMS-Layui ]**：[ExciteCMS 快速开发脚手架：一款后端基于 SpringBoot2 + Sa-Token + Mybatis-Plus，前端基于 Layuimini 的内容管理系统，具备RBAC、日志管理、代码生成等功能，并集成常用的支付、OSS等第三方服务，拥有详细的开发文档](https://gitee.com/ExciteTeam/ExciteCMS-SpringBoot-Layui) 如果您的项目使用了Sa-Token，欢迎提交pr @@ -220,3 +216,4 @@ QQ交流群：1群：1002350610 (已满) 、 (扫码添加微信，备注：sa-token，邀您加入群聊)
+ diff --git a/mvn clean.bat b/mvn clean.bat index 75f25b1a..c266da31 100644 --- a/mvn clean.bat +++ b/mvn clean.bat @@ -75,12 +75,17 @@ call mvn clean cd .. - - - - cd .. +:: test clean + +cd sa-token-test +call mvn clean +cd .. + + + + :: 最后打印 echo; echo; diff --git a/pom.xml b/pom.xml index 33ec99b1..07df68de 100644 --- a/pom.xml +++ b/pom.xml @@ -8,7 +8,7 @@ cn.dev33 sa-token-parent pom - 1.28.0 + 1.29.0 sa-token @@ -21,6 +21,7 @@ sa-token-core sa-token-starter sa-token-plugin + @@ -36,7 +37,7 @@ - 1.28.0 + 1.29.0 1.8 utf-8 utf-8 diff --git a/sa-token-core/pom.xml b/sa-token-core/pom.xml index a8e4c114..c86ac26a 100644 --- a/sa-token-core/pom.xml +++ b/sa-token-core/pom.xml @@ -7,7 +7,7 @@ cn.dev33 sa-token-parent - 1.28.0 + 1.29.0 jar diff --git a/sa-token-core/src/main/java/cn/dev33/satoken/dao/SaTokenDaoDefaultImpl.java b/sa-token-core/src/main/java/cn/dev33/satoken/dao/SaTokenDaoDefaultImpl.java index dc612384..c81c10c0 100644 --- a/sa-token-core/src/main/java/cn/dev33/satoken/dao/SaTokenDaoDefaultImpl.java +++ b/sa-token-core/src/main/java/cn/dev33/satoken/dao/SaTokenDaoDefaultImpl.java @@ -99,7 +99,7 @@ public class SaTokenDaoDefaultImpl implements SaTokenDao { if(getKeyTimeout(key) == SaTokenDao.NOT_VALUE_EXPIRE) { return; } - // 无动作 + dataMap.put(key, object); } @Override diff --git a/sa-token-core/src/main/java/cn/dev33/satoken/secure/BCrypt.java b/sa-token-core/src/main/java/cn/dev33/satoken/secure/BCrypt.java new file mode 100644 index 00000000..2a62d43d --- /dev/null +++ b/sa-token-core/src/main/java/cn/dev33/satoken/secure/BCrypt.java @@ -0,0 +1,533 @@ +package cn.dev33.satoken.secure; + + +import java.nio.charset.StandardCharsets; +import java.security.SecureRandom; + +/** + * BCrypt加密算法实现。由它加密的文件可在所有支持的操作系统和处理器上进行转移。它的口令必须是8至56个字符，并将在内部被转化为448位的密钥。 + *

+ * 此类来自于https://github.com/jeremyh/jBCrypt/ + *

+ * 使用方法如下： + *

+ * {@code + * String pw_hash = BCrypt.hashpw(plain_password, BCrypt.gensalt()); + * } + *

+ * 使用checkpw方法检查被加密的字符串是否与原始字符串匹配： + *

+ * {@code + * BCrypt.checkpw(candidate_password, stored_hash); + * } + *

+ * gensalt方法提供了可选参数 (log_rounds) 来定义加盐多少，也决定了加密的复杂度: + *

+ * {@code + * String strong_salt = BCrypt.gensalt(10); + * String stronger_salt = BCrypt.gensalt(12); + * } + * + * @author Damien Miller + * @since 4.1.1 + */ +public class BCrypt { + // BCrypt parameters + private static final int GENSALT_DEFAULT_LOG2_ROUNDS = 10; + private static final int BCRYPT_SALT_LEN = 16; + + // Blowfish parameters + private static final int BLOWFISH_NUM_ROUNDS = 16; + + // Initial contents of key schedule + private static final int[] P_orig = {0x243f6a88, 0x85a308d3, 0x13198a2e, 0x03707344, 0xa4093822, 0x299f31d0, 0x082efa98, 0xec4e6c89, 0x452821e6, 0x38d01377, 0xbe5466cf, 0x34e90c6c, 0xc0ac29b7, + 0xc97c50dd, 0x3f84d5b5, 0xb5470917, 0x9216d5d9, 0x8979fb1b}; + private static final int[] S_orig = {0xd1310ba6, 0x98dfb5ac, 0x2ffd72db, 0xd01adfb7, 0xb8e1afed, 0x6a267e96, 0xba7c9045, 0xf12c7f99, 0x24a19947, 0xb3916cf7, 0x0801f2e2, 0x858efc16, 0x636920d8, + 0x71574e69, 0xa458fea3, 0xf4933d7e, 0x0d95748f, 0x728eb658, 0x718bcd58, 0x82154aee, 0x7b54a41d, 0xc25a59b5, 0x9c30d539, 0x2af26013, 0xc5d1b023, 0x286085f0, 0xca417918, 0xb8db38ef, + 0x8e79dcb0, 0x603a180e, 0x6c9e0e8b, 0xb01e8a3e, 0xd71577c1, 0xbd314b27, 0x78af2fda, 0x55605c60, 0xe65525f3, 0xaa55ab94, 0x57489862, 0x63e81440, 0x55ca396a, 0x2aab10b6, 0xb4cc5c34, + 0x1141e8ce, 0xa15486af, 0x7c72e993, 0xb3ee1411, 0x636fbc2a, 0x2ba9c55d, 0x741831f6, 0xce5c3e16, 0x9b87931e, 0xafd6ba33, 0x6c24cf5c, 0x7a325381, 0x28958677, 0x3b8f4898, 0x6b4bb9af, + 0xc4bfe81b, 0x66282193, 0x61d809cc, 0xfb21a991, 0x487cac60, 0x5dec8032, 0xef845d5d, 0xe98575b1, 0xdc262302, 0xeb651b88, 0x23893e81, 0xd396acc5, 0x0f6d6ff3, 0x83f44239, 0x2e0b4482, + 0xa4842004, 0x69c8f04a, 0x9e1f9b5e, 0x21c66842, 0xf6e96c9a, 0x670c9c61, 0xabd388f0, 0x6a51a0d2, 0xd8542f68, 0x960fa728, 0xab5133a3, 0x6eef0b6c, 0x137a3be4, 0xba3bf050, 0x7efb2a98, + 0xa1f1651d, 0x39af0176, 0x66ca593e, 0x82430e88, 0x8cee8619, 0x456f9fb4, 0x7d84a5c3, 0x3b8b5ebe, 0xe06f75d8, 0x85c12073, 0x401a449f, 0x56c16aa6, 0x4ed3aa62, 0x363f7706, 0x1bfedf72, + 0x429b023d, 0x37d0d724, 0xd00a1248, 0xdb0fead3, 0x49f1c09b, 0x075372c9, 0x80991b7b, 0x25d479d8, 0xf6e8def7, 0xe3fe501a, 0xb6794c3b, 0x976ce0bd, 0x04c006ba, 0xc1a94fb6, 0x409f60c4, + 0x5e5c9ec2, 0x196a2463, 0x68fb6faf, 0x3e6c53b5, 0x1339b2eb, 0x3b52ec6f, 0x6dfc511f, 0x9b30952c, 0xcc814544, 0xaf5ebd09, 0xbee3d004, 0xde334afd, 0x660f2807, 0x192e4bb3, 0xc0cba857, + 0x45c8740f, 0xd20b5f39, 0xb9d3fbdb, 0x5579c0bd, 0x1a60320a, 0xd6a100c6, 0x402c7279, 0x679f25fe, 0xfb1fa3cc, 0x8ea5e9f8, 0xdb3222f8, 0x3c7516df, 0xfd616b15, 0x2f501ec8, 0xad0552ab, + 0x323db5fa, 0xfd238760, 0x53317b48, 0x3e00df82, 0x9e5c57bb, 0xca6f8ca0, 0x1a87562e, 0xdf1769db, 0xd542a8f6, 0x287effc3, 0xac6732c6, 0x8c4f5573, 0x695b27b0, 0xbbca58c8, 0xe1ffa35d, + 0xb8f011a0, 0x10fa3d98, 0xfd2183b8, 0x4afcb56c, 0x2dd1d35b, 0x9a53e479, 0xb6f84565, 0xd28e49bc, 0x4bfb9790, 0xe1ddf2da, 0xa4cb7e33, 0x62fb1341, 0xcee4c6e8, 0xef20cada, 0x36774c01, + 0xd07e9efe, 0x2bf11fb4, 0x95dbda4d, 0xae909198, 0xeaad8e71, 0x6b93d5a0, 0xd08ed1d0, 0xafc725e0, 0x8e3c5b2f, 0x8e7594b7, 0x8ff6e2fb, 0xf2122b64, 0x8888b812, 0x900df01c, 0x4fad5ea0, + 0x688fc31c, 0xd1cff191, 0xb3a8c1ad, 0x2f2f2218, 0xbe0e1777, 0xea752dfe, 0x8b021fa1, 0xe5a0cc0f, 0xb56f74e8, 0x18acf3d6, 0xce89e299, 0xb4a84fe0, 0xfd13e0b7, 0x7cc43b81, 0xd2ada8d9, + 0x165fa266, 0x80957705, 0x93cc7314, 0x211a1477, 0xe6ad2065, 0x77b5fa86, 0xc75442f5, 0xfb9d35cf, 0xebcdaf0c, 0x7b3e89a0, 0xd6411bd3, 0xae1e7e49, 0x00250e2d, 0x2071b35e, 0x226800bb, + 0x57b8e0af, 0x2464369b, 0xf009b91e, 0x5563911d, 0x59dfa6aa, 0x78c14389, 0xd95a537f, 0x207d5ba2, 0x02e5b9c5, 0x83260376, 0x6295cfa9, 0x11c81968, 0x4e734a41, 0xb3472dca, 0x7b14a94a, + 0x1b510052, 0x9a532915, 0xd60f573f, 0xbc9bc6e4, 0x2b60a476, 0x81e67400, 0x08ba6fb5, 0x571be91f, 0xf296ec6b, 0x2a0dd915, 0xb6636521, 0xe7b9f9b6, 0xff34052e, 0xc5855664, 0x53b02d5d, + 0xa99f8fa1, 0x08ba4799, 0x6e85076a, 0x4b7a70e9, 0xb5b32944, 0xdb75092e, 0xc4192623, 0xad6ea6b0, 0x49a7df7d, 0x9cee60b8, 0x8fedb266, 0xecaa8c71, 0x699a17ff, 0x5664526c, 0xc2b19ee1, + 0x193602a5, 0x75094c29, 0xa0591340, 0xe4183a3e, 0x3f54989a, 0x5b429d65, 0x6b8fe4d6, 0x99f73fd6, 0xa1d29c07, 0xefe830f5, 0x4d2d38e6, 0xf0255dc1, 0x4cdd2086, 0x8470eb26, 0x6382e9c6, + 0x021ecc5e, 0x09686b3f, 0x3ebaefc9, 0x3c971814, 0x6b6a70a1, 0x687f3584, 0x52a0e286, 0xb79c5305, 0xaa500737, 0x3e07841c, 0x7fdeae5c, 0x8e7d44ec, 0x5716f2b8, 0xb03ada37, 0xf0500c0d, + 0xf01c1f04, 0x0200b3ff, 0xae0cf51a, 0x3cb574b2, 0x25837a58, 0xdc0921bd, 0xd19113f9, 0x7ca92ff6, 0x94324773, 0x22f54701, 0x3ae5e581, 0x37c2dadc, 0xc8b57634, 0x9af3dda7, 0xa9446146, + 0x0fd0030e, 0xecc8c73e, 0xa4751e41, 0xe238cd99, 0x3bea0e2f, 0x3280bba1, 0x183eb331, 0x4e548b38, 0x4f6db908, 0x6f420d03, 0xf60a04bf, 0x2cb81290, 0x24977c79, 0x5679b072, 0xbcaf89af, + 0xde9a771f, 0xd9930810, 0xb38bae12, 0xdccf3f2e, 0x5512721f, 0x2e6b7124, 0x501adde6, 0x9f84cd87, 0x7a584718, 0x7408da17, 0xbc9f9abc, 0xe94b7d8c, 0xec7aec3a, 0xdb851dfa, 0x63094366, + 0xc464c3d2, 0xef1c1847, 0x3215d908, 0xdd433b37, 0x24c2ba16, 0x12a14d43, 0x2a65c451, 0x50940002, 0x133ae4dd, 0x71dff89e, 0x10314e55, 0x81ac77d6, 0x5f11199b, 0x043556f1, 0xd7a3c76b, + 0x3c11183b, 0x5924a509, 0xf28fe6ed, 0x97f1fbfa, 0x9ebabf2c, 0x1e153c6e, 0x86e34570, 0xeae96fb1, 0x860e5e0a, 0x5a3e2ab3, 0x771fe71c, 0x4e3d06fa, 0x2965dcb9, 0x99e71d0f, 0x803e89d6, + 0x5266c825, 0x2e4cc978, 0x9c10b36a, 0xc6150eba, 0x94e2ea78, 0xa5fc3c53, 0x1e0a2df4, 0xf2f74ea7, 0x361d2b3d, 0x1939260f, 0x19c27960, 0x5223a708, 0xf71312b6, 0xebadfe6e, 0xeac31f66, + 0xe3bc4595, 0xa67bc883, 0xb17f37d1, 0x018cff28, 0xc332ddef, 0xbe6c5aa5, 0x65582185, 0x68ab9802, 0xeecea50f, 0xdb2f953b, 0x2aef7dad, 0x5b6e2f84, 0x1521b628, 0x29076170, 0xecdd4775, + 0x619f1510, 0x13cca830, 0xeb61bd96, 0x0334fe1e, 0xaa0363cf, 0xb5735c90, 0x4c70a239, 0xd59e9e0b, 0xcbaade14, 0xeecc86bc, 0x60622ca7, 0x9cab5cab, 0xb2f3846e, 0x648b1eaf, 0x19bdf0ca, + 0xa02369b9, 0x655abb50, 0x40685a32, 0x3c2ab4b3, 0x319ee9d5, 0xc021b8f7, 0x9b540b19, 0x875fa099, 0x95f7997e, 0x623d7da8, 0xf837889a, 0x97e32d77, 0x11ed935f, 0x16681281, 0x0e358829, + 0xc7e61fd6, 0x96dedfa1, 0x7858ba99, 0x57f584a5, 0x1b227263, 0x9b83c3ff, 0x1ac24696, 0xcdb30aeb, 0x532e3054, 0x8fd948e4, 0x6dbc3128, 0x58ebf2ef, 0x34c6ffea, 0xfe28ed61, 0xee7c3c73, + 0x5d4a14d9, 0xe864b7e3, 0x42105d14, 0x203e13e0, 0x45eee2b6, 0xa3aaabea, 0xdb6c4f15, 0xfacb4fd0, 0xc742f442, 0xef6abbb5, 0x654f3b1d, 0x41cd2105, 0xd81e799e, 0x86854dc7, 0xe44b476a, + 0x3d816250, 0xcf62a1f2, 0x5b8d2646, 0xfc8883a0, 0xc1c7b6a3, 0x7f1524c3, 0x69cb7492, 0x47848a0b, 0x5692b285, 0x095bbf00, 0xad19489d, 0x1462b174, 0x23820e00, 0x58428d2a, 0x0c55f5ea, + 0x1dadf43e, 0x233f7061, 0x3372f092, 0x8d937e41, 0xd65fecf1, 0x6c223bdb, 0x7cde3759, 0xcbee7460, 0x4085f2a7, 0xce77326e, 0xa6078084, 0x19f8509e, 0xe8efd855, 0x61d99735, 0xa969a7aa, + 0xc50c06c2, 0x5a04abfc, 0x800bcadc, 0x9e447a2e, 0xc3453484, 0xfdd56705, 0x0e1e9ec9, 0xdb73dbd3, 0x105588cd, 0x675fda79, 0xe3674340, 0xc5c43465, 0x713e38d8, 0x3d28f89e, 0xf16dff20, + 0x153e21e7, 0x8fb03d4a, 0xe6e39f2b, 0xdb83adf7, 0xe93d5a68, 0x948140f7, 0xf64c261c, 0x94692934, 0x411520f7, 0x7602d4f7, 0xbcf46b2e, 0xd4a20068, 0xd4082471, 0x3320f46a, 0x43b7d4b7, + 0x500061af, 0x1e39f62e, 0x97244546, 0x14214f74, 0xbf8b8840, 0x4d95fc1d, 0x96b591af, 0x70f4ddd3, 0x66a02f45, 0xbfbc09ec, 0x03bd9785, 0x7fac6dd0, 0x31cb8504, 0x96eb27b3, 0x55fd3941, + 0xda2547e6, 0xabca0a9a, 0x28507825, 0x530429f4, 0x0a2c86da, 0xe9b66dfb, 0x68dc1462, 0xd7486900, 0x680ec0a4, 0x27a18dee, 0x4f3ffea2, 0xe887ad8c, 0xb58ce006, 0x7af4d6b6, 0xaace1e7c, + 0xd3375fec, 0xce78a399, 0x406b2a42, 0x20fe9e35, 0xd9f385b9, 0xee39d7ab, 0x3b124e8b, 0x1dc9faf7, 0x4b6d1856, 0x26a36631, 0xeae397b2, 0x3a6efa74, 0xdd5b4332, 0x6841e7f7, 0xca7820fb, + 0xfb0af54e, 0xd8feb397, 0x454056ac, 0xba489527, 0x55533a3a, 0x20838d87, 0xfe6ba9b7, 0xd096954b, 0x55a867bc, 0xa1159a58, 0xcca92963, 0x99e1db33, 0xa62a4a56, 0x3f3125f9, 0x5ef47e1c, + 0x9029317c, 0xfdf8e802, 0x04272f70, 0x80bb155c, 0x05282ce3, 0x95c11548, 0xe4c66d22, 0x48c1133f, 0xc70f86dc, 0x07f9c9ee, 0x41041f0f, 0x404779a4, 0x5d886e17, 0x325f51eb, 0xd59bc0d1, + 0xf2bcc18f, 0x41113564, 0x257b7834, 0x602a9c60, 0xdff8e8a3, 0x1f636c1b, 0x0e12b4c2, 0x02e1329e, 0xaf664fd1, 0xcad18115, 0x6b2395e0, 0x333e92e1, 0x3b240b62, 0xeebeb922, 0x85b2a20e, + 0xe6ba0d99, 0xde720c8c, 0x2da2f728, 0xd0127845, 0x95b794fd, 0x647d0862, 0xe7ccf5f0, 0x5449a36f, 0x877d48fa, 0xc39dfd27, 0xf33e8d1e, 0x0a476341, 0x992eff74, 0x3a6f6eab, 0xf4f8fd37, + 0xa812dc60, 0xa1ebddf8, 0x991be14c, 0xdb6e6b0d, 0xc67b5510, 0x6d672c37, 0x2765d43b, 0xdcd0e804, 0xf1290dc7, 0xcc00ffa3, 0xb5390f92, 0x690fed0b, 0x667b9ffb, 0xcedb7d9c, 0xa091cf0b, + 0xd9155ea3, 0xbb132f88, 0x515bad24, 0x7b9479bf, 0x763bd6eb, 0x37392eb3, 0xcc115979, 0x8026e297, 0xf42e312d, 0x6842ada7, 0xc66a2b3b, 0x12754ccc, 0x782ef11c, 0x6a124237, 0xb79251e7, + 0x06a1bbe6, 0x4bfb6350, 0x1a6b1018, 0x11caedfa, 0x3d25bdd8, 0xe2e1c3c9, 0x44421659, 0x0a121386, 0xd90cec6e, 0xd5abea2a, 0x64af674e, 0xda86a85f, 0xbebfe988, 0x64e4c3fe, 0x9dbc8057, + 0xf0f7c086, 0x60787bf8, 0x6003604d, 0xd1fd8346, 0xf6381fb0, 0x7745ae04, 0xd736fccc, 0x83426b33, 0xf01eab71, 0xb0804187, 0x3c005e5f, 0x77a057be, 0xbde8ae24, 0x55464299, 0xbf582e61, + 0x4e58f48f, 0xf2ddfda2, 0xf474ef38, 0x8789bdc2, 0x5366f9c3, 0xc8b38e74, 0xb475f255, 0x46fcd9b9, 0x7aeb2661, 0x8b1ddf84, 0x846a0e79, 0x915f95e2, 0x466e598e, 0x20b45770, 0x8cd55591, + 0xc902de4c, 0xb90bace1, 0xbb8205d0, 0x11a86248, 0x7574a99e, 0xb77f19b6, 0xe0a9dc09, 0x662d09a1, 0xc4324633, 0xe85a1f02, 0x09f0be8c, 0x4a99a025, 0x1d6efe10, 0x1ab93d1d, 0x0ba5a4df, + 0xa186f20f, 0x2868f169, 0xdcb7da83, 0x573906fe, 0xa1e2ce9b, 0x4fcd7f52, 0x50115e01, 0xa70683fa, 0xa002b5c4, 0x0de6d027, 0x9af88c27, 0x773f8641, 0xc3604c06, 0x61a806b5, 0xf0177a28, + 0xc0f586e0, 0x006058aa, 0x30dc7d62, 0x11e69ed7, 0x2338ea63, 0x53c2dd94, 0xc2c21634, 0xbbcbee56, 0x90bcb6de, 0xebfc7da1, 0xce591d76, 0x6f05e409, 0x4b7c0188, 0x39720a3d, 0x7c927c24, + 0x86e3725f, 0x724d9db9, 0x1ac15bb4, 0xd39eb8fc, 0xed545578, 0x08fca5b5, 0xd83d7cd3, 0x4dad0fc4, 0x1e50ef5e, 0xb161e6f8, 0xa28514d9, 0x6c51133c, 0x6fd5c7e7, 0x56e14ec4, 0x362abfce, + 0xddc6c837, 0xd79a3234, 0x92638212, 0x670efa8e, 0x406000e0, 0x3a39ce37, 0xd3faf5cf, 0xabc27737, 0x5ac52d1b, 0x5cb0679e, 0x4fa33742, 0xd3822740, 0x99bc9bbe, 0xd5118e9d, 0xbf0f7315, + 0xd62d1c7e, 0xc700c47b, 0xb78c1b6b, 0x21a19045, 0xb26eb1be, 0x6a366eb4, 0x5748ab2f, 0xbc946e79, 0xc6a376d2, 0x6549c2c8, 0x530ff8ee, 0x468dde7d, 0xd5730a1d, 0x4cd04dc6, 0x2939bbdb, + 0xa9ba4650, 0xac9526e8, 0xbe5ee304, 0xa1fad5f0, 0x6a2d519a, 0x63ef8ce2, 0x9a86ee22, 0xc089c2b8, 0x43242ef6, 0xa51e03aa, 0x9cf2d0a4, 0x83c061ba, 0x9be96a4d, 0x8fe51550, 0xba645bd6, + 0x2826a2f9, 0xa73a3ae1, 0x4ba99586, 0xef5562e9, 0xc72fefd3, 0xf752f7da, 0x3f046f69, 0x77fa0a59, 0x80e4a915, 0x87b08601, 0x9b09e6ad, 0x3b3ee593, 0xe990fd5a, 0x9e34d797, 0x2cf0b7d9, + 0x022b8b51, 0x96d5ac3a, 0x017da67d, 0xd1cf3ed6, 0x7c7d2d28, 0x1f9f25cf, 0xadf2b89b, 0x5ad6b472, 0x5a88f54c, 0xe029ac71, 0xe019a5e6, 0x47b0acfd, 0xed93fa9b, 0xe8d3c48d, 0x283b57cc, + 0xf8d56629, 0x79132e28, 0x785f0191, 0xed756055, 0xf7960e44, 0xe3d35e8c, 0x15056dd4, 0x88f46dba, 0x03a16125, 0x0564f0bd, 0xc3eb9e15, 0x3c9057a2, 0x97271aec, 0xa93a072a, 0x1b3f6d9b, + 0x1e6321f5, 0xf59c66fb, 0x26dcf319, 0x7533d928, 0xb155fdf5, 0x03563482, 0x8aba3cbb, 0x28517711, 0xc20ad9f8, 0xabcc5167, 0xccad925f, 0x4de81751, 0x3830dc8e, 0x379d5862, 0x9320f991, + 0xea7a90c2, 0xfb3e7bce, 0x5121ce64, 0x774fbe32, 0xa8b6e37e, 0xc3293d46, 0x48de5369, 0x6413e680, 0xa2ae0810, 0xdd6db224, 0x69852dfd, 0x09072166, 0xb39a460a, 0x6445c0dd, 0x586cdecf, + 0x1c20c8ae, 0x5bbef7dd, 0x1b588d40, 0xccd2017f, 0x6bb4e3bb, 0xdda26a7e, 0x3a59ff45, 0x3e350a44, 0xbcb4cdd5, 0x72eacea8, 0xfa6484bb, 0x8d6612ae, 0xbf3c6f47, 0xd29be463, 0x542f5d9e, + 0xaec2771b, 0xf64e6370, 0x740e0d8d, 0xe75b1357, 0xf8721671, 0xaf537d5d, 0x4040cb08, 0x4eb4e2cc, 0x34d2466a, 0x0115af84, 0xe1b00428, 0x95983a1d, 0x06b89fb4, 0xce6ea048, 0x6f3f3b82, + 0x3520ab82, 0x011a1d4b, 0x277227f8, 0x611560b1, 0xe7933fdc, 0xbb3a792b, 0x344525bd, 0xa08839e1, 0x51ce794b, 0x2f32c9b7, 0xa01fbac9, 0xe01cc87e, 0xbcc7d1f6, 0xcf0111c3, 0xa1e8aac7, + 0x1a908749, 0xd44fbd9a, 0xd0dadecb, 0xd50ada38, 0x0339c32a, 0xc6913667, 0x8df9317c, 0xe0b12b4f, 0xf79e59b7, 0x43f5bb3a, 0xf2d519ff, 0x27d9459c, 0xbf97222c, 0x15e6fc2a, 0x0f91fc71, + 0x9b941525, 0xfae59361, 0xceb69ceb, 0xc2a86459, 0x12baa8d1, 0xb6c1075e, 0xe3056a0c, 0x10d25065, 0xcb03a442, 0xe0ec6e0e, 0x1698db3b, 0x4c98a0be, 0x3278e964, 0x9f1f9532, 0xe0d392df, + 0xd3a0342b, 0x8971f21e, 0x1b0a7441, 0x4ba3348c, 0xc5be7120, 0xc37632d8, 0xdf359f8d, 0x9b992f2e, 0xe60b6f47, 0x0fe3f11d, 0xe54cda54, 0x1edad891, 0xce6279cf, 0xcd3e7e6f, 0x1618b166, + 0xfd2c1d05, 0x848fd2c5, 0xf6fb2299, 0xf523f357, 0xa6327623, 0x93a83531, 0x56cccd02, 0xacf08162, 0x5a75ebb5, 0x6e163697, 0x88d273cc, 0xde966292, 0x81b949d0, 0x4c50901b, 0x71c65614, + 0xe6c6c7bd, 0x327a140a, 0x45e1d006, 0xc3f27b9a, 0xc9aa53fd, 0x62a80f00, 0xbb25bfe2, 0x35bdd2f6, 0x71126905, 0xb2040222, 0xb6cbcf7c, 0xcd769c2b, 0x53113ec0, 0x1640e3d3, 0x38abbd60, + 0x2547adf0, 0xba38209c, 0xf746ce76, 0x77afa1c5, 0x20756060, 0x85cbfe4e, 0x8ae88dd8, 0x7aaaf9b0, 0x4cf9aa7e, 0x1948c25c, 0x02fb8a8c, 0x01c36ae4, 0xd6ebe1f9, 0x90d4f869, 0xa65cdea0, + 0x3f09252d, 0xc208e69f, 0xb74e6132, 0xce77e25b, 0x578fdfe3, 0x3ac372e6}; + + // bcrypt IV: "OrpheanBeholderScryDoubt". The C implementation calls + // this "ciphertext", but it is really plaintext or an IV. We keep + // the name to make code comparison easier. + static private final int[] bf_crypt_ciphertext = {0x4f727068, 0x65616e42, 0x65686f6c, 0x64657253, 0x63727944, 0x6f756274}; + + // Table for Base64 encoding + static private final char[] base64_code = {'.', '/', 'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M', 'N', 'O', 'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X', 'Y', 'Z', 'a', 'b', + 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z', '0', '1', '2', '3', '4', '5', '6', '7', '8', '9'}; + + // Table for Base64 decoding + static private final byte[] index_64 = {-1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, + -1, -1, -1, -1, -1, -1, -1, 0, 1, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, -1, -1, -1, -1, -1, -1, -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, -1, -1, -1, -1, -1, -1, 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, -1, -1, -1, -1, -1}; + + // Expanded Blowfish key + private int[] P; + private int[] S; + + /** + * Encode a byte array using bcrypt's slightly-modified base64 encoding scheme. Note that this is *not* compatible with the standard MIME-base64 encoding. + * + * @param d the byte array to encode + * @param len the number of bytes to encode + * @return base64-encoded string + * @throws IllegalArgumentException if the length is invalid + */ + private static String encode_base64(byte[] d, int len) throws IllegalArgumentException { + int off = 0; + StringBuilder rs = new StringBuilder(); + int c1, c2; + + if (len <= 0 || len > d.length) + throw new IllegalArgumentException("Invalid len"); + + while (off < len) { + c1 = d[off++] & 0xff; + rs.append(base64_code[(c1 >> 2) & 0x3f]); + c1 = (c1 & 0x03) << 4; + if (off >= len) { + rs.append(base64_code[c1 & 0x3f]); + break; + } + c2 = d[off++] & 0xff; + c1 |= (c2 >> 4) & 0x0f; + rs.append(base64_code[c1 & 0x3f]); + c1 = (c2 & 0x0f) << 2; + if (off >= len) { + rs.append(base64_code[c1 & 0x3f]); + break; + } + c2 = d[off++] & 0xff; + c1 |= (c2 >> 6) & 0x03; + rs.append(base64_code[c1 & 0x3f]); + rs.append(base64_code[c2 & 0x3f]); + } + return rs.toString(); + } + + /** + * Look up the 3 bits base64-encoded by the specified character, range-checking againt conversion table + * + * @param x the base64-encoded value + * @return the decoded value of x + */ + private static byte char64(char x) { + if ((int) x > index_64.length) + return -1; + return index_64[x]; + } + + /** + * Decode a string encoded using bcrypt's base64 scheme to a byte array.
+ * Note that this is *not* compatible with the standard MIME-base64 encoding. + * + * @param s the string to decode + * @param maxolen the maximum number of bytes to decode + * @return an array containing the decoded bytes + * @throws IllegalArgumentException if maxolen is invalid + */ + private static byte[] decodeBase64(String s, int maxolen) throws IllegalArgumentException { + final StringBuilder rs = new StringBuilder(); + int off = 0, slen = s.length(), olen = 0; + byte[] ret; + byte c1, c2, c3, c4, o; + + if (maxolen <= 0) + throw new IllegalArgumentException("Invalid maxolen"); + + while (off < slen - 1 && olen < maxolen) { + c1 = char64(s.charAt(off++)); + c2 = char64(s.charAt(off++)); + if (c1 == -1 || c2 == -1) + break; + o = (byte) (c1 << 2); + o |= (c2 & 0x30) >> 4; + rs.append((char) o); + if (++olen >= maxolen || off >= slen) + break; + c3 = char64(s.charAt(off++)); + if (c3 == -1) + break; + o = (byte) ((c2 & 0x0f) << 4); + o |= (c3 & 0x3c) >> 2; + rs.append((char) o); + if (++olen >= maxolen || off >= slen) + break; + c4 = char64(s.charAt(off++)); + o = (byte) ((c3 & 0x03) << 6); + o |= c4; + rs.append((char) o); + ++olen; + } + + ret = new byte[olen]; + for (off = 0; off < olen; off++) + ret[off] = (byte) rs.charAt(off); + return ret; + } + + /** + * Blowfish encipher a single 64-bit block encoded as two 32-bit halves + * + * @param lr an array containing the two 32-bit half blocks + * @param off the position in the array of the blocks + */ + private void encipher(int[] lr, int off) { + int i, n, l = lr[off], r = lr[off + 1]; + + l ^= P[0]; + for (i = 0; i <= BLOWFISH_NUM_ROUNDS - 2; ) { + // Feistel substitution on left word + n = S[(l >> 24) & 0xff]; + n += S[0x100 | ((l >> 16) & 0xff)]; + n ^= S[0x200 | ((l >> 8) & 0xff)]; + n += S[0x300 | (l & 0xff)]; + r ^= n ^ P[++i]; + + // Feistel substitution on right word + n = S[(r >> 24) & 0xff]; + n += S[0x100 | ((r >> 16) & 0xff)]; + n ^= S[0x200 | ((r >> 8) & 0xff)]; + n += S[0x300 | (r & 0xff)]; + l ^= n ^ P[++i]; + } + lr[off] = r ^ P[BLOWFISH_NUM_ROUNDS + 1]; + lr[off + 1] = l; + } + + /** + * Cycically extract a word of key material + * + * @param data the string to extract the data from + * @param offp a "pointer" (as a one-entry array) to the current offset into data + * @return the next word of material from data + */ + private static int streamToWord(byte[] data, int[] offp) { + int i; + int word = 0; + int off = offp[0]; + + for (i = 0; i < 4; i++) { + word = (word << 8) | (data[off] & 0xff); + off = (off + 1) % data.length; + } + + offp[0] = off; + return word; + } + + /** + * Initialise the Blowfish key schedule + */ + private void init_key() { + P = P_orig.clone(); + S = S_orig.clone(); + } + + /** + * Key the Blowfish cipher + * + * @param key an array containing the key + */ + private void key(byte[] key) { + int i; + int[] koffp = {0}; + int[] lr = {0, 0}; + int plen = P.length, slen = S.length; + + for (i = 0; i < plen; i++) + P[i] = P[i] ^ streamToWord(key, koffp); + + for (i = 0; i < plen; i += 2) { + encipher(lr, 0); + P[i] = lr[0]; + P[i + 1] = lr[1]; + } + + for (i = 0; i < slen; i += 2) { + encipher(lr, 0); + S[i] = lr[0]; + S[i + 1] = lr[1]; + } + } + + /** + * Perform the "enhanced key schedule" step described by Provos and Mazieres in "A Future-Adaptable Password Scheme" http://www.openbsd.org/papers/bcrypt-paper.ps + * + * @param data salt information + * @param key password information + */ + private void ekskey(byte[] data, byte[] key) { + int i; + int[] koffp = {0}; + int[] doffp = {0}; + int[] lr = {0, 0}; + int plen = P.length, slen = S.length; + + for (i = 0; i < plen; i++) + P[i] = P[i] ^ streamToWord(key, koffp); + + for (i = 0; i < plen; i += 2) { + lr[0] ^= streamToWord(data, doffp); + lr[1] ^= streamToWord(data, doffp); + encipher(lr, 0); + P[i] = lr[0]; + P[i + 1] = lr[1]; + } + + for (i = 0; i < slen; i += 2) { + lr[0] ^= streamToWord(data, doffp); + lr[1] ^= streamToWord(data, doffp); + encipher(lr, 0); + S[i] = lr[0]; + S[i + 1] = lr[1]; + } + } + + /** + * 加密密文 + * + * @param password 明文密码 + * @param salt 加盐 + * @param log_rounds hash中叠加的对数 + * @param cdata 加密数据 + * @return 加密后的密文 + */ + public byte[] crypt(byte[] password, byte[] salt, int log_rounds, int[] cdata) { + int rounds, i, j; + int clen = cdata.length; + byte[] ret; + + if (log_rounds < 4 || log_rounds > 30) + throw new IllegalArgumentException("Bad number of rounds"); + rounds = 1 << log_rounds; + if (salt.length != BCRYPT_SALT_LEN) + throw new IllegalArgumentException("Bad salt length"); + + init_key(); + ekskey(salt, password); + for (i = 0; i != rounds; i++) { + key(password); + key(salt); + } + + for (i = 0; i < 64; i++) { + for (j = 0; j < (clen >> 1); j++) + encipher(cdata, j << 1); + } + + ret = new byte[clen * 4]; + for (i = 0, j = 0; i < clen; i++) { + ret[j++] = (byte) ((cdata[i] >> 24) & 0xff); + ret[j++] = (byte) ((cdata[i] >> 16) & 0xff); + ret[j++] = (byte) ((cdata[i] >> 8) & 0xff); + ret[j++] = (byte) (cdata[i] & 0xff); + } + return ret; + } + + /** + * 生成密文，使用长度为10的加盐方式 + * + * @param password 需要加密的明文 + * @return 密文 + */ + public static String hashpw(String password) { + return hashpw(password, gensalt()); + } + + /** + * 生成密文 + * + * @param password 需要加密的明文 + * @param salt 盐，使用{@link #gensalt()} 生成 + * @return 密文 + */ + public static String hashpw(String password, String salt) { + BCrypt bcrypt; + String real_salt; + byte[] saltb; + byte[] hashed; + char minor = (char) 0; + int rounds, off; + StringBuilder rs = new StringBuilder(); + + if (salt.charAt(0) != '$' || salt.charAt(1) != '2') + throw new IllegalArgumentException("Invalid salt version"); + if (salt.charAt(2) == '$') + off = 3; + else { + minor = salt.charAt(2); + // pr#1560@Github + // 修正一个在Blowfish实现上的安全风险 + if ((minor != 'a' && minor != 'x' && minor != 'y' && minor != 'b') || salt.charAt(3) != '$') + throw new IllegalArgumentException("Invalid salt revision"); + off = 4; + } + + // Extract number of rounds + if (salt.charAt(off + 2) > '$') + throw new IllegalArgumentException("Missing salt rounds"); + rounds = Integer.parseInt(salt.substring(off, off + 2)); + + real_salt = salt.substring(off + 3, off + 25); + byte[] passwordb = (password + (minor >= 'a' ? "\000" : "")).getBytes(StandardCharsets.UTF_8); + saltb = decodeBase64(real_salt, BCRYPT_SALT_LEN); + + bcrypt = new BCrypt(); + hashed = bcrypt.crypt(passwordb, saltb, rounds, bf_crypt_ciphertext.clone()); + + rs.append("$2"); + if (minor >= 'a') + rs.append(minor); + rs.append("$"); + if (rounds < 10) + rs.append("0"); + if (rounds > 30) { + throw new IllegalArgumentException("rounds exceeds maximum (30)"); + } + rs.append(rounds); + rs.append("$"); + rs.append(encode_base64(saltb, saltb.length)); + rs.append(encode_base64(hashed, bf_crypt_ciphertext.length * 4 - 1)); + return rs.toString(); + } + + /** + * 生成盐 + * + * @param log_rounds hash中叠加的2的对数 - the work factor therefore increases as 2**log_rounds. + * @param random {@link SecureRandom} + * @return an encoded salt value + */ + public static String gensalt(int log_rounds, SecureRandom random) { + final StringBuilder rs = new StringBuilder(); + byte[] rnd = new byte[BCRYPT_SALT_LEN]; + + random.nextBytes(rnd); + + rs.append("$2a$"); + if (log_rounds < 10) + rs.append("0"); + if (log_rounds > 30) { + throw new IllegalArgumentException("log_rounds exceeds maximum (30)"); + } + rs.append(log_rounds); + rs.append("$"); + rs.append(encode_base64(rnd, rnd.length)); + return rs.toString(); + } + + /** + * 生成盐 + * + * @param log_rounds the log2 of the number of rounds of hashing to apply - the work factor therefore increases as 2**log_rounds. + * @return 盐 + */ + public static String gensalt(int log_rounds) { + return gensalt(log_rounds, new SecureRandom()); + } + + /** + * 生成盐 + * + * @return 盐 + */ + public static String gensalt() { + return gensalt(GENSALT_DEFAULT_LOG2_ROUNDS); + } + + /** + * 检查明文密码文本是否匹配加密后的文本 + * + * @param plaintext 需要验证的明文密码 + * @param hashed 密文 + * @return 是否匹配 + */ + public static boolean checkpw(String plaintext, String hashed) { + byte[] hashed_bytes; + byte[] try_bytes; + + String try_pw; + try { + try_pw = hashpw(plaintext, hashed); + } catch (Exception ignore) { + // 生成密文时错误直接返回false issue#1377@Github + return false; + } + hashed_bytes = hashed.getBytes(StandardCharsets.UTF_8); + try_bytes = try_pw.getBytes(StandardCharsets.UTF_8); + if (hashed_bytes.length != try_bytes.length) { + return false; + } + byte ret = 0; + for (int i = 0; i < try_bytes.length; i++) + ret |= hashed_bytes[i] ^ try_bytes[i]; + return ret == 0; + } +} diff --git a/sa-token-core/src/main/java/cn/dev33/satoken/session/SaSession.java b/sa-token-core/src/main/java/cn/dev33/satoken/session/SaSession.java index 150ceca5..66039965 100644 --- a/sa-token-core/src/main/java/cn/dev33/satoken/session/SaSession.java +++ b/sa-token-core/src/main/java/cn/dev33/satoken/session/SaSession.java @@ -8,6 +8,7 @@ import java.util.Vector; import java.util.concurrent.ConcurrentHashMap; import cn.dev33.satoken.SaManager; +import cn.dev33.satoken.dao.SaTokenDao; import cn.dev33.satoken.fun.SaRetFunction; import cn.dev33.satoken.util.SaFoxUtil; @@ -216,8 +217,10 @@ public class SaSession implements Serializable { * @param minTimeout 过期时间 (单位: 秒) */ public void updateMinTimeout(long minTimeout) { - if(getTimeout() < minTimeout) { - SaManager.getSaTokenDao().updateSessionTimeout(this.id, minTimeout); + long min = trans(minTimeout); + long curr = trans(getTimeout()); + if(curr < min) { + updateTimeout(minTimeout); } } @@ -226,12 +229,21 @@ public class SaSession implements Serializable { * @param maxTimeout 过期时间 (单位: 秒) */ public void updateMaxTimeout(long maxTimeout) { - if(getTimeout() > maxTimeout) { - SaManager.getSaTokenDao().updateSessionTimeout(this.id, maxTimeout); + long max = trans(maxTimeout); + long curr = trans(getTimeout()); + if(curr > max) { + updateTimeout(maxTimeout); } } - + /** + * value为 -1 时返回 Long.MAX_VALUE，否则原样返回 + * @param value / + * @return / + */ + protected long trans(long value) { + return value == SaTokenDao.NEVER_EXPIRE ? Long.MAX_VALUE : value; + } // ----------------------- 存取值 (类型转换) diff --git a/sa-token-core/src/main/java/cn/dev33/satoken/stp/SaLoginConfig.java b/sa-token-core/src/main/java/cn/dev33/satoken/stp/SaLoginConfig.java new file mode 100644 index 00000000..b62560a0 --- /dev/null +++ b/sa-token-core/src/main/java/cn/dev33/satoken/stp/SaLoginConfig.java @@ -0,0 +1,72 @@ +package cn.dev33.satoken.stp; + +import java.util.Map; + +/** + * + * 快速构建 调用 `StpUtil.login()` 时的 [配置参数 Model ] + * + * @author kong + * + */ +public class SaLoginConfig { + + /** + * @param device 此次登录的客户端设备标识 + * @return SaLoginModel配置对象 + */ + public static SaLoginModel setDevice(String device) { + return create().setDevice(device); + } + + /** + * @param isLastingCookie 是否为持久Cookie（临时Cookie在浏览器关闭时会自动删除，持久Cookie在重新打开后依然存在） + * @return 对象自身 + */ + public static SaLoginModel setIsLastingCookie(Boolean isLastingCookie) { + return create().setIsLastingCookie(isLastingCookie); + } + + /** + * @param timeout 指定此次登录token的有效期, 单位:秒 （如未指定，自动取全局配置的timeout值） + * @return 对象自身 + */ + public static SaLoginModel setTimeout(Long timeout) { + return create().setTimeout(timeout); + } + + /** + * @param extraData 扩展信息（只在jwt模式下生效） + * @return 对象自身 + */ + public static SaLoginModel setExtraData(Map extraData) { + return create().setExtraData(extraData); + } + + /** + * @param token 预定Token（预定本次登录生成的Token值） + * @return 对象自身 + */ + public static SaLoginModel setToken(String token) { + return create().setToken(token); + } + + /** + * 写入扩展数据（只在jwt模式下生效） + * @param key 键 + * @param value 值 + * @return 对象自身 + */ + public static SaLoginModel setExtra(String key, Object value) { + return create().setExtra(key, value); + } + + /** + * 静态方法获取一个 SaLoginModel 对象 + * @return SaLoginModel 对象 + */ + public static SaLoginModel create() { + return new SaLoginModel(); + } + +} diff --git a/sa-token-core/src/main/java/cn/dev33/satoken/stp/SaLoginModel.java b/sa-token-core/src/main/java/cn/dev33/satoken/stp/SaLoginModel.java index f3989153..7c8480da 100644 --- a/sa-token-core/src/main/java/cn/dev33/satoken/stp/SaLoginModel.java +++ b/sa-token-core/src/main/java/cn/dev33/satoken/stp/SaLoginModel.java @@ -1,5 +1,8 @@ package cn.dev33.satoken.stp; +import java.util.LinkedHashMap; +import java.util.Map; + import cn.dev33.satoken.SaManager; import cn.dev33.satoken.config.SaTokenConfig; import cn.dev33.satoken.dao.SaTokenDao; @@ -27,16 +30,26 @@ public class SaLoginModel { */ public Long timeout; + /** + * 扩展信息（只在jwt模式下生效） + */ + public Map extraData; + + /** + * 预定Token（预定本次登录生成的Token值） + */ + public String token; + /** - * @return 参考 {@link #device} + * @return 此次登录的客户端设备标识 */ public String getDevice() { return device; } /** - * @param device 参考 {@link #device} + * @param device 此次登录的客户端设备标识 * @return 对象自身 */ public SaLoginModel setDevice(String device) { @@ -45,14 +58,14 @@ public class SaLoginModel { } /** - * @return 参考 {@link #isLastingCookie} + * @return 参考 是否为持久Cookie（临时Cookie在浏览器关闭时会自动删除，持久Cookie在重新打开后依然存在） */ public Boolean getIsLastingCookie() { return isLastingCookie; } /** - * @param isLastingCookie 参考 {@link #isLastingCookie} + * @param isLastingCookie 是否为持久Cookie（临时Cookie在浏览器关闭时会自动删除，持久Cookie在重新打开后依然存在） * @return 对象自身 */ public SaLoginModel setIsLastingCookie(Boolean isLastingCookie) { @@ -61,14 +74,14 @@ public class SaLoginModel { } /** - * @return 参考 {@link #timeout} + * @return 指定此次登录token的有效期, 单位:秒 （如未指定，自动取全局配置的timeout值） */ public Long getTimeout() { return timeout; } /** - * @param timeout 参考 {@link #timeout} + * @param timeout 指定此次登录token的有效期, 单位:秒 （如未指定，自动取全局配置的timeout值） * @return 对象自身 */ public SaLoginModel setTimeout(long timeout) { @@ -76,6 +89,75 @@ public class SaLoginModel { return this; } + /** + * @return 扩展信息（只在jwt模式下生效） + */ + public Map getExtraData() { + return extraData; + } + + /** + * @param extraData 扩展信息（只在jwt模式下生效） + * @return 对象自身 + */ + public SaLoginModel setExtraData(Map extraData) { + this.extraData = extraData; + return this; + } + + /** + * @return 预定Token（预定本次登录生成的Token值） + */ + public String getToken() { + return token; + } + + /** + * @param token 预定Token（预定本次登录生成的Token值） + * @return 对象自身 + */ + public SaLoginModel setToken(String token) { + this.token = token; + return this; + } + + /* + * toString + */ + @Override + public String toString() { + return "SaLoginModel [device=" + device + ", isLastingCookie=" + isLastingCookie + ", timeout=" + timeout + + ", extraData=" + extraData + ", token=" + token + "]"; + } + + // ------ 附加方法 + + + /** + * 写入扩展数据（只在jwt模式下生效） + * @param key 键 + * @param value 值 + * @return 对象自身 + */ + public SaLoginModel setExtra(String key, Object value) { + if(this.extraData == null) { + this.extraData = new LinkedHashMap<>(); + } + this.extraData.put(key, value); + return this; + } + + /** + * 获取扩展数据（只在jwt模式下生效） + * @param key 键 + * @return 扩展数据的值 + */ + public Object getExtra(String key) { + if(this.extraData == null) { + return null; + } + return this.extraData.get(key); + } /** * @return Cookie时长 @@ -134,14 +216,6 @@ public class SaLoginModel { return new SaLoginModel(); } - /** - * toString - */ - @Override - public String toString() { - return "SaLoginModel [device=" + device + ", isLastingCookie=" + isLastingCookie + ", timeout=" + timeout + "]"; - } - /** * 更换为 getDeviceOrDefault() diff --git a/sa-token-core/src/main/java/cn/dev33/satoken/stp/StpLogic.java b/sa-token-core/src/main/java/cn/dev33/satoken/stp/StpLogic.java index 33312b0c..297a4f6d 100644 --- a/sa-token-core/src/main/java/cn/dev33/satoken/stp/StpLogic.java +++ b/sa-token-core/src/main/java/cn/dev33/satoken/stp/StpLogic.java @@ -1,9 +1,6 @@ package cn.dev33.satoken.stp; -import java.util.ArrayList; -import java.util.Collections; -import java.util.List; -import java.util.Objects; +import java.util.*; import java.util.function.Consumer; import cn.dev33.satoken.SaManager; @@ -19,6 +16,7 @@ import cn.dev33.satoken.context.model.SaCookie; import cn.dev33.satoken.context.model.SaRequest; import cn.dev33.satoken.context.model.SaStorage; import cn.dev33.satoken.dao.SaTokenDao; +import cn.dev33.satoken.exception.ApiDisabledException; import cn.dev33.satoken.exception.DisableLoginException; import cn.dev33.satoken.exception.NotLoginException; import cn.dev33.satoken.exception.NotPermissionException; @@ -84,14 +82,15 @@ public class StpLogic { } /** - * 创建一个TokenValue - * @param loginId loginId - * @param device 设备标识 - * @param timeout 过期时间 - * @return 生成的tokenValue + * 创建一个TokenValue + * @param loginId loginId + * @param device 设备标识 + * @param timeout 过期时间 + * @param extraData 扩展信息 + * @return 生成的tokenValue */ - public String createTokenValue(Object loginId, String device, long timeout) { - return SaStrategy.me.createToken.apply(loginId, loginType); + public String createTokenValue(Object loginId, String device, long timeout, Map extraData) { + return SaStrategy.me.createToken.apply(loginId, loginType); } /** @@ -268,13 +267,36 @@ public class StpLogic { public void login(Object id, boolean isLastingCookie) { login(id, new SaLoginModel().setIsLastingCookie(isLastingCookie)); } - + /** * 会话登录，并指定所有登录参数Model * @param id 登录id，建议的类型：（long | int | String） * @param loginModel 此次登录的参数Model */ public void login(Object id, SaLoginModel loginModel) { + // 1、创建会话 + String token = createLoginSession(id, loginModel); + + // 2、在当前客户端注入Token + setTokenValue(token, loginModel.getCookieTimeout()); + } + + /** + * 创建指定账号id的登录会话 + * @param id 登录id，建议的类型：（long | int | String） + * @return 返回会话令牌 + */ + public String createLoginSession(Object id) { + return createLoginSession(id, new SaLoginModel()); + } + + /** + * 创建指定账号id的登录会话 + * @param id 登录id，建议的类型：（long | int | String） + * @param loginModel 此次登录的参数Model + * @return 返回会话令牌 + */ + public String createLoginSession(Object id, SaLoginModel loginModel) { SaTokenException.throwByNull(id, "账号id不能为空"); @@ -301,7 +323,11 @@ public class StpLogic { } // 如果至此，仍未成功创建tokenValue, 则开始生成一个 if(tokenValue == null) { - tokenValue = createTokenValue(id, loginModel.getDeviceOrDefault(), loginModel.getTimeout()); + if(SaFoxUtil.isEmpty(loginModel.getToken())) { + tokenValue = createTokenValue(id, loginModel.getDeviceOrDefault(), loginModel.getTimeout(), loginModel.getExtraData()); + } else { + tokenValue = loginModel.getToken(); + } } // ------ 3. 获取 User-Session , 续期 @@ -314,15 +340,15 @@ public class StpLogic { // ------ 4. 持久化其它数据 // token -> id 映射关系 saveTokenToIdMapping(tokenValue, id, loginModel.getTimeout()); - - // 在当前会话写入tokenValue - setTokenValue(tokenValue, loginModel.getCookieTimeout()); // 写入 [token-last-activity] setLastActivityToNow(tokenValue); - + // $$ 通知监听器，账号xxx 登录成功 SaManager.getSaTokenListener().doLogin(loginType, id, loginModel); + + // 返回Token + return tokenValue; } // --- 注销 @@ -549,7 +575,7 @@ public class StpLogic { if(loginId == null) { throw NotLoginException.newInstance(loginType, NotLoginException.INVALID_TOKEN, tokenValue); } - // 如果是已经过期，则抛出已经过期 + // 如果是已经过期，则抛出：已经过期 if(loginId.equals(NotLoginException.TOKEN_TIMEOUT)) { throw NotLoginException.newInstance(loginType, NotLoginException.TOKEN_TIMEOUT, tokenValue); } @@ -613,7 +639,7 @@ public class StpLogic { } // loginId为null或者在异常项里面，均视为未登录, 返回null Object loginId = getLoginIdNotHandle(tokenValue); - if(loginId == null || NotLoginException.ABNORMAL_LIST.contains(loginId)) { + if(isValidLoginId(loginId) == false) { return null; } // 如果已经[临时过期] @@ -654,12 +680,19 @@ public class StpLogic { * @return 账号id */ public Object getLoginIdByToken(String tokenValue) { - if(tokenValue == null) { + // token为空时，直接返回null + if(SaFoxUtil.isEmpty(tokenValue)) { return null; } - return getLoginIdNotHandle(tokenValue); + // loginId为无效值时，直接返回null + String loginId = getLoginIdNotHandle(tokenValue); + if(isValidLoginId(loginId) == false) { + return null; + } + // + return loginId; } - + /** * 获取指定Token对应的账号id (不做任何特殊处理) * @param tokenValue token值 @@ -668,6 +701,16 @@ public class StpLogic { public String getLoginIdNotHandle(String tokenValue) { return getSaTokenDao().get(splicingKeyTokenValue(tokenValue)); } + + /** + * 获取Token扩展信息（只在jwt模式下有效） + * @param key 键值 + * @return 对应的扩展数据 + */ + public Object getExtra(String key) { + throw new ApiDisabledException(); + } + // ---- 其它操作 /** @@ -804,7 +847,7 @@ public class StpLogic { String tokenValue = getTokenValue(); if(tokenValue == null || Objects.equals(tokenValue, "")) { // 随机一个token送给Ta - tokenValue = createTokenValue(null, null, getConfig().getTimeout()); + tokenValue = createTokenValue(null, null, getConfig().getTimeout(), null); // 写入 [最后操作时间] setLastActivityToNow(tokenValue); // 在当前会话写入这个tokenValue @@ -840,7 +883,7 @@ public class StpLogic { */ protected void setLastActivityToNow(String tokenValue) { // 如果token == null 或者 设置了[永不过期], 则立即返回 - if(tokenValue == null || getConfig().getActivityTimeout() == SaTokenDao.NEVER_EXPIRE) { + if(tokenValue == null || isOpenActivityCheck() == false) { return; } // 将[最后操作时间]标记为当前时间戳 @@ -853,7 +896,7 @@ public class StpLogic { */ protected void clearLastActivity(String tokenValue) { // 如果token == null 或者 设置了[永不过期], 则立即返回 - if(tokenValue == null || getConfig().getActivityTimeout() == SaTokenDao.NEVER_EXPIRE) { + if(tokenValue == null || isOpenActivityCheck() == false) { return; } // 删除[最后操作时间] @@ -868,7 +911,7 @@ public class StpLogic { */ public void checkActivityTimeout(String tokenValue) { // 如果token == null 或者 设置了[永不过期], 则立即返回 - if(tokenValue == null || getConfig().getActivityTimeout() == SaTokenDao.NEVER_EXPIRE) { + if(tokenValue == null || isOpenActivityCheck() == false) { return; } // 如果本次请求已经有了[检查标记], 则立即返回 @@ -906,7 +949,7 @@ public class StpLogic { */ public void updateLastActivityToNow(String tokenValue) { // 如果token == null 或者 设置了[永不过期], 则立即返回 - if(tokenValue == null || getConfig().getActivityTimeout() == SaTokenDao.NEVER_EXPIRE) { + if(tokenValue == null || isOpenActivityCheck() == false) { return; } getSaTokenDao().update(splicingKeyLastActivityTime(tokenValue), String.valueOf(System.currentTimeMillis())); @@ -921,7 +964,6 @@ public class StpLogic { updateLastActivityToNow(getTokenValue()); } - // ------------------- 过期时间相关 ------------------- /** @@ -994,7 +1036,7 @@ public class StpLogic { return SaTokenDao.NOT_VALUE_EXPIRE; } // 如果设置了永不过期, 则返回 -1 - if(getConfig().getActivityTimeout() == SaTokenDao.NEVER_EXPIRE) { + if(isOpenActivityCheck() == false) { return SaTokenDao.NEVER_EXPIRE; } // ------ 开始查询 @@ -1016,6 +1058,53 @@ public class StpLogic { return timeout; } + /** + * 对当前 Token 的 timeout 值进行续期 + * @param timeout 要修改成为的有效时间 (单位: 秒) + */ + public void renewTimeout(long timeout) { + // 续期 db 数据 + String tokenValue = getTokenValue(); + renewTimeout(tokenValue, timeout); + + // 续期客户端Cookie有效期 + if(getConfig().getIsReadCookie()) { + setTokenValueToCookie(tokenValue, (int)timeout); + } + } + + /** + * 对指定 Token 的 timeout 值进行续期 + * @param tokenValue 指定token + * @param timeout 要修改成为的有效时间 (单位: 秒) + */ + public void renewTimeout(String tokenValue, long timeout) { + + // Token 指向的 LoginId 异常时，不进行任何操作 + Object loginId = getLoginIdByToken(tokenValue); + if(loginId == null) { + return; + } + + SaTokenDao dao = getSaTokenDao(); + + // 续期 Token 有效期 + dao.updateTimeout(splicingKeyTokenValue(tokenValue), timeout); + + // 续期 Token-Session 有效期 + SaSession tokenSession = getTokenSessionByToken(tokenValue, false); + if(tokenSession != null) { + tokenSession.updateTimeout(timeout); + } + + // 续期指向的 User-Session 有效期 + getSessionByLoginId(loginId).updateMinTimeout(timeout); + + // Token-Activity 活跃检查相关 + if(isOpenActivityCheck()) { + dao.updateTimeout(splicingKeyLastActivityTime(tokenValue), timeout); + } + } // ------------------- 角色验证操作 ------------------- @@ -1604,7 +1693,7 @@ public class StpLogic { } /** - * 拼接key： tokenValue的专属session + * 拼接key： tokenValue的Token-Session * @param tokenValue token值 * @return key */ @@ -1666,7 +1755,15 @@ public class StpLogic { public boolean getConfigOfIsShare() { return getConfig().getIsShare(); } - + + /** + * 返回全局配置是否开启了Token 活跃校验 + * @return / + */ + public boolean isOpenActivityCheck() { + return getConfig().getActivityTimeout() != SaTokenDao.NEVER_EXPIRE; + } + /** * 返回持久化对象 * @return / @@ -1694,7 +1791,8 @@ public class StpLogic { *

当对方再次访问系统时，会抛出NotLoginException异常，场景值=-2 * @param loginId 账号id */ - public void logoutByLoginId(Object loginId) { + @Deprecated + public void logoutByLoginId(Object loginId) { this.kickout(loginId); } @@ -1706,8 +1804,21 @@ public class StpLogic { * @param loginId 账号id * @param device 设备标识 (填null代表所有注销设备) */ - public void logoutByLoginId(Object loginId, String device) { + @Deprecated + public void logoutByLoginId(Object loginId, String device) { this.kickout(loginId, device); } - + + /** + * 创建一个TokenValue + * @param loginId loginId + * @param device 设备标识 + * @param timeout 过期时间 + * @return 生成的tokenValue + */ + @Deprecated + public String createTokenValue(Object loginId, String device, long timeout) { + return createTokenValue(loginId, device, timeout, null); + } + } diff --git a/sa-token-core/src/main/java/cn/dev33/satoken/stp/StpUtil.java b/sa-token-core/src/main/java/cn/dev33/satoken/stp/StpUtil.java index 2f46bc22..397ad657 100644 --- a/sa-token-core/src/main/java/cn/dev33/satoken/stp/StpUtil.java +++ b/sa-token-core/src/main/java/cn/dev33/satoken/stp/StpUtil.java @@ -132,6 +132,25 @@ public class StpUtil { stpLogic.login(id, loginModel); } + /** + * 创建指定账号id的登录会话 + * @param id 登录id，建议的类型：（long | int | String） + * @return 返回会话令牌 + */ + public static String createLoginSession(Object id) { + return stpLogic.createLoginSession(id); + } + + /** + * 创建指定账号id的登录会话 + * @param id 登录id，建议的类型：（long | int | String） + * @param loginModel 此次登录的参数Model + * @return 返回会话令牌 + */ + public static String createLoginSession(Object id, SaLoginModel loginModel) { + return stpLogic.createLoginSession(id, loginModel); + } + // --- 注销 /** @@ -286,7 +305,16 @@ public class StpUtil { public static Object getLoginIdByToken(String tokenValue) { return stpLogic.getLoginIdByToken(tokenValue); } - + + /** + * 获取Token扩展信息（只在jwt模式下有效） + * @param key 键值 + * @return 对应的扩展数据 + */ + public static Object getExtra(String key) { + return stpLogic.getExtra(key); + } + // =================== User-Session 相关 =================== @@ -408,8 +436,23 @@ public class StpUtil { public static long getTokenActivityTimeout() { return stpLogic.getTokenActivityTimeout(); } - + /** + * 对当前 Token 的 timeout 值进行续期 + * @param timeout 要修改成为的有效时间 (单位: 秒) + */ + public static void renewTimeout(long timeout) { + stpLogic.renewTimeout(timeout); + } + + /** + * 对指定 Token 的 timeout 值进行续期 + * @param tokenValue 指定token + * @param timeout 要修改成为的有效时间 (单位: 秒) + */ + public static void renewTimeout(String tokenValue, long timeout) { + stpLogic.renewTimeout(tokenValue, timeout); + } // =================== 角色验证操作 =================== diff --git a/sa-token-core/src/main/java/cn/dev33/satoken/util/SaResult.java b/sa-token-core/src/main/java/cn/dev33/satoken/util/SaResult.java index 388ab60e..d751215b 100644 --- a/sa-token-core/src/main/java/cn/dev33/satoken/util/SaResult.java +++ b/sa-token-core/src/main/java/cn/dev33/satoken/util/SaResult.java @@ -10,6 +10,7 @@ import java.util.Map; * code=状态码
* msg=描述信息
* data=携带对象
+ * * @author kong * */ diff --git a/sa-token-core/src/main/java/cn/dev33/satoken/util/SaTokenConsts.java b/sa-token-core/src/main/java/cn/dev33/satoken/util/SaTokenConsts.java index ae01d8f7..b7626501 100644 --- a/sa-token-core/src/main/java/cn/dev33/satoken/util/SaTokenConsts.java +++ b/sa-token-core/src/main/java/cn/dev33/satoken/util/SaTokenConsts.java @@ -13,7 +13,7 @@ public class SaTokenConsts { /** * Sa-Token 当前版本号 */ - public static final String VERSION_NO = "v1.28.0"; + public static final String VERSION_NO = "v1.29.0"; /** * Sa-Token 开源地址 diff --git a/sa-token-demo/sa-token-demo-alone-redis/pom.xml b/sa-token-demo/sa-token-demo-alone-redis/pom.xml index 48b3903c..6345fe6b 100644 --- a/sa-token-demo/sa-token-demo-alone-redis/pom.xml +++ b/sa-token-demo/sa-token-demo-alone-redis/pom.xml @@ -16,7 +16,7 @@ - 1.28.0 + 1.29.0 diff --git a/sa-token-demo/sa-token-demo-dubbo-consumer/pom.xml b/sa-token-demo/sa-token-demo-dubbo-consumer/pom.xml index df920f6c..9d79dd47 100644 --- a/sa-token-demo/sa-token-demo-dubbo-consumer/pom.xml +++ b/sa-token-demo/sa-token-demo-dubbo-consumer/pom.xml @@ -16,7 +16,7 @@ 1.8 3.1.1 - 1.28.0 + 1.29.0 diff --git a/sa-token-demo/sa-token-demo-dubbo-consumer/src/main/java/com/pj/more/TestController.java b/sa-token-demo/sa-token-demo-dubbo-consumer/src/main/java/com/pj/more/TestController.java index d933e121..096afb38 100644 --- a/sa-token-demo/sa-token-demo-dubbo-consumer/src/main/java/com/pj/more/TestController.java +++ b/sa-token-demo/sa-token-demo-dubbo-consumer/src/main/java/com/pj/more/TestController.java @@ -56,5 +56,17 @@ public class TestController { return "ok"; } + + // Provider端登录，状态在Provider端保持 + @RequestMapping("test4") + public String test4() { + // 登录 + demoService.doLogin(10004); + + // 打印一下 + demoService.isLogin("----------- 会话信息 "); + + return "ok"; + } } \ No newline at end of file diff --git a/sa-token-demo/sa-token-demo-dubbo-provider/pom.xml b/sa-token-demo/sa-token-demo-dubbo-provider/pom.xml index 7b74d4e0..6c3929ff 100644 --- a/sa-token-demo/sa-token-demo-dubbo-provider/pom.xml +++ b/sa-token-demo/sa-token-demo-dubbo-provider/pom.xml @@ -16,7 +16,7 @@ 1.8 3.1.1 - 1.28.0 + 1.29.0 diff --git a/sa-token-demo/sa-token-demo-jwt/pom.xml b/sa-token-demo/sa-token-demo-jwt/pom.xml index 940135ad..d36427be 100644 --- a/sa-token-demo/sa-token-demo-jwt/pom.xml +++ b/sa-token-demo/sa-token-demo-jwt/pom.xml @@ -16,7 +16,7 @@ - 1.28.0 + 1.29.0 diff --git a/sa-token-demo/sa-token-demo-jwt/src/main/java/com/pj/test/TestJwtController.java b/sa-token-demo/sa-token-demo-jwt/src/main/java/com/pj/test/TestJwtController.java index db7416a5..e3a5e8f4 100644 --- a/sa-token-demo/sa-token-demo-jwt/src/main/java/com/pj/test/TestJwtController.java +++ b/sa-token-demo/sa-token-demo-jwt/src/main/java/com/pj/test/TestJwtController.java @@ -73,6 +73,8 @@ public class TestJwtController { public AjaxJson test() { System.out.println(); System.out.println("--------------进入请求--------------"); + System.out.println(StpUtil.getExtra("username")); + System.out.println(StpUtil.getExtra("nick")); return AjaxJson.getSuccess(); } diff --git a/sa-token-demo/sa-token-demo-oauth2-client/pom.xml b/sa-token-demo/sa-token-demo-oauth2-client/pom.xml index 6f654a38..f7e13a68 100644 --- a/sa-token-demo/sa-token-demo-oauth2-client/pom.xml +++ b/sa-token-demo/sa-token-demo-oauth2-client/pom.xml @@ -17,7 +17,7 @@ 1.8 3.1.1 - 1.28.0 + 1.29.0 diff --git a/sa-token-demo/sa-token-demo-oauth2-server/pom.xml b/sa-token-demo/sa-token-demo-oauth2-server/pom.xml index 0a33c6c8..49ce6d06 100644 --- a/sa-token-demo/sa-token-demo-oauth2-server/pom.xml +++ b/sa-token-demo/sa-token-demo-oauth2-server/pom.xml @@ -17,7 +17,7 @@ 1.8 3.1.1 - 1.28.0 + 1.29.0 diff --git a/sa-token-demo/sa-token-demo-oauth2-server/src/main/java/com/pj/oauth2/SaOAuth2TemplateImpl.java b/sa-token-demo/sa-token-demo-oauth2-server/src/main/java/com/pj/oauth2/SaOAuth2TemplateImpl.java index 471f75b1..8db67008 100644 --- a/sa-token-demo/sa-token-demo-oauth2-server/src/main/java/com/pj/oauth2/SaOAuth2TemplateImpl.java +++ b/sa-token-demo/sa-token-demo-oauth2-server/src/main/java/com/pj/oauth2/SaOAuth2TemplateImpl.java @@ -21,7 +21,8 @@ public class SaOAuth2TemplateImpl extends SaOAuth2Template { .setClientId("10001") .setClientSecret("aaaa-bbbb-cccc-dddd-eeee") .setAllowUrl("*") - .setContractScope("userinfo"); + .setContractScope("userinfo") + .setIsAutoMode(true); } return null; } diff --git a/sa-token-demo/sa-token-demo-quick-login/pom.xml b/sa-token-demo/sa-token-demo-quick-login/pom.xml index 0588429b..651ba368 100644 --- a/sa-token-demo/sa-token-demo-quick-login/pom.xml +++ b/sa-token-demo/sa-token-demo-quick-login/pom.xml @@ -15,7 +15,7 @@ - 1.28.0 + 1.29.0 diff --git a/sa-token-demo/sa-token-demo-solon/pom.xml b/sa-token-demo/sa-token-demo-solon/pom.xml index 4a7e2dcd..c27d22c2 100644 --- a/sa-token-demo/sa-token-demo-solon/pom.xml +++ b/sa-token-demo/sa-token-demo-solon/pom.xml @@ -9,7 +9,7 @@ - 1.28.0 + 1.29.0 @@ -18,7 +18,7 @@ org.noear solon-web - 1.5.50 + 1.6.1 diff --git a/sa-token-demo/sa-token-demo-springboot/pom.xml b/sa-token-demo/sa-token-demo-springboot/pom.xml index 833e7064..3b2c91e4 100644 --- a/sa-token-demo/sa-token-demo-springboot/pom.xml +++ b/sa-token-demo/sa-token-demo-springboot/pom.xml @@ -17,7 +17,7 @@ - 1.28.0 + 1.29.0 diff --git a/sa-token-demo/sa-token-demo-springboot/src/main/java/com/pj/satoken/at/StpUserUtil.java b/sa-token-demo/sa-token-demo-springboot/src/main/java/com/pj/satoken/at/StpUserUtil.java index a0fa0767..cb0fd6a2 100644 --- a/sa-token-demo/sa-token-demo-springboot/src/main/java/com/pj/satoken/at/StpUserUtil.java +++ b/sa-token-demo/sa-token-demo-springboot/src/main/java/com/pj/satoken/at/StpUserUtil.java @@ -136,6 +136,25 @@ public class StpUserUtil { stpLogic.login(id, loginModel); } + /** + * 创建指定账号id的登录会话 + * @param id 登录id，建议的类型：（long | int | String） + * @return 返回会话令牌 + */ + public static String createLoginSession(Object id) { + return stpLogic.createLoginSession(id); + } + + /** + * 创建指定账号id的登录会话 + * @param id 登录id，建议的类型：（long | int | String） + * @param loginModel 此次登录的参数Model + * @return 返回会话令牌 + */ + public static String createLoginSession(Object id, SaLoginModel loginModel) { + return stpLogic.createLoginSession(id, loginModel); + } + // --- 注销 /** diff --git a/sa-token-demo/sa-token-demo-springboot/src/main/java/com/pj/test/TestController.java b/sa-token-demo/sa-token-demo-springboot/src/main/java/com/pj/test/TestController.java index 565923a4..0712eb2d 100644 --- a/sa-token-demo/sa-token-demo-springboot/src/main/java/com/pj/test/TestController.java +++ b/sa-token-demo/sa-token-demo-springboot/src/main/java/com/pj/test/TestController.java @@ -235,7 +235,6 @@ public class TestController { return AjaxJson.getSuccessData("登录成功"); } - // 测试 浏览器访问： http://localhost:8081/test/test @RequestMapping("test") public AjaxJson test() { @@ -248,5 +247,5 @@ public class TestController { public AjaxJson test2() { return AjaxJson.getSuccess(); } - + } diff --git a/sa-token-demo/sa-token-demo-sso-server/pom.xml b/sa-token-demo/sa-token-demo-sso-server/pom.xml index 05d8a46b..b0e1f94c 100644 --- a/sa-token-demo/sa-token-demo-sso-server/pom.xml +++ b/sa-token-demo/sa-token-demo-sso-server/pom.xml @@ -16,7 +16,7 @@ - 1.28.0 + 1.29.0 diff --git a/sa-token-demo/sa-token-demo-sso1-client/pom.xml b/sa-token-demo/sa-token-demo-sso1-client/pom.xml index ef02b80e..7f99915b 100644 --- a/sa-token-demo/sa-token-demo-sso1-client/pom.xml +++ b/sa-token-demo/sa-token-demo-sso1-client/pom.xml @@ -16,7 +16,7 @@ - 1.28.0 + 1.29.0 diff --git a/sa-token-demo/sa-token-demo-sso2-client/pom.xml b/sa-token-demo/sa-token-demo-sso2-client/pom.xml index d2c441f5..5c69df52 100644 --- a/sa-token-demo/sa-token-demo-sso2-client/pom.xml +++ b/sa-token-demo/sa-token-demo-sso2-client/pom.xml @@ -16,7 +16,7 @@ - 1.28.0 + 1.29.0 diff --git a/sa-token-demo/sa-token-demo-sso3-client/pom.xml b/sa-token-demo/sa-token-demo-sso3-client/pom.xml index 122a524b..2c098cbc 100644 --- a/sa-token-demo/sa-token-demo-sso3-client/pom.xml +++ b/sa-token-demo/sa-token-demo-sso3-client/pom.xml @@ -16,7 +16,7 @@ - 1.28.0 + 1.29.0 diff --git a/sa-token-demo/sa-token-demo-thymeleaf/pom.xml b/sa-token-demo/sa-token-demo-thymeleaf/pom.xml index 4447a432..beeb0f63 100644 --- a/sa-token-demo/sa-token-demo-thymeleaf/pom.xml +++ b/sa-token-demo/sa-token-demo-thymeleaf/pom.xml @@ -16,7 +16,7 @@ - 1.28.0 + 1.29.0 diff --git a/sa-token-demo/sa-token-demo-webflux/pom.xml b/sa-token-demo/sa-token-demo-webflux/pom.xml index 82cd6655..ac9b9bd2 100644 --- a/sa-token-demo/sa-token-demo-webflux/pom.xml +++ b/sa-token-demo/sa-token-demo-webflux/pom.xml @@ -16,7 +16,7 @@ - 1.28.0 + 1.29.0 diff --git a/sa-token-demo/sa-token-demo-websocket-spring/.gitignore b/sa-token-demo/sa-token-demo-websocket-spring/.gitignore new file mode 100644 index 00000000..99a6e767 --- /dev/null +++ b/sa-token-demo/sa-token-demo-websocket-spring/.gitignore @@ -0,0 +1,12 @@ +target/ + +node_modules/ +bin/ +.settings/ +unpackage/ +.classpath +.project + +.idea/ + +.factorypath \ No newline at end of file diff --git a/sa-token-demo/sa-token-demo-websocket-spring/pom.xml b/sa-token-demo/sa-token-demo-websocket-spring/pom.xml new file mode 100644 index 00000000..201500ae --- /dev/null +++ b/sa-token-demo/sa-token-demo-websocket-spring/pom.xml @@ -0,0 +1,69 @@ + + 4.0.0 + cn.dev33 + sa-token-demo-websocket-spring + 0.0.1-SNAPSHOT + + + + org.springframework.boot + spring-boot-starter-parent + 2.0.0.RELEASE + + + + + + + 1.29.0 + + + + + + + org.springframework.boot + spring-boot-starter-web + + + org.springframework.boot + spring-boot-starter-aop + + + + + org.springframework.boot + spring-boot-starter-websocket + + + + + cn.dev33 + sa-token-spring-boot-starter + ${sa-token-version} + + + + + + + + org.springframework.boot + spring-boot-configuration-processor + true + + + + + + \ No newline at end of file diff --git a/sa-token-demo/sa-token-demo-websocket-spring/src/main/java/com/pj/SaTokenWebSocketSpringApplication.java b/sa-token-demo/sa-token-demo-websocket-spring/src/main/java/com/pj/SaTokenWebSocketSpringApplication.java new file mode 100644 index 00000000..431fab28 --- /dev/null +++ b/sa-token-demo/sa-token-demo-websocket-spring/src/main/java/com/pj/SaTokenWebSocketSpringApplication.java @@ -0,0 +1,32 @@ +package com.pj; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; + +import cn.dev33.satoken.SaManager; + +/** + * Sa-Token 整合 WebSocket 鉴权示例 + * @author kong + * + */ +@SpringBootApplication +public class SaTokenWebSocketSpringApplication { + + /* + * 1、访问登录接口，拿到会话Token： + * http://localhost:8081/acc/doLogin?name=zhang&pwd=123456 + * + * 2、找一个WebSocket在线测试页面进行连接， + * 例如： + * https://www.bejson.com/httputil/websocket/ + * 然后连接地址： + * ws://localhost:8081/ws-connect?satoken=2e6db38f-1e78-40bc-aa8f-e8f1f77fbef5 + */ + + public static void main(String[] args) { + SpringApplication.run(SaTokenWebSocketSpringApplication.class, args); + System.out.println("\n启动成功：Sa-Token配置如下：" + SaManager.getConfig()); + } + +} diff --git a/sa-token-demo/sa-token-demo-websocket-spring/src/main/java/com/pj/test/LoginController.java b/sa-token-demo/sa-token-demo-websocket-spring/src/main/java/com/pj/test/LoginController.java new file mode 100644 index 00000000..11abbe3c --- /dev/null +++ b/sa-token-demo/sa-token-demo-websocket-spring/src/main/java/com/pj/test/LoginController.java @@ -0,0 +1,48 @@ +package com.pj.test; + +import org.springframework.web.bind.annotation.RequestMapping; +import org.springframework.web.bind.annotation.RestController; + +import cn.dev33.satoken.stp.StpUtil; +import cn.dev33.satoken.util.SaResult; + +/** + * 登录测试 + * @author kong + * + */ +@RestController +@RequestMapping("/acc/") +public class LoginController { + + // 测试登录 ---- http://localhost:8081/acc/doLogin?name=zhang&pwd=123456 + @RequestMapping("doLogin") + public SaResult doLogin(String name, String pwd) { + // 此处仅作模拟示例，真实项目需要从数据库中查询数据进行比对 + if("zhang".equals(name) && "123456".equals(pwd)) { + StpUtil.login(10001); + return SaResult.ok("登录成功").set("token", StpUtil.getTokenValue()); + } + return SaResult.error("登录失败"); + } + + // 查询登录状态 ---- http://localhost:8081/acc/isLogin + @RequestMapping("isLogin") + public SaResult isLogin() { + return SaResult.ok("是否登录：" + StpUtil.isLogin()); + } + + // 查询 Token 信息 ---- http://localhost:8081/acc/tokenInfo + @RequestMapping("tokenInfo") + public SaResult tokenInfo() { + return SaResult.data(StpUtil.getTokenInfo()); + } + + // 测试注销 ---- http://localhost:8081/acc/logout + @RequestMapping("logout") + public SaResult logout() { + StpUtil.logout(); + return SaResult.ok(); + } + +} diff --git a/sa-token-demo/sa-token-demo-websocket-spring/src/main/java/com/pj/ws/MyWebSocketHandler.java b/sa-token-demo/sa-token-demo-websocket-spring/src/main/java/com/pj/ws/MyWebSocketHandler.java new file mode 100644 index 00000000..990cc39d --- /dev/null +++ b/sa-token-demo/sa-token-demo-websocket-spring/src/main/java/com/pj/ws/MyWebSocketHandler.java @@ -0,0 +1,83 @@ +package com.pj.ws; + +import java.io.IOException; +import java.util.concurrent.ConcurrentHashMap; + +import org.springframework.web.socket.CloseStatus; +import org.springframework.web.socket.TextMessage; +import org.springframework.web.socket.WebSocketSession; +import org.springframework.web.socket.handler.TextWebSocketHandler; + +/** + * 处理 WebSocket 连接 + * + * @author kong + * @date: 2022-2-11 + */ +public class MyWebSocketHandler extends TextWebSocketHandler { + + /** + * 固定前缀 + */ + private static final String USER_ID = "user_id_"; + + /** + * 存放Session集合，方便推送消息 + */ + private static ConcurrentHashMap webSocketSessionMaps = new ConcurrentHashMap<>(); + + // 监听：连接开启 + @Override + public void afterConnectionEstablished(WebSocketSession session) throws Exception { + + // put到集合，方便后续操作 + String userId = session.getAttributes().get("userId").toString(); + webSocketSessionMaps.put(USER_ID + userId, session); + + + // 给个提示 + String tips = "Web-Socket 连接成功，sid=" + session.getId() + "，userId=" + userId; + System.out.println(tips); + sendMessage(session, tips); + } + + // 监听：连接关闭 + @Override + public void afterConnectionClosed(WebSocketSession session, CloseStatus status) throws Exception { + // 从集合移除 + String userId = session.getAttributes().get("userId").toString(); + webSocketSessionMaps.remove(USER_ID + userId); + + // 给个提示 + String tips = "Web-Socket 连接关闭，sid=" + session.getId() + "，userId=" + userId; + System.out.println(tips); + } + + // 收到消息 + @Override + public void handleTextMessage(WebSocketSession session, TextMessage message) throws IOException { + System.out.println("sid为：" + session.getId() + "，发来：" + message); + } + + // ----------- + + // 向指定客户端推送消息 + public static void sendMessage(WebSocketSession session, String message) { + try { + System.out.println("向sid为：" + session.getId() + "，发送：" + message); + session.sendMessage(new TextMessage(message)); + } catch (IOException e) { + throw new RuntimeException(e); + } + } + + // 向指定用户推送消息 + public static void sendMessage(long userId, String message) { + WebSocketSession session = webSocketSessionMaps.get(USER_ID + userId); + if(session != null) { + sendMessage(session, message); + } + } + +} + diff --git a/sa-token-demo/sa-token-demo-websocket-spring/src/main/java/com/pj/ws/WebSocketConfig.java b/sa-token-demo/sa-token-demo-websocket-spring/src/main/java/com/pj/ws/WebSocketConfig.java new file mode 100644 index 00000000..186b52be --- /dev/null +++ b/sa-token-demo/sa-token-demo-websocket-spring/src/main/java/com/pj/ws/WebSocketConfig.java @@ -0,0 +1,30 @@ +package com.pj.ws; + +import org.springframework.context.annotation.Configuration; +import org.springframework.web.socket.config.annotation.EnableWebSocket; +import org.springframework.web.socket.config.annotation.WebSocketConfigurer; +import org.springframework.web.socket.config.annotation.WebSocketHandlerRegistry; + +/** + * WebSocket 相关配置 + * + * @author kong + * @date: 2022-2-11 + */ +@Configuration +@EnableWebSocket +public class WebSocketConfig implements WebSocketConfigurer { + + // 注册 WebSocket 处理器 + @Override + public void registerWebSocketHandlers(WebSocketHandlerRegistry webSocketHandlerRegistry) { + webSocketHandlerRegistry + // WebSocket 连接处理器 + .addHandler(new MyWebSocketHandler(), "/ws-connect") + // WebSocket 拦截器 + .addInterceptors(new WebSocketInterceptor()) + // 允许跨域 + .setAllowedOrigins("*"); + } + +} diff --git a/sa-token-demo/sa-token-demo-websocket-spring/src/main/java/com/pj/ws/WebSocketInterceptor.java b/sa-token-demo/sa-token-demo-websocket-spring/src/main/java/com/pj/ws/WebSocketInterceptor.java new file mode 100644 index 00000000..3643c1a5 --- /dev/null +++ b/sa-token-demo/sa-token-demo-websocket-spring/src/main/java/com/pj/ws/WebSocketInterceptor.java @@ -0,0 +1,45 @@ +package com.pj.ws; + +import java.util.Map; + +import org.springframework.http.server.ServerHttpRequest; +import org.springframework.http.server.ServerHttpResponse; +import org.springframework.web.socket.WebSocketHandler; +import org.springframework.web.socket.server.HandshakeInterceptor; + +import cn.dev33.satoken.stp.StpUtil; + +/** + * WebSocket 握手的前置拦截器 + * + * @author kong + * @date: 2022-2-11 + */ +public class WebSocketInterceptor implements HandshakeInterceptor { + + // 握手之前触发 (return true 才会握手成功 ) + @Override + public boolean beforeHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler handler, + Map attr) { + + System.out.println("---- 握手之前触发 " + StpUtil.getTokenValue()); + + // 未登录情况下拒绝握手 + if(StpUtil.isLogin() == false) { + System.out.println("---- 未授权客户端，连接失败"); + return false; + } + + // 标记 userId，握手成功 + attr.put("userId", StpUtil.getLoginIdAsLong()); + return true; + } + + // 握手之后触发 + @Override + public void afterHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, + Exception exception) { + System.out.println("---- 握手之后触发 "); + } + +} diff --git a/sa-token-demo/sa-token-demo-websocket-spring/src/main/resources/application.yml b/sa-token-demo/sa-token-demo-websocket-spring/src/main/resources/application.yml new file mode 100644 index 00000000..cb63067a --- /dev/null +++ b/sa-token-demo/sa-token-demo-websocket-spring/src/main/resources/application.yml @@ -0,0 +1,49 @@ +# 端口 +server: + port: 8081 + +# sa-token配置 +sa-token: + # token名称 (同时也是cookie名称) + token-name: satoken + # token有效期，单位s 默认30天, -1代表永不过期 + timeout: 2592000 + # token临时有效期 (指定时间内无操作就视为token过期) 单位: 秒 + activity-timeout: -1 + # 是否允许同一账号并发登录 (为true时允许一起登录, 为false时新登录挤掉旧登录) + is-concurrent: true + # 在多人登录同一账号时，是否共用一个token (为true时所有登录共用一个token, 为false时每次登录新建一个token) + is-share: true + # token风格 + token-style: uuid + # 是否输出操作日志 + is-log: false + +spring: + # redis配置 + redis: + # Redis数据库索引（默认为0） + database: 0 + # Redis服务器地址 + host: 127.0.0.1 + # Redis服务器连接端口 + port: 6379 + # Redis服务器连接密码（默认为空） + password: + # 连接超时时间 + timeout: 10s + lettuce: + pool: + # 连接池最大连接数 + max-active: 200 + # 连接池最大阻塞等待时间（使用负值表示没有限制） + max-wait: -1ms + # 连接池中的最大空闲连接 + max-idle: 10 + # 连接池中的最小空闲连接 + min-idle: 0 + + + + + \ No newline at end of file diff --git a/sa-token-demo/sa-token-demo-websocket/.gitignore b/sa-token-demo/sa-token-demo-websocket/.gitignore new file mode 100644 index 00000000..99a6e767 --- /dev/null +++ b/sa-token-demo/sa-token-demo-websocket/.gitignore @@ -0,0 +1,12 @@ +target/ + +node_modules/ +bin/ +.settings/ +unpackage/ +.classpath +.project + +.idea/ + +.factorypath \ No newline at end of file diff --git a/sa-token-demo/sa-token-demo-websocket/pom.xml b/sa-token-demo/sa-token-demo-websocket/pom.xml new file mode 100644 index 00000000..0b52bac6 --- /dev/null +++ b/sa-token-demo/sa-token-demo-websocket/pom.xml @@ -0,0 +1,69 @@ + + 4.0.0 + cn.dev33 + sa-token-demo-websocket + 0.0.1-SNAPSHOT + + + + org.springframework.boot + spring-boot-starter-parent + 2.0.0.RELEASE + + + + + + + 1.29.0 + + + + + + + org.springframework.boot + spring-boot-starter-web + + + org.springframework.boot + spring-boot-starter-aop + + + + + org.springframework.boot + spring-boot-starter-websocket + + + + + cn.dev33 + sa-token-spring-boot-starter + ${sa-token-version} + + + + + + + + org.springframework.boot + spring-boot-configuration-processor + true + + + + + + \ No newline at end of file diff --git a/sa-token-demo/sa-token-demo-websocket/src/main/java/com/pj/SaTokenWebSocketApplication.java b/sa-token-demo/sa-token-demo-websocket/src/main/java/com/pj/SaTokenWebSocketApplication.java new file mode 100644 index 00000000..6450ede8 --- /dev/null +++ b/sa-token-demo/sa-token-demo-websocket/src/main/java/com/pj/SaTokenWebSocketApplication.java @@ -0,0 +1,32 @@ +package com.pj; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; + +import cn.dev33.satoken.SaManager; + +/** + * Sa-Token 整合 WebSocket 鉴权示例 + * @author kong + * + */ +@SpringBootApplication +public class SaTokenWebSocketApplication { + + /* + * 1、访问登录接口，拿到会话Token： + * http://localhost:8081/acc/doLogin?name=zhang&pwd=123456 + * + * 2、找一个WebSocket在线测试页面进行连接， + * 例如： + * https://www.bejson.com/httputil/websocket/ + * 然后连接地址： + * ws://localhost:8081/ws-connect/2e6db38f-1e78-40bc-aa8f-e8f1f77fbef5 + */ + + public static void main(String[] args) { + SpringApplication.run(SaTokenWebSocketApplication.class, args); + System.out.println("\n启动成功：Sa-Token配置如下：" + SaManager.getConfig()); + } + +} diff --git a/sa-token-demo/sa-token-demo-websocket/src/main/java/com/pj/test/LoginController.java b/sa-token-demo/sa-token-demo-websocket/src/main/java/com/pj/test/LoginController.java new file mode 100644 index 00000000..11abbe3c --- /dev/null +++ b/sa-token-demo/sa-token-demo-websocket/src/main/java/com/pj/test/LoginController.java @@ -0,0 +1,48 @@ +package com.pj.test; + +import org.springframework.web.bind.annotation.RequestMapping; +import org.springframework.web.bind.annotation.RestController; + +import cn.dev33.satoken.stp.StpUtil; +import cn.dev33.satoken.util.SaResult; + +/** + * 登录测试 + * @author kong + * + */ +@RestController +@RequestMapping("/acc/") +public class LoginController { + + // 测试登录 ---- http://localhost:8081/acc/doLogin?name=zhang&pwd=123456 + @RequestMapping("doLogin") + public SaResult doLogin(String name, String pwd) { + // 此处仅作模拟示例，真实项目需要从数据库中查询数据进行比对 + if("zhang".equals(name) && "123456".equals(pwd)) { + StpUtil.login(10001); + return SaResult.ok("登录成功").set("token", StpUtil.getTokenValue()); + } + return SaResult.error("登录失败"); + } + + // 查询登录状态 ---- http://localhost:8081/acc/isLogin + @RequestMapping("isLogin") + public SaResult isLogin() { + return SaResult.ok("是否登录：" + StpUtil.isLogin()); + } + + // 查询 Token 信息 ---- http://localhost:8081/acc/tokenInfo + @RequestMapping("tokenInfo") + public SaResult tokenInfo() { + return SaResult.data(StpUtil.getTokenInfo()); + } + + // 测试注销 ---- http://localhost:8081/acc/logout + @RequestMapping("logout") + public SaResult logout() { + StpUtil.logout(); + return SaResult.ok(); + } + +} diff --git a/sa-token-demo/sa-token-demo-websocket/src/main/java/com/pj/ws/WebSocketConfig.java b/sa-token-demo/sa-token-demo-websocket/src/main/java/com/pj/ws/WebSocketConfig.java new file mode 100644 index 00000000..356393ef --- /dev/null +++ b/sa-token-demo/sa-token-demo-websocket/src/main/java/com/pj/ws/WebSocketConfig.java @@ -0,0 +1,18 @@ +package com.pj.ws; + +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import org.springframework.web.socket.server.standard.ServerEndpointExporter; + +/** + * 开启WebSocket支持 + */ +@Configuration +public class WebSocketConfig { + + @Bean + public ServerEndpointExporter serverEndpointExporter() { + return new ServerEndpointExporter(); + } + +} \ No newline at end of file diff --git a/sa-token-demo/sa-token-demo-websocket/src/main/java/com/pj/ws/WebSocketConnect.java b/sa-token-demo/sa-token-demo-websocket/src/main/java/com/pj/ws/WebSocketConnect.java new file mode 100644 index 00000000..c99e701f --- /dev/null +++ b/sa-token-demo/sa-token-demo-websocket/src/main/java/com/pj/ws/WebSocketConnect.java @@ -0,0 +1,102 @@ +package com.pj.ws; + +import java.io.IOException; +import java.util.concurrent.ConcurrentHashMap; + +import javax.websocket.OnClose; +import javax.websocket.OnError; +import javax.websocket.OnMessage; +import javax.websocket.OnOpen; +import javax.websocket.Session; +import javax.websocket.server.PathParam; +import javax.websocket.server.ServerEndpoint; + +import org.springframework.stereotype.Component; + +import cn.dev33.satoken.exception.SaTokenException; +import cn.dev33.satoken.stp.StpUtil; +import cn.dev33.satoken.util.SaFoxUtil; + +/** + * WebSocket 连接测试 + */ +@Component +@ServerEndpoint("/ws-connect/{satoken}") +public class WebSocketConnect { + + /** + * 固定前缀 + */ + private static final String USER_ID = "user_id_"; + + /** + * 存放Session集合，方便推送消息 （javax.websocket.Session） + */ + private static ConcurrentHashMap sessionMap = new ConcurrentHashMap<>(); + + // 监听：连接成功 + @OnOpen + public void onOpen(Session session, @PathParam("satoken") String satoken) throws IOException { + + // 根据 token 获取对应的 userId + Object loginId = StpUtil.getLoginIdByToken(satoken); + if(loginId == null) { + session.close(); + throw new SaTokenException("连接失败，无效Token：" + satoken); + } + + // put到集合，方便后续操作 + long userId = SaFoxUtil.getValueByType(loginId, long.class); + sessionMap.put(USER_ID + userId, session); + + // 给个提示 + String tips = "Web-Socket 连接成功，sid=" + session.getId() + "，userId=" + userId; + System.out.println(tips); + sendMessage(session, tips); + } + + // 监听: 连接关闭 + @OnClose + public void onClose(Session session) { + System.out.println("连接关闭，sid=" + session.getId()); + for (String key : sessionMap.keySet()) { + if(sessionMap.get(key).getId().equals(session.getId())) { + sessionMap.remove(key); + } + } + } + + // 监听：收到客户端发送的消息 + @OnMessage + public void onMessage(Session session, String message) { + System.out.println("sid为：" + session.getId() + "，发来：" + message); + } + + // 监听：发生异常 + @OnError + public void onError(Session session, Throwable error) { + System.out.println("sid为：" + session.getId() + "，发生错误"); + error.printStackTrace(); + } + + // --------- + + // 向指定客户端推送消息 + public static void sendMessage(Session session, String message) { + try { + System.out.println("向sid为：" + session.getId() + "，发送：" + message); + session.getBasicRemote().sendText(message); + } catch (IOException e) { + throw new RuntimeException(e); + } + } + + // 向指定用户推送消息 + public static void sendMessage(long userId, String message) { + Session session = sessionMap.get(USER_ID + userId); + if(session != null) { + sendMessage(session, message); + } + } + +} diff --git a/sa-token-demo/sa-token-demo-websocket/src/main/resources/application.yml b/sa-token-demo/sa-token-demo-websocket/src/main/resources/application.yml new file mode 100644 index 00000000..cb63067a --- /dev/null +++ b/sa-token-demo/sa-token-demo-websocket/src/main/resources/application.yml @@ -0,0 +1,49 @@ +# 端口 +server: + port: 8081 + +# sa-token配置 +sa-token: + # token名称 (同时也是cookie名称) + token-name: satoken + # token有效期，单位s 默认30天, -1代表永不过期 + timeout: 2592000 + # token临时有效期 (指定时间内无操作就视为token过期) 单位: 秒 + activity-timeout: -1 + # 是否允许同一账号并发登录 (为true时允许一起登录, 为false时新登录挤掉旧登录) + is-concurrent: true + # 在多人登录同一账号时，是否共用一个token (为true时所有登录共用一个token, 为false时每次登录新建一个token) + is-share: true + # token风格 + token-style: uuid + # 是否输出操作日志 + is-log: false + +spring: + # redis配置 + redis: + # Redis数据库索引（默认为0） + database: 0 + # Redis服务器地址 + host: 127.0.0.1 + # Redis服务器连接端口 + port: 6379 + # Redis服务器连接密码（默认为空） + password: + # 连接超时时间 + timeout: 10s + lettuce: + pool: + # 连接池最大连接数 + max-active: 200 + # 连接池最大阻塞等待时间（使用负值表示没有限制） + max-wait: -1ms + # 连接池中的最大空闲连接 + max-idle: 10 + # 连接池中的最小空闲连接 + min-idle: 0 + + + + + \ No newline at end of file diff --git a/sa-token-doc/doc/README.md b/sa-token-doc/doc/README.md index b2611b51..bdd006ae 100644 --- a/sa-token-doc/doc/README.md +++ b/sa-token-doc/doc/README.md @@ -1,9 +1,9 @@

logo

-

Sa-Token v1.28.0

+

Sa-Token v1.29.0

一个轻量级 Java 权限认证框架，让鉴权变得简单、优雅！
-

+

@@ -119,8 +119,13 @@ StpUtil.switchTo(10044); // 将当前会话身份临时切换为其它账号 ## 开源仓库 Star 趋势 + +

+ [![giteye-chart](https://chart.giteye.net/gitee/dromara/sa-token/77YQZ6UK.png 'Gitee')](https://giteye.net/chart/77YQZ6UK) +

+ [![github-chart](https://starchart.cc/dromara/sa-token.svg 'GitHub')](https://starchart.cc/dromara/sa-token) 如果 Sa-Token 帮助到了您，希望您可以为其点上一个 `star`： @@ -139,13 +144,12 @@ StpUtil.switchTo(10044); // 将当前会话身份临时切换为其它账号 - **[ helio-starters ]**：[ 基于JDK15 + Spring Boot 2.4 + Sa-Token + Mybatis-Plus的单体Boot版脚手架和微服务Cloud版脚手架，带有配套后台管理前端模板及代码生成器](https://gitee.com/uncarbon97/helio-starters) -- **[ sa-token-plugin ]**：[Sa-Token第三方插件实现，基于Sa-Token-Core，提供一些与官方不同实现机制的的插件集合，作为Sa-Token开源生态的补充](https://gitee.com/bootx/sa-token-plugin) - - **[ easy-admin ]**：[一个基于SpringBoot2 + Sa-Token + Mybatis-Plus + Snakerflow + Layui 的后台管理系统，灵活多变可前后端分离，也可单体，内置代码生成器、权限管理、工作流引擎等](https://gitee.com/lakernote/easy-admin) - **[ RuoYi-Vue-Plus ]**：[基于 RuoYi-Vue 集成 SaToken + Lombok + Mybatis-Plus + Undertow + knife4j + Hutool + Feign 重写所有原生业务 定期与 RuoYi-Vue 同步](https://gitee.com/JavaLionLi/RuoYi-Vue-Plus/tree/satoken/) -如果您的项目使用了Sa-Token，欢迎提交pr +更多请参考：[Sa-Token 生态](/more/link) + ## 友情链接 - **[ OkHttps ]**：[ 一个轻量级http通信框架，API设计无比优雅，支持 WebSocket 以及 Stomp 协议](https://gitee.com/ejlchina-zhxu/okhttps) @@ -160,6 +164,8 @@ StpUtil.switchTo(10044); // 将当前会话身份临时切换为其它账号 ## 贡献者名单 感谢每一个为 Sa-Token 贡献代码的小伙伴 +

+ [![Giteye chart](https://chart.giteye.net/gitee/dromara/sa-token/CGZ7GT8E.png)](https://giteye.net/chart/CGZ7GT8E) ## 交流群 diff --git a/sa-token-doc/doc/_sidebar.md b/sa-token-doc/doc/_sidebar.md index 3b9f3e56..4b71ccf4 100644 --- a/sa-token-doc/doc/_sidebar.md +++ b/sa-token-doc/doc/_sidebar.md @@ -50,6 +50,7 @@ - [OAuth2-Server搭建](/oauth2/oauth2-server) - [OAuth2-Server端-API列表](/oauth2/oauth2-api) - [OAuth2-二次开发说明](/oauth2/oauth2-dev) + - [OAuth2-与登录会话实现数据互通](/oauth2/oauth2-interworking) - **微服务** - [分布式Session会话](/micro/dcs-session) @@ -70,7 +71,7 @@ - **其它** - [更新日志](/more/update-log) - - [友情链接](/more/link) + - [框架生态](/more/link) - [推荐公众号](/more/tj-gzh) - [赞助 Sa-Token](/more/sa-token-donate) diff --git a/sa-token-doc/doc/fun/auth-flow.md b/sa-token-doc/doc/fun/auth-flow.md index 8ec1048a..f8c6c525 100644 --- a/sa-token-doc/doc/fun/auth-flow.md +++ b/sa-token-doc/doc/fun/auth-flow.md @@ -4,11 +4,11 @@ ### Sa-Token 功能结构图： -![sa-token-rz](https://color-test.oss-cn-qingdao.aliyuncs.com/sa-token/x/sa-token-js3.png 's-w') +![sa-token-rz](https://oss.dev33.cn/sa-token/art/sa-token-js4.png 's-w') ### Sa-Token 认证流程图： -![sa-token-rz](https://color-test.oss-cn-qingdao.aliyuncs.com/sa-token/x/sa-token-rz2.png 's-w') +![sa-token-rz](https://oss.dev33.cn/sa-token/art/sa-token-rz2.png 's-w') diff --git a/sa-token-doc/doc/fun/timeline.md b/sa-token-doc/doc/fun/timeline.md index 717727a2..d62c91dd 100644 --- a/sa-token-doc/doc/fun/timeline.md +++ b/sa-token-doc/doc/fun/timeline.md @@ -18,8 +18,9 @@ - **2021-07-29：** Gitee star 数量破3K。 - **2021-09-07：** GitHub star 数量破6K。 - **2021-09-24：** Sa-Token star 数量 (6280) 超过 SpringSecurity (6247)。 -- **2021-10-19：** Gitee star数量破4K。 +- **2021-10-19：** Gitee star 数量破4K。 - **2021-11-08：** 荣获开源中国 “码云 GVP 认证”。 -- **2021-11-17：** GitHub star数量破7K。 +- **2021-11-17：** GitHub star 数量破7K。 +- **2021-11-28：** Gitee star 数量破5K。 diff --git a/sa-token-doc/doc/fun/token-timeout.md b/sa-token-doc/doc/fun/token-timeout.md index aeadfca8..26332a23 100644 --- a/sa-token-doc/doc/fun/token-timeout.md +++ b/sa-token-doc/doc/fun/token-timeout.md @@ -7,7 +7,7 @@ Sa-Token 提供两种Token自动过期策略，分别是`timeout`与`activity-ti ### timeout 1. `timeout`代表Token的长久有效期，单位/秒，例如将其配置为 2592000 (30天)，代表在30天后，Token必定过期，无法继续使用 -2. `timeout`无法续签，想要继续使用必须重新登录 +2. `timeout`~~无法续签，想要继续使用必须重新登录~~。v1.29.0+ 版本新增续期方法：`StpUtil.renewTimeout(100)`。 3. `timeout`的值配置为-1后，代表永久有效，不会过期 diff --git a/sa-token-doc/doc/index.html b/sa-token-doc/doc/index.html index 5e75004c..f0c5345e 100644 --- a/sa-token-doc/doc/index.html +++ b/sa-token-doc/doc/index.html @@ -13,51 +13,85 @@ - +
+
+ +
+ +

Sa-Token

+ v1.29.0 +
+ +
+ +
+ - 🌱 生态 - ❤️ 赞助 - 🧾 更新日志 - + --> +
加载中...
@@ -65,12 +99,24 @@
+ + + + + + @@ -161,6 +163,7 @@ + @@ -192,7 +195,6 @@ s.parentNode.insertBefore(hm, s); })(); - - + diff --git a/sa-token-doc/doc/lib/docsify-plugin.js b/sa-token-doc/doc/lib/docsify-plugin.js new file mode 100644 index 00000000..038403d4 --- /dev/null +++ b/sa-token-doc/doc/lib/docsify-plugin.js @@ -0,0 +1,86 @@ +// 声明 docsify 插件 +var myDocsifyPlugin = function(hook, vm) { + + // 钩子函数：解析之前执行 + hook.beforeEach(function(content) { + try{ + // 功能 1，替换全局变量 + content = content.replace(/\$\{sa.top.version\}/g, window.saTokenTopVersion); + + // 添加 [toc] 标记 + content = content.replace(/\[\[toc\]\]/g, '
'); + + }catch(e){ + // + } + return content; + }); + + // 钩子函数：每次路由切换时，解析内容之后执行 + hook.afterEach(function(html) { + + // 功能 2，文章底部添加仓库地址 + var url = 'https://gitee.com/dromara/sa-token/tree/dev/sa-token-doc/doc/' + vm.route.file; + var url2 = 'https://github.com/dromara/sa-token/tree/dev/sa-token-doc/doc/' + vm.route.file; + var footer = [ + '






', + '' + ].join(''); + return html + footer; + }); + + // 每钩子函数：次路由切换时数据全部加载完成后调用，没有参数。 + hook.doneEach(function() { + + // 功能3，给代码盒子，添加行数样式 + $('pre code').each(function(){ + var lines = $(this).text().split('\n').length; + var $numbering = $('