Sie sehen die Dokumentation zu Apigee Edge.
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.
| Attribut | Beschreibung | Standardeinstellung | Präsenz |
|---|---|---|---|
| name |
Der interne Name der Richtlinie. Folgende Zeichen sind im Namen zulässig: A-Z0-9._\-$ %. Die Edge-Verwaltungs-UI erzwingt jedoch zusätzliche Einschränkungen, z. B. das automatische Entfernen nicht alphanumerischer Zeichen.
Optional können Sie das Element |
– | Erforderlich |
| continueOnError |
Legen Sie false fest, um einen Fehler zurückzugeben, wenn eine Richtlinie fehlschlägt. Dies ist für die meisten Richtlinien das erwartete Verhalten.
Legen Sie |
false | Optional |
| aktiviert |
Setzen Sie den Wert auf true, um die Richtlinie zu erzwingen.
Legen Sie |
true | Optional |
| async | Dieses Attribut wurde verworfen. | false | Eingestellte Funktionen |
<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.
| Standard | Wenn Sie dieses Element weglassen, wird der Wert des Namensattributs der Richtlinie verwendet. |
| Präsenz | Optional |
| Typ | String |
<Source>
<Source>JWS-variable</Source>
Gibt, sofern vorhanden, die Ablaufvariable an, in der die Richtlinie das zu decodierende JWS finden soll.
| Standard | request.header.authorization (Wichtige Informationen zur Standardeinstellung finden Sie im Hinweis oben). |
| Präsenz | Optional |
| Typ | String |
| Zulässige Werte | Ein Edge-Flow-Variablenname |
Ablaufvariablen
Bei Erfolg legen die Richtlinien VerifyJWS und DecodeJWS Kontextvariablen gemäß diesem Muster fest:
jws.{policy_name}.{variable_name}
Beispiel: Lautet der Richtlinienname verify-jws, so speichert die Richtlinie den im JWS angegebene Algorithmus in dieser Kontextvariable: jws.verify-jws.header.algorithm
| Variablenname | Beschreibung |
|---|---|
decoded.header.name |
JSON-Parsingwert eines Headers in der Nutzlast. Für jeden Header in der Nutzlast wird eine Variable festgelegt. Sie können auch die header.name-Ablaufvariablen verwenden. Dies ist jedoch die empfohlene Variable für den Zugriff auf einen Header. |
header.algorithm |
Der für das JWS verwendete Signaturalgorithmus. Zum Beispiel RS256, HS384 usw. Weitere Informationen finden Sie unter Headerparameter (Algorithmus). |
header.kid |
Die Schlüssel-ID, falls bei der Erstellung das JWS hinzugefügt. Weitere Informationen zur Verifizierung eines JWS finden Sie unter JSON-Webschlüsselsatz (JWKS) verwenden" in JWT und JWS-Richtlinien. Weitere Informationen finden Sie unter Header-Parameter (Key ID). |
header.type |
Wert des Header-Typs. Weitere Informationen finden Sie unter (Type) Header-Parameter. |
header.name |
Der Wert des benannten Headers (Standard oder Zusätzlich). Eines der Elemente wird für jeden zusätzlichen Header im Header-Teil des JWS bestimmt. |
header-json |
Die Kopfzeile im JSON-Format. |
payload |
Die JWS-Nutzlast, wenn dem JWS eine Nutzlast zugewiesen ist. Bei einer getrennten Nutzlast ist diese Variable leer. |
valid |
Bei „VerifyJWS“ ist diese Variable „true“, wenn die Signatur verifiziert wurde und die aktuelle Zeit vor dem Ablaufdatum des Tokens und nach dem Wert „notBefore“ des Tokens liegt, sofern vorhanden. Ansonsten ist die Variable "false".
Im Fall von DecodeJWS ist die Variable nicht festgelegt. |
Fehlerreferenz
In diesem Abschnitt werden die Fehlercodes und Fehlermeldungen beschrieben, die zurückgegeben werden, sowie die Fehlervariablen, die von Edge festgelegt werden, wenn diese Richtlinie einen Fehler auslöst. Diese Informationen sind wichtig, wenn Sie Fehlerregeln zur Verarbeitung von Fehlern entwickeln. Weitere Informationen finden Sie unter Was Sie über Richtlinienfehler wissen müssen und Fehler beheben.
Laufzeitfehler
Diese Fehler können bei Ausführung der Richtlinie auftreten.
| Fehlercode | HTTP-Status | Tritt auf, wenn Folgendes eintritt |
|---|---|---|
steps.jws.FailedToDecode |
401 | Die JWS konnte aufgrund der Richtlinie nicht entschlüsselt werden. Die JWS ist möglicherweise beschädigt. |
steps.jws.FailedToResolveVariable |
401 | Tritt auf, wenn die im Element <Source> der Richtlinie angegebene Flussvariable nicht vorhanden ist. |
steps.jws.InvalidClaim |
401 | Bei einem fehlenden Anspruch oder nicht übereinstimmenden Ansprüchen oder einem fehlenden Header oder Header. |
steps.jws.InvalidJsonFormat |
401 | Ungültige JSON-Datei im JWS-Header |
steps.jws.InvalidJws |
401 | Dieser Fehler tritt auf, wenn die JWS-Signaturprüfung fehlschlägt. |
steps.jws.InvalidPayload |
401 | Die JWS-Nutzlast ist ungültig. |
steps.jws.InvalidSignature |
401 | <DetachedContent> wird weggelassen und das JWS hat eine separate Inhaltsnutzlast. |
steps.jws.MissingPayload |
401 | Die JWS-Nutzlast fehlt. |
steps.jws.NoAlgorithmFoundInHeader |
401 | Tritt auf, wenn der JWS den Algorithmusheader weglässt. |
steps.jws.UnknownException |
401 | Es ist eine unbekannte Ausnahme aufgetreten. |
Bereitstellungsfehler
Diese Fehler können auftreten, wenn Sie einen Proxy mit dieser Richtlinie bereitstellen.
| Fehlername | Tritt auf, wenn Folgendes eintritt |
|---|---|
InvalidAlgorithm |
Die einzigen gültigen Werte sind: RS256, RS384, RS512, PS256, PS384, PS512, ES256, ES384, ES512, HS256, HS384, HS512. |
|
|
Andere mögliche Bereitstellungsfehler. |
Fehlervariablen
Diese Variablen werden bei Laufzeitfehlern festgelegt. Weitere Informationen finden Sie unter Was Sie über Richtlinienfehler wissen müssen.
| Variablen | Wo | Beispiel |
|---|---|---|
fault.name="fault_name" |
fault_name ist der Name des Fehlers, der in der obigen Tabelle Laufzeitfehler aufgeführt ist. Der Fehlername ist der letzte Teil des Fehlercodes. | fault.name Matches "TokenExpired" |
JWS.failed |
Bei allen JWT-Richtlinien wird im Fall eines Fehlers dieselbe Variable festgelegt. | jws.JWS-Policy.failed = true |
Beispiel für eine Fehlerantwort
Bei der Fehlerbehandlung besteht die Best Practice darin, den errorcode-Teil der Fehlerantwort zu beachten. Verlassen Sie sich nicht auf den Text in faultstring. Er kann sich ändern.
Beispiel für eine Fehlerregel
<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>