整合 jwt 临时令牌鉴权

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

@@ -19,7 +19,7 @@ import cn.dev33.satoken.stp.StpInterfaceDefaultImpl;
 import cn.dev33.satoken.stp.StpLogic;
 import cn.dev33.satoken.stp.StpUtil;
 import cn.dev33.satoken.temp.SaTempInterface;
-import cn.dev33.satoken.temp.SaTempInterfaceDefaultImpl;
+import cn.dev33.satoken.temp.SaTempDefaultImpl;
 import cn.dev33.satoken.util.SaFoxUtil;
 
 /**
@@ -146,7 +146,7 @@ public class SaManager {
 	}
 
 	/**
-	 * 临时验证模块 Bean  
+	 * 临时令牌验证模块 Bean  
 	 */
 	private static SaTempInterface saTemp;
 	public static void setSaTemp(SaTempInterface saTemp) {
@@ -156,7 +156,7 @@ public class SaManager {
 		if (saTemp == null) {
 			synchronized (SaManager.class) {
 				if (saTemp == null) {
-					setSaTemp(new SaTempInterfaceDefaultImpl());
+					setSaTemp(new SaTempDefaultImpl());
 				}
 			}
 		}

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

@@ -61,6 +61,11 @@ public class SaTokenConfig {
 	/** 是否打印操作日志 */
 	private Boolean isLog = false;
 
+	/**
+	 * jwt秘钥 (只有集成 sa-token-temp-jwt 模块时此参数才会生效) 
+	 */
+	private String jwtSecretKey;
+	
 
 	/**
 	 * @return token名称 (同时也是cookie名称)
@@ -315,6 +320,7 @@ public class SaTokenConfig {
 
 	/**
 	 * @param isLog 是否打印操作日志
+	 * @return 对象自身
 	 */
 	public SaTokenConfig setIsLog(Boolean isLog) {
 		this.isLog = isLog;
@@ -322,7 +328,23 @@ public class SaTokenConfig {
 	}
 
 	/**
-	 * toString()
+	 * @return jwt秘钥 (只有集成 sa-token-temp-jwt 模块时此参数才会生效)  
+	 */
+	public String getJwtSecretKey() {
+		return jwtSecretKey;
+	}
+
+	/**
+	 * @param jwtSecretKey jwt秘钥 (只有集成 sa-token-temp-jwt 模块时此参数才会生效)  
+	 * @return 对象自身
+	 */
+	public SaTokenConfig setJwtSecretKey(String jwtSecretKey) {
+		this.jwtSecretKey = jwtSecretKey;
+		return this;
+	}
+
+	/**
+	 * toString() 
 	 */
 	@Override
 	public String toString() {
@@ -331,9 +353,11 @@ public class SaTokenConfig {
 				+ isReadBody + ", isReadHead=" + isReadHead + ", isReadCookie=" + isReadCookie + ", tokenStyle="
 				+ tokenStyle + ", dataRefreshPeriod=" + dataRefreshPeriod + ", tokenSessionCheckLogin="
 				+ tokenSessionCheckLogin + ", autoRenew=" + autoRenew + ", cookieDomain=" + cookieDomain
-				+ ", tokenPrefix=" + tokenPrefix + ", isV=" + isV + ", isLog=" + isLog + "]";
+				+ ", tokenPrefix=" + tokenPrefix + ", isV=" + isV + ", isLog=" + isLog + ", jwtSecretKey="
+				+ jwtSecretKey + "]";
 	}
 	
+	
 
 	
 

sa-token-core/src/main/java/cn/dev33/satoken/temp/SaTempDefaultImpl.java

@@ -0,0 +1,10 @@
+package cn.dev33.satoken.temp;
+
+/**
+ * Sa-Token 临时令牌验证模块 默认实现类 
+ * @author kong
+ *
+ */
+public class SaTempDefaultImpl implements SaTempInterface {
+	
+}

sa-token-core/src/main/java/cn/dev33/satoken/temp/SaTempInterface.java

@@ -4,7 +4,7 @@ import cn.dev33.satoken.SaManager;
 import cn.dev33.satoken.util.SaFoxUtil;
 
 /**
- * Sa-Token 临时验证模块接口 
+ * Sa-Token 临时令牌验证模块接口 
  * @author kong
  *
  */
@@ -69,4 +69,11 @@ public interface SaTempInterface {
 		return SaManager.getConfig().getTokenName() + ":temp-token:" + token;
 	}
 
+	/**
+	 * @return jwt秘钥 (只有集成 sa-token-temp-jwt 模块时此参数才会生效)  
+	 */
+	public default String getJwtSecretKey() {
+		return null;
+	}
+	
 }

sa-token-core/src/main/java/cn/dev33/satoken/temp/SaTempInterfaceDefaultImpl.java

@@ -1,10 +0,0 @@
-package cn.dev33.satoken.temp;
-
-/**
- * Sa-Token 临时验证模块 逻辑
- * @author kong
- *
- */
-public class SaTempInterfaceDefaultImpl implements SaTempInterface {
-	
-}

sa-token-core/src/main/java/cn/dev33/satoken/temp/SaTempUtil.java

@@ -3,7 +3,7 @@ package cn.dev33.satoken.temp;
 import cn.dev33.satoken.SaManager;
 
 /**
- * Sa-Token 临时验证模块 
+ * Sa-Token 临时验证令牌模块 
  * @author kong
  *
  */

sa-token-demo/sa-token-demo-springboot/pom.xml

@@ -37,7 +37,7 @@
             <artifactId>sa-token-spring-boot-starter</artifactId>
             <version>${sa-token-version}</version>
         </dependency>
-		
+        
 		<!-- sa-token整合redis (使用jdk默认序列化方式) -->
 		<!-- <dependency>
             <groupId>cn.dev33</groupId>

sa-token-doc/doc/start/download.md

@@ -95,6 +95,8 @@ implementation 'cn.dev33:sa-token-core:1.19.0'
 		├── sa-token-dao-redis                    // [插件] Sa-Token 整合 Redis (使用jdk默认序列化方式)
 		├── sa-token-dao-redis-jackson            // [插件] Sa-Token 整合 Redis (使用jackson序列化方式)
 		├── sa-token-spring-aop                   // [插件] Sa-Token 整合 SpringAOP 注解鉴权
+		├── sa-token-temp-jwt                     // [插件] Sa-Token 整合 jwt 临时令牌鉴权 
+		├── sa-token-quick-login                  // [插件] Sa-Token 快速注入登录页插件 
 		├── sa-token-oauth2                       // [插件] Sa-Token 实现 OAuth2.0 模块(内测暂未发布)
 	├── sa-token-demo                         // [示例] Sa-Token 示例合集
 		├── sa-token-demo-springboot              // [示例] Sa-Token 整合 SpringBoot 
@@ -104,7 +106,7 @@ implementation 'cn.dev33:sa-token-core:1.19.0'
 		├── sa-token-demo-oauth2-server           // [示例] Sa-Token 集成 OAuth2.0 (服务端)
 		├── sa-token-demo-oauth2-client           // [示例] Sa-Token 集成 OAuth2.0 (客户端)
 	├── sa-token-doc                          // [文档] Sa-Token 开发文档 
-	├──pom.xml
+	├──pom.xml                                // [依赖] 顶级pom文件 
 ```
 
 

sa-token-doc/doc/use/config.md

@@ -77,3 +77,4 @@ public class SaTokenConfigure {
 | tokenPrefix			| Boolean	| true		| token前缀, 格式样例(satoken: Bearer xxxx-xxxx-xxxx-xxxx)	[参考：token前缀](/use/token-prefix) 			|
 | isV					| Boolean	| true		| 是否在初始化配置时打印版本字符画													|
 | isLog					| Boolean	| false		| 是否打印操作日志																	|
+| jwtSecretKey			| String	| null		| jwt秘钥 (只有集成 sa-token-temp-jwt 模块时此参数才会生效)							|

sa-token-plugin/pom.xml

@@ -22,6 +22,7 @@
         <module>sa-token-spring-aop</module>
         <!-- <module>sa-token-oauth2</module> -->
         <module>sa-token-quick-login</module>
+        <module>sa-token-temp-jwt</module>
     </modules>
 
 </project>

sa-token-plugin/sa-token-temp-jwt/.gitignore

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

sa-token-plugin/sa-token-temp-jwt/pom.xml

@@ -0,0 +1,40 @@
+<?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/maven-v4_0_0.xsd">
+	<modelVersion>4.0.0</modelVersion>
+	
+	<parent>
+        <groupId>cn.dev33</groupId>
+        <artifactId>sa-token-plugin</artifactId>
+        <version>1.19.0</version>
+    </parent>
+    <packaging>jar</packaging>
+
+	<name>sa-token-temp-jwt</name>
+    <artifactId>sa-token-temp-jwt</artifactId>
+	<description>sa-token-temp-jwt</description>
+
+	<dependencies>
+		<!-- sa-token-spring-boot-starter -->
+		<dependency>
+            <groupId>cn.dev33</groupId>
+            <artifactId>sa-token-core</artifactId>
+            <version>${sa-token-version}</version>
+        </dependency>
+		<!-- jwt -->
+        <dependency>
+			<groupId>io.jsonwebtoken</groupId>
+			<artifactId>jjwt</artifactId>
+			<version>0.9.1</version>
+        </dependency>
+		<!-- spring-boot-configuration -->
+		<dependency>
+			<groupId>org.springframework.boot</groupId>
+			<artifactId>spring-boot-configuration-processor</artifactId>
+			<version>2.0.0.RELEASE</version>
+			<optional>true</optional>
+		</dependency>
+	</dependencies>
+
+</project>

sa-token-plugin/sa-token-temp-jwt/src/main/java/cn/dev33/satoken/temp/jwt/SaJwtUtil.java

@@ -0,0 +1,114 @@
+package cn.dev33.satoken.temp.jwt;
+
+import cn.dev33.satoken.dao.SaTokenDao;
+import cn.dev33.satoken.exception.SaTokenException;
+import io.jsonwebtoken.Claims;
+import io.jsonwebtoken.JwtBuilder;
+import io.jsonwebtoken.Jwts;
+import io.jsonwebtoken.SignatureAlgorithm;
+
+/**
+ * jwt操作工具类 
+ * @author kong
+ *
+ */
+public class SaJwtUtil {
+	
+	/**
+	 * key: value
+	 */
+	public static final String KEY_VALUE = "value"; 
+
+	/**
+	 * key: 有效期 (时间戳)
+	 */
+	public static final String KEY_EFF = "eff"; 
+
+	/** 当有效期被设为此值时，代表永不过期 */ 
+	public static final long NEVER_EXPIRE = SaTokenDao.NEVER_EXPIRE;
+	
+	/**
+	 * 根据指定值创建 jwt-token 
+	 * @param value 要保存的值
+	 * @param timeout token有效期 (单位 秒)
+     * @param keyt 秘钥
+	 * @return jwt-token 
+	 */
+    public static String createToken(Object value, long timeout, String keyt) {
+    	// 计算eff有效期 
+    	long eff = timeout;
+    	if(timeout != NEVER_EXPIRE) {
+    		eff = timeout * 1000 + System.currentTimeMillis();
+    	}
+    	// 在这里你可以使用官方提供的claim方法构建载荷，也可以使用setPayload自定义载荷，但是两者不可一起使用 
+        JwtBuilder builder = Jwts.builder()
+        		// .setHeaderParam("typ", "JWT")
+        		.claim(KEY_VALUE, value)
+        		.claim(KEY_EFF, eff)
+                .signWith(SignatureAlgorithm.HS256, keyt.getBytes());
+        // 生成jwt-token 
+        return builder.compact();
+    }
+
+    /**
+     * 从一个 jwt-token 解析出载荷 
+     * @param jwtToken JwtToken值 
+     * @param keyt 秘钥
+     * @return Claims对象 
+     */
+    public static Claims parseToken(String jwtToken, String keyt) {
+    	// 解析出载荷 
+    	Claims claims = Jwts.parser()
+        		.setSigningKey(keyt.getBytes())
+        		.parseClaimsJws(jwtToken).getBody();
+        // 返回 
+        return claims;
+    }
+
+    /**
+     * 从一个 jwt-token 解析出载荷, 并取出数据 
+     * @param jwtToken JwtToken值 
+     * @param keyt 秘钥
+     * @return 值 
+     */
+    public static Object getValue(String jwtToken, String keyt) {
+    	// 取出数据 
+    	Claims claims = parseToken(jwtToken, keyt);
+    	
+    	// 验证是否超时 
+    	Long eff = claims.get(KEY_EFF, Long.class);
+    	if((eff == null || eff < System.currentTimeMillis()) && eff != NEVER_EXPIRE) {
+    		throw new SaTokenException("Token已超时");
+    	}
+    	
+        // 获取数据 
+        return claims.get(KEY_VALUE);
+    }
+
+    /**
+     * 从一个 jwt-token 解析出载荷, 并取出其剩余有效期 
+     * @param jwtToken JwtToken值 
+     * @param keyt 秘钥
+     * @return 值 
+     */
+    public static long getTimeout(String jwtToken, String keyt) {
+    	// 取出数据 
+    	Claims claims = parseToken(jwtToken, keyt);
+    	
+    	// 验证是否超时 
+    	Long eff = claims.get(KEY_EFF, Long.class);
+    	
+    	// 永不过期 
+    	if(eff == NEVER_EXPIRE) {
+    		return NEVER_EXPIRE;
+    	}
+    	// 已经超时 
+    	if(eff == null || eff < System.currentTimeMillis()) {
+    		return SaTokenDao.NOT_VALUE_EXPIRE;
+    	}
+    	
+        // 计算timeout 
+        return (eff - System.currentTimeMillis()) / 1000;
+    }
+    
+}

sa-token-plugin/sa-token-temp-jwt/src/main/java/cn/dev33/satoken/temp/jwt/SaTempForJwt.java

@@ -0,0 +1,51 @@
+package cn.dev33.satoken.temp.jwt;
+
+import cn.dev33.satoken.SaManager;
+import cn.dev33.satoken.exception.SaTokenException;
+import cn.dev33.satoken.temp.SaTempInterface;
+import cn.dev33.satoken.util.SaFoxUtil;
+
+/**
+ * Sa-Token 临时令牌验证模块接口 JWT实现类 
+ * @author kong
+ *
+ */
+public class SaTempForJwt implements SaTempInterface {
+	
+	/**
+	 * 根据value创建一个token 
+	 */
+	public String createToken(Object value, long timeout) {
+		String token = SaJwtUtil.createToken(value, timeout, getJwtSecretKey());
+		return token;
+	}
+	
+	/**
+	 *  解析token获取value 
+	 */
+	public Object parseToken(String token) {
+		Object value = SaJwtUtil.getValue(token, getJwtSecretKey());
+		return value;
+	}
+	
+	/**
+	 * 返回指定token的剩余有效期，单位：秒 
+	 */
+	public long getTimeout(String token) {
+		long timeout = SaJwtUtil.getTimeout(token, getJwtSecretKey());
+		return timeout;
+	}
+	
+	/**
+	 * 获取jwt秘钥 
+	 * @return jwt秘钥 
+	 */
+	public String getJwtSecretKey() {
+		String jwtSecretKey = SaManager.getConfig().getJwtSecretKey();
+		if(SaFoxUtil.isEmpty(jwtSecretKey)) {
+			throw new SaTokenException("请配置：jwtSecretKey");
+		}
+		return jwtSecretKey;
+	}
+	
+}

sa-token-plugin/sa-token-temp-jwt/src/main/resources/META-INF/spring.factories

@@ -0,0 +1 @@
+org.springframework.boot.autoconfigure.EnableAutoConfiguration=cn.dev33.satoken.temp.jwt.SaTempForJwt

sa-token-starter/sa-token-reactor-spring-boot-starter/src/main/java/cn/dev33/satoken/reactor/spring/SaTokenSpringAutowired.java

@@ -15,6 +15,7 @@ import cn.dev33.satoken.context.SaTokenContextForThreadLocal;
 import cn.dev33.satoken.dao.SaTokenDao;
 import cn.dev33.satoken.listener.SaTokenListener;
 import cn.dev33.satoken.stp.StpInterface;
+import cn.dev33.satoken.temp.SaTempInterface;
 
 /**
  * 利用spring的自动装配来加载开发者重写的Bean
@@ -113,6 +114,16 @@ public class SaTokenSpringAutowired {
 	public void setSaTokenListener(SaTokenListener saTokenListener) {
 		SaManager.setSaTokenListener(saTokenListener);
 	}
+
+	/**
+	 * 注入临时令牌验证模块 Bean
+	 * 
+	 * @param saTemp saTemp对象 
+	 */
+	@Autowired(required = false)
+	public void setSaTemp(SaTempInterface saTemp) {
+		SaManager.setSaTemp(saTemp);
+	}
 	
 	/**
 	 * 利用自动注入特性，获取Spring框架内部使用的路由匹配器

sa-token-starter/sa-token-solon-plugin/src/main/java/cn/dev33/satoken/solon/XPluginImp.java

@@ -16,6 +16,7 @@ import cn.dev33.satoken.listener.SaTokenListener;
 import cn.dev33.satoken.solon.integration.SaContextForSolon;
 import cn.dev33.satoken.solon.integration.SaTokenMethodInterceptor;
 import cn.dev33.satoken.stp.StpInterface;
+import cn.dev33.satoken.temp.SaTempInterface;
 
 /**
  * @author noear
@@ -39,25 +40,30 @@ public class XPluginImp implements Plugin {
         //注入容器交互Bean
         SaManager.setSaTokenContext(new SaContextForSolon());
 
-        //注入侦听器Bean
+        // 注入侦听器 Bean
         Aop.getAsyn(SaTokenListener.class, bw->{
             SaManager.setSaTokenListener(bw.raw());
         });
 
-        //注入框架行为Bean
+        // 注入框架行为 Bean
         Aop.getAsyn(SaTokenAction.class, bw->{
             SaManager.setSaTokenAction(bw.raw());
         });
 
-        //注入权限认证Bean
+        // 注入权限认证 Bean
         Aop.getAsyn(StpInterface.class, bw->{
             SaManager.setStpInterface(bw.raw());
         });
 
-        //注入持久化Bean
+        // 注入持久化 Bean
         Aop.getAsyn(SaTokenDao.class, bw->{
             SaManager.setSaTokenDao(bw.raw());
         });
+
+        // 临时令牌验证模块 Bean
+        Aop.getAsyn(SaTempInterface.class, bw->{
+            SaManager.setSaTemp(bw.raw());
+        });
         
     }
 }

sa-token-starter/sa-token-spring-boot-starter/src/main/java/cn/dev33/satoken/spring/SaTokenSpringAutowired.java

@@ -14,6 +14,7 @@ import cn.dev33.satoken.context.SaTokenContext;
 import cn.dev33.satoken.dao.SaTokenDao;
 import cn.dev33.satoken.listener.SaTokenListener;
 import cn.dev33.satoken.stp.StpInterface;
+import cn.dev33.satoken.temp.SaTempInterface;
 
 /**
  * 利用spring的自动装配来加载开发者重写的Bean
@@ -105,6 +106,16 @@ public class SaTokenSpringAutowired {
 		SaManager.setSaTokenListener(saTokenListener);
 	}
 
+	/**
+	 * 注入临时令牌验证模块 Bean
+	 * 
+	 * @param saTemp saTemp对象 
+	 */
+	@Autowired(required = false)
+	public void setSaTemp(SaTempInterface saTemp) {
+		SaManager.setSaTemp(saTemp);
+	}
+	
 	/**
 	 * 利用自动注入特性，获取Spring框架内部使用的路由匹配器
 	 * 

sa-token-starter/sa-token-spring-boot-starter/src/test/java/com/pj/test/SaTokenSpringBootStarterTest.java

@@ -177,7 +177,6 @@ public class SaTokenSpringBootStarterTest {
     	
     	// 解析token  
     	String value = SaTempUtil.parseToken(token, String.class);
-    	System.out.println(value);
     	Assert.assertEquals(value, "group-1014"); 
     	
     	// 过期时间