DecodeJWS-Richtlinie

<ph type="x-smartling-placeholder"></ph> Sie sehen die Dokumentation zu Apigee Edge.
Gehen Sie zur Apigee X-Dokumentation. Weitere Informationen

Was

Decodiert den JWS-Header, ohne die Signatur in der JWS zu prüfen, und schreibt jeden Header in eine Ablaufvariable. Diese Richtlinie ist besonders nützlich, wenn sie in Kombination mit der VerifyJWS-Richtlinie verwendet wird. Dabei muss der Wert eines Headers innerhalb der JWS bekannt sein, bevor die Signatur der JWS verifiziert werden kann.

Eine JWS kann eine attached-Nutzlast im folgenden Format haben:

header.payload.signature

Der JWS kann die Nutzlast auch auslassen, was als detached-Nutzlast bezeichnet wird. Er hat dann folgendes Format:

header..signature

Die DecodeJWS-Richtlinie funktioniert mit beiden Formen, da sie nur den Header-Teil des JWS decodiert. Die DecodeJWS-Richtlinie funktioniert unabhängig vom Algorithmus, der zum Signieren des JWS verwendet wurde.

Eine ausführliche Einführung und einen Überblick über JWS-Formen findet sich unter JWS- und JWT-Richtlinienübersicht.

Video

In diesem kurzen Video erfahren Sie, wie ein JWT decodiert wird. Das Video bezieht sich zwar speziell auf ein JWT, viele der Konzepte sind jedoch für JWS identisch.

Beispiel: Eine JWS decodieren

Die unten dargestellte Richtlinie decodiert eine JWS, die in der Ablaufvariablen var.JWS gespeichert ist. Diese Variable muss vorhanden sein und eine ausführbare (decodierbare) JWS enthalten. Die Richtlinie kann die JWS aus einer beliebigen Ablaufvariablen abrufen.

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

Für jeden Header im Header-Teil der JWS legt die Richtlinie eine Ablaufvariable mit folgendem Namen fest:

jws.policy-name.header.header-name

Wenn der JWS eine Nutzlast zugewiesen ist, wird die Ablaufvariable jws.policy-name.header.payload auf die Nutzlast gesetzt. Bei einer getrennten Nutzlast ist payload leer. Eine vollständige Liste der durch diese Richtlinie festgelegten Variablen finden Sie unter Ablaufvariablen.

Elementreferenz für "JWS decodieren"

In der Richtlinienreferenz werden die Elemente und Attribute der Richtlinie "JWS decodieren" beschrieben.

Attribute, die auf das oberste Element angewendet werden

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

Die folgenden Attribute gelten für alle übergeordneten Richtlinienelemente.

<DisplayName>

<DisplayName>Policy Display Name</DisplayName>

Wird zusätzlich zum Namensattribut verwendet, um die Richtlinie im Proxy-Editor der Verwaltungs-UI mit einem anderen Namen in einer natürlichen Sprache zu versehen.

<Source>

<Source>JWS-variable</Source>

Gibt, sofern vorhanden, die Ablaufvariable an, in der die Richtlinie das zu decodierende JWS finden soll.

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

Fehlerreferenz

This section describes the fault codes and error messages that are returned and fault variables that are set by Edge 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.

Deployment errors

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

Fault variables

These variables are set when a runtime error occurs. For more information, see What you need to know about policy errors.

Example error response

For error handling, the best practice is to trap the errorcode part of the error response. Do not rely on the text in the faultstring, because it could change.

Example fault rule

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