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

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

Что

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

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

header.payload.signature

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

header..signature

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

Подробное описание и обзор формата JWS см. в разделе «Обзор политик 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 пустое. Полный список переменных, устанавливаемых этой политикой, см. в разделе «Переменные потока» .

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

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

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

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

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

<DisplayName>

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