JSON Web令牌（JWT）介绍与使用

小灰灰 2023-07-10 14:20 37阅读 0赞

手机端接口开发会遇到一个问题是，接口登录后需要返回一个Token。token首先有一点必须唯一，每次请求都需要把token给带上。基于必须唯一的特性，很多朋友在开发是都选择了uuid。是不是token的生成有没有可以遵循的标准，或生成token的一些技术呢？

本文将介绍生成token标记[JSON Web Token(TWT)][JSON Web Token_TWT]。

## **什么是JSON Web令牌？** ##

JSON Web令牌（JWT）是一个开放标准（[RFC 7519][]），它定义了一种紧凑且自包含的方式，用于在各方之间安全地将信息作为JSON对象传输。由于此信息是经过数字签名的，因此可以被验证和信任。可以使用秘密（使用**HMAC**算法）或使用**RSA**或**ECDSA**的公用/专用密钥对对JWT进行**签名**。

尽管可以对JWT进行加密以在各方之间提供保密性，但我们将重点关注已*签名的*令牌。签名的令牌可以验证其中包含的声明的*完整性*，而加密的令牌则将这些声明*隐藏*在其他方的面前。当使用公钥/私钥对对令牌进行签名时，签名还证明只有持有私钥的一方才是对其进行签名的一方。

## **什么时候应该使用JSON Web令牌？** ##

以下是JSON Web令牌有用的一些情况：

*  **授权**：这是使用JWT的最常见方案。一旦用户登录，每个后续请求将包括JWT，从而允许用户访问该令牌允许的路由，服务和资源。单一登录是当今广泛使用JWT的一项功能，因为它的开销很小并且可以在不同的域中轻松使用。
 *  **信息交换**：JSON Web令牌是在各方之间安全地传输信息的好方法。因为可以对JWT进行签名（例如，使用公钥/私钥对），所以您可以确定发件人是他们所说的人。此外，由于签名是使用标头和有效负载计算的，因此您还可以验证内容是否遭到篡改。

## **JSON Web令牌结构是什么？** ##

JSON Web令牌以紧凑的形式由三部分组成，这些部分由点（`.`）分隔，分别是：

*  标头
 *  有效载荷
 *  签名

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JlbHZpbmU_size_16_color_FFFFFF_t_70][]

因此，JWT通常如下所示。

`xxxxx.yyyyy.zzzzz`

让我们分解不同的部分。

### **标头** ###

标头*通常*由两部分组成：令牌的类型（即JWT）和所使用的签名算法，例如HMAC SHA256或RSA。

例如：

{ "alg": "HS256", "typ": "JWT" }

然后，此JSON被**Base64Url**编码以形成JWT的第一部分。

### **有效载荷** ###

令牌的第二部分是有效负载，其中包含声明。声明是有关实体（通常是用户）和其他数据的声明。索赔有以下三种类型：*注册的*，*公共的*和*私人*索赔。

*  [**已注册的权利要求**][Link 1]：这些是一组非强制性的但建议使用的预定义权利要求，以提供一组有用的，可互操作的权利要求。其中一些是：** iss**（发布者），** exp**（到期时间），** sub**（主题），** aud**（受众群体）[等][Link 1]。
    
    > 请注意，声明名称仅是三个字符，因为JWT是紧凑的。
 *  [**公开声明**][Link 2]：使用JWT的人员可以随意定义这些声明。但是为避免冲突，应在[ IANA JSON Web令牌注册表][IANA JSON Web]中定义它们，或将其定义为包含抗冲突名称空间的URI。
 *  [**私人权利**][Link 3]：这些都是使用它们同意并既不是当事人之间建立共享信息的自定义声明*注册*或*公众*的权利要求。

有效负载示例可能是：

{ "sub": "1234567890", "name": "John Doe", "admin": true }

然后，对有效负载进行**Base64Url**编码，以形成JSON Web令牌的第二部分。

> 请注意，对于已签名的令牌，此信息尽管可以防止篡改，但任何人都可以读取。除非将其加密，否则请勿将机密信息放入JWT的有效负载或报头元素中。

### **签名** ###

要创建签名部分，您必须获取编码的标头，编码的有效载荷，机密，标头中指定的算法，并对其进行签名。

例如，如果要使用HMAC SHA256算法，则将通过以下方式创建签名：

HMACSHA256( base64UrlEncode(header) + "." + base64UrlEncode(payload), secret)

签名用于验证消息在此过程中没有更改，并且对于使用私钥进行签名的令牌，它还可以验证JWT的发送者是它所说的真实身份。

### **放在一起** ###

输出是三个由点分隔的Base64-URL字符串，可以在HTML和HTTP环境中轻松传递这些字符串，与基于XML的标准（例如SAML）相比，它更紧凑。

下面显示了一个JWT，它已对先前的标头和有效负载进行了编码，并用一个秘密进行了签名。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JlbHZpbmU_size_16_color_FFFFFF_t_70 1][]

如果您想使用JWT并将这些概念付诸实践，则可以使用[jwt.io Debugger][]解码，验证和生成JWT。

## **JSON Web令牌如何工作？** ##

在身份验证中，当用户使用其凭据成功登录时，将返回JSON Web令牌。由于令牌是凭据，因此必须格外小心以防止安全问题。通常，令牌的保留时间不应超过要求的时间。

[由于缺乏安全性，][Link 4]您也不[应该将敏感的会话数据存储在浏览器中][Link 4]。

每当用户想要访问受保护的路由或资源时，用户代理通常应使用**承载**模式在**授权**标头中发送JWT 。标头的内容应如下所示：

Authorization: Bearer <token>

在某些情况下，这可以是无状态授权机制。服务器的受保护路由将在`Authorization`标头中检查有效的JWT ，如果存在，则将允许用户访问受保护的资源。如果JWT包含必要的数据，则可以减少查询数据库中某些操作的需求，尽管这种情况并非总是如此。

如果令牌是在`Authorization`标头中发送的，则跨域资源共享（CORS）不会成为问题，因为它不使用cookie。

下图显示了如何获取JWT并将其用于访问API或资源：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JlbHZpbmU_size_16_color_FFFFFF_t_70 2][]

1.  应用程序或客户端向授权服务器请求授权。这是通过不同的授权流程之一执行的。例如，典型的符合[OpenID Connect的][OpenID Connect] Web应用程序将`/oauth/authorize`使用[授权代码流][Link 5]通过端点。
2.  授予授权后，授权服务器会将访问令牌返回给应用程序。
3.  该应用程序使用访问令牌来访问受保护的资源（例如API）。

请注意，使用签名的令牌，令牌中包含的所有信息都会暴露给用户或其他方，即使他们无法更改它。这意味着您不应将机密信息放入令牌中。

## **我们为什么要使用JSON Web令牌？** ##

让我们谈谈与**简单Web令牌（SWT）**和**安全性声明标记语言令牌（SAML）**相比，**JSON Web令牌（JWT）**的好处。

由于JSON不如XML冗长，因此在编码时JSON的大小也较小，从而使JWT比SAML更为紧凑。这使得JWT是在HTML和HTTP环境中传递的不错的选择。

在安全方面，只能使用HMAC算法由共享机密对SWT进行对称签名。但是，JWT和SAML令牌可以使用X.509证书形式的公用/专用密钥对进行签名。与签名JSON的简单性相比，使用XML数字签名对XML进行签名而不引入模糊的安全漏洞是非常困难的。

JSON解析器在大多数编程语言中都很常见，因为它们直接映射到对象。相反，XML没有自然的文档到对象映射。与SAML断言相比，这使使用JWT更加容易。

关于用法，JWT是在Internet规模上使用的。这强调了在多个平台（尤其是移动平台）上对JSON Web令牌进行客户端处理的简便性。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JlbHZpbmU_size_16_color_FFFFFF_t_70 3][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JlbHZpbmU_size_16_color_FFFFFF_t_70 4][]

*编码的JWT和编码的SAML的长度比较*

如果您想了解有关JSON Web令牌的更多信息，甚至开始使用它们在自己的应用程序中执行身份验证，请浏览到Auth0 上的[JSON Web令牌登录页面][JSON Web]。

**Java中使用JSON Web令牌**

GitHub源码：[https://github.com/auth0/java-jwt][https_github.com_auth0_java-jwt]

Maven中导入jwt包：

通过secret创建token，以下代码是通过HMAC256加密算法进行处理，也可以使用其他算法进行加密处理，可支持的算法如下。

/**
         * 创建token
         * 可以设置如下内容： iss（发布者）， exp（到期时间）， sub（主题）， aud（受众群体）
         * @return
         */
        public String createTokenByHMAC256(){
            try {
                Algorithm algorithmHS = Algorithm.HMAC256(secret);
                JWTCreator.Builder builder = JWT.create();
                if(StringUtils.isNotEmpty(iss)){
                    builder.withIssuer(iss);
                }
                if(StringUtils.isNotEmpty(sub)){
                    builder.withSubject(sub);
                }
                if(exp!=null){
                    builder.withExpiresAt(exp);
                }
                String token = builder.sign(algorithmHS);
                return token;
            } catch (JWTCreationException exception){
                //Invalid Signing configuration / Couldn't convert Claims.
            }
            return null;
        }

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JlbHZpbmU_size_16_color_FFFFFF_t_70 5][]

Token校验

/**
         * 校验Token的正确性
         * @param token
         * @return
         */
        public boolean verify(String token){
            try {
                Algorithm algorithm = Algorithm.HMAC256("secret");
                Verification require = JWT.require(algorithm);
                if(StringUtils.isNotEmpty(iss)){
                    require.withIssuer(iss);
                }
                if(StringUtils.isNotEmpty(sub)){
                    require.withSubject(sub);
                }
                JWTVerifier verifier = require
                        .build(); //Reusable verifier instance
                DecodedJWT jwt = verifier.verify(token);
                return true;
            } catch (JWTVerificationException exception){
                //Invalid signature/claims
                return false;
            }
        }

### 解码令牌 ###

/**
         * 解码token
         * @param token
         * @return
         */
        public DecodedJWT decode(String token){
            try {
                DecodedJWT jwt = JWT.decode(token);
                return jwt;
            } catch (JWTDecodeException exception){
                //Invalid token
            }
            return null;
        }

[JSON Web Token_TWT]: https://jwt.io/
[RFC 7519]: https://tools.ietf.org/html/rfc7519
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JlbHZpbmU_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20200303111530145.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JlbHZpbmU=,size_16,color_FFFFFF,t_70
[Link 1]: https://tools.ietf.org/html/rfc7519#section-4.1
[Link 2]: https://tools.ietf.org/html/rfc7519#section-4.2
[IANA JSON Web]: https://www.iana.org/assignments/jwt/jwt.xhtml
[Link 3]: https://tools.ietf.org/html/rfc7519#section-4.3
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JlbHZpbmU_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/20200303114756565.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JlbHZpbmU=,size_16,color_FFFFFF,t_70
[jwt.io Debugger]: http://jwt.io/
[Link 4]: https://cheatsheetseries.owasp.org/cheatsheets/HTML5_Security_Cheat_Sheet.html#local-storage
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JlbHZpbmU_size_16_color_FFFFFF_t_70 2]: https://img-blog.csdnimg.cn/2020030311495282.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JlbHZpbmU=,size_16,color_FFFFFF,t_70
[OpenID Connect]: http://openid.net/connect/
[Link 5]: http://openid.net/specs/openid-connect-core-1_0.html#CodeFlowAuth
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JlbHZpbmU_size_16_color_FFFFFF_t_70 3]: https://img-blog.csdnimg.cn/20200303115308302.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JlbHZpbmU=,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JlbHZpbmU_size_16_color_FFFFFF_t_70 4]: https://img-blog.csdnimg.cn/20200303115333903.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JlbHZpbmU=,size_16,color_FFFFFF,t_70
[JSON Web]: http://auth0.com/learn/json-web-tokens
[https_github.com_auth0_java-jwt]: https://github.com/auth0/java-jwt
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JlbHZpbmU_size_16_color_FFFFFF_t_70 5]: https://img-blog.csdnimg.cn/20200303122348926.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JlbHZpbmU=,size_16,color_FFFFFF,t_70