Политика декодированияJWT

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

Что

Расшифровывает 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

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

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

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

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

<DisplayName>

<DisplayName>Policy Display Name</DisplayName>

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

<Источник>

<Source>jwt-variable</Source>

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

Переменные потока

В случае успеха политики Verify JWT и Decode JWT устанавливают переменные контекста в соответствии со следующим шаблоном:

jwt.{policy_name}.{variable_name}

Например, если имя политики — jwt-parse-token , то политика сохранит субъект, указанный в JWT, в контекстной переменной с именем jwt.jwt-parse-token.decoded.claim.sub . (Для обратной совместимости он также будет доступен в jwt.jwt-parse-token.claim.subject ).

Ссылка на ошибку

В этом разделе описаны коды ошибок и сообщения об ошибках, которые возвращаются, а также переменные ошибок, которые устанавливаются Edge, когда эта политика вызывает ошибку. Эту информацию важно знать, если вы разрабатываете правила обработки ошибок. Дополнительные сведения см. в разделах Что нужно знать об ошибках политики и Обработка ошибок .

Ошибки выполнения

Эти ошибки могут возникать при выполнении политики.

Ошибки развертывания

Эти ошибки могут возникнуть при развертывании прокси-сервера, содержащего эту политику.

Переменные неисправности

Эти переменные устанавливаются при возникновении ошибки во время выполнения. Дополнительные сведения см. в разделе Что нужно знать об ошибках политики .

Пример ответа об ошибке

Для обработки ошибок лучше всего перехватывать часть errorcode в ответе на ошибку. Не полагайтесь на текст в faultstring , поскольку он может измениться.

Пример правила неисправности

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