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

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

Что

Декодирует заголовок JWS без проверки подписи на JWS и записывает каждый заголовок в переменную потока. Эта политика наиболее полезна при использовании совместно с политикой VerifyJWS , когда значение заголовка из JWS должно быть известно перед проверкой подписи JWS.

JWS может иметь прикрепленную полезную нагрузку, как в форме:

header.payload.signature

Или JWS может опустить полезную нагрузку, называемую отдельной полезной нагрузкой, и иметь вид:

header..signature

Политика DecodeJWS работает с обеими формами, поскольку она декодирует только часть заголовка JWS. Политика DecodeJWS также работает независимо от алгоритма, который использовался для подписи JWS.

См. обзор политик JWS и JWT для подробного введения и обзора формата JWS.

Видео

Посмотрите короткое видео, чтобы узнать, как декодировать JWT. Хотя это видео относится только к JWT, многие концепции одинаковы и для JWS.

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

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

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

Для каждого заголовка в заголовочной части JWS политика устанавливает переменную потока с именем:

jws.policy-name.header.header-name

Если у JWS есть прикрепленные полезные данные, он устанавливает jws. policy-name .header.payload переменная потока для полезных данных. Для отсоединенной полезной нагрузки payload пуста. Полный список переменных, установленных этой политикой, см. в разделе Переменные потока .

Справочник элементов для декодирования JWS

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

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

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

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

<ОтображаемоеИмя>

<DisplayName>Policy Display Name</DisplayName>

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

<Источник>

<Source>JWS-variable</Source>

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

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

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

jws.{policy_name}.{variable_name}

Например, если имя политики verify-jws , то политика сохранит алгоритм, указанный в JWS, в этой контекстной переменной: jws.verify-jws.header.algorithm

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

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

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

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

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

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

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

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

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

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

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

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