Правило DecodeJWS

Вы просматриваете документацию по 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. Хотя в этом видео речь идет о 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 будет пустым. Полный список переменных, заданных этими правилами, приведен в разделе Переменные потока.

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

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

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

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

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

<DisplayName>

<DisplayName>Policy Display Name</DisplayName>

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

<Source>

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