Merge branch 'dev' into pref/1.31.0-double_check_lock

This commit is contained in:
click33
2022-08-26 00:21:39 +08:00
committed by GitHub
156 changed files with 5194 additions and 1469 deletions

View File

@@ -21,6 +21,7 @@
<module>sa-token-alone-redis</module>
<module>sa-token-dao-redis</module>
<module>sa-token-dao-redis-jackson</module>
<module>sa-token-dao-redis-fastjson</module>
<module>sa-token-dao-redisx</module>
<module>sa-token-dialect-thymeleaf</module>
<module>sa-token-sso</module>

View File

@@ -37,12 +37,13 @@ public class SaStorageForDubbo implements SaStorage {
* 在 [Request作用域] 里写入一个值
*/
@Override
public void set(String key, Object value) {
public SaStorageForDubbo set(String key, Object value) {
rpcContext.setObjectAttachment(key, value);
// 如果是token写入则回传到Consumer端
if(key.equals(SaTokenConsts.JUST_CREATED_NOT_PREFIX)) {
RpcContext.getServerContext().setAttachment(key, value);
}
return this;
}
/**
@@ -57,8 +58,9 @@ public class SaStorageForDubbo implements SaStorage {
* 在 [Request作用域] 里删除一个值
*/
@Override
public void delete(String key) {
public SaStorageForDubbo delete(String key) {
rpcContext.removeAttachment(key);
return this;
}
}

View File

@@ -0,0 +1,13 @@
target/
node_modules/
bin/
.settings/
unpackage/
.classpath
.project
.factorypath
.idea/
.iml

View File

@@ -0,0 +1,34 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<parent>
<artifactId>sa-token-plugin</artifactId>
<groupId>cn.dev33</groupId>
<version>${revision}</version>
<relativePath>../pom.xml</relativePath>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>sa-token-dao-redis-fastjson</artifactId>
<dependencies>
<!-- sa-token-spring-boot-starter -->
<dependency>
<groupId>cn.dev33</groupId>
<artifactId>sa-token-core</artifactId>
<version>${revision}</version>
</dependency>
<!-- RedisTemplate 相关操作API -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-redis</artifactId>
<version>2.3.3.RELEASE</version>
</dependency>
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>fastjson</artifactId>
<version>1.2.83</version>
</dependency>
</dependencies>
</project>

View File

@@ -0,0 +1,239 @@
package cn.dev33.satoken.dao;
import cn.dev33.satoken.session.SaSession;
import cn.dev33.satoken.util.SaFoxUtil;
import com.alibaba.fastjson.JSON;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.redis.connection.RedisConnectionFactory;
import org.springframework.data.redis.core.StringRedisTemplate;
import org.springframework.data.redis.serializer.StringRedisSerializer;
import org.springframework.stereotype.Component;
import java.util.ArrayList;
import java.util.List;
import java.util.Set;
import java.util.concurrent.TimeUnit;
/**
* Sa-Token持久层接口 [Redis版 (使用JSON字符串进行序列化)]
*
* @author sikadai
*
*/
@Component
public class SaTokenDaoRedisFastjson implements SaTokenDao {
/**
* String专用
*/
public StringRedisTemplate stringRedisTemplate;
/**
* Object专用
*/
public StringRedisTemplate objectRedisTemplate;
/**
* 标记:是否已初始化成功
*/
public boolean isInit;
@Autowired
public void init(RedisConnectionFactory connectionFactory) {
// 不重复初始化
if(this.isInit) {
return;
}
// 指定相应的序列化方案
StringRedisSerializer keySerializer = new StringRedisSerializer();
StringRedisSerializer valueSerializer = new StringRedisSerializer();
// 构建StringRedisTemplate
StringRedisTemplate stringTemplate = new StringRedisTemplate();
stringTemplate.setConnectionFactory(connectionFactory);
stringTemplate.afterPropertiesSet();
// 构建RedisTemplate
StringRedisTemplate template = new StringRedisTemplate();
template.setConnectionFactory(connectionFactory);
template.setKeySerializer(keySerializer);
template.setHashKeySerializer(keySerializer);
template.setValueSerializer(valueSerializer);
template.setHashValueSerializer(valueSerializer);
template.afterPropertiesSet();
// 开始初始化相关组件
this.stringRedisTemplate = stringTemplate;
this.objectRedisTemplate = template;
this.isInit = true;
}
/**
* 获取Value如无返空
*/
@Override
public String get(String key) {
return stringRedisTemplate.opsForValue().get(key);
}
/**
* 写入Value并设定存活时间 (单位: 秒)
*/
@Override
public void set(String key, String value, long timeout) {
if(timeout == 0 || timeout <= SaTokenDao.NOT_VALUE_EXPIRE) {
return;
}
// 判断是否为永不过期
if(timeout == SaTokenDao.NEVER_EXPIRE) {
stringRedisTemplate.opsForValue().set(key, value);
} else {
stringRedisTemplate.opsForValue().set(key, value, timeout, TimeUnit.SECONDS);
}
}
/**
* 修改指定key-value键值对 (过期时间不变)
*/
@Override
public void update(String key, String value) {
long expire = getTimeout(key);
// -2 = 无此键
if(expire == SaTokenDao.NOT_VALUE_EXPIRE) {
return;
}
this.set(key, value, expire);
}
/**
* 删除Value
*/
@Override
public void delete(String key) {
stringRedisTemplate.delete(key);
}
/**
* 获取Value的剩余存活时间 (单位: 秒)
*/
@Override
public long getTimeout(String key) {
return stringRedisTemplate.getExpire(key);
}
/**
* 修改Value的剩余存活时间 (单位: 秒)
*/
@Override
public void updateTimeout(String key, long timeout) {
// 判断是否想要设置为永久
if(timeout == SaTokenDao.NEVER_EXPIRE) {
long expire = getTimeout(key);
if(expire == SaTokenDao.NEVER_EXPIRE) {
// 如果其已经被设置为永久,则不作任何处理
} else {
// 如果尚未被设置为永久那么再次set一次
this.set(key, this.get(key), timeout);
}
return;
}
stringRedisTemplate.expire(key, timeout, TimeUnit.SECONDS);
}
/**
* 获取Object如无返空
*/
@Override
public Object getObject(String key) {
return objectRedisTemplate.opsForValue().get(key);
}
@Override
public SaSession getSession(String sessionId) {
Object obj = getObject(sessionId);
if (obj == null) {
return null;
}
return JSON.parseObject(obj.toString(), SaSession.class);
}
/**
* 写入Object并设定存活时间 (单位: 秒)
*/
@Override
public void setObject(String key, Object object, long timeout) {
if(timeout == 0 || timeout <= SaTokenDao.NOT_VALUE_EXPIRE) {
return;
}
String toValue = JSON.toJSONString(object);
// 判断是否为永不过期
if(timeout == SaTokenDao.NEVER_EXPIRE) {
objectRedisTemplate.opsForValue().set(key, toValue);
} else {
objectRedisTemplate.opsForValue().set(key, toValue, timeout, TimeUnit.SECONDS);
}
}
/**
* 更新Object (过期时间不变)
*/
@Override
public void updateObject(String key, Object object) {
long expire = getObjectTimeout(key);
// -2 = 无此键
if(expire == SaTokenDao.NOT_VALUE_EXPIRE) {
return;
}
this.setObject(key, object, expire);
}
/**
* 删除Object
*/
@Override
public void deleteObject(String key) {
objectRedisTemplate.delete(key);
}
/**
* 获取Object的剩余存活时间 (单位: 秒)
*/
@Override
public long getObjectTimeout(String key) {
return objectRedisTemplate.getExpire(key);
}
/**
* 修改Object的剩余存活时间 (单位: 秒)
*/
@Override
public void updateObjectTimeout(String key, long timeout) {
// 判断是否想要设置为永久
if(timeout == SaTokenDao.NEVER_EXPIRE) {
long expire = getObjectTimeout(key);
if(expire == SaTokenDao.NEVER_EXPIRE) {
// 如果其已经被设置为永久,则不作任何处理
} else {
// 如果尚未被设置为永久那么再次set一次
this.setObject(key, this.getObject(key), timeout);
}
return;
}
objectRedisTemplate.expire(key, timeout, TimeUnit.SECONDS);
}
/**
* 搜索数据
*/
@Override
public List<String> searchData(String prefix, String keyword, int start, int size, boolean sortType) {
Set<String> keys = stringRedisTemplate.keys(prefix + "*" + keyword + "*");
List<String> list = new ArrayList<String>(keys);
return SaFoxUtil.searchList(list, start, size, sortType);
}
}

View File

@@ -0,0 +1 @@
org.springframework.boot.autoconfigure.EnableAutoConfiguration=cn.dev33.satoken.dao.SaTokenDaoRedisFastjson

View File

@@ -69,6 +69,10 @@ public class SaTokenDaoRedisJackson implements SaTokenDao {
@Autowired
public void init(RedisConnectionFactory connectionFactory) {
// 不重复初始化
if(this.isInit) {
return;
}
// 指定相应的序列化方案
StringRedisSerializer keySerializer = new StringRedisSerializer();
@@ -112,11 +116,9 @@ public class SaTokenDaoRedisJackson implements SaTokenDao {
template.afterPropertiesSet();
// 开始初始化相关组件
if(this.isInit == false) {
this.stringRedisTemplate = stringTemplate;
this.objectRedisTemplate = template;
this.isInit = true;
}
this.stringRedisTemplate = stringTemplate;
this.objectRedisTemplate = template;
this.isInit = true;
}
@@ -271,10 +273,10 @@ public class SaTokenDaoRedisJackson implements SaTokenDao {
* 搜索数据
*/
@Override
public List<String> searchData(String prefix, String keyword, int start, int size) {
public List<String> searchData(String prefix, String keyword, int start, int size, boolean sortType) {
Set<String> keys = stringRedisTemplate.keys(prefix + "*" + keyword + "*");
List<String> list = new ArrayList<String>(keys);
return SaFoxUtil.searchList(list, start, size);
return SaFoxUtil.searchList(list, start, size, sortType);
}
}

View File

@@ -41,6 +41,11 @@ public class SaTokenDaoRedis implements SaTokenDao {
@Autowired
public void init(RedisConnectionFactory connectionFactory) {
// 不重复初始化
if(this.isInit) {
return;
}
// 指定相应的序列化方案
StringRedisSerializer keySerializer = new StringRedisSerializer();
JdkSerializationRedisSerializer valueSerializer = new JdkSerializationRedisSerializer();
@@ -58,11 +63,9 @@ public class SaTokenDaoRedis implements SaTokenDao {
template.afterPropertiesSet();
// 开始初始化相关组件
if(this.isInit == false) {
this.stringRedisTemplate = stringTemplate;
this.objectRedisTemplate = template;
this.isInit = true;
}
this.stringRedisTemplate = stringTemplate;
this.objectRedisTemplate = template;
this.isInit = true;
}
@@ -217,10 +220,10 @@ public class SaTokenDaoRedis implements SaTokenDao {
* 搜索数据
*/
@Override
public List<String> searchData(String prefix, String keyword, int start, int size) {
public List<String> searchData(String prefix, String keyword, int start, int size, boolean sortType) {
Set<String> keys = stringRedisTemplate.keys(prefix + "*" + keyword + "*");
List<String> list = new ArrayList<String>(keys);
return SaFoxUtil.searchList(list, start, size);
return SaFoxUtil.searchList(list, start, size, sortType);
}

View File

@@ -0,0 +1,33 @@
### 使用示例
#### 1.配置
```yaml
sa-token-dao: #名字可以随意取
redis:
server: "localhost:6379"
password: 123456
db: 1
```
#### 2.代码
**注入风格**
```java
@Configuration
public class Config {
@Bean
public SaTokenDao saTokenDaoInit(@Inject("${sa-token-dao.redis}") SaTokenDaoOfRedis saTokenDao) {
return saTokenDao;
}
}
```
**手动风格**
```java
SaTokenDaoOfRedis saTokenDao = new SaTokenDaoOfRedis(props);
SaManager.setSaTokenDao(saTokenDao);
```

View File

@@ -33,7 +33,8 @@
<dependency>
<groupId>org.noear</groupId>
<artifactId>solon-test</artifactId>
<version>1.7.5</version>
<version>1.9.1</version>
<scope>test</scope>
</dependency>
</dependencies>

View File

@@ -177,9 +177,9 @@ public class SaTokenDaoOfRedis implements SaTokenDao {
* 搜索数据
*/
@Override
public List<String> searchData(String prefix, String keyword, int start, int size) {
public List<String> searchData(String prefix, String keyword, int start, int size, boolean sortType) {
Set<String> keys = redisBucket.keys(prefix + "*" + keyword + "*");
List<String> list = new ArrayList<String>(keys);
return SaFoxUtil.searchList(list, start, size);
return SaFoxUtil.searchList(list, start, size, sortType);
}
}

View File

@@ -26,8 +26,8 @@
<!-- hutool (jwt) -->
<dependency>
<groupId>cn.hutool</groupId>
<artifactId>hutool-all</artifactId>
<version>5.7.14</version>
<artifactId>hutool-jwt</artifactId>
<version>5.8.5</version>
</dependency>
</dependencies>

View File

@@ -0,0 +1,274 @@
package cn.dev33.satoken.jwt;
import java.util.Map;
import java.util.Objects;
import cn.dev33.satoken.dao.SaTokenDao;
import cn.dev33.satoken.jwt.exception.SaJwtException;
import cn.dev33.satoken.jwt.exception.SaJwtExceptionCode;
import cn.dev33.satoken.util.SaFoxUtil;
import cn.hutool.json.JSONObject;
import cn.hutool.jwt.JWT;
import cn.hutool.jwt.JWTException;
/**
* jwt 操作模板方法封装
* @author kong
*
*/
public class SaJwtTemplate {
/**
* key账号类型
*/
public static final String LOGIN_TYPE = "loginType";
/**
* key账号id
*/
public static final String LOGIN_ID = "loginId";
/**
* key登录设备类型
*/
public static final String DEVICE = "device";
/**
* key有效截止期 (时间戳)
*/
public static final String EFF = "eff";
/**
* key乱数 混入随机字符串,防止每次生成的 token 都是一样的
*/
public static final String RN_STR = "rnStr";
/**
* 当有效期被设为此值时,代表永不过期
*/
public static final long NEVER_EXPIRE = SaTokenDao.NEVER_EXPIRE;
/**
* 表示一个值不存在
*/
public static final long NOT_VALUE_EXPIRE = SaTokenDao.NOT_VALUE_EXPIRE;
// ------ 创建
/**
* 创建 jwt (简单方式)
* @param loginType 登录类型
* @param loginId 账号id
* @param extraData 扩展数据
* @param keyt 秘钥
* @return jwt-token
*/
public String createToken(String loginType, Object loginId, Map<String, Object> extraData, String keyt) {
// 构建
JWT jwt = JWT.create()
.setPayload(LOGIN_TYPE, loginType)
.setPayload(LOGIN_ID, loginId)
.setPayload(RN_STR, SaFoxUtil.getRandomString(32))
.addPayloads(extraData)
;
// 返回
return generateToken(jwt, keyt);
}
/**
* 创建 jwt (全参数方式)
* @param loginType 账号类型
* @param loginId 账号id
* @param device 设备类型
* @param timeout token有效期 (单位 秒)
* @param extraData 扩展数据
* @param keyt 秘钥
* @return jwt-token
*/
public String createToken(String loginType, Object loginId, String device,
long timeout, Map<String, Object> extraData, String keyt) {
// 计算有效期
long effTime = timeout;
if(timeout != NEVER_EXPIRE) {
effTime = timeout * 1000 + System.currentTimeMillis();
}
// 创建
JWT jwt = JWT.create()
.setPayload(LOGIN_TYPE, loginType)
.setPayload(LOGIN_ID, loginId)
.setPayload(DEVICE, device)
.setPayload(EFF, effTime)
.setPayload(RN_STR, SaFoxUtil.getRandomString(32))
.addPayloads(extraData);
// 返回
return generateToken(jwt, keyt);
}
/**
* 为 JWT 对象和 keyt 秘钥,生成 token 字符串
* @param jwt JWT构建对象
* @return 根据 JWT 对象和 keyt 秘钥,生成的 token 字符串
*/
public String generateToken (JWT jwt, String keyt) {
return jwt.setKey(keyt.getBytes()).sign();
}
// ------ 解析
/**
* jwt 解析
* @param token Jwt-Token值
* @param loginType 登录类型
* @param keyt 秘钥
* @param isCheckTimeout 是否校验 timeout 字段
* @return 解析后的jwt 对象
*/
public JWT parseToken(String token, String loginType, String keyt, boolean isCheckTimeout) {
// 秘钥不可以为空
if(keyt == null) {
throw new SaJwtException("请配置 jwt 秘钥");
}
// 如果token为null
if(token == null) {
throw new SaJwtException("jwt 字符串不可为空");
}
// 解析
JWT jwt = null;
try {
jwt = JWT.of(token);
} catch (JWTException e) {
throw new SaJwtException("jwt 解析失败:" + token, e).setCode(SaJwtExceptionCode.CODE_40101);
}
JSONObject payloads = jwt.getPayloads();
// 校验 Token 签名
boolean verify = jwt.setKey(keyt.getBytes()).verify();
if(verify == false) {
throw new SaJwtException("jwt 签名无效:" + token).setCode(SaJwtExceptionCode.CODE_40102);
};
// 校验 loginType
if(Objects.equals(loginType, payloads.getStr(LOGIN_TYPE)) == false) {
throw new SaJwtException("jwt loginType 无效:" + token).setCode(SaJwtExceptionCode.CODE_40103);
}
// 校验 Token 有效期
if(isCheckTimeout) {
Long effTime = payloads.getLong(EFF, 0L);
if(effTime != NEVER_EXPIRE) {
if(effTime == null || effTime < System.currentTimeMillis()) {
throw new SaJwtException("jwt 已过期:" + token).setCode(SaJwtExceptionCode.CODE_40104);
}
}
}
// 返回
return jwt;
}
/**
* 获取 jwt 数据载荷 (校验 sign、loginType、timeout
* @param token token值
* @param loginType 登录类型
* @param keyt 秘钥
* @return 载荷
*/
public JSONObject getPayloads(String token, String loginType, String keyt) {
return parseToken(token, loginType, keyt, true).getPayloads();
}
/**
* 获取 jwt 数据载荷 (校验 sign、loginType不校验 timeout
* @param token token值
* @param loginType 登录类型
* @param keyt 秘钥
* @return 载荷
*/
public JSONObject getPayloadsNotCheck(String token, String loginType, String keyt) {
return parseToken(token, loginType, keyt, false).getPayloads();
}
/**
* 获取 jwt 代表的账号id
* @param token Token值
* @param loginType 登录类型
* @param keyt 秘钥
* @return 值
*/
public Object getLoginId(String token, String loginType, String keyt) {
return getPayloads(token, loginType, keyt).get(LOGIN_ID);
}
/**
* 获取 jwt 代表的账号id (未登录时返回null)
* @param token Token值
* @param loginType 登录类型
* @param keyt 秘钥
* @return 值
*/
public Object getLoginIdOrNull(String token, String loginType, String keyt) {
try {
return getPayloads(token, loginType, keyt).get(LOGIN_ID);
} catch (SaJwtException e) {
return null;
}
}
/**
* 获取 jwt 剩余有效期
* @param token JwtToken值
* @param loginType 登录类型
* @param keyt 秘钥
* @return 值
*/
public long getTimeout(String token, String loginType, String keyt) {
// 如果token为null
if(token == null) {
return NOT_VALUE_EXPIRE;
}
// 取出数据
JWT jwt = null;
try {
jwt = JWT.of(token);
} catch (JWTException e) {
// 解析失败
return NOT_VALUE_EXPIRE;
}
JSONObject payloads = jwt.getPayloads();
// 如果签名无效
boolean verify = jwt.setKey(keyt.getBytes()).verify();
if(verify == false) {
return NOT_VALUE_EXPIRE;
};
// 如果 loginType 无效
if(Objects.equals(loginType, payloads.getStr(LOGIN_TYPE)) == false) {
return NOT_VALUE_EXPIRE;
}
// 如果被设置为:永不过期
Long effTime = payloads.get(EFF, Long.class);
if(effTime == NEVER_EXPIRE) {
return NEVER_EXPIRE;
}
// 如果已经超时
if(effTime == null || effTime < System.currentTimeMillis()) {
return NOT_VALUE_EXPIRE;
}
// 计算timeout (转化为以秒为单位的有效时间)
return (effTime - System.currentTimeMillis()) / 1000;
}
}

View File

@@ -1,15 +1,9 @@
package cn.dev33.satoken.jwt;
import java.util.Map;
import java.util.Objects;
import cn.dev33.satoken.dao.SaTokenDao;
import cn.dev33.satoken.jwt.exception.SaJwtException;
import cn.dev33.satoken.jwt.exception.SaJwtExceptionCode;
import cn.dev33.satoken.util.SaFoxUtil;
import cn.hutool.json.JSONObject;
import cn.hutool.jwt.JWT;
import cn.hutool.jwt.JWTException;
/**
* jwt 操作工具类封装
@@ -18,40 +12,64 @@ import cn.hutool.jwt.JWTException;
*/
public class SaJwtUtil {
/**
* 底层 saJwtTemplate 对象
*/
public static SaJwtTemplate saJwtTemplate = new SaJwtTemplate();
/**
* 获取底层 saJwtTemplate 对象
* @return /
*/
public static SaJwtTemplate getSaJwtTemplate() {
return saJwtTemplate;
}
/**
* 设置底层 saJwtTemplate 对象
* @param saJwtTemplate /
*/
public static void setSaJwtTemplate(SaJwtTemplate saJwtTemplate) {
SaJwtUtil.saJwtTemplate = saJwtTemplate;
}
// 常量
/**
* key账号类型
*/
public static final String LOGIN_TYPE = "loginType";
public static final String LOGIN_TYPE = SaJwtTemplate.LOGIN_TYPE;
/**
* key账号id
*/
public static final String LOGIN_ID = "loginId";
public static final String LOGIN_ID = SaJwtTemplate.LOGIN_ID;
/**
* key登录设备类型
*/
public static final String DEVICE = "device";
public static final String DEVICE = SaJwtTemplate.DEVICE;
/**
* key有效截止期 (时间戳)
*/
public static final String EFF = "eff";
public static final String EFF = SaJwtTemplate.EFF;
/**
* key乱数 混入随机字符串,防止每次生成的 token 都是一样的
*/
public static final String RN_STR = "rnStr";
public static final String RN_STR = SaJwtTemplate.RN_STR;
/**
* 当有效期被设为此值时,代表永不过期
*/
public static final long NEVER_EXPIRE = SaTokenDao.NEVER_EXPIRE;
public static final long NEVER_EXPIRE = SaJwtTemplate.NEVER_EXPIRE;
/**
* 表示一个值不存在
*/
public static final long NOT_VALUE_EXPIRE = SaTokenDao.NOT_VALUE_EXPIRE;
public static final long NOT_VALUE_EXPIRE = SaJwtTemplate.NOT_VALUE_EXPIRE;
// ------ 创建
@@ -64,18 +82,7 @@ public class SaJwtUtil {
* @return jwt-token
*/
public static String createToken(String loginType, Object loginId, Map<String, Object> extraData, String keyt) {
// 构建
String token = JWT.create()
.setPayload(LOGIN_TYPE, loginType)
.setPayload(LOGIN_ID, loginId)
.setPayload(RN_STR, SaFoxUtil.getRandomString(32))
.addPayloads(extraData)
.setKey(keyt.getBytes())
.sign();
// 返回
return token;
return saJwtTemplate.createToken(loginType, loginId, extraData, keyt);
}
/**
@@ -90,26 +97,18 @@ public class SaJwtUtil {
*/
public static String createToken(String loginType, Object loginId, String device,
long timeout, Map<String, Object> extraData, String keyt) {
// 计算有效期
long effTime = timeout;
if(timeout != NEVER_EXPIRE) {
effTime = timeout * 1000 + System.currentTimeMillis();
}
// 创建
JWT jwt = JWT.create()
.setPayload(LOGIN_TYPE, loginType)
.setPayload(LOGIN_ID, loginId)
.setPayload(DEVICE, device)
.setPayload(EFF, effTime)
.setPayload(RN_STR, SaFoxUtil.getRandomString(32))
.addPayloads(extraData);
// 返回
return jwt.setKey(keyt.getBytes()).sign();
return saJwtTemplate.createToken(loginType, loginId, device, timeout, extraData, keyt);
}
/**
* 为 JWT 对象和 keyt 秘钥,生成 token 字符串
* @param jwt JWT构建对象
* @return 根据 JWT 对象和 keyt 秘钥,生成的 token 字符串
*/
public static String generateToken (JWT jwt, String keyt) {
return saJwtTemplate.generateToken(jwt, keyt);
}
// ------ 解析
/**
@@ -121,49 +120,7 @@ public class SaJwtUtil {
* @return 解析后的jwt 对象
*/
public static JWT parseToken(String token, String loginType, String keyt, boolean isCheckTimeout) {
// 秘钥不可以为空
if(keyt == null) {
throw new SaJwtException("请配置 jwt 秘钥");
}
// 如果token为null
if(token == null) {
throw new SaJwtException("jwt 字符串不可为空");
}
// 解析
JWT jwt = null;
try {
jwt = JWT.of(token);
} catch (JWTException e) {
throw new SaJwtException("jwt 解析失败:" + token, e).setCode(SaJwtExceptionCode.CODE_40101);
}
JSONObject payloads = jwt.getPayloads();
// 校验 Token 签名
boolean verify = jwt.setKey(keyt.getBytes()).verify();
if(verify == false) {
throw new SaJwtException("jwt 签名无效:" + token).setCode(SaJwtExceptionCode.CODE_40102);
};
// 校验 loginType
if(Objects.equals(loginType, payloads.getStr(LOGIN_TYPE)) == false) {
throw new SaJwtException("jwt loginType 无效:" + token).setCode(SaJwtExceptionCode.CODE_40103);
}
// 校验 Token 有效期
if(isCheckTimeout) {
Long effTime = payloads.getLong(EFF, 0L);
if(effTime != NEVER_EXPIRE) {
if(effTime == null || effTime < System.currentTimeMillis()) {
throw new SaJwtException("jwt 已过期:" + token).setCode(SaJwtExceptionCode.CODE_40104);
}
}
}
// 返回
return jwt;
return saJwtTemplate.parseToken(token, loginType, keyt, isCheckTimeout);
}
/**
@@ -174,7 +131,7 @@ public class SaJwtUtil {
* @return 载荷
*/
public static JSONObject getPayloads(String token, String loginType, String keyt) {
return parseToken(token, loginType, keyt, true).getPayloads();
return saJwtTemplate.getPayloads(token, loginType, keyt);
}
/**
@@ -185,7 +142,7 @@ public class SaJwtUtil {
* @return 载荷
*/
public static JSONObject getPayloadsNotCheck(String token, String loginType, String keyt) {
return parseToken(token, loginType, keyt, false).getPayloads();
return saJwtTemplate.getPayloadsNotCheck(token, loginType, keyt);
}
/**
@@ -196,7 +153,7 @@ public class SaJwtUtil {
* @return 值
*/
public static Object getLoginId(String token, String loginType, String keyt) {
return getPayloads(token, loginType, keyt).get(LOGIN_ID);
return saJwtTemplate.getLoginId(token, loginType, keyt);
}
/**
@@ -207,11 +164,7 @@ public class SaJwtUtil {
* @return 值
*/
public static Object getLoginIdOrNull(String token, String loginType, String keyt) {
try {
return getPayloads(token, loginType, keyt).get(LOGIN_ID);
} catch (SaJwtException e) {
return null;
}
return saJwtTemplate.getLoginIdOrNull(token, loginType, keyt);
}
/**
@@ -222,45 +175,7 @@ public class SaJwtUtil {
* @return 值
*/
public static long getTimeout(String token, String loginType, String keyt) {
// 如果token为null
if(token == null) {
return NOT_VALUE_EXPIRE;
}
// 取出数据
JWT jwt = null;
try {
jwt = JWT.of(token);
} catch (JWTException e) {
// 解析失败
return NOT_VALUE_EXPIRE;
}
JSONObject payloads = jwt.getPayloads();
// 如果签名无效
boolean verify = jwt.setKey(keyt.getBytes()).verify();
if(verify == false) {
return NOT_VALUE_EXPIRE;
};
// 如果 loginType 无效
if(Objects.equals(loginType, payloads.getStr(LOGIN_TYPE)) == false) {
return NOT_VALUE_EXPIRE;
}
// 如果被设置为:永不过期
Long effTime = payloads.get(EFF, Long.class);
if(effTime == NEVER_EXPIRE) {
return NEVER_EXPIRE;
}
// 如果已经超时
if(effTime == null || effTime < System.currentTimeMillis()) {
return NOT_VALUE_EXPIRE;
}
// 计算timeout (转化为以秒为单位的有效时间)
return (effTime - System.currentTimeMillis()) / 1000;
return saJwtTemplate.getTimeout(token, loginType, keyt);
}
}

View File

@@ -1,12 +0,0 @@
package cn.dev33.satoken.jwt;
/**
* 已更名为 StpLogicJwtForMixin请更换
*
* @author kong
* @since: 2022-5-1
*/
@Deprecated
public class StpLogicJwtForMix extends StpLogicJwtForMixin {
}

View File

@@ -150,11 +150,19 @@ public class StpLogicJwtForMixin extends StpLogic {
}
/**
* 获取Token携带的扩展信息
* 获取当前 Token 的扩展信息
*/
@Override
public Object getExtra(String key) {
return SaJwtUtil.getPayloads(getTokenValue(), loginType, jwtSecretKey()).get(key);
return getExtra(getTokenValue(), key);
}
/**
* 获取指定 Token 的扩展信息
*/
@Override
public Object getExtra(String tokenValue, String key) {
return SaJwtUtil.getPayloads(tokenValue, loginType, jwtSecretKey()).get(key);
}
/**
@@ -196,7 +204,7 @@ public class StpLogicJwtForMixin extends StpLogic {
* [禁用] 根据条件查询Token
*/
@Override
public List<String> searchTokenValue(String keyword, int start, int size) {
public List<String> searchTokenValue(String keyword, int start, int size, boolean sortType) {
throw new ApiDisabledException();
}

View File

@@ -49,11 +49,19 @@ public class StpLogicJwtForSimple extends StpLogic {
}
/**
* 获取Token携带的扩展信息
* 获取当前 Token 的扩展信息
*/
@Override
public Object getExtra(String key) {
return SaJwtUtil.getPayloadsNotCheck(getTokenValue(), loginType, jwtSecretKey()).get(key);
return getExtra(getTokenValue(), key);
}
/**
* 获取指定 Token 的扩展信息
*/
@Override
public Object getExtra(String tokenValue, String key) {
return SaJwtUtil.getPayloadsNotCheck(tokenValue, loginType, jwtSecretKey()).get(key);
}
}

View File

@@ -2,12 +2,12 @@ package cn.dev33.satoken.jwt;
import java.util.Map;
import cn.dev33.satoken.SaManager;
import cn.dev33.satoken.context.SaHolder;
import cn.dev33.satoken.dao.SaTokenDao;
import cn.dev33.satoken.exception.ApiDisabledException;
import cn.dev33.satoken.exception.SaTokenException;
import cn.dev33.satoken.jwt.exception.SaJwtException;
import cn.dev33.satoken.listener.SaTokenEventCenter;
import cn.dev33.satoken.stp.SaLoginModel;
import cn.dev33.satoken.stp.SaTokenInfo;
import cn.dev33.satoken.stp.StpLogic;
@@ -98,8 +98,8 @@ public class StpLogicJwtForStateless extends StpLogic {
// ------ 2、生成一个token
String tokenValue = createTokenValue(id, loginModel.getDeviceOrDefault(), loginModel.getTimeout(), loginModel.getExtraData());
// $$ 通知监听器,账号xxx 登录成功
SaManager.getSaTokenListener().doLogin(loginType, id, tokenValue, loginModel);
// $$ 发布事件:账号xxx 登录成功
SaTokenEventCenter.doLogin(loginType, id, tokenValue, loginModel);
return tokenValue;
}
@@ -138,11 +138,19 @@ public class StpLogicJwtForStateless extends StpLogic {
}
/**
* 获取Token携带的扩展信息
* 获取当前 Token 的扩展信息
*/
@Override
public Object getExtra(String key) {
return SaJwtUtil.getPayloads(getTokenValue(), loginType, jwtSecretKey()).get(key);
return getExtra(getTokenValue(), key);
}
/**
* 获取指定 Token 的扩展信息
*/
@Override
public Object getExtra(String tokenValue, String key) {
return SaJwtUtil.getPayloads(tokenValue, loginType, jwtSecretKey()).get(key);
}

View File

@@ -1,12 +0,0 @@
package cn.dev33.satoken.jwt;
/**
* 已更名为 StpLogicJwtForSimple请更换
*
* @author kong
* @since: 2022-5-1
*/
@Deprecated
public class StpLogicJwtForStyle extends StpLogicJwtForSimple {
}

View File

@@ -226,7 +226,7 @@ public class SaOAuth2Handle {
* @return 处理结果
*/
public static Object doLogin(SaRequest req, SaResponse res, SaOAuth2Config cfg) {
return cfg.getDoLoginHandle().apply(req.getParamNotNull(Param.name), req.getParamNotNull("pwd"));
return cfg.getDoLoginHandle().apply(req.getParamNotNull(Param.name), req.getParamNotNull(Param.pwd));
}
/**
@@ -255,30 +255,31 @@ public class SaOAuth2Handle {
String username = req.getParamNotNull(Param.username);
String password = req.getParamNotNull(Param.password);
String clientId = req.getParamNotNull(Param.client_id);
String clientSecret = req.getParamNotNull(Param.client_secret);
String scope = req.getParam(Param.scope, "");
// 2、校验 ClientScope
SaOAuth2Util.checkContract(clientId, scope);
// 2、校验 ClientScope 和 scope
SaOAuth2Util.checkClientSecretAndScope(clientId, clientSecret, scope);
// 3、防止因前端误传token造成逻辑干扰
SaHolder.getStorage().set(StpUtil.stpLogic.splicingKeyJustCreatedSave(), "no-token");
// SaHolder.getStorage().set(StpUtil.stpLogic.splicingKeyJustCreatedSave(), "no-token");
// 4、调用API 开始登录,如果没能成功登录,则直接退出
// 3、调用API 开始登录,如果没能成功登录,则直接退出
Object retObj = cfg.getDoLoginHandle().apply(username, password);
if(StpUtil.isLogin() == false) {
return retObj;
}
// 5、构建 ra对象
// 4、构建 ra对象
RequestAuthModel ra = new RequestAuthModel();
ra.clientId = clientId;
ra.loginId = StpUtil.getLoginId();
ra.scope = scope;
// 7、生成 Access-Token
// 5、生成 Access-Token
AccessTokenModel at = SaOAuth2Util.generateAccessToken(ra, true);
// 8、返回 Access-Token
// 6、返回 Access-Token
return SaResult.data(at.toLineMap());
}

View File

@@ -98,6 +98,21 @@ public class SaOAuth2Template {
SaOAuth2Exception.throwBy(scopeList.contains(scope) == false, "该 Access-Token 不具备 Scope" + scope);
}
}
/**
* 校验:指定 Client-Token 是否具有指定 Scope
* @param clientToken Client-Token
* @param scopes 需要校验的权限列表
*/
public void checkClientTokenScope(String clientToken, String... scopes) {
if(scopes == null || scopes.length == 0) {
return;
}
ClientTokenModel ct = checkClientToken(clientToken);
List<String> scopeList = SaFoxUtil.convertStringToList(ct.scope);
for (String scope : scopes) {
SaOAuth2Exception.throwBy(scopeList.contains(scope) == false, "该 Client-Token 不具备 Scope" + scope);
}
}
// ------------------- generate 构建数据
/**
@@ -381,6 +396,25 @@ public class SaOAuth2Template {
SaOAuth2Exception.throwBy(cm.clientSecret == null || cm.clientSecret.equals(clientSecret) == false, "无效client_secret: " + clientSecret);
return cm;
}
/**
* 校验clientId 与 clientSecret 是否正确,并且是否签约了指定 scopes
* @param clientId 应用id
* @param clientSecret 秘钥
* @param scopes 权限(多个用逗号隔开)
* @return SaClientModel对象
*/
public SaClientModel checkClientSecretAndScope(String clientId, String clientSecret, String scopes) {
// 先校验 clientSecret
SaClientModel cm = checkClientSecret(clientId, clientSecret);
// 再校验 是否签约
List<String> clientScopeList = SaFoxUtil.convertStringToList(cm.contractScope);
List<String> scopelist = SaFoxUtil.convertStringToList(scopes);
if(clientScopeList.containsAll(scopelist) == false) {
throw new SaOAuth2Exception("请求的Scope暂未签约");
}
// 返回数据
return cm;
}
/**
* 校验:使用 code 获取 token 时提供的参数校验
* @param code 授权码

View File

@@ -49,7 +49,7 @@ public class SaOAuth2Util {
public static ClientTokenModel checkClientToken(String clientToken) {
return saOAuth2Template.checkClientToken(clientToken);
}
/**
* 获取 Access-Token 所代表的LoginId
* @param accessToken Access-Token
@@ -68,6 +68,15 @@ public class SaOAuth2Util {
saOAuth2Template.checkScope(accessToken, scopes);
}
/**
* 校验:指定 Client-Token 是否具有指定 Scope
* @param clientToken Client-Token
* @param scopes 需要校验的权限列表
*/
public static void checkClientTokenScope(String clientToken, String... scopes) {
saOAuth2Template.checkClientTokenScope(clientToken, scopes);
}
// ------------------- generate 构建数据
/**
@@ -198,6 +207,17 @@ public class SaOAuth2Util {
return saOAuth2Template.checkClientSecret(clientId, clientSecret);
}
/**
* 校验clientId 与 clientSecret 是否正确,并且是否签约了指定 scopes
* @param clientId 应用id
* @param clientSecret 秘钥
* @param scopes 权限(多个用逗号隔开)
* @return SaClientModel对象
*/
public static SaClientModel checkClientSecretAndScope(String clientId, String clientSecret, String scopes) {
return saOAuth2Template.checkClientSecretAndScope(clientId, clientSecret, scopes);
}
/**
* 校验:使用 code 获取 token 时提供的参数校验
* @param code 授权码

View File

@@ -1,5 +1,7 @@
package cn.dev33.satoken.aop;
import java.lang.reflect.Method;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
@@ -8,6 +10,7 @@ import org.aspectj.lang.reflect.MethodSignature;
import org.springframework.core.annotation.Order;
import org.springframework.stereotype.Component;
import cn.dev33.satoken.annotation.SaIgnore;
import cn.dev33.satoken.strategy.SaStrategy;
import cn.dev33.satoken.util.SaTokenConsts;
@@ -54,9 +57,18 @@ public class SaCheckAspect {
@Around("pointcut()")
public Object around(ProceedingJoinPoint joinPoint) throws Throwable {
// 注解鉴权
// 获取对应的 Method 处理函数
MethodSignature signature = (MethodSignature) joinPoint.getSignature();
SaStrategy.me.checkMethodAnnotation.accept(signature.getMethod());
Method method = signature.getMethod();
// 如果此 Method 或其所属 Class 标注了 @SaIgnore则忽略掉鉴权
if(SaStrategy.me.isAnnotationPresent.apply(method, SaIgnore.class)) {
// ...
} else {
// 注解鉴权
SaStrategy.me.checkMethodAnnotation.accept(method);
}
try {
// 执行原有逻辑

View File

@@ -53,7 +53,7 @@ public class SaSsoConfig implements Serializable {
/**
* 配置 Server 端单点登录授权地址
*/
public String authUrl;
public String authUrl = "/sso/auth";
/**
* 是否打开单点注销功能
@@ -73,26 +73,30 @@ public class SaSsoConfig implements Serializable {
/**
* 配置 Server 端的 ticket 校验地址
*/
public String checkTicketUrl;
public String checkTicketUrl = "/sso/checkTicket";
/**
* 配置 Server 端查询 userinfo 地址
*/
public String userinfoUrl;
public String userinfoUrl = "/sso/userinfo";
/**
* 配置 Server 端单点注销地址
*/
public String sloUrl;
public String sloUrl = "/sso/logout";
/**
* 配置当前 Client 端的单点注销回调URL (为空时自动获取)
*/
public String ssoLogoutCall;
/**
* 配置 Server 端主机总地址,拼接在 authUrl、checkTicketUrl、userinfoUrl、sloUrl 属性前面,用以简化各种 url 配置
*/
public String serverUrl;
// ----------------- 其它
/**
* 接口调用时的时间戳允许的差距单位ms-1代表不校验差距
*/
@@ -261,6 +265,22 @@ public class SaSsoConfig implements Serializable {
return this;
}
/**
* @return 配置的 Server 端主机总地址,拼接在 authUrl、checkTicketUrl、userinfoUrl、sloUrl 属性前面,用以简化各种 url 配置
*/
public String getServerUrl() {
return serverUrl;
}
/**
* @param serverUrl 配置 Server 端主机总地址,拼接在 authUrl、checkTicketUrl、userinfoUrl、sloUrl 属性前面,用以简化各种 url 配置
* @return 对象自身
*/
public SaSsoConfig setServerUrl(String serverUrl) {
this.serverUrl = serverUrl;
return this;
}
/**
* @return 接口调用时的时间戳允许的差距单位ms-1代表不校验差距
*/
@@ -276,7 +296,7 @@ public class SaSsoConfig implements Serializable {
this.timestampDisparity = timestampDisparity;
return this;
}
@Override
public String toString() {
return "SaSsoConfig ["
@@ -290,10 +310,42 @@ public class SaSsoConfig implements Serializable {
+ ", userinfoUrl=" + userinfoUrl
+ ", sloUrl=" + sloUrl
+ ", ssoLogoutCall=" + ssoLogoutCall
+ ", serverUrl=" + serverUrl
+ ", timestampDisparity=" + timestampDisparity
+ "]";
}
// 额外添加的一些函数
/**
* @return 获取拼接urlServer 端单点登录授权地址
*/
public String splicingAuthUrl() {
return SaFoxUtil.spliceTwoUrl(getServerUrl(), getAuthUrl());
}
/**
* @return 获取拼接urlServer 端的 ticket 校验地址
*/
public String splicingCheckTicketUrl() {
return SaFoxUtil.spliceTwoUrl(getServerUrl(), getCheckTicketUrl());
}
/**
* @return 获取拼接urlServer 端查询 userinfo 地址
*/
public String splicingUserinfoUrl() {
return SaFoxUtil.spliceTwoUrl(getServerUrl(), getUserinfoUrl());
}
/**
* @return 获取拼接urlServer 端单点注销地址
*/
public String splicingSloUrl() {
return SaFoxUtil.spliceTwoUrl(getServerUrl(), getSloUrl());
}
/**
* 以数组形式写入允许的授权回调地址
* @param url 所有集合
@@ -305,7 +357,6 @@ public class SaSsoConfig implements Serializable {
}
// -------------------- SaSsoHandle 所有回调函数 --------------------
@@ -325,6 +376,8 @@ public class SaSsoConfig implements Serializable {
/**
* SSO-Client端自定义校验Ticket返回值的处理逻辑 每次从认证中心获取校验Ticket的结果后调用
* <p> 参数loginId, back
* <p> 返回值:返回给前端的值
*/
public BiFunction<Object, String, Object> ticketResultHandle = null;

View File

@@ -22,6 +22,9 @@ public class SaSsoConsts {
/** SSO-Server端校验ticket 获取账号id */
public static String ssoCheckTicket = "/sso/checkTicket";
/** SSO-Server端获取userinfo */
public static String ssoUserinfo = "/sso/userinfo";
/** SSO-Server端 (and Client端):单点注销地址 */
public static String ssoLogout = "/sso/logout";

View File

@@ -361,10 +361,22 @@ public class SaSsoHandle {
// --------- 两种模式
if(cfg.getIsHttp()) {
// 模式三:使用 http 请求从认证中心校验ticket
// q1、使用模式三:使用 http 请求从认证中心校验ticket
// 计算当前 sso-client 的单点注销回调地址
String ssoLogoutCall = null;
if(cfg.getIsSlo()) {
ssoLogoutCall = SaHolder.getRequest().getUrl().replace(currUri, Api.ssoLogoutCall);
// 如果配置了回调地址,就使用配置的值:
if(SaFoxUtil.isNotEmpty(cfg.getSsoLogoutCall())) {
ssoLogoutCall = cfg.getSsoLogoutCall();
}
// 如果提供了当前 uri则根据此值来计算
else if(SaFoxUtil.isNotEmpty(currUri)) {
ssoLogoutCall = SaHolder.getRequest().getUrl().replace(currUri, Api.ssoLogoutCall);
}
// 否则视为不注册单点注销回调地址
else {
}
}
// 发起请求
@@ -379,7 +391,7 @@ public class SaSsoHandle {
throw new SaSsoException(result.getMsg()).setCode(SaSsoExceptionCode.CODE_20005);
}
} else {
// 模式二直连Redis校验ticket
// q2、使用模式二直连Redis校验ticket
return SaSsoUtil.checkTicket(ticket);
}
}

View File

@@ -253,7 +253,7 @@ public class SaSsoTemplate {
public String buildServerAuthUrl(String clientLoginUrl, String back) {
// 服务端认证地址
String serverUrl = SaSsoManager.getConfig().getAuthUrl();
String serverUrl = SaSsoManager.getConfig().splicingAuthUrl();
// 对back地址编码
back = (back == null ? "" : back);
@@ -327,7 +327,7 @@ public class SaSsoTemplate {
* @return Server端 账号资料查询地址
*/
public String buildUserinfoUrl(Object loginId) {
String userinfoUrl = SaSsoManager.getConfig().getUserinfoUrl();
String userinfoUrl = SaSsoManager.getConfig().splicingUserinfoUrl();
return addSignParams(userinfoUrl, loginId);
}
@@ -340,7 +340,7 @@ public class SaSsoTemplate {
*/
public String buildCheckTicketUrl(String ticket, String ssoLogoutCallUrl) {
// 裸地址
String url = SaSsoManager.getConfig().getCheckTicketUrl();
String url = SaSsoManager.getConfig().splicingCheckTicketUrl();
// 拼接ticket参数
url = SaFoxUtil.joinParam(url, ParamName.ticket, ticket);
@@ -360,7 +360,7 @@ public class SaSsoTemplate {
* @return 单点注销URL
*/
public String buildSloUrl(Object loginId) {
String url = SaSsoManager.getConfig().getSloUrl();
String url = SaSsoManager.getConfig().splicingSloUrl();
return addSignParams(url, loginId);
}