Zasada dekodowania JWT

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

Co

Dekoduje token JWT bez weryfikowania jego podpisu. Jest to najbardziej przydatne w połączeniu z zasadą VerifyJWT, gdy wartość roszczenia z tokena JWT musi być znana przed zweryfikowaniem podpisu tokena JWT.

Zasada JWT Decode działa niezależnie od algorytmu użytego do podpisania tokena JWT. Szczegółowe wprowadzenie znajdziesz w omówieniu zasad JWS i JWT.

Wideo

Obejrzyj krótki film, aby dowiedzieć się, jak dekodować token JWT.

Przykład: dekodowanie tokena JWT

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

<DecodeJWT name="JWT-Decode-HS256">
    <DisplayName>JWT Verify HS256</DisplayName>
    <Source>var.jwt</Source>
</DecodeJWT>

Zasada zapisuje dane wyjściowe w zmiennych kontekstowych, aby kolejne zasady lub warunki w proxy interfejsu API mogły sprawdzać te wartości. Listę zmiennych ustawianych przez tę zasadę znajdziesz w sekcji Zmienne przepływu.

Dokumentacja elementu Decode JWT

Dokumentacja zasady opisuje elementy i atrybuty zasady Decode JWT.

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

<DecodeJWT name="JWT" 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 serwera proxy w interfejsie zarządzania inną nazwą w języku naturalnym.

<Source>

<Source>jwt-variable</Source>

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

Zmienne przepływu

Gdy operacja się uda, zostaną ustawione zasady Zweryfikuj token JWT i dekoduj JWT zmiennych kontekstowych zgodnie z tym wzorcem:

jwt.{policy_name}.{variable_name}

Jeśli na przykład nazwa zasady to jwt-parse-token, to zasada będzie przechowywać podmiot określony w tokenie JWT w zmiennej kontekstowej o nazwie jwt.jwt-parse-token.decoded.claim.sub. Aby zapewnić zgodność wsteczną, będzie ona też dostępna w wersji jwt.jwt-parse-token.claim.subject.

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="JWT Policy Errors">
            <Step>
                <Name>JavaScript-1</Name>
                <Condition>(fault.name Matches "TokenExpired")</Condition>
            </Step>
            <Condition>JWT.failed=true</Condition>
        </FaultRule>
    </FaultRules>