lsm/sa-token
1
0
Fork 0
mirror of https://gitee.com/dromara/sa-token.git synced 2026-02-27 16:50:24 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Id-Token 模块更名为 Same-Token

Browse Source
This commit is contained in:
click33
2022-10-24 12:25:22 +08:00
parent 00886066e3
commit 2dc0a44dfe
34 changed files with 564 additions and 180 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
sa-token-core/src/main/java/cn/dev33/satoken/SaManager.java
View File

@@ -13,6 +13,7 @@ import cn.dev33.satoken.dao.SaTokenDaoDefaultImpl;
import cn.dev33.satoken.exception.SaTokenException;
import cn.dev33.satoken.json.SaJsonTemplate;
import cn.dev33.satoken.json.SaJsonTemplateDefaultImpl;
import cn.dev33.satoken.same.SaSameTemplate;
import cn.dev33.satoken.sign.SaSignTemplate;
import cn.dev33.satoken.sign.SaSignTemplateDefaultImpl;
import cn.dev33.satoken.stp.StpInterface;
@@ -191,6 +192,24 @@ public class SaManager {
}
return saSignTemplate;
}
/**
* Same-Token Bean
*/
private volatile static SaSameTemplate saSameTemplate;
public static void setSaSameTemplate(SaSameTemplate saSameTemplate) {
SaManager.saSameTemplate = saSameTemplate;
}
public static SaSameTemplate getSaSameTemplate() {
if (saSameTemplate == null) {
synchronized (SaManager.class) {
if (saSameTemplate == null) {
setSaSameTemplate(new SaSameTemplate());
}
}
}
return saSameTemplate;
}
/**
* StpLogic集合, 记录框架所有成功初始化的StpLogic

2
sa-token-core/src/main/java/cn/dev33/satoken/application/SaApplication.java
View File

@@ -63,7 +63,7 @@ public class SaApplication implements SaSetValueInterface {
public List<String> keys() {
// 查出来
String prefix = splicingDataKey("");
List<String> list = SaManager.getSaTokenDao().searchData(prefix, "", -1, 0, true);
List<String> list = SaManager.getSaTokenDao().searchData(prefix, "", 0, -1, true);
// 裁减掉固定前缀
int prefixLength = prefix.length();

104
sa-token-core/src/main/java/cn/dev33/satoken/config/SaTokenConfig.java
View File

@@ -74,11 +74,6 @@ public class SaTokenConfig implements Serializable {
* jwt秘钥 (只有集成 jwt 模块时此参数才会生效)
*/
private String jwtSecretKey;
/**
* Id-Token的有效期 (单位: 秒)
*/
private long idTokenTimeout = 60 * 60 * 24;
/**
* Http Basic 认证的账号和密码
@@ -88,8 +83,14 @@ public class SaTokenConfig implements Serializable {
/** 配置当前项目的网络访问地址 */
private String currDomain;
/** 是否校验Id-Token（部分rpc插件有效） */
private Boolean checkIdToken = false;
/**
* Same-Token 的有效期 (单位: 秒)
*/
private long sameTokenTimeout = 60 * 60 * 24;
/** 是否校验Same-Token（部分rpc插件有效） */
private Boolean checkSameToken = false;
/**
* Cookie配置对象
@@ -389,22 +390,6 @@ public class SaTokenConfig implements Serializable {
return this;
}
/**
* @return Id-Token的有效期 (单位: 秒)
*/
public long getIdTokenTimeout() {
return idTokenTimeout;
}
/**
* @param idTokenTimeout Id-Token的有效期 (单位: 秒)
* @return 对象自身
*/
public SaTokenConfig setIdTokenTimeout(long idTokenTimeout) {
this.idTokenTimeout = idTokenTimeout;
return this;
}
/**
* @return Http Basic 认证的账号和密码
*/
@@ -438,18 +423,34 @@ public class SaTokenConfig implements Serializable {
}
/**
* @return 是否校验Id-Token（部分rpc插件有效）
* @return Same-Token 的有效期 (单位: 秒)
*/
public Boolean getCheckIdToken() {
return checkIdToken;
public long getSameTokenTimeout() {
return sameTokenTimeout;
}
/**
* @param checkIdToken 是否校验Id-Token（部分rpc插件有效）
* @return 对象自身
* @param sameTokenTimeout Same-Token 的有效期 (单位: 秒)
* @return 对象自身
*/
public SaTokenConfig setCheckIdToken(Boolean checkIdToken) {
this.checkIdToken = checkIdToken;
public SaTokenConfig setSameTokenTimeout(long sameTokenTimeout) {
this.sameTokenTimeout = sameTokenTimeout;
return this;
}
/**
* @return 是否校验Same-Token（部分rpc插件有效）
*/
public Boolean getCheckSameToken() {
return checkSameToken;
}
/**
* @param checkSameToken 是否校验Same-Token（部分rpc插件有效）
* @return 对象自身
*/
public SaTokenConfig setCheckSameToken(Boolean checkSameToken) {
this.checkSameToken = checkSameToken;
return this;
}
@@ -490,10 +491,10 @@ public class SaTokenConfig implements Serializable {
+ ", isPrint=" + isPrint
+ ", isLog=" + isLog
+ ", jwtSecretKey=" + jwtSecretKey
+ ", idTokenTimeout=" + idTokenTimeout
+ ", basic=" + basic
+ ", currDomain=" + currDomain
+ ", checkIdToken=" + checkIdToken
+ ", sameTokenTimeout=" + sameTokenTimeout
+ ", checkSameToken=" + checkSameToken
+ ", cookie=" + cookie
+ "]";
}
@@ -519,5 +520,44 @@ public class SaTokenConfig implements Serializable {
return this;
}
/**
* <h1> 本函数设计已过时，未来版本可能移除此函数，请及时更换为 getSameTokenTimeout() ，使用方式保持不变 </h1>
* @return Id-Token的有效期 (单位: 秒)
*/
@Deprecated
public long getIdTokenTimeout() {
return sameTokenTimeout;
}
/**
* <h1> 本函数设计已过时，未来版本可能移除此函数，请及时更换为 setSameTokenTimeout() ，使用方式保持不变 </h1>
* @param idTokenTimeout Id-Token的有效期 (单位: 秒)
* @return 对象自身
*/
@Deprecated
public SaTokenConfig setIdTokenTimeout(long idTokenTimeout) {
this.sameTokenTimeout = idTokenTimeout;
return this;
}
/**
* <h1> 本函数设计已过时，未来版本可能移除此函数，请及时更换为 getCheckSameToken() ，使用方式保持不变 </h1>
* @return 是否校验Id-Token（部分rpc插件有效）
*/
@Deprecated
public Boolean getCheckIdToken() {
return checkSameToken;
}
/**
* <h1> 本函数设计已过时，未来版本可能移除此函数，请及时更换为 setCheckSameToken() ，使用方式保持不变 </h1>
* @param checkIdToken 是否校验Id-Token（部分rpc插件有效）
* @return 对象自身
*/
@Deprecated
public SaTokenConfig setCheckIdToken(Boolean checkIdToken) {
this.checkSameToken = checkIdToken;
return this;
}
}

2
sa-token-core/src/main/java/cn/dev33/satoken/exception/IdTokenInvalidException.java
View File

@@ -1,10 +1,12 @@
package cn.dev33.satoken.exception;
/**
* <h1> 本类设计已过时，未来版本可能移除此类，请及时更换为 SameTokenInvalidException ，使用方式保持不变 </h1>
* 一个异常：代表提供的 Id-Token 无效
*
* @author kong
*/
@Deprecated
public class IdTokenInvalidException extends SaTokenException {
/**

24
sa-token-core/src/main/java/cn/dev33/satoken/exception/SameTokenInvalidException.java Normal file
View File

@@ -0,0 +1,24 @@
package cn.dev33.satoken.exception;
/**
* 一个异常：代表提供的 Same-Token 无效
*
* @author kong
* @since 2022-10-24
*/
public class SameTokenInvalidException extends SaTokenException {
/**
* 序列化版本号
*/
private static final long serialVersionUID = 6806129545290130144L;
/**
* 一个异常：代表提供的 Same-Token 无效
* @param message 异常描述
*/
public SameTokenInvalidException(String message) {
super(message);
}
}

3
sa-token-core/src/main/java/cn/dev33/satoken/id/SaIdTemplate.java
View File

@@ -6,11 +6,14 @@ import cn.dev33.satoken.exception.IdTokenInvalidException;
import cn.dev33.satoken.util.SaFoxUtil;
/**
* <h1> 本类设计已过时，未来版本可能移除此类，请及时更换为 SaSameTemplate ，使用方式保持不变 </h1>
*
* Sa-Token-Id 身份凭证模块
* <p> 身份凭证的获取与校验，可用于微服务内部调用鉴权
* @author kong
*
*/
@Deprecated
public class SaIdTemplate {
/**

3
sa-token-core/src/main/java/cn/dev33/satoken/id/SaIdUtil.java
View File

@@ -1,10 +1,13 @@
package cn.dev33.satoken.id;
/**
* <h1> 本类设计已过时，未来版本可能移除此类，请及时更换为 SaSameUtil ，使用方式保持不变 </h1>
*
* Sa-Token-Id 身份凭证模块-工具类
* @author kong
*
*/
@Deprecated
public class SaIdUtil {
private SaIdUtil(){}

174
sa-token-core/src/main/java/cn/dev33/satoken/same/SaSameTemplate.java Normal file
View File

@@ -0,0 +1,174 @@
package cn.dev33.satoken.same;
import cn.dev33.satoken.SaManager;
import cn.dev33.satoken.context.SaHolder;
import cn.dev33.satoken.exception.SameTokenInvalidException;
import cn.dev33.satoken.util.SaFoxUtil;
/**
* Sa Same-Token 同源系统身份认证模块 - 模板方法类
*
* <p> 解决同源系统互相调用时的身份认证校验， 例如：微服务网关请求转发鉴权、微服务RPC调用鉴权
*
* @author kong
* @since 2022-10-24
*/
public class SaSameTemplate {
/**
* 提交 Same-Token 时，建议使用的参数名称
*/
public static final String SAME_TOKEN = "SA-SAME-TOKEN";
// -------------------- 获取 & 校验
/**
* 获取当前 Same-Token, 如果不存在，则立即创建并返回
* @return /
*/
public String getToken() {
String currentToken = getTokenNh();
if(SaFoxUtil.isEmpty(currentToken)) {
// 注意这里的自刷新不能做到高并发可用
currentToken = refreshToken();
}
return currentToken;
}
/**
* 判断一个 Same-Token 是否有效
* @param token /
* @return /
*/
public boolean isValid(String token) {
// 1、 如果传入的 token 为空，则立即返回 false
if(SaFoxUtil.isEmpty(token)) {
return false;
}
// 2、 验证当前 Same-Token 及 Past-Same-Token
return token.equals(getToken()) || token.equals(getPastTokenNh());
}
/**
* 校验一个 Same-Token 是否有效 (如果无效则抛出异常)
* @param token /
*/
public void checkToken(String token) {
if(isValid(token) == false) {
token = (token == null ? "" : token);
throw new SameTokenInvalidException("无效Same-Token：" + token);
}
}
/**
* 校验当前 Request 上下文提供的 Same-Token 是否有效 (如果无效则抛出异常)
*/
public void checkCurrentRequestToken() {
checkToken(SaHolder.getRequest().getHeader(SAME_TOKEN));
}
/**
* 刷新一次 Same-Token (注意集群环境中不要多个服务重复调用)
* @return 刷新后产生的新 Same-Token
*/
public String refreshToken() {
// 1. 先将当前 Same-Token 写入到 Past-Same-Token 中
String sameToken = getTokenNh();
if(SaFoxUtil.isEmpty(sameToken) == false) {
savePastToken(sameToken, getTokenTimeout());
}
// 2. 再刷新当前 Same-Token
String newSameToken = createToken();
saveToken(newSameToken);
// 3. 返回新的 Same-Token
return newSameToken;
}
// ------------------------------ 保存Token
/**
* 保存 Same-Token
* @param token /
*/
public void saveToken(String token) {
if(SaFoxUtil.isEmpty(token)) {
return;
}
SaManager.getSaTokenDao().set(splicingTokenSaveKey(), token, SaManager.getConfig().getSameTokenTimeout());
}
/**
* 保存 Past-Same-Token
* @param token token
* @param timeout 有效期（单位：秒）
*/
public void savePastToken(String token, long timeout){
if(SaFoxUtil.isEmpty(token)) {
return;
}
SaManager.getSaTokenDao().set(splicingPastTokenSaveKey(), token, timeout);
}
// -------------------- 获取Token
/**
* 获取 Same-Token，不做任何处理
* @return /
*/
public String getTokenNh() {
return SaManager.getSaTokenDao().get(splicingTokenSaveKey());
}
/**
* 获取 Past-Same-Token，不做任何处理
* @return /
*/
public String getPastTokenNh() {
return SaManager.getSaTokenDao().get(splicingPastTokenSaveKey());
}
/**
* 获取 Same-Token 的剩余有效期 (单位：秒)
* @return /
*/
public long getTokenTimeout() {
return SaManager.getSaTokenDao().getTimeout(splicingTokenSaveKey());
}
// -------------------- 创建Token
/**
* 创建一个 Same-Token
* @return Token
*/
public String createToken() {
return SaFoxUtil.getRandomString(64);
}
// -------------------- 拼接key
/**
* 拼接key：Same-Token 的存储 key
* @return key
*/
public String splicingTokenSaveKey() {
return SaManager.getConfig().getTokenName() + ":var:same-token";
}
/**
* 拼接key：次级 Same-Token 的存储 key
* @return key
*/
public String splicingPastTokenSaveKey() {
return SaManager.getConfig().getTokenName() + ":var:past-same-token";
}
}

83
sa-token-core/src/main/java/cn/dev33/satoken/same/SaSameUtil.java Normal file
View File

@@ -0,0 +1,83 @@
package cn.dev33.satoken.same;
import cn.dev33.satoken.SaManager;
/**
* Sa Same-Token 同源系统身份认证模块 - 工具类
*
* <p> 解决同源系统互相调用时的身份认证校验， 例如：微服务网关请求转发鉴权、微服务RPC调用鉴权
*
* @author kong
* @since 2022-10-24
*/
public class SaSameUtil {
private SaSameUtil(){}
/**
* 提交 Same-Token 时，建议使用的参数名称
*/
public static final String SAME_TOKEN = SaSameTemplate.SAME_TOKEN;
// -------------------- 获取 & 校验
/**
* 获取当前 Same-Token, 如果不存在，则立即创建并返回
* @return /
*/
public static String getToken() {
return SaManager.getSaSameTemplate().getToken();
}
/**
* 判断一个 Same-Token 是否有效
* @param token /
* @return /
*/
public static boolean isValid(String token) {
return SaManager.getSaSameTemplate().isValid(token);
}
/**
* 校验一个 Same-Token 是否有效 (如果无效则抛出异常)
* @param token /
*/
public static void checkToken(String token) {
SaManager.getSaSameTemplate().checkToken(token);
}
/**
* 校验当前 Request 上下文提供的 Same-Token 是否有效 (如果无效则抛出异常)
*/
public static void checkCurrentRequestToken() {
SaManager.getSaSameTemplate().checkCurrentRequestToken();
}
/**
* 刷新一次 Same-Token (注意集群环境中不要多个服务重复调用)
* @return 刷新后产生的新 Same-Token
*/
public static String refreshToken() {
return SaManager.getSaSameTemplate().refreshToken();
}
// -------------------- 获取Token
/**
* 获取 Same-Token，不做任何处理
* @return /
*/
public static String getTokenNh() {
return SaManager.getSaSameTemplate().getTokenNh();
}
/**
* 获取 Past-Same-Token，不做任何处理
* @return /
*/
public static String getPastTokenNh() {
return SaManager.getSaSameTemplate().getPastTokenNh();
}
}