VerifyJWS ポリシー

このページは Apigee と Apigee ハイブリッドに適用されます。

Apigee Edge のドキュメントを表示する。

概要

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

JWS が検証済みで有効である場合、リクエストの処理続行が許可されます。JWS の署名を検証できない場合、またはなんらかのエラーが原因で JWS が無効な場合、すべての処理が停止し、レスポンスでエラーが返されます。

このポリシーは拡張可能なポリシーです。Apigee ライセンスによっては、このポリシーの使用によって費用や使用量に影響する場合があります。ポリシータイプと使用量への影響については、ポリシータイプをご覧ください。

JWS の構成要素およびその暗号化と署名の方法については、RFC7515 をご覧ください。

動画

JWS の署名を検証する方法についての短い動画をご覧ください。この動画は JWT の検証に関するものですが、コンセプトの多くは JWS でも同じです。

サンプル

HS256 アルゴリズムで署名された添付済み JWS を検証する

このポリシー サンプルでは、HS256 暗号化アルゴリズム（SHA-256 チェックサムを使用した HMAC）で署名された連結 JWS を検証します。JWS は、JWS という名前のフォーム パラメータを介してプロキシ リクエスト内で渡されます。鍵は private.secretkey という名前の変数に含まれています。

連結された JWS には、エンコード済みのヘッダー、ペイロード、署名が含まれます。

header.payload.signature

ポリシー構成には、JWS の参照先（<Source> 要素で指定されたフロー変数内）、必要な署名アルゴリズム、秘密鍵の場所（Apigee フロー変数に格納され、Apigee KVM から取得可能など）など、JWS のデコードと評価に Apigee が必要とする情報が含まれます。

<VerifyJWS name="JWS-Verify-HS256">
    <DisplayName>JWS Verify HS256</DisplayName>
    <Algorithm>HS256</Algorithm>
    <Source>request.formparam.JWS</Source>
    <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
    <SecretKey>
        <Value ref="private.secretkey"/>
    </SecretKey>
</VerifyJWS>

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

RS256 アルゴリズムで署名された分離済み JWS を検証する

このポリシー サンプルでは、RS256 アルゴリズムで署名された分離済み JWS を検証します。検証するには公開鍵を用意する必要があります。JWS は、JWS という名前のフォーム パラメータを介してプロキシ リクエスト内で渡されます。公開鍵は public.publickey という名前の変数に含まれています。

分離済み JWS では JWS のペイロードが省略されます。

header..signature

ペイロードが含まれる変数名を <DetachedContent> 要素に指定して VerifyJWS ポリシーにペイロードを渡すかどうかは任意です。<DetachedContent> に指定するコンテンツは、JWS 署名が作成された時点における、エンコードされていない元の形式にする必要があります。

<VerifyJWS name="JWS-Verify-RS256">
    <DisplayName>JWS Verify RS256</DisplayName>
    <Algorithm>RS256</Algorithm>
    <Source>request.formparam.JWS</Source>
    <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
    <PublicKey>
        <Value ref="public.publickey"/>
    </PublicKey>
    <DetachedContent>private.payload</DetachedContent>
</VerifyJWS>

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

鍵要素の設定

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

アルゴリズム 鍵要素
HS* 
<SecretKey>
  <Value ref="private.secretkey"/>
</SecretKey>
RS*、ES*、PS* 
<PublicKey>
  <Value ref="rsa_public_key"/>
</PublicKey>

または

<PublicKey>
  <JWKS ref="jwks_val_ref_or_url"/>
</PublicKey>
* 鍵の要件について詳しくは、署名の暗号化アルゴリズムについてをご覧ください。

要素リファレンス

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

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

S

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

<VerifyJWS name="JWS" continueOnError="false" enabled="true" async="false">

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

属性 説明 デフォルト 要否
name ポリシーの内部名。名前に使用できる文字は A-Z0-9._\-$ % のみです。ただし、Apigee UI には追加の制限があり、たとえば、英数字以外の文字は自動的に削除されます。

必要に応じて、<displayname></displayname> 要素を使用して、Apigee UI プロキシ エディタでポリシーに別の自然言語名でラベルを付けます。

 なし 必須
continueOnError ポリシーが失敗した場合にエラーを返すには、false に設定します。これはほとんどのポリシーで想定される動作です。

ポリシーが失敗した後もフローの実行を続行する場合は、true に設定します。

 false 省略可
有効 ポリシーを適用するには、true に設定します。

ポリシーを「turn off」するには、false に設定します。ポリシーがフローに接続されている場合でも適用されません。

 true 省略可
非同期 この属性は非推奨となりました。 false 非推奨

<DisplayName>

<DisplayName>Policy Display Name</DisplayName>

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

デフォルト この要素を省略した場合、ポリシーの name 属性の値が使用されます。
要否 省略可
型 文字列

<Algorithm>

<Algorithm>HS256</Algorithm>

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

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

デフォルト 該当なし
要否 必須
型 カンマ区切り値の文字列
有効な値 HS256、HS384、HS512、RS256、RS384、RS512、ES256、ES384、ES512、PS256、PS384、PS512

<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>

指定された追加クレームの名前と値のペアが JWS ヘッダーに含まれていることと、アサートされたクレーム値が一致していることを検証します。

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

デフォルト 該当なし
要否 省略可
型

文字列（デフォルト）、数値、ブール値、マッピング

明示的に指定しない場合、デフォルトで文字列型になります。
配列 （省略可）値が型の配列かどうかを示すには true に設定しますデフォルト: false
有効な値 追加のクレームに使用する任意の値。

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

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

<DetachedContent>

<DetachedContent>variable-name-here</DetachedContent>

コンテンツ ペイロードとともに生成される JWS は、次の形式です。

header.payload.signature

GenerateJWS ポリシーを使用して分離ペイロードを作成する場合、生成される JWS ではペイロードが省略されて、次の形式になります。

header..signature

分離ペイロードの場合は、<DetachedContent> 要素を使用して VerifyJWS ポリシーにペイロードを渡すかどうかは任意です。指定するコンテンツ ペイロードは、JWS 署名が作成された時点におけるオリジナルのエンコードされていない形式にする必要があります。

次の場合、ポリシーはエラーを返します。

  • <DetachedContent> が指定されていて、JWS に分離済みコンテンツ ペイロードが含まれていない（障害コードは steps.jws.ContentIsNotDetached）。
  • <DetachedContent> が指定されておらず、JWS に分離済みコンテンツ ペイロードが含まれている（障害コードは steps.jws.InvalidSignature）。
デフォルト N/A
要否 省略可
型 変数リファレンス

<IgnoreCriticalHeaders>

<IgnoreCriticalHeaders>true|false</IgnoreCriticalHeaders>

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

この要素を true に設定する理由の 1 つとして、テスト環境においてヘッダーが存在しない場合にポリシーでエラーを発生させたくないという状況が考えられます。

デフォルト false
要否 省略可
型 ブール値
有効な値 true または false

<IgnoreUnresolvedVariables>

<IgnoreUnresolvedVariables>true|false</IgnoreUnresolvedVariables>

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

デフォルト false
要否 省略可
型 ブール値
有効な値 true または false

<KnownHeaders>

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

or:

<KnownHeaders ref=’variable_containing_headers’/>

GenerateJWS ポリシーでは <CriticalHeaders> 要素を使用して、トークンに crit ヘッダーを入力します。次に例を示します。

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

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

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

デフォルト 該当なし
要否 省略可
型 文字列のカンマ区切り配列
有効な値 配列または配列を含む変数の名前

<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 のいずれかの場合にのみ使用します。

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

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

デフォルト 該当なし
要否 RSA アルゴリズムを使用して JWS を検証するには、JWKS または Value 要素を使用します。
型 文字列
有効な値 フロー変数、文字列値、URL

<PublicKey/Value>

<PublicKey>
   <Value ref="public.publickey"/>
</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>

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

デフォルト 該当なし
要否 RSA アルゴリズムで署名された JWS を検証するには、JWKS または Value 要素を使用します。
型 文字列
有効な値 フロー変数または文字列。

<SecretKey>

<SecretKey encoding="base16|hex|base64|base64url" >
  <Value ref="private.your-variable-name"/>
</SecretKey>

対称（HS*）アルゴリズム（HS256、HS384、HS512 のいずれか）を使用する JWS の検証時に使用する秘密鍵を指定します。

この要素はオプションです。ただし、<PublicKey> または <SecretKey> のいずれかの要素のみを含める必要があります。アルゴリズムが RS*、PS*、ES* である JWS を検証する場合は <PublicKey> 要素を使用し、アルゴリズムが HS* である JWS を検証する場合は <SecretKey> 要素を使用します*。

<SecretKey> の子

次の表に、<SecretKey> の子要素と属性の説明を示します。

子 要否 説明
エンコード（属性） 省略可

参照される変数での鍵のエンコード方法を指定します。デフォルトでは、encoding 属性が存在しない場合、鍵のエンコードは UTF-8 として扱われます。この属性で有効な値は、hex、base16、base64、base64url です。エンコード値の hex と base16 は同義です。

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

上記の例では、エンコードが base64 であるため、変数 private.secretkey の内容が SUxvdmVBUElz の場合、鍵は 9 バイトのセットとしてデコードされ、その 16 進数は 49 4c 6f 76 65 41 50 49 73 になります。
値（要素） 必須

エンコードされた秘密鍵。ペイロードの検証に使用される秘密鍵を指定します。private.secret-key などの変数で間接的に鍵を指定するには、ref 属性を使用します。

<SecretKey>
  <Value ref="private.my-secret-variable"/>
</SecretKey>

Apigee は、HS256 / HS384 / HS512 アルゴリズムに対して最小限の鍵強度を適用します。鍵の最小長は、HS256 で 32 バイト、HS384 で 48 バイト、HS512 で 64 バイトです。強度の低い鍵を使用すると実行時エラーが発生します。

<Source>

<Source>JWS-variable</Source>

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

デフォルト request.header.authorization（デフォルトに関する重要な情報については、上記の注をご覧ください）。
要否 省略可
型 文字列
有効な値 Apigee フロー変数名。

<Type>

<Type>type-string-here</Type>

値として Signed のみが許可される省略可能な要素です。ポリシーによって署名付き JWS が検証されることを指定します。<Type> は、GenerateJWT ポリシーと VerifyJWT ポリシーで対応する要素と合わせるために提供されます（Signed か Encrypted のいずれかの値を使用できます）。

デフォルト 該当なし
要否 省略可
型 文字列
有効な値 Signed

Flow variables

Upon success, the Verify JWS and Decode JWS policies set context variables according to this pattern:

jws.{policy_name}.{variable_name}

For example, if the policy name is verify-jws, then the policy will store the algorithm specified in the JWS to this context variable: jws.verify-jws.header.algorithm

Variable name Description
decoded.header.name The JSON-parsable value of a header in the payload. One variable is set for every header in the payload. While you can also use the header.name flow variables, this is the recommended variable to use to access a header.
header.algorithm The signing algorithm used on the JWS. For example, RS256, HS384, and so on. See (Algorithm) Header Parameter for more.
header.kid The Key ID, if added when the JWS was generated. See also "Using a JSON Web Key Set (JWKS)" at JWT and JWS policies overview to verify a JWS. See (Key ID) Header Parameter for more.
header.type The header type value. See (Type) Header Parameter for more.
header.name The value of the named header (standard or additional). One of these will be set for every additional header in the header portion of the JWS.
header-json The header in JSON format.
payload The JWS payload if the JWS has an attached payload. For a detached paylod, this variable is empty.
valid In the case of VerifyJWS, this variable will be true when the signature is verified, and the current time is before the token expiry, and after the token notBefore value, if they are present. Otherwise false.

In the case of DecodeJWS, this variable is not set.

エラー リファレンス

This section describes the fault codes and error messages that are returned and fault variables that are set by Apigee when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults.

Runtime errors

These errors can occur when the policy executes.

Fault code HTTP status Occurs when
steps.jws.AlgorithmInTokenNotPresentInConfiguration 401 Occurs when the verification policy has multiple algorithms
steps.jws.AlgorithmMismatch 401 The algorithm specified in the header by the Generate policy did not match the one expected in the Verify policy. The algorithms specified must match.
steps.jws.ContentIsNotDetached 401 <DetachedContent> is specified when the JWS does not contain a detached content payload.
steps.jws.FailedToDecode 401 The policy was unable to decode the JWS. The JWS is possibly corrupted.
steps.jws.InsufficientKeyLength 401 For a key less than 32 bytes for the HS256 algorithm
steps.jws.InvalidClaim 401 For a missing claim or claim mismatch, or a missing header or header mismatch.
steps.jws.InvalidCurve 401 The curve specified by the key is not valid for the Elliptic Curve algorithm.
steps.jws.InvalidJsonFormat 401 Invalid JSON found in the JWS header.
steps.jws.InvalidJws 401 This error occurs when the JWS signature verification fails.
steps.jws.InvalidPayload 401 The JWS payload is invalid.
steps.jws.InvalidSignature 401 <DetachedContent> is omitted and the JWS has a detached content payload.
steps.jws.KeyIdMissing 401 The Verify policy uses a JWKS as a source for public keys, but the signed JWS does not include a kid property in the header.
steps.jws.KeyParsingFailed 401 The public key could not be parsed from the given key information.
steps.jws.MissingPayload 401 The JWS payload is missing.
steps.jws.NoAlgorithmFoundInHeader 401 Occurs when the JWS omits the algorithm header.
steps.jws.NoMatchingPublicKey 401 The Verify policy uses a JWKS as a source for public keys, but the kid in the signed JWS is not listed in the JWKS.
steps.jws.UnhandledCriticalHeader 401 A header found by the Verify JWS policy in the crit header is not listed in KnownHeaders.
steps.jws.UnknownException 401 An unknown exception occurred.
steps.jws.WrongKeyType 401 Wrong type of key specified. For example, if you specify an RSA key for an Elliptic Curve algorithm, or a curve key for an RSA algorithm.

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Error name Occurs when
InvalidAlgorithm The only valid values are: RS256, RS384, RS512, PS256, PS384, PS512, ES256, ES384, ES512, HS256, HS384, HS512.

EmptyElementForKeyConfiguration

FailedToResolveVariable

InvalidConfigurationForActionAndAlgorithmFamily

InvalidConfigurationForVerify

InvalidEmptyElement

InvalidFamiliesForAlgorithm

InvalidKeyConfiguration

InvalidNameForAdditionalClaim

InvalidNameForAdditionalHeader

InvalidPublicKeyId

InvalidPublicKeyValue

InvalidSecretInConfig

InvalidTypeForAdditionalClaim

InvalidTypeForAdditionalHeader

InvalidValueForElement

InvalidValueOfArrayAttribute

InvalidVariableNameForSecret

MissingConfigurationElement

MissingElementForKeyConfiguration

MissingNameForAdditionalClaim

MissingNameForAdditionalHeader

 Other possible deployment errors.

障害変数

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

変数 説明 例
fault.name="fault_name" fault_name は、上記のランタイム エラーの表に記載されている障害の名前です。障害名は、障害コードの最後の部分です。 fault.name Matches "TokenExpired"
JWS.failed 障害の場合は、すべての JWS ポリシーで同じ変数が設定されます。 jws.JWS-Policy.failed = true

エラー レスポンスの例

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

障害ルールの例

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