Правило DecodeJWT

Вы просматриваете документацию по Apigee Edge.
Перейдите к документации по Apigee X. Информация

Что

Декодирует JWT без проверки подписи. Особенно полезно использовать это правило вместе с VerifyJWT, когда значение утверждения из JWT должно быть известно до проверки подписи JWT.

Правило декодирования JWT работает независимо от алгоритма, который использовался для подписи JWT. Подробную информацию можно найти в статье Общие сведения о правилах JWS и JWT.

Видео

Посмотрите короткое видео о том, как декодировать JWT.

Пример: декодирование токена JWT

Правила, приведенные ниже, декодируют токен JWT, найденный в переменной потока var.jwt. Эта переменная должна присутствовать и содержать действительный (декодируемый) JWT. Правило может получить JWT из любой переменной потока.

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

Правило записывает выходные данные в переменные контекста, чтобы последующие правила или условия в прокси-сервере API могли проверять эти значения. Список переменных, заданных этими правилами, приведен в разделе Переменные потока.

Справочник по элементам для функции "Декодировать токен JWT"

В справочнике по правилам описаны элементы и атрибуты правила Decode JWT.

Атрибуты, которые применяются к элементу верхнего уровня

<DecodeJWT name="JWT" continueOnError="false" enabled="true" async="false">

Следующие атрибуты являются общими для всех родительских элементов правил.

<DisplayName>

<DisplayName>Policy Display Name</DisplayName>

Используйте этот атрибут вместе с атрибутом name, чтобы присвоить правилу в редакторе прокси-сервера в интерфейсе управления другое название на естественном языке.

<Source>

<Source>jwt-variable</Source>

Если присутствует, указывает переменную потока, в которой правило ожидает найти JWT для декодирования.

Flow variables

Upon success, the Verify JWT and Decode JWT policies set context variables according to this pattern:

jwt.{policy_name}.{variable_name}

For example, if the policy name is jwt-parse-token , then the policy will store the subject specified in the JWT to the context variable named jwt.jwt-parse-token.decoded.claim.sub. (For backward compatibility, it will also be available in jwt.jwt-parse-token.claim.subject)

Справочник по ошибкам

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