一、什么是JWT
JSON Web Token (JWT)是一个开放标准(RFC 7519),它定义了一种紧凑的、自包含的方式,用于作为JSON对象在各方之间安全地传输信息。特别适用于分布式站点的单点登录(SSO)场景。JWT的声明一般被用来在身份提供者和服务提供者间传递被认证的用户身份信息,以便于从资源服务器获取资源,也可以增加一些额外的其它业务逻辑所必须的声明信息,该token也可直接被用于认证,也可被加密。
二、JWT的数据结构
本文讨论常见的签名型 JWT(JWS Compact Serialization),由三部分组成。加密型 JWT(JWE)使用不同结构,不适用本节的三段格式。以下仅为结构示意:
base64url(header).base64url(payload).base64url(signature)
中间用点(.)分隔成三个部分。JWT的三个部分依次如下:
- Header(头部)
- Payload(负载)
- Signature(签名)
Header
Header部分是一个JSON对象,描述JWT的元数据,通常是下面的样子
{
"alg": "HS256",
"typ": "JWT"
}
上面代码中,alg属性表示签名的算法(algorithm),本例选择 HMAC SHA256(写成 HS256),JWT 标准并不指定统一默认算法;typ属性表示这个令牌(token)的类型(type),本例写为 JWT;该头字段是可选的。
将上面的JSON对象使用Base64URL算法(详见后文)转成字符串就成了第一部分Header。
Payload
Payload部分也是一个JSON对象,用来存放实际需要传递的数据。JWT规定了7个官方字段,供选用。
- iss (issuer):签发人
- exp (expiration time):过期时间
- sub (subject):主题
- aud (audience):受众
- nbf (Not Before):生效时间
- iat (Issued At):签发时间
- jti (JWT ID):编号
我们还可以在这个部分自己定义字段,下面就是一个例子
{
"sub": "1234567890",
"name": "John Doe",
"admin": true
}
这个JSON对象也要使用Base64URL算法转成字符串。
Signature
Signature部分是对前两部分的签名,防止数据篡改。首先,需要指定一个密钥(secret)。这个密钥只有服务器才知道,不能泄露给用户。然后,使用Header里面指定的签名算法(本例固定为 HMAC SHA256),按照下面的公式产生签名。
HMACSHA256(
base64UrlEncode(header) + "." +
base64UrlEncode(payload),
secret)
Base64URL
前面提到,Header和Payload序列化的算法是Base64URL。这个算法跟Base64算法基本类似,但有一些小的不同。 JWT作为一个令牌(token),有些场合可能会放到URL(比如api.example.com/?token=xxx)。Base64有三个字符+,/和=,在 URL里面有特殊含义,所以要被替换掉:去除尾部的=、+替换成-,/替换成_ 。这就是Base64URL算法。 算出签名以后,把Header、Payload、Signature三个部分拼成一个字符串,每个部分之间用"点"(.)分隔,就可以返回给用户。
三、特点
- JWT默认是不加密,但也是可以加密的。生成原始Token以后,可以用密钥再加密一次。
- JWT不加密的情况下,不能将秘密数据写入JWT。
- JWT不仅可以用于认证,也可以用于交换信息。有效使用JWT,可以降低服务器查询数据库的次数。
- JWT的最大缺点是,由于服务器不保存session状态,因此无法在使用过程中废止某个token,或者更改token的权限。也就是说,一旦JWT签发了,在到期之前就会始终有效,除非服务器部署额外的逻辑。
- JWT本身包含了认证信息,一旦泄露,任何人都可以获得该令牌的所有权限。为了减少盗用,JWT的有效期应该设置得比较短。对于一些比较重要的权限,使用时应该再次对用户进行认证。
- 为了减少盗用,JWT不应该使用HTTP协议明码传输,要使用HTTPS协议传输。
四、使用
以下代码沿用 golang-jwt/jwt/v4 API。
安装项目依赖(在已有 Go module 中执行)
go get github.com/golang-jwt/jwt/v4
定义 claims 和 secret
代码片段需要导入 fmt、time 和 github.com/golang-jwt/jwt/v4。
type UserClaim struct {
UserName string `json:"user_name"`
jwt.RegisteredClaims // 注意!这是jwt-go的v4版本新增的,原先是jwt.StandardClaims
}
var Secret = []byte("replace-with-your-random-secret-at-least-32-bytes") // 仅为占位示例,实际从配置读取随机密钥
生成Token
func GenToken(user string) (string, error) {
claim := UserClaim{
user,
jwt.RegisteredClaims{
ExpiresAt: jwt.NewNumericDate(time.Now().Add(24 * time.Hour)), //24h后过期
Issuer: "gameFei", //签发人
},
}
token := jwt.NewWithClaims(jwt.SigningMethodHS256, claim) //使用HS256算法
return token.SignedString(Secret)
}
解析Token
func ParseToken(tokenStr string) (*UserClaim, error) {
token, err := jwt.ParseWithClaims(tokenStr, &UserClaim{}, func(token *jwt.Token) (interface{}, error) {
return Secret, nil
}, jwt.WithValidMethods([]string{jwt.SigningMethodHS256.Alg()}))
if err != nil {
return nil, err
}
if claims, ok := token.Claims.(*UserClaim); ok && token.Valid {
return claims, nil
}
return nil, fmt.Errorf("invalid token")
}