API Gateway:コンシューマーの認証と権限付与

次のセクションでは、Java コードサンプルを使用してトークンを生成する方法について説明します。他のプログラミング言語でキーペアを生成するために、関連ツールを使用することもできます。

1. Maven プロジェクトを作成し、必要な依存関係を追加します。

   まず、Maven プロジェクトを作成し、次の依存関係を追加します。

   <dependency>
       <groupId>org.bitbucket.b_c</groupId>
       <artifactId>jose4j</artifactId>
       <version>0.7.0</version>
   </dependency>

2. トークンを生成する方法を選択します。

   デフォルトの対称鍵サンプルまたは非対称鍵サンプルを使用してトークンを生成できます。要件に基づいてメソッドを選択してください。

   デフォルトの対称鍵サンプルを使用したトークンの生成

   サンプルコード:

   package org.example;
   
   import java.io.UnsupportedEncodingException;
   import java.security.PrivateKey;
   
   import org.jose4j.base64url.Base64;
   import org.jose4j.json.JsonUtil;
   import org.jose4j.jwk.OctJwkGenerator;
   import org.jose4j.jwk.OctetSequenceJsonWebKey;
   import org.jose4j.jws.AlgorithmIdentifiers;
   import org.jose4j.jws.JsonWebSignature;
   import org.jose4j.jwt.JwtClaims;
   import org.jose4j.jwt.NumericDate;
   import org.jose4j.keys.HmacKey;
   import org.jose4j.lang.JoseException;
   import sun.lwawt.macosx.CSystemTray;
   
   public class Main {
       public static void main(String[] args) throws JoseException, UnsupportedEncodingException {
           // このトピックの前の例を使用します。
           String privateKeyJson = "{\n"
                   + "    \"k\": \"VoBG-oyqVoyCr9G56ozmq8n_rlDDyYMQOd_DO4GOkEY\",\n"
                   + "    \"kty\": \"oct\",\n"
                   + "    \"alg\": \"HS256\",\n"
                   + "}";
           JwtClaims claims = new JwtClaims();
           claims.setGeneratedJwtId();
           claims.setIssuedAtToNow();
           // 有効期限を 7 日未満の値に設定します。
           NumericDate date = NumericDate.now();
           date.addSeconds(120*60);
           claims.setExpirationTime(date);
           claims.setNotBeforeMinutesInThePast(1);
           // カスタムパラメーターを追加します。すべての値は STRING 型である必要があります。
           // コンシューマー ID を設定します。
           claims.setClaim("uid", "11215ac069234abcb8944232b79ae711");
           JsonWebSignature jws = new JsonWebSignature();
           // 暗号化アルゴリズムを設定します。
           jws.setAlgorithmHeaderValue(AlgorithmIdentifiers.HMAC_SHA256);
           jws.setKey(new HmacKey(Base64.decode(JsonUtil.parseJson(privateKeyJson).get("k").toString())));
           jws.setPayload(claims.toJson());
           String jwtResult = jws.getCompactSerialization();
           System.out.println("Generate Json Web token , result is \n " + jwtResult);
       }
   }

   コードパラメーターの説明:

   • privateKeyJson: コンシューマーを作成するときに使用される JSON Web Key Set (JWKS) です。コンシューマーの作成時に JWKS を記録するか、コンシューマーの作成後にコンシューマーの基本情報ページから取得できます。

   • コンシューマー ID を設定します。これは claims.setClaim("uid", "11215ac069234abcb8944232b79ae711") で指定されます。コンシューマー ID は、コンシューマーを作成するときにコンソールでデフォルトで生成されます。ビジネスロジックに基づいて ID を変更することもできます。コンシューマーを作成した後、コンシューマーの基本情報ページからコンシューマー ID を取得できます。

   • 暗号化アルゴリズムを設定します。これは jws.setAlgorithmHeaderValue(AlgorithmIdentifiers.HMAC_SHA256) で指定されます。暗号化アルゴリズムは、JWKS で指定されたアルゴリズムと同じである必要があります。

     説明

     サポートされている暗号化アルゴリズムは、ES256、ES384、ES512、RS256、RS384、RS512、PS256、PS384、PS512、HS256、HS384、HS512、および EdDSA です。

     対称暗号化を使用する場合は、「k」をデコードする必要があります。

     jws.setKey(new HmacKey(Base64.decode(JsonUtil.parseJson(privateKeyJson).get("k").toString())));

   • 有効期限を設定します。有効期限は 7 日未満である必要があります。トークンの有効期限が切れた後、セキュリティを確保するために新しいトークンを生成する必要があります。

     ...
         NumericDate date = NumericDate.now();
         date.addSeconds(120*60);
         claims.setExpirationTime(date);
         claims.setNotBeforeMinutesInThePast(1);
     ...

   • 必要に応じて、JWKS の PAYLOAD にカスタムパラメーターを追加できます。

   非対称鍵サンプルを使用したトークンの生成

   サンプルコード:

   package org.example;
   
   import java.io.UnsupportedEncodingException;
   import java.security.PrivateKey;
   
   import org.jose4j.base64url.Base64;
   import org.jose4j.json.JsonUtil;
   import org.jose4j.jwk.OctJwkGenerator;
   import org.jose4j.jwk.OctetSequenceJsonWebKey;
   import org.jose4j.jws.AlgorithmIdentifiers;
   import org.jose4j.jws.JsonWebSignature;
   import org.jose4j.jwt.JwtClaims;
   import org.jose4j.jwt.NumericDate;
   import org.jose4j.keys.HmacKey;
   import org.jose4j.lang.JoseException;
   import sun.lwawt.macosx.CSystemTray;
   
   public class Main {
       public static void main(String[] args) throws JoseException, UnsupportedEncodingException {
           // このトピックの前の例を使用します。
           String privateKeyJson = "{\n"
                   + "    \"k\": \"VoBG-oyqVoyCr9G56ozmq8n_rlDDyYMQOd_DO4GOkEY\",\n"
                   + "    \"kty\": \"oct\",\n"
                   + "    \"alg\": \"HS256\",\n"
                   + "}";
           JwtClaims claims = new JwtClaims();
           claims.setGeneratedJwtId();
           claims.setIssuedAtToNow();
           // 有効期限を 7 日未満の値に設定します。
           NumericDate date = NumericDate.now();
           date.addSeconds(120*60);
           claims.setExpirationTime(date);
           claims.setNotBeforeMinutesInThePast(1);
           // カスタムパラメーターを追加します。すべての値は STRING 型である必要があります。
           // コンシューマー ID を設定します。
           claims.setClaim("uid", "11215ac069234abcb8944232b79ae711");
           JsonWebSignature jws = new JsonWebSignature();
           // 暗号化アルゴリズムを設定します。
           jws.setAlgorithmHeaderValue(AlgorithmIdentifiers.HMAC_SHA256);
           jws.setKey(new HmacKey(Base64.decode(JsonUtil.parseJson(privateKeyJson).get("k").toString())));
           jws.setPayload(claims.toJson());
           String jwtResult = jws.getCompactSerialization();
           System.out.println("Generate Json Web token , result is \n " + jwtResult);
       }
   }

   コードパラメーターの説明:

   • privateKeyJson、コンシューマー ID、および有効期限を設定します。設定は、対称暗号化アルゴリズムの場合と同じです。

     暗号化アルゴリズムを設定します。これは jws.setAlgorithmHeaderValue(AlgorithmIdentifiers.RSA_USING_SHA256) で指定されます。暗号化アルゴリズムは、JWKS で指定されたアルゴリズムと同じである必要があります。

     非対称鍵暗号化アルゴリズムの場合、その秘密鍵を使用してデータを暗号化する必要があります。

     ...
         jws.setAlgorithmHeaderValue(AlgorithmIdentifiers.RSA_USING_SHA256);
         PrivateKey privateKey = new RsaJsonWebKey(JsonUtil.parseJson(privateKeyJson)).getPrivateKey();
         jws.setKey(privateKey);
     ...

   • 必要に応じて、JWKS の PAYLOAD にカスタムパラメーターを追加できます。