jwt-generate

IBM® API Connect の Generate JWT セキュリティー・ポリシーは、JSON Web トークン (JWT) を生成するために使用します。

jwt-generate ポリシーの構造は、以下のとおりです。

- jwt-generate:
  title: title
  description: description
  jwt: json_web_token
  jti-claim: jwt_id_claim
  iss-claim: issuer_claim
  exp-claim: validity_period
  sub-claim: subject_claim
  aud-claim: audience_claim
  jws-jwk: sign_jwk_variable_name
  jws-alg: cryptographic_algorithm
  jws-crypto: sign_crypto_object
  jwe-enc: encryption_algorithm
  jwe-jwk: encrypt_jwk_variable_name
  jwe-alg: key_encryption_algorithm
  jwe-crypto: encrypt_crypto_object

以下の表に、このポリシーのプロパティーを示します。

表 1. Generate JWT ポリシーのプロパティー
プロパティー・ラベル	プロパティー名	必須	説明	データ型
タイトル	title	いいえ	ポリシーのタイトル。デフォルト値は、`jwt-generate` です。	ストリング
説明	description	いいえ	ポリシーの説明。	ストリング
JSON Web トークン (JWT)	jwt	いいえ	生成された JWT を格納するためのランタイム変数。デフォルト値は、`generated.jwt` です。ただし、設定しない場合、生成された JWT はベアラー・トークンとして許可ヘッダーに書き込まれます。	ストリング
JWT ID クレーム	jti-claim	いいえ	JWT ID (jti) クレームを JWT に追加するかどうかを指定します。選択した場合、プロパティーが `true` に設定され、UUID が生成されて JTI クレーム値として設定されます。	ブール
Issuer クレーム	iss-claim	はい	Issuer (iss) クレーム・ストリングの取得元となるランタイム変数。このクレームは、JWT を発行したプリンシパルを表しています。デフォルト値は、`iss.claim` です。	ストリング
Subject クレーム	sub-claim	いいえ	Subject (sub) クレーム・ストリングの取得元となるランタイム変数。	ストリング
Audience クレーム	aud-claim	いいえ	Audience (aud) クレーム・ストリングの取得元となるランタイム変数。複数の変数を設定する場合は、コンマ区切りのストリングを使用します。	ストリング
有効期間	exp-claim	はい	JWT が有効とみなされる期間として、現在の日時に追加される時間の長さ (秒)。デフォルト値は `3600` です。	整数
プライベート・クレーム	private-claims	いいえ	一連の有効な JSON クレームの取得元となるランタイム変数。これらのクレームは、前に指定した任意の一連のクレームに追加されます。	ストリング
署名用 JWK 変数名	jws-jwk	いいえ	JWT に署名するために使用される JWK を含むランタイム変数。¹	ストリング
暗号アルゴリズム	jws-alg	いいえ	使用する暗号アルゴリズム。有効な値は次のとおりです。 HS256 HS384 HS512 RS256 RS384 RS512 ES256 ES384 ES512 なし	ストリング
署名用暗号オブジェクト	jws-crypto	いいえ	JWT に署名するために使用する暗号オブジェクト。¹	ストリング
暗号化アルゴリズム	jwe-enc	いいえ	使用する暗号化アルゴリズム。有効な値は次のとおりです。 A128CBC-HS256 A192CBC-HS384 A256CBC-HS512	ストリング
暗号化用 JWK 変数名	jwe-jwk	いいえ	JWT を暗号化するために使用する JWK を格納するランタイム変数。	ストリング
鍵暗号化アルゴリズム	jwe-alg	いいえ	使用する鍵暗号化アルゴリズム。有効な値は次のとおりです。 RSA1_5 RSA-OAEP RSA-OAEP-256 dir A128KW A192KW A256KW	ストリング
暗号化用暗号オブジェクト	jwe-crypto	いいえ	クレームを暗号化するために使用する暗号オブジェクト。	ストリング

例

以下に jwt-generate ポリシーの例を示します。

- jwt-generate:
    title: jwt-generate
    iss-claim: iss.claim
    exp-claim: 3600
    jwt: generated.jwt
    jti-claim: true
    sub-claim: sub.claim
    aud-claim: aud.claim
    private-claims: private.claims
    jws-jwk: jws.jwk
    jws-alg: HS256
    jws-crypto: jwsCryptoObjectName
    jwe-enc: A128CBC-HS256
    jwe-jwk: jwe.jwk
    jwe-alg: A128KW
    jwe-crypto: jweCryptoObjectName

jwt-generate セキュリティー・ポリシーの使用方法について詳しくは、『組み込みポリシー』セクションの Generate JWT (jwt-generate) を参照してください。

¹ JWK も暗号オブジェクトも JWT に署名するために必要な暗号化データを提供する有効な方法です。ただし、両方のデータ型を指定した場合は、暗号オブジェクトのみが使用されます。

最終更新: 2017 年 10 月 31 日