cn.hutool.jwt

Class JWTValidator

java.lang.Object

cn.hutool.jwt.JWTValidator

public class JWTValidator
extends Object

JWT数据校验器，用于校验包括：

• 算法是否一致
• 算法签名是否正确
• 字段值是否有效（例如时间未过期等）

Since:

5.7.2

Author:

looly

Constructor Summary

Constructors

Constructor and Description
JWTValidator(JWT jwt) 构造

Method Summary

Modifier and Type	Method and Description
static JWTValidator	of(JWT jwt) 创建JWT验证器
static JWTValidator	of(String token) 创建JWT验证器
JWTValidator	validateAlgorithm() 验证算法，使用JWT对象自带的JWTSigner
JWTValidator	validateAlgorithm(JWTSigner signer) 验证算法，使用自定义的JWTSigner
JWTValidator	validateDate() 检查JWT的以下三两个时间： RegisteredPayload.NOT_BEFORE：被检查时间必须晚于生效时间 RegisteredPayload.EXPIRES_AT：被检查时间必须早于失效时间 RegisteredPayload.ISSUED_AT：签发时间必须早于失效时间 如果某个时间没有设置，则不检查（表示无限制）
JWTValidator	validateDate(Date dateToCheck) 检查JWT的以下三两个时间： RegisteredPayload.NOT_BEFORE：生效时间不能晚于当前时间 RegisteredPayload.EXPIRES_AT：失效时间不能早于当前时间 RegisteredPayload.ISSUED_AT： 签发时间不能晚于当前时间 如果某个时间没有设置，则不检查（表示无限制）
JWTValidator	validateDate(Date dateToCheck, long leeway) 检查JWT的以下三两个时间： RegisteredPayload.NOT_BEFORE：生效时间不能晚于当前时间 RegisteredPayload.EXPIRES_AT：失效时间不能早于当前时间 RegisteredPayload.ISSUED_AT： 签发时间不能晚于当前时间 如果某个时间没有设置，则不检查（表示无限制）

Methods inherited from class java.lang.Object

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

Constructor Detail

JWTValidator

public JWTValidator(JWT jwt)

构造

Parameters:

jwt - JWT对象

Method Detail

of

public static JWTValidator of(String token)

创建JWT验证器

Parameters:

token - JWT Token

Returns:

JWTValidator

of

public static JWTValidator of(JWT jwt)

创建JWT验证器

Parameters:

jwt - JWT对象

Returns:

JWTValidator

validateAlgorithm

public JWTValidator validateAlgorithm()
                               throws ValidateException

验证算法，使用JWT对象自带的JWTSigner

Returns:

this

Throws:

ValidateException - 验证失败的异常

validateAlgorithm

public JWTValidator validateAlgorithm(JWTSigner signer)
                               throws ValidateException

验证算法，使用自定义的JWTSigner

Parameters:

signer - 用于验证算法的签名器

Returns:

this

Throws:

ValidateException - 验证失败的异常

validateDate

public JWTValidator validateDate()
                          throws ValidateException

检查JWT的以下三两个时间：

• RegisteredPayload.NOT_BEFORE：被检查时间必须晚于生效时间
• RegisteredPayload.EXPIRES_AT：被检查时间必须早于失效时间
• RegisteredPayload.ISSUED_AT：签发时间必须早于失效时间

如果某个时间没有设置，则不检查（表示无限制）

Returns:

this

Throws:

ValidateException - 验证失败的异常

Since:

5.7.3

validateDate

public JWTValidator validateDate(Date dateToCheck)
                          throws ValidateException

检查JWT的以下三两个时间：

• RegisteredPayload.NOT_BEFORE：生效时间不能晚于当前时间
• RegisteredPayload.EXPIRES_AT：失效时间不能早于当前时间
• RegisteredPayload.ISSUED_AT： 签发时间不能晚于当前时间

如果某个时间没有设置，则不检查（表示无限制）

Parameters:

dateToCheck - 被检查的时间，一般为当前时间

Returns:

this

Throws:

ValidateException - 验证失败的异常

validateDate

public JWTValidator validateDate(Date dateToCheck,
                                 long leeway)
                          throws ValidateException

检查JWT的以下三两个时间：

• RegisteredPayload.NOT_BEFORE：生效时间不能晚于当前时间
• RegisteredPayload.EXPIRES_AT：失效时间不能早于当前时间
• RegisteredPayload.ISSUED_AT： 签发时间不能晚于当前时间

如果某个时间没有设置，则不检查（表示无限制）

Parameters:

dateToCheck - 被检查的时间，一般为当前时间

leeway - 容忍空间，单位：秒。当不能晚于当前时间时，向后容忍；不能早于向前容忍。

Returns:

this

Throws:

ValidateException - 验证失败的异常