VerifyJWT ポリシー

概要

クライアントやその他のシステムから受信した JWT の署名を検証します。また、このポリシーはクレームを抽出してコンテキスト変数に格納し、後続のポリシーまたは条件でそれらの値を調べて、認可やルーティングを決定できるようにします。詳しくは、JWS ポリシーと JWT ポリシーの概要をご覧ください。

このポリシーが実行されると、Edge は JWT の署名を検証し、有効期限と開始時期に基づいて JWT が有効であることを検証します。このポリシーは、必要に応じて subject や issuer、audience、追加クレームの値など、JWT の特定クレームの値を検証することもできます。

検証の結果 JWT が有効である場合、JWT に含まれるすべてのクレームが抽出されて後続のポリシーや条件で使用できるようにコンテキスト変数に格納され、リクエストの続行が許可されます。JWT の署名を検証できない場合、タイムスタンプが原因で JWT が無効となった場合、すべての処理が停止し、レスポンスでエラーが返されます。

JWT の各部について、またその暗号化と署名の方法については、RFC7519 をご覧ください。

動画

JWT の署名を検証する方法についての動画をご覧ください。

サンプル

• HS256 アルゴリズムで署名された JWT の検証
• RS256 アルゴリズムで署名された JWT の検証

HS256 アルゴリズムで署名された JWT の検証

このポリシー サンプルでは、HS256 暗号化アルゴリズム（SHA-256 チェックサムを使用した HMAC）で署名された JWT を検証します。JWT は、jwt という名前のフォーム パラメータを介してプロキシ リクエスト内で渡されます。キーは private.secretkey という名前の変数に含まれています。ポリシーに対してリクエストする方法など、詳しい例については上記の動画をご覧ください。

ポリシーの構成には JWT のデコード（復号）と評価に必要な情報を含めます。たとえば、JWT の場所（Source 要素に指定されたフロー変数内）、検証に必要な署名アルゴリズム、秘密鍵の場所（Edge フロー変数に保存され、Edge KVM などから取得可能）、必要なクレームとその値のセットなどです。

<VerifyJWT name="JWT-Verify-HS256">
    <DisplayName>JWT Verify HS256</DisplayName>
    <Algorithm>HS256</Algorithm>
    <Source>request.formparam.jwt</Source>
    <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
    <SecretKey>
        <Value ref="private.secretkey"/>
    </SecretKey>
    <Subject>monty-pythons-flying-circus</Subject>
    <Issuer>urn://apigee-edge-JWT-policy-test</Issuer>
    <Audience>fans</Audience>
    <AdditionalClaims>
        <Claim name="show">And now for something completely different.</Claim>
    </AdditionalClaims>
</VerifyJWT>

ポリシーは出力をコンテキスト変数に書き込み、後続のポリシーまたは API プロキシの条件でその値を調べられるようにします。このポリシーの変数のリストについては、フロー変数をご覧ください。

RS256 アルゴリズムで署名された JWT の検証

このポリシー サンプルでは、RS256 アルゴリズムで署名された JWT を検証します。検証するには公開鍵を用意する必要があります。JWT は、jwt という名前のフォーム パラメータを介してプロキシ リクエスト内で渡されます。公開鍵は public.publickey という名前の変数に格納されます。ポリシーに対してリクエストする方法など、詳しい例については上記の動画をご覧ください。

このサンプル ポリシーの各要素に関する要件とオプションについて詳しくは、要素リファレンスをご覧ください。

<VerifyJWT name="JWT-Verify-RS256">
    <Algorithm>RS256</Algorithm>
    <Source>request.formparam.jwt</Source>
    <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
    <PublicKey>
        <Value ref="public.publickey"/>
    </PublicKey>
    <Subject>apigee-seattle-hatrack-montage</Subject>
    <Issuer>urn://apigee-edge-JWT-policy-test</Issuer>
    <Audience>urn://c60511c0-12a2-473c-80fd-42528eb65a6a</Audience>
    <AdditionalClaims>
        <Claim name="show">And now for something completely different.</Claim>
    </AdditionalClaims>
</VerifyJWT>

上記のポリシー構成に対し、JWT が以下のヘッダーを含み、

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

かつ以下のペイロードを含む場合、

{
  "sub" : "apigee-seattle-hatrack-montage",
  "iss" : "urn://apigee-edge-JWT-policy-test",
  "aud" : "urn://c60511c0-12a2-473c-80fd-42528eb65a6a",
  "show": "And now for something completely different."
}

指定された公開鍵で署名を検証できれば、この JWT は有効とみなされます。

上記と同じヘッダーで以下のペイロードを含む JWT の場合、

{
  "sub" : "monty-pythons-flying-circus",
  "iss" : "urn://apigee-edge-JWT-policy-test",
  "aud" : "urn://c60511c0-12a2-473c-80fd-42528eb65a6a",
  "show": "And now for something completely different."
}

JWT に含まれる sub クレームが、ポリシー構成で指定された Subject 要素の必須値と一致しないため、署名が検証可能であっても無効と判断されます。

ポリシーは出力をコンテキスト変数に書き込み、後続のポリシーまたは API プロキシの条件でその値を調べられるようにします。このポリシーの変数のリストについては、フロー変数をご覧ください。

鍵要素の設定

JWT の検証に使用する鍵の指定に使用する要素は、次の表に示すように選択したアルゴリズムによって異なります。

<SecretKey>
  <Value ref="private.secretkey"/>
</SecretKey>

<PublicKey>
  <Value ref="rsa_public_key_or_value"/>
</PublicKey>

<PublicKey>
  <Certificate ref="signed_cert_val_ref"/>
</PublicKey>

<PublicKey>
  <JWKS ref="jwks_val_or_ref"/>
</PublicKey>

要素リファレンス

このポリシー リファレンスでは、Verify JWT ポリシーの要素と属性について説明します。

注: 構成は使用する暗号化アルゴリズムにより異なります。特定のユースケースの構成例については、サンプルをご覧ください。

最上位の要素に適用される属性

<VerifyJWT name="JWT" continueOnError="false" enabled="true" async="false">

次の属性は、すべてのポリシーの親要素に共通です。

<DisplayName>

<DisplayName>Policy Display Name</DisplayName>

name 属性に加えて、管理 UI プロキシ エディタのポリシーに別の自然言語名でラベルを付けるために使います。

<Algorithm>

<Algorithm>HS256</Algorithm>

トークンに署名する暗号化アルゴリズムを指定します。RS*、PS*、ES* の各アルゴリズムでは公開鍵 / 秘密鍵ペアを使用し、HS* アルゴリズムでは共有シークレットを使用します。署名暗号化アルゴリズムについてもご覧ください。

複数の値をカンマで区切りながら指定できます。たとえば、「HS256, HS512」や「RS256, PS256」とします。ただし、HS* アルゴリズムとその他のアルゴリズム、または ES* アルゴリズムとその他のアルゴリズムを組み合わることはできません。必要な鍵の種類が異なるからです。RS* アルゴリズムと PS* アルゴリズムは組み合わせることができます。

<Audience>

<Audience>audience-here</Audience>

or:

<Audience ref='variable-name-here'/>

このポリシーは、JWT の aud クレームがポリシー構成に指定された値と一致することを確認します。一致しない場合、ポリシーはエラーを返します。このクレームは、この JWT を受け取ると想定された対象を識別します。これは、RFC7519 に記載されている登録済みクレームの 1 つです。

<AdditionalClaims/Claim>

<AdditionalClaims>
    <Claim name='claim1'>explicit-value-of-claim-here</Claim>
    <Claim name='claim2' ref='variable-name-here'/>
    <Claim name='claim3' ref='variable-name-here' type='boolean'/>
 </AdditionalClaims>

or:

<AdditionalClaims ref='claim_payload'/>

指定された追加クレームが JWT ペイロードに含まれていること、および表明されたクレーム値同士が一致することを検証します。

追加クレームには、標準 JWT クレーム名や登録済み JWT クレーム名以外の名前を使用します。追加クレームの値は、文字列、数値、ブール値、マッピング、または配列です。マッピングとは名前と値のペアのセットのことです。このタイプのクレーム値はポリシー構成で明示的に指定することも、フロー変数への参照を利用して間接的に指定することもできます。

<Claim> 要素には次の属性があります。

• name -（必須）クレームの名前。
• ref -（省略可）フロー変数の名前。設定された場合、ポリシーはこの変数の値をクレームとして使用します。ref 属性と明示的なクレーム値が両方指定された場合、明示的な値がデフォルトとなり、参照されたフロー変数が解決されない場合に使用されます。
• type -（省略可）文字列（デフォルト）、数値、ブール値、マッピングのいずれか
• array -（省略可）値が型の配列かどうかを示すには true に設定します（デフォルトは false）。

<Claim> 要素を含める場合、クレーム名はポリシーの構成時に静的に設定します。あるいは、JSON オブジェクトを渡してクレーム名を指定することもできます。JSON オブジェクトは変数として渡されるため、クレーム名はランタイムに判定されます。

例:

<AdditionalClaims ref='json_claims'/>

ここで、変数 json_claims には次の形式の JSON オブジェクトが含まれます。

{
  "sub" : "person@example.com",
  "iss" : "urn://secure-issuer@example.com",
  "non-registered-claim" : {
    "This-is-a-thing" : 817,
    "https://example.com/foobar" : { "p": 42, "q": false }
  }
}

<AdditionalHeaders/Claim>

<AdditionalHeaders>
    <Claim name='claim1'>explicit-value-of-claim-here</Claim>
    <Claim name='claim2' ref='variable-name-here'/>
    <Claim name='claim3' ref='variable-name-here' type='boolean'/>
    <Claim name='claim4' ref='variable-name' type='string' array='true'/>
 </AdditionalHeaders>

指定された追加クレームの名前と値のペアが JWT ヘッダーに含まれていること、および表明されたクレーム値同士が一致することを検証します。

追加クレームには、標準 JWT クレーム名や登録済み JWT クレーム名以外の名前を使用します。追加クレームの値は、文字列、数値、ブール値、マッピング、または配列です。マッピングとは名前と値のペアのセットのことです。このタイプのクレーム値はポリシー構成で明示的に指定することも、フロー変数への参照を利用して間接的に指定することもできます。

<Claim> 要素には次の属性があります。

• name -（必須）クレームの名前。
• ref -（省略可）フロー変数の名前。設定された場合、ポリシーはこの変数の値をクレームとして使用します。ref 属性と明示的なクレーム値が両方指定された場合、明示的な値がデフォルトとなり、参照されたフロー変数が解決されない場合に使用されます。
• type -（省略可）文字列（デフォルト）、数値、ブール値、マッピングのいずれか
• array -（省略可）値が型の配列かどうかを示すには true に設定します（デフォルトは false）。

<CustomClaims>

注: 現在、UI を使用して新しい GenerateJWT ポリシーを追加すると CustomClaims 要素が挿入されます。この要素は機能していないため無視されます。代わりに使用する要素は <AdditionalClaims> です。あとで正しい要素が挿入されるように UI が更新されます。

<Id>

<Id>explicit-jti-value-here</Id>
 -or-
<Id ref='variable-name-here'/>
 -or-
<Id/>

JWT に特定の jti クレームがあることを確認します。text 値と ref 属性が両方とも空白の場合、ポリシーはランダムな UUID を含む jti を生成します。JWT ID（jti）クレームは、JWT の一意の識別子です。jti について詳しくは、RFC7519 をご覧ください。

<IgnoreCriticalHeaders>

<IgnoreCriticalHeaders>true|false</IgnoreCriticalHeaders>

false に設定すると、JWT の crit ヘッダーにリストされたヘッダーの中に、<KnownHeaders> 要素のリストにないものがあった場合に、ポリシーがエラーを返します。true に設定すると、VerifyJWT ポリシーで crit ヘッダーが無視されます。

この要素を true に設定する状況の 1 つとして、テスト環境で、ヘッダー不足によるエラー発生に対する準備がまだできていない場合があります。

<IgnoreIssuedAt>

<IgnoreIssuedAt>true|false</IgnoreIssuedAt>

false に設定すると（デフォルト）、未来の時刻を指定する iat（Issued at）クレームが JWT に含まれていた場合に、ポリシーがエラーを返します。true に設定すると、ポリシーが検証時に iat を無視します。

<IgnoreUnresolvedVariables>

<IgnoreUnresolvedVariables>true|false</IgnoreUnresolvedVariables>

false に設定すると、ポリシーで指定された参照値が解決できない場合にエラーを返します。true に設定すると、解決できない変数を空の文字列（null）として扱います。

<Issuer>

<Issuer ref='variable-name-here'/>
<Issuer>issuer-string-here</Issuer>

このポリシーは、JWT の発行者がポリシー構成の要素に指定された文字列と一致することを検証します。JWT の発行者を識別するクレーム。RFC7519 に記載されている登録済みクレームの 1 つです。

<KnownHeaders>

<KnownHeaders>a,b,c</KnownHeaders>

or:

<KnownHeaders ref=’variable_containing_headers’/>

GenerateJWT ポリシーは <CriticalHeaders> 要素を使用して、JWT 内の crit ヘッダーに情報を入力します。例:

{
  “typ: “...”,
  “alg” : “...”,
  “crit” : [ “a”, “b”, “c” ],
}

VerifyJWT ポリシーは JWT で crit ヘッダーを調べ、存在する場合は、そこにリストされた各ヘッダーが <KnownHeaders> 要素にもリストされているかどうか確認します。<KnownHeaders> 要素は、crit にリストされた項目のスーパーセットを含むことができます。必要なことは、crit にリストされたすべてのヘッダーが <KnownHeaders> 要素にリストされていることです。ポリシーが crit で検出したヘッダーの中に <KnownHeaders> にリストされていないものがあると、VerifyJWT ポリシーは失敗します。

<IgnoreCriticalHeaders> 要素を true に設定することで、VerifyJWT ポリシーが crit ヘッダーを無視するよう構成することもできます。

<PublicKey/Certificate>

<PublicKey>
   <Certificate ref="signed_public.cert"/>
</PublicKey>
-or-
<PublicKey>
    <Certificate>
    -----BEGIN CERTIFICATE-----
    cert data
    -----END CERTIFICATE-----
    </Certificate>
</PublicKey>

JWT 上の署名を検証するために使用される署名済み証明書を指定します。ref 属性を使用して署名済み証明書をフロー変数に渡すか、PEM でエンコードされた証明書を直接指定します。アルゴリズムが RS256 / RS384 / RS512、PS256 / PS384 / PS512、ES256 / ES384 / ES512 のいずれかの場合にのみ使用します。

<PublicKey/JWKS>

<!-- Specify the JWKS. -->
<PublicKey>
   <JWKS>jwks-value-here</JWKS>
</PublicKey>

or:

<!-- Specify a variable containing the JWKS. -->
<PublicKey>
   <JWKS ref="public.jwks"/>
</PublicKey>

or:

<!-- Specify a public URL that returns the JWKS.
The URL is static, meaning you cannot set it using a variable. -->
<PublicKey>
   <JWKS uri="jwks-url"/>
</PublicKey>

公開鍵のセットを含む JWKS フォーマット（RFC 7517）の値を指定します。アルゴリズムが RS256 / RS384 / RS512、PS256 / PS384 / PS512、ES256 / ES384 / ES512 のいずれかの場合にのみ使用します。

受信 JWT が JWKS のセットに存在する鍵 ID を保持している場合、ポリシーは正しい公開鍵を使用して JWT 署名を検証します。この機能について詳しくは、JSON Web Key Set（JEKS）を使用した JWT の検証をご覧ください。

値を公開 URL から取得した場合、Edge は JWKS を 300 秒間キャッシュに保存します。キャッシュが期限切れになると、Edge は JWKS を再取得します。

<PublicKey/Value>

<PublicKey>
   <Value ref="public.publickeyorcert"/>
</PublicKey>
-or-
<PublicKey>
    <Value>
    -----BEGIN PUBLIC KEY-----
    MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAw2kPrRzcufvUNHvTH/WW
    Q0UrCw5c0+Y707KX3PpXkZGbtTT4nvU1jC0d1lHV8MfUyRXmpmnNxJHAC2F73IyN
    C5TBtXMORc+us7A2cTtC4gZV256bT4h3sIEMsDl0Joz9K9MPzVPFxa1i0RgNt06n
    Xn/Bs2UbbLlKP5Q1HPxewUDEh0gVMqz9wdIGwH1pPxKvd3NltYGfPsUQovlof3l2
    ALvO7i5Yrm96kknfFEWf1EjmCCKvz2vjVbBb6mp1ZpYfc9MOTZVpQcXSbzb/BWUo
    ZmkDb/DRW5onclGzxQITBFP3S6JXd4LNESJcTp705ec1cQ9Wp2Kl+nKrKyv1E5Xx
    DQIDAQAB
    -----END PUBLIC KEY-----
    </Value>
</PublicKey>

JWT 上の署名を検証するために使用される公開鍵または公開証明書を指定します。ref 属性を使用して、公開鍵 / 公開証明書をフロー変数に渡すか、PEM でエンコードされた鍵を直接指定します。アルゴリズムが RS256 / RS384 / RS512、PS256 / PS384 / PS512、ES256 / ES384 / ES512 のいずれかの場合にのみ使用します。

<SecretKey/Value>

<SecretKey>
  <Value ref="private.your-variable-name"/>
</SecretKey>

HMAC アルゴリズムでトークンを検証するかトークンに署名するための秘密鍵です。アルゴリズムが HS256、HS384、HS512 のいずれかである場合にのみ使用します。ref 属性を使用して、鍵をフロー変数に渡します。

<Source>

<Source>jwt-variable</Source>

ポリシー構成に含める場合は、検証対象の JWT が存在すると予想されるフロー変数を指定します。

<Subject>

<Subject>subject-string-here</Subject>

このポリシーは、JWT のサブジェクトの値がポリシー構成で指定された文字列と一致することを確認します。このクレームは、JWT のサブジェクトに関するステートメントを識別または作成します。これは、RFC7519 に記載されている標準的なクレームの 1 つです。

<TimeAllowance>

<TimeAllowance>120s</TimeAllowance>

「猶予期間」を示します。たとえば猶予期間を 60 秒に指定した場合、有効期限切れの JWT でも期限切れの後 60 秒間は有効として扱われます。not-before-time も同様に評価されます。デフォルトは 0 秒（猶予期間なし）です。

フロー変数

Verify JWT ポリシーと Decode JWT ポリシーは、成功すると次のパターンに従ってコンテキスト変数を設定します。

jwt.{policy_name}.{variable_name}

たとえば、ポリシー名が jwt-parse-token の場合、ポリシーは JWT で指定されたサブジェクトをコンテキスト変数 jwt.jwt-parse-token.decoded.claim.sub に保存します。（下位互換性を確保するため、jwt.jwt-parse-token.claim.subject でも利用できます）。

エラー リファレンス

このセクションでは、このポリシーによってエラーがトリガーされたときに返される障害コードとエラー メッセージ、Edge によって設定される障害変数について説明します。これは、障害に対処する障害ルールを作成するうえで重要な情報です。詳細については、ポリシーエラーについて知っておくべきことと障害の処理をご覧ください。

ランタイム エラー

このエラーは、ポリシーの実行時に発生することがあります。

デプロイエラー

以下のエラーは、このポリシーを含むプロキシをデプロイするときに発生することがあります。

障害変数

ランタイム エラーが発生すると、次の変数が設定されます。詳細については、ポリシーエラーについて知っておくべきことをご覧ください。

エラー レスポンスの例

ベスト プラクティスとして、エラー処理では、エラー レスポンスの errorcode の部分をトラップすることをおすすめします。faultstring のテキストには依存しないでください。この部分は変更される可能性があります。

障害ルールの例

    <FaultRules>
        <FaultRule name="JWT Policy Errors">
            <Step>
                <Name>JavaScript-1</Name>
                <Condition>(fault.name Matches "TokenExpired")</Condition>
            </Step>
            <Condition>JWT.failed=true</Condition>
        </FaultRule>
    </FaultRules>