Zasada dekodowania JWS

Wyświetlasz dokumentację Apigee Edge.
Przejdź do dokumentacji Apigee X. info

Co

Dekoduje nagłówek JWS bez weryfikowania podpisu JWS i zapisuje każdy nagłówek w zmiennej przepływu. Ta zasada jest najbardziej przydatna w połączeniu z zasadą VerifyJWS, gdy wartość nagłówka w JWS musi być znana przed zweryfikowaniem podpisu JWS.

JWS może mieć dołączony ładunek, np. w takiej postaci:

header.payload.signature

JWS może też pomijać ładunek, który jest nazywany odłączonym ładunkiem, i mieć taką postać:

header..signature

Zasada DecodeJWS działa w obu przypadkach, ponieważ dekoduje tylko część nagłówka JWS. Zasada DecodeJWS działa też niezależnie od algorytmu użytego do podpisania JWS.

Szczegółowe wprowadzenie i omówienie formatu JWS znajdziesz w artykule Omówienie zasad JWS i JWT.

Wideo

Obejrzyj krótki film, aby dowiedzieć się, jak dekodować token JWT. Ten film dotyczy tokena JWT, ale wiele koncepcji jest takich samych w przypadku JWS.

Przykład: dekodowanie JWS

Zasada pokazana poniżej dekoduje JWS znaleziony w zmiennej przepływu var.JWS. Ta zmienna musi być obecna i zawierać prawidłowy (dekodowalny) JWS. Zasada może pobrać JWS z dowolnej zmiennej przepływu.

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

W przypadku każdego nagłówka w części nagłówka JWS zasada ustawia zmienną przepływu o nazwie:

jws.policy-name.header.header-name

Jeśli JWS ma dołączony ładunek, zasada ustawia zmienną przepływu jws.policy-name.header.payload na ładunek. W przypadku odłączonego ładunku payload jest pusty. Pełną listę zmiennych ustawianych przez tę zasadę znajdziesz w artykule Zmienne przepływu.

Dokumentacja elementu Decode JWS

Dokumentacja zasady opisuje elementy i atrybuty zasady Decode JWS.

Atrybuty, które mają zastosowanie do elementu najwyższego poziomu

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

Te atrybuty są wspólne dla wszystkich elementów nadrzędnych zasad.

<DisplayName>

<DisplayName>Policy Display Name</DisplayName>

Użyj tego elementu oprócz atrybutu name, aby oznaczyć zasadę w edytorze proxy w interfejsie zarządzania inną nazwą w języku naturalnym.

<Source>

<Source>JWS-variable</Source>

Jeśli ten element jest obecny, określa zmienną przepływu, w której zasada ma znaleźć JWS do dekodowania.

Zmienne przepływu

Po pomyślnym zakończeniu zostają ustawione zasady Weryfikuj JWS i Decode JWS. zmiennych kontekstowych zgodnie z tym wzorcem:

jws.{policy_name}.{variable_name}

Jeśli na przykład nazwa zasady to verify-jws, to zasada będzie przechowywać algorytm określony w JWS na tę zmienną kontekstową: jws.verify-jws.header.algorithm

Dokumentacja błędów

W tej sekcji opisujemy kody błędów i komunikaty o błędach, które są zwracane, oraz zmienne błędów ustawiane przez Edge, gdy ta zasada wywołuje błąd. Te informacje są ważne, jeśli opracowujesz reguły dotyczące błędów do obsługi takich błędów. Więcej informacji znajdziesz w sekcjach Co musisz wiedzieć o błędach zasad i Postępowanie w przypadku błędów.

Błędy w czasie wykonywania

Te błędy mogą wystąpić podczas wykonywania zasady.

Błędy wdrażania

Te błędy mogą wystąpić podczas wdrażania serwera proxy zawierającego te zasady.

Zmienne błędów

Te zmienne są ustawiane po wystąpieniu błędu działania. Więcej informacji znajdziesz w artykule Podstawowe informacje o błędach związanych z naruszeniem zasad.

Przykładowa odpowiedź na błąd

W przypadku obsługi błędów sprawdzoną metodą jest przechwycenie części błędu errorcode. . Nie polegaj na tekście zawartym w pliku faultstring, ponieważ może się on zmienić.

Przykładowa reguła błędu

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