Zasada dekodowania JWS

Przeglądasz dokumentację Apigee Edge.
Przejdź do Dokumentacja Apigee X. informacje.

Co

Dekoduje nagłówek JWS bez weryfikacji podpisu w JWS i zapisuje każdy nagłówek w kluczu zmienną przepływu danych. Ta zasada jest najbardziej przydatna, gdy jest używana razem z zasadąVerifyJWS, gdy wartość nagłówka w JWS musi być znana przed weryfikacją podpisu JWS.

JWS może mieć dołączony ładunek, na przykład:

header.payload.signature

Oprogramowanie JWS może też pominąć ładunek nazywany odłączonym i mieć postać:

header..signature

Zasada DecodeJWS działa w obu tych formularzach, ponieważ dekoduje tylko nagłówek JWS. Zasada DecodeJWS działa też niezależnie od algorytmu użytego do podpisania JWS.

Szczegółowe informacje znajdziesz w omówieniu zasad JWS i JWT. oraz omówienie formatu JWS.

Wideo

Obejrzyj krótki film, aby dowiedzieć się, jak zdekodować token JWT. W tym filmie i JWT, wiele koncepcji jest takich samych w przypadku JWS.

Przykład: dekodowanie JWS

Poniższa zasada dekoduje plik JWS znaleziony w zmiennej przepływu var.JWS. Ten musi być obecna i zawierać prawidłowy (z możliwością dekodowania) JWS. Polityka może uzyskać JWS z dowolną zmienną przepływu.

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

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

jws.policy-name.header.header-name

Jeśli JWS ma załączony ładunek, ustawia jws.policy-name.header.payload do ładunku. W przypadku ładunku odłączonego pole payload jest puste. Pełną listę zmiennych ustawianych przez te zasady znajdziesz w sekcji Zmienne przepływu.

Dokumentacja elementu na potrzeby dekodowania JWS

Dokumentacja zasady zawiera opis elementów i atrybutów zasady Decode JWS.

Atrybuty, które zastosuj do elementu najwyższego poziomu

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

Poniższe atrybuty są wspólne dla wszystkich elementów nadrzędnych zasad.

<DisplayName>

<DisplayName>Policy Display Name</DisplayName>

Użyj oprócz atrybutu name [nazwa], aby oznaczyć zasadę etykietą w edytorze serwera proxy w interfejsie zarządzania z inną nazwą w języku naturalnym.

<Source>

<Source>JWS-variable</Source>

Jeśli istnieje, określa zmienną przepływu, w której zasada oczekuje, że kod JWS zostanie znaleziony do ich 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

Informacje o błędzie

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>