DecodeJWS ポリシー

概要

JWS の署名を検証せずに JWS をデコードし、各ヘッダーをフロー変数に書き込みます。このポリシーは、JWS の署名の検証前に JWS 内のヘッダーの値がわかっている必要のある場合に、VerifyJWS ポリシーと組み合わせて使用すると非常に便利です。

JWS は添付ペイロードを持つことができ、次の形式になります。

header.payload.signature

また、JWS はペイロードを省略でき、それは分離ペイロードと呼ばれ、次の形式になります。

header..signature

DecodeJWS ポリシーは JWS のヘッダー部分のみをデコードするため、どちらの形式でも機能します。DecodeJWS ポリシーは JWS への署名に使用されたアルゴリズムにも関係なく機能します。

JWS の詳細と形式の概要については、JWS および JWT ポリシーの概要をご覧ください。

動画

JWT のデコード方法についての短い動画をご覧ください。この動画は JWT 用ですが、コンセプトの多くは JWS と同じです。

サンプル: JWS をデコードする

以下に示すポリシーでは、フロー変数 var.JWS 内の JWT をデコードします。この変数が存在し、かつ有効（デコード可能）な JWS が含まれている必要があります。このポリシーは、JWS をあらゆるフロー変数から得ることができます。

<DecodeJWS name="JWS-Decode-HS256">
    <DisplayName>JWS Verify HS256</DisplayName>
    <Source>var.JWS</Source>
</DecodeJWS>

JWS のヘッダー部分にあるヘッダーごとに、このポリシーでは次の名前のフロー変数が設定されます。

jws.policy-name.header.header-name

JWS が添付ペイロードを持っている場合は、ペイロードに jws.policy-name.header.payload フロー変数が設定されます。分離ペイロードの場合は、payload が空になります。このポリシーで設定される変数の全リストについては、フロー変数をご覧ください。

Decode JWS の要素リファレンス

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

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

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

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

属性	説明	デフォルト	要否
name	ポリシーの内部名。名前に使用できる文字は `A-Z0-9._\-$ %` のみです。ただし、Edge 管理 UI では、英数字以外の文字を自動的に削除するなど、追加の制限が適用されます。必要に応じて、`<displayname></displayname>` 要素を使用して、管理 UI プロキシエディタでポリシーに別の自然言語名でラベルを付けます。	なし	必須
continueOnError	ポリシーが失敗した場合にエラーを返すには、`false` に設定します。これはほとんどのポリシーで想定される動作です。ポリシーが失敗してもフロー実行を続行するには、`true` に設定します。	false	省略可
enabled	ポリシーを適用するには `true` に設定します。ポリシーを「turn off」するには、`false` に設定します。ポリシーがフローに接続されている場合でも適用されません。	true	省略可
async	この属性は非推奨となりました。	false	非推奨

<DisplayName>

<DisplayName>Policy Display Name</DisplayName>

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

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

<Source>

<Source>JWS-variable</Source>

この要素が存在する場合、デコード対象の JWS が検出されるとポリシーが想定するフロー変数を指定します。

注: デフォルトでは、JWS は変数 request.header.authorization から取得されます。この場合、Edge はリクエストの Authorization ヘッダー内で JWS を検索します。Authorization ヘッダーに JWS を渡す場合、ポリシーに Source 要素を含める必要はありません。ただし、認可ヘッダーに Bearer を含める必要があります。たとえば、Authorization ヘッダーで JWS を次のように渡します。

curl -v http://52.200.92.187:9001/doctest-JWS/verify-rs256 -H "Authorization: Bearer <your JWS>"

フォームまたはクエリパラメータ変数やその他の変数から JWS を取得するポリシーを構成できます。変数が存在しない場合、またはポリシーが JWS を検出できない場合、ポリシーはエラーを返します。

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

フロー変数

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

jws.{policy_name}.{variable_name}

たとえば、ポリシー名が verify-jws の場合、ポリシーは JWS で指定されたアルゴリズムをコンテキスト変数 jws.verify-jws.header.algorithm に保存します。

変数名	説明
`decoded.header.name`	ペイロードに含まれるヘッダーの JSON 解析可能な値。ペイロードに含まれるすべてのヘッダーに 1 つの変数が設定されます。`header.name` フロー変数を使用することもできますが、ヘッダーへのアクセスにはこの変数を使用することをおすすめします。
`header.algorithm`	JWS で使用される署名アルゴリズム。たとえば、RS256、HS384 など。詳細については、（アルゴリズム）ヘッダーパラメータをご覧ください。
`header.kid`	鍵 ID（JWS の生成時に追加された場合）。JWS を検証するため、JWT と JWS ポリシーの概要の「JSON Web Key Set（JWKS）の使用」もご覧ください。詳細については、（鍵 ID）ヘッダーパラメータをご覧ください。
`header.type`	ヘッダータイプの値。詳細は、（タイプ）ヘッダーパラメータをご覧ください。
`header.name`	名前付きヘッダーの値（標準または追加）。このいずれかが、JWS のヘッダー部分のすべての追加ヘッダーに設定されます。
`header-json`	JSON 形式のヘッダー。
`payload`	JWS ペイロード（JWS に接続されたペイロードが存在する場合）。分離済みペイロードの場合、この変数は空です。
`valid`	VerifyJWS では、署名が検証済みで、現在時刻がトークンの有効期限よりも前で、notBefore トークンの値よりも後の場合、この変数は true になります。それ以外は、false になります。 DecodeJWS では、この変数は設定されません。

エラーリファレンス

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

ランタイムエラー

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

障害コード	HTTP ステータス	発生条件
`steps.jws.FailedToDecode`	401	ポリシーで JWS をデコードできなかった場合。JWS が破損している可能性があります。
`steps.jws.FailedToResolveVariable`	401	ポリシーの `<Source>` 要素で指定されたフロー変数が存在しない場合に発生します。
`steps.jws.InvalidClaim`	401	クレームが欠落しているか、一致していない場合。または、ヘッダーが欠落しているか、一致していない場合。
`steps.jws.InvalidJsonFormat`	401	無効な JSON が JWS ヘッダーで検出された場合。
`steps.jws.InvalidJws`	401	JWS 署名の検証で不合格だった場合。
`steps.jws.InvalidPayload`	401	JWS ペイロードが無効な場合。
`steps.jws.InvalidSignature`	401	`<DetachedContent>` が省略され、JWS に分離済みのコンテンツペイロードがある場合。
`steps.jws.MissingPayload`	401	JWS ペイロードが欠落している場合。
`steps.jws.NoAlgorithmFoundInHeader`	401	JWS がアルゴリズムヘッダーを省略すると発生します。
`steps.jws.UnknownException`	401	不明な例外が発生した場合。

デプロイエラー

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

エラー名エラーが発生する条件

InvalidAlgorithm 有効な値は、RS256、RS384、RS512、PS256、PS384、PS512、ES256、ES384、ES512、HS256、HS384、HS512 のみです。

エラー名	エラーが発生する条件
`InvalidAlgorithm`	有効な値は、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`	その他の発生の可能性があるデプロイエラー。

EmptyElementForKeyConfiguration

FailedToResolveVariable

InvalidConfigurationForActionAndAlgorithmFamily

InvalidConfigurationForVerify

InvalidEmptyElement

InvalidFamiliesForAlgorithm

InvalidKeyConfiguration

InvalidNameForAdditionalClaim

InvalidNameForAdditionalHeader

InvalidPublicKeyId

InvalidPublicKeyValue

InvalidSecretInConfig

InvalidTypeForAdditionalClaim

InvalidTypeForAdditionalHeader

InvalidValueForElement

InvalidValueOfArrayAttribute

InvalidVariableNameForSecret

MissingConfigurationElement

MissingElementForKeyConfiguration

MissingNameForAdditionalClaim

MissingNameForAdditionalHeader

その他の発生の可能性があるデプロイエラー。

障害変数

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

変数	説明	例
`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>