wang.bigbird.domain.framework.web.auth.security.jwt.utils

类 JwtSecurityUtils

java.lang.Object

wang.bigbird.domain.framework.web.auth.security.jwt.utils.JwtSecurityUtils

所有已实现的接口:

org.springframework.beans.factory.InitializingBean

@Component(value="jwtSecurityUtils")
public class JwtSecurityUtils
extends Object
implements org.springframework.beans.factory.InitializingBean

JWT token创建与解析工具

在本模块中设计了一种对应关系用于记录：用户与refresh token，token与refresh token的映射。 其中，用户-->refresh token是一对多的关系，token-->refresh token是一对一的关系。 本模块采用redis有序set来记录：用户-->refresh token这种关系， 当发生用户权限变更需要强制使对应用户的token失效时， 可通过删除用户-->refresh token这种关系以达到目的， 另外在redis有序set中可将refresh token的签发时间作为score， 以便查询refresh token的签发时间。

作者:

Bigbird

字段概要

字段

限定符和类型	字段和说明
static String	ACCESS_TOKEN_SUBJECT
static String	REFRESH_TOKEN_SUBJECT

构造器概要

构造器

构造器和说明
JwtSecurityUtils(JwtSecurityProperties jwtSecurityProperties)

方法概要

限定符和类型	方法和说明
void	afterPropertiesSet()
JwtToken	createRefreshToken(JwtAuthData jwtAuthData, Integer refreshTokenValidityInDays, String appKeyAndSecret) 创建jwt refresh token
org.springframework.security.core.Authentication	getAuthentication(String token, String appKey) 获取认证信息
JwtAuthData	getJwtAuthData(String token, String appKeyAndSecret) 解析token，获取认证权限基础数据
AccessTokenAuthData	getJwtAuthDataFromAccessToken(String token, String appKeyAndSecret) 获取AccessToken权限数据
String	getJwtAuthDataFromToken(io.jsonwebtoken.Claims claims, String subject) 从token中提取出认证权限数据
String[]	getWithoutJwtSecurityApi() 获取不需要认证的接口列表
boolean	isEnableJwtSecurity() 是否启用认证授权机制
void	kickedOffline(String id) 强制token下线
void	kickedOffline(String type, Long id) 强制认证对象下线
JwtToken	loadTokenByRefreshToken(String refreshToken, Integer tokenValidityInSeconds, String appKeyAndSecret) 通过refresh token换取token

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

ACCESS_TOKEN_SUBJECT

public static final String ACCESS_TOKEN_SUBJECT

另请参阅:

常量字段值

REFRESH_TOKEN_SUBJECT

public static final String REFRESH_TOKEN_SUBJECT

另请参阅:

常量字段值

构造器详细资料

JwtSecurityUtils

public JwtSecurityUtils(JwtSecurityProperties jwtSecurityProperties)

方法详细资料

afterPropertiesSet

public void afterPropertiesSet()

指定者:

afterPropertiesSet 在接口中 org.springframework.beans.factory.InitializingBean

isEnableJwtSecurity

public boolean isEnableJwtSecurity()

是否启用认证授权机制

返回:

getWithoutJwtSecurityApi

public String[] getWithoutJwtSecurityApi()

获取不需要认证的接口列表

返回:

createRefreshToken

public JwtToken createRefreshToken(JwtAuthData jwtAuthData,
                                   Integer refreshTokenValidityInDays,
                                   String appKeyAndSecret)

创建jwt refresh token

参数:

jwtAuthData - JWT认证权限数据

refreshTokenValidityInDays - refreshToken有效期，以天为单位

appKeyAndSecret - 组成格式：appKey:appSecret，为空则采用默认密钥生成签名key

返回:

loadTokenByRefreshToken

public JwtToken loadTokenByRefreshToken(String refreshToken,
                                        Integer tokenValidityInSeconds,
                                        String appKeyAndSecret)

通过refresh token换取token

参数:

refreshToken - refresh token

tokenValidityInSeconds - accessToken有效期，以秒为单位

appKeyAndSecret - 组成格式：appKey:appSecret，为空则采用默认密钥生成签名key

返回:

getAuthentication

public org.springframework.security.core.Authentication getAuthentication(String token,
                                                                          String appKey)

获取认证信息

参数:

token -

appKey -

返回:

认证信息

getJwtAuthData

public JwtAuthData getJwtAuthData(String token,
                                  String appKeyAndSecret)

解析token，获取认证权限基础数据

参数:

token -

appKeyAndSecret - 组成格式：appKey:appSecret，为空则采用默认密钥生成签名key

返回:

认证权限基础数据

kickedOffline

public void kickedOffline(String type,
                          Long id)

强制认证对象下线

参数:

type - 认证对象类型

id - 认证对象标识

kickedOffline

public void kickedOffline(String id)

强制token下线

参数:

id - token id

getJwtAuthDataFromToken

public String getJwtAuthDataFromToken(io.jsonwebtoken.Claims claims,
                                      String subject)

从token中提取出认证权限数据

参数:

claims -

subject -

返回:

以字符串模式返回完整的权限数据

getJwtAuthDataFromAccessToken

public AccessTokenAuthData getJwtAuthDataFromAccessToken(String token,
                                                         String appKeyAndSecret)

获取AccessToken权限数据

参数:

token - jwt对应的加密串

appKeyAndSecret - 组成格式：appKey:appSecret，为空则采用默认密钥生成签名key

返回:

AccessToken权限数据