crypt.jwt 库模块帮助文档

crypt.jwt 成员列表 #

JSON Web Token 令牌

crypt.jwt.decode #

解码并返回令牌信息

crypt.jwt.decode(token) #

不验证签名，直接解码并返回令牌信息

crypt.jwt.decode(token,key,algorithm) #

验证签名，失败返回 null。
成功则解码并获取令牌记录的 JSON 数据，
然后对 JSON 进行解析并返回解码后的对象。

参数 @key 指定密钥或 PEM 格式公钥。
可选用参数 @algorithm 指定签名算法，默认为 "HS256"，
也可指定为 "RS256" 或 "none"，算法为 "none" 则 @key 可指定空字符串。
其他算法请自行添加到 crypt.jwt.algorithm 命名空间，
可参考 crypt.jwt.algorithm.EdDSA 库源代码。

crypt.jwt.encode #

生成 JWT 令牌。

crypt.jwt.encode(data,key,algorithm) #

生成令牌，
参数 @data 指定要存储到客户端的数据（必须是一个表对象）
参数 @key 指定密钥或 PEM 格式私钥。
可选用参数 @algorithm 指定签名算法，默认为 "HS256"，
也可指定为 "RS256" 或 "none"，算法为 "none" 则 @key 可指定空字符串。
其他算法请自行添加到 crypt.jwt.algorithm 命名空间，
可参考 crypt.jwt.algorithm.EdDSA 库源代码。

crypt.jwt.algorithm 成员列表 #

此命名空间用于扩展 crypt.jwt 支持的算法。

crypt.jwt.algorithm.* #

添加 crypt.jwt 支持的算法。
请参考 rypt.jwt.algorithm.EdDSA 库源码，关键代码：

namespace crypt.jwt.algorithm.EdDSA {  
    sign = function(key, payload) {  
        //返回签名（字符串或 buffer，不必使用 URLBase64 编码）;  
    };  
    verify = function(key, signature, payload) {  
        //返回验证结果（布尔值），signature 已使用 URLBase64 解码（字符串）*/;  
    };  
}  

Markdown 格式