jwt token使用autho0-jwt框架使用(二)

约定不等于承诺〃 2022-05-24 02:10 351阅读 0赞

## 转载：[http://www.leftso.com/blog/221.html][http_www.leftso.com_blog_221.html]  转在学习分享，还有其他不错博文，可供学习。 ##

## 一、前言 ##

Java编程中使用jwt,首先你必须了解jwt是什么，长什么样子。如果你不了解可以先去本站另外一篇博客[什么是JWT？][JWT]

## 二、Java编程中jwt框架选择 ##

在Java编程中,实现jwt标准的有很多框架，本博客采用的框架是auth0的java-jwt版本为3.2.0

## 三、什么是Java-JWT ##

auth0的java-jwt是一个JSON WEB TOKEN（JWT）的一个实现。

## 四、安装下载相关依赖 ##

如果你是采用**maven**的方式,在你的项目pom.xml文件中添加以下java-jwt的依赖片段:

如果你是采用**Gradle**的方式,则添加以下内容:

compile 'com.auth0:java-jwt:3.2.0'

## 五、java-jwt已经实现的算法 ##

该库使用以下算法实现JWT验证和签名:

<table> 
 <thead> 
  <tr> 
   <th style="vertical-align:bottom;">JWS</th> 
   <th style="vertical-align:bottom;">算法</th> 
   <th style="vertical-align:bottom;">介绍</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td style="vertical-align:top;">HS256</td> 
   <td style="vertical-align:top;">HMAC256</td> 
   <td style="vertical-align:top;">HMAC with SHA-256</td> 
  </tr> 
  <tr> 
   <td style="vertical-align:top;">HS384</td> 
   <td style="vertical-align:top;">HMAC384</td> 
   <td style="vertical-align:top;">HMAC with SHA-384</td> 
  </tr> 
  <tr> 
   <td style="vertical-align:top;">HS512</td> 
   <td style="vertical-align:top;">HMAC512</td> 
   <td style="vertical-align:top;">HMAC with SHA-512</td> 
  </tr> 
  <tr> 
   <td style="vertical-align:top;">RS256</td> 
   <td style="vertical-align:top;">RSA256</td> 
   <td style="vertical-align:top;">RSASSA-PKCS1-v1_5 with SHA-256</td> 
  </tr> 
  <tr> 
   <td style="vertical-align:top;">RS384</td> 
   <td style="vertical-align:top;">RSA384</td> 
   <td style="vertical-align:top;">RSASSA-PKCS1-v1_5 with SHA-384</td> 
  </tr> 
  <tr> 
   <td style="vertical-align:top;">RS512</td> 
   <td style="vertical-align:top;">RSA512</td> 
   <td style="vertical-align:top;">RSASSA-PKCS1-v1_5 with SHA-512</td> 
  </tr> 
  <tr> 
   <td style="vertical-align:top;">ES256</td> 
   <td style="vertical-align:top;">ECDSA256</td> 
   <td style="vertical-align:top;">ECDSA with curve P-256 and SHA-256</td> 
  </tr> 
  <tr> 
   <td style="vertical-align:top;">ES384</td> 
   <td style="vertical-align:top;">ECDSA384</td> 
   <td style="vertical-align:top;">ECDSA with curve P-384 and SHA-384</td> 
  </tr> 
  <tr> 
   <td style="vertical-align:top;">ES512</td> 
   <td style="vertical-align:top;">ECDSA512</td> 
   <td style="vertical-align:top;">ECDSA with curve P-521 and SHA-512</td> 
  </tr> 
 </tbody> 
</table>

## 六、如何使用java-jwt ##

**6.1.选择一种算法**

算法定义了一个令牌是如何被签名和验证的。它可以用HMAC算法的原始值来实例化，也可以在RSA和ECDSA算法的情况下对密钥对或密钥提供程序进行实例化。创建后，该实例可用于令牌签名和验证操作。

在使用RSA或ECDSA算法时，只需要签署JWTs，就可以通过传递null值来避免指定公钥。当您需要验证JWTs时，也可以使用私钥进行操作  
  
使用静态的字符密文或者key来获取算法器:

//HMAC
    Algorithm algorithmHS = Algorithm.HMAC256("secret");
    
    //RSA
    RSAPublicKey publicKey = //Get the key instance
    RSAPrivateKey privateKey = //Get the key instance
    Algorithm algorithmRS = Algorithm.RSA256(publicKey, privateKey);

使用一个key提供者来获取算法:  
  通过使用KeyProvider，您可以在运行时更改密钥，用于验证令牌签名或为RSA或ECDSA算法签署一个新的令牌。这是通过实现RSAKeyProvider或ECDSAKeyProvider方法实现的:

*  `getPublicKeyById(String kid)`: 它在令牌签名验证中调用，它应该返回用于验证令牌的密钥。如果使用了关键的轮换，例如JWK，它可以使用id来获取正确的轮换键(或者只是一直返回相同的键)。
 *  `getPrivateKey()`: 在令牌签名期间调用它，它应该返回用于签署JWT的密钥。
 *  `getPrivateKeyId()`:在令牌签名期间调用它，它应该返回标识由getPrivateKey()返回的键的id的id。这个值比JWTCreator.Builder和keyid(String)方法中的值更受欢迎。如果您不需要设置孩子的值，就避免使用KeyProvider实例化算法。

下面的代码片段将展示如何使用：

final JwkStore jwkStore = new JwkStore("{JWKS_FILE_HOST}");
    final RSAPrivateKey privateKey = //Get the key instance
    final String privateKeyId = //Create an Id for the above key
    
    RSAKeyProvider keyProvider = new RSAKeyProvider() {
        @Override
        public RSAPublicKey getPublicKeyById(String kid) {
            //Received 'kid' value might be null if it wasn't defined in the Token's header
            RSAPublicKey publicKey = jwkStore.get(kid);
            return (RSAPublicKey) publicKey;
        }
    
        @Override
        public RSAPrivateKey getPrivateKey() {
            return privateKey;
        }
    
        @Override
        public String getPrivateKeyId() {
            return privateKeyId;
        }
    };
    
    Algorithm algorithm = Algorithm.RSA256(keyProvider);
    //Use the Algorithm to create and verify JWTs.

提示:对于使用JWKs的简单的键轮换，可以尝试JWKs-rsa-java库。  
  
**6.2.创建一个签名的JWT token**  
首先需要通过调用`jwt.create()`创建一个`JWTCreator`实例

*  例如使用 `HS256算法:`

try {
        Algorithm algorithm = Algorithm.HMAC256("secret");
        String token = JWT.create()
            .withIssuer("auth0")
            .sign(algorithm);
    } catch (UnsupportedEncodingException exception){
        //UTF-8 encoding not supported
    } catch (JWTCreationException exception){
        //Invalid Signing configuration / Couldn't convert Claims.
    }

*  例如使用`RS256算法:`

RSAPublicKey publicKey = //Get the key instance
    RSAPrivateKey privateKey = //Get the key instance
    try {
        Algorithm algorithm = Algorithm.RSA256(publicKey, privateKey);
        String token = JWT.create()
            .withIssuer("auth0")
            .sign(algorithm);
    } catch (JWTCreationException exception){
        //Invalid Signing configuration / Couldn't convert Claims.
    }

如果Claim不能转换为JSON，或者在签名过程中使用的密钥无效，那么将会抛出`JWTCreationException`异常。  
  
**6.3.验证令牌**  
  首先需要通过调用jwt.require()和传递算法实例来创建一个JWTVerifier实例。如果您要求令牌具有特定的Claim值，请使用构建器来定义它们。方法build()返回的实例是可重用的，因此您可以定义一次，并使用它来验证不同的标记。最后调用verifier.verify()来验证token

*  例如使用 `HS256算法的时候:`

String token = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXUyJ9.eyJpc3MiOiJhdXRoMCJ9.AbIJTDMFc7yUa5MhvcP03nJPyCPzZtQcGEp-zWfOkEE";
    try {
        Algorithm algorithm = Algorithm.HMAC256("secret");
        JWTVerifier verifier = JWT.require(algorithm)
            .withIssuer("auth0")
            .build(); //Reusable verifier instance
        DecodedJWT jwt = verifier.verify(token);
    } catch (UnsupportedEncodingException exception){
        //UTF-8 encoding not supported
    } catch (JWTVerificationException exception){
        //Invalid signature/claims
    }

*  例如使用 `RS256算法的时候:`

String token = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXUyJ9.eyJpc3MiOiJhdXRoMCJ9.AbIJTDMFc7yUa5MhvcP03nJPyCPzZtQcGEp-zWfOkEE";
    RSAPublicKey publicKey = //Get the key instance
    RSAPrivateKey privateKey = //Get the key instance
    try {
        Algorithm algorithm = Algorithm.RSA256(publicKey, privateKey);
        JWTVerifier verifier = JWT.require(algorithm)
            .withIssuer("auth0")
            .build(); //Reusable verifier instance
        DecodedJWT jwt = verifier.verify(token);
    } catch (JWTVerificationException exception){
        //Invalid signature/claims
    }

如果令牌有一个无效的签名，或者没有满足Claim要求，那么将会抛出JWTVerificationException异常  
  
**6.4.jwt时间的验证**  
JWT令牌可能包括可用于验证的DateNumber字段：

*  这个令牌发布了一个过期的时间 `"iat" < TODAY`
 *  这个令牌还没过期 `"exp" > TODAY` and
 *  这个令牌已经被使用了. `"nbf" > TODAY`

当验证一个令牌时，时间验证会自动发生，导致在值无效时抛出一个JWTVerificationException。如果前面的任何一个字段都丢失了，那么在这个验证中就不会考虑这些字段。  
要指定令牌仍然被认为有效的余地窗口，在JWTVerifier builder中使用accept回旋()方法，并传递一个正值的秒值。这适用于上面列出的每一项。

JWTVerifier verifier = JWT.require(algorithm)
        .acceptLeeway(1) // 1 sec for nbf, iat and exp
        .build();

您还可以为给定的日期声明指定一个自定义值，并为该声明覆盖缺省值。

JWTVerifier verifier = JWT.require(algorithm)
        .acceptLeeway(1)   //1 sec for nbf and iat
        .acceptExpiresAt(5)   //5 secs for exp
        .build();

如果您需要在您的lib/app中测试此行为，将验证实例转换为basever可视化，以获得verific.build()方法的可见性，该方法可以接受定制的时钟。例如:

BaseVerification verification = (BaseVerification) JWT.require(algorithm)
        .acceptLeeway(1)
        .acceptExpiresAt(5);
    Clock clock = new CustomClock(); //Must implement Clock interface
    JWTVerifier verifier = verification.build(clock);

**6.5解码一个jwt令牌**

String token = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXUyJ9.eyJpc3MiOiJhdXRoMCJ9.AbIJTDMFc7yUa5MhvcP03nJPyCPzZtQcGEp-zWfOkEE";
    try {
        DecodedJWT jwt = JWT.decode(token);
    } catch (JWTDecodeException exception){
        //Invalid token
    }

如果令牌有无效的语法，或者消息头或有效负载不是JSONs，那么将会抛出JWTDecodeException异常。  
  
**6.6JWT头部解析**

Algorithm ("alg")

返回jwt的算法值或,如果没有定义则返回null

String algorithm = jwt.getAlgorithm();

Type ("typ")

返回jwt的类型值，如果没有定义则返回null（多数情况类型值为jwt）

String type = jwt.getType();

Content Type ("cty")

返回内容的类型,如果没有定义则返回null

String contentType = jwt.getContentType();

Key Id ("kid")  
返回key的id值,如果没有定义则返回null

String keyId = jwt.getKeyId();

私有的Claims,即自定义字段

在令牌的头部中定义的附加声明可以通过调用getHeaderClaim() 获取,即使无法找到，也会返回。您可以通过调用claim.isNull()来检查声明的值是否为null。

Claim claim = jwt.getHeaderClaim("owner");

当使用jwt.create()创建一个令牌时，您可以通过调用withHeader()来指定头声明，并同时传递声明的映射。

Map<String, Object> headerClaims = new HashMap();
    headerClaims.put("owner", "auth0");
    String token = JWT.create()
            .withHeader(headerClaims)
            .sign(algorithm);

提示:在签名过程之后，alg和typ值将始终包含在Header中。  
  
**6.7JWT的负载(Payload)声明**

Issuer ("iss")

返回签发者的名称值,如果没有在负载中定义则返回null

String issuer = jwt.getIssuer();

Subject ("sub")

返回jwt所面向的用户的值,如果没有在负载中定义则返回null

String subject = jwt.getSubject();

Audience ("aud")

返回该jwt由谁接收,如果没有在负载中定义则返回null

List<String> audience = jwt.getAudience();

Expiration Time ("exp")

返回该jwt的过期时间,如果在负载中没有定义则返回null

Date expiresAt = jwt.getExpiresAt();

Not Before ("nbf")

Returns the Not Before value or null if it's not defined in the Payload.

Date notBefore = jwt.getNotBefore();

Issued At ("iat")

返回在什么时候签发的,如果在负载中没有定义则返回null

Date issuedAt = jwt.getIssuedAt();

JWT ID ("jti")

返回该jwt的唯一标志,如果在负载中没有定义则返回null

String id = jwt.getId();

**自定义声明**  
在令牌有效负载中定义的附加声明可以通过调用getClaims()或 getClaim()和传递声明名来获得。即使无法找到声明，也将会有返回值。您可以通过调用claim.isNull()来检查声明的值是否为null。

Map<String, Claim> claims = jwt.getClaims();    //Key is the Claim name
    Claim claim = claims.get("isAdmin");

或者:

Claim claim = jwt.getClaim("isAdmin");

当使用jwt.create()创建一个令牌时，您可以通过调用withClaim()来指定自定义声明，并同时传递名称和值。

String token = JWT.create()
            .withClaim("name", 123)
            .withArrayClaim("array", new Integer[]{
       1, 2, 3})
            .sign(algorithm);

您还可以通过调用withClaim()来验证jwt.require()的自定义声明，并传递该名称和所需的值。

JWTVerifier verifier = JWT.require(algorithm)
        .withClaim("name", 123)
        .withArrayClaim("array", 1, 2, 3)
        .build();
    DecodedJWT jwt = verifier.verify("my.jwt.token");

提示:当前支持的自定义JWT声明创建和验证的类型是:Boolean, Integer, Double, String, Date 和Arrays。  
  
**6.8Claim Class**  
索赔类是索赔值的包装器。它允许您将索赔作为不同的类类型。可用的工具方法:  
原始的:

*  **asBoolean()**: 返回布尔值,如果不能转换返回null。
 *  **asInt()**: 返回整数值,如果不能转换返回null。
 *  **asDouble()**: 返回 Double 值,如果不能转换则返回null。
 *  **asLong()**: 返回Long 值，如果不能转换则返回null。
 *  **asString()**: 返回String值,如果不能转换则返回null。
 *  **asDate()**: 返回 Date值,如果不能转换则返回null。 必须是一个数字日期 (Unix 系统时间戳). 注意，JWT标准指定所有的数字日期值必须以秒为单位。

自定义类型和集合:

要获得作为集合的声明，您需要提供要转换的内容的类类型

*  as(class): 返回 Class Type 的解析值. 对于集合，您应该使用asArray和asList方法。
 *  asMap(): 返回被转换为 Map<String, Object>的值
 *  asArray(class): 返回被转换成元素类型的 Class Type, or null if the value isn't a JSON Array.
 *  asList(class): 返回集合元素的 Class Type, or null if the value isn't a JSON Array.

如果不能将值转换为给定的类类型，则会抛出JWTDecodeException异常

[http_www.leftso.com_blog_221.html]: http://www.leftso.com/blog/221.html
[JWT]: http://www.leftso.com/blog/220.html