Политика HMAC

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

Вычисляет и проверяет хеш-код аутентификации сообщения (HMAC). Иногда называемый хеш-кодом аутентификации сообщения с ключом или хешем с ключом, HMAC использует криптографическую хеш-функцию, такую ​​как SHA-1, SHA-224, SHA-256, SHA-384, SHA-512 или MD-5, применяемую к «сообщению» вместе с секретным ключом для получения подписи или кода аутентификации сообщения. Термин «сообщение» здесь относится к любому потоку байтов. Отправитель сообщения также может отправить HMAC получателю, и получатель может использовать HMAC для аутентификации сообщения.

Чтобы узнать больше о HMAC, см. HMAC: Keyed-Hashing for Message Authentication (rfc2104) .

Образцы

<HMAC name='HMAC-1'>

  <Algorithm>SHA256</Algorithm>

  <SecretKey ref='private.secretkey'/>

  <IgnoreUnresolvedVariables>true|false</IgnoreUnresolvedVariables> <!-- optional -->

  <!--
    The "message" can include fixed and multiple variable parts,
    including newlines and static functions.
    Whitespace is significant.
   -->
  <Message>Fixed Part
    {a_variable}
    {timeFormatUTCMs(timeFormatString1,system.timestamp)}
    {nonce}
  </Message>

  <!-- default encoding is base64 -->
  <Output encoding='base16'>name_of_variable</Output>

</HMAC>

<HMAC name='HMAC-1'>

  <Algorithm>SHA256</Algorithm>

  <SecretKey ref='private.secretkey'/>

  <IgnoreUnresolvedVariables>true|false</IgnoreUnresolvedVariables> <!-- optional -->

  <!--
    The "message" can include fixed and multiple variable parts,
    including newlines and static functions.
    Whitespace is significant.
   -->
  <Message>Fixed Part
    {a_variable}
    {timeFormatUTCMs(timeFormatString1,system.timestamp)}
    {nonce}
  </Message>

  <!--
    VerificationValue is optional.
    Include it to perform an HMAC check.
  -->
  <VerificationValue encoding='base16' ref='expected_hmac_value'/>

  <!-- default encoding is base64 -->
  <Output encoding='base16'>name_of_variable</Output>

</HMAC>

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

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

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

<HMAC name="HMAC" continueOnError="false" enabled="true" async="false">

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

<Алгоритм>

<Algorithm>algorithm-name</Algorithm>

Указывает алгоритм хеширования для вычисления HMAC.

<DisplayName>

<DisplayName>Policy Display Name</DisplayName>

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

<Сообщение>

<Message>message_template_here</Message>
or
<Message ref='variable_here'/>

Указывает полезную нагрузку сообщения для подписи. Входные данные этого элемента поддерживают шаблоны сообщений (подстановка переменных), позволяющие включать дополнительные элементы во время выполнения, такие как метки времени, одноразовые числа, списки заголовков или другую информацию. Например:

<Message>Fixed Part
    {a_variable}
    {timeFormatUTCMs(timeFormatString1,system.timestamp)}
    {nonce}
</Message>

Шаблон сообщения может включать фиксированные и переменные элементы, в том числе переносы строк и статические функции. Пробелы имеют значение.

<Вывод>

<Output encoding='encoding_name'>variable_name</Output>

Указывает имя переменной, которой политика должна присвоить вычисленное значение HMAC. Также указывается кодировка, используемая для выходных данных.

<Секретный ключ>

<SecretKey encoding='encoding_name' ref='private.secretkey'/>

Указывает секретный ключ, используемый для вычисления HMAC. Ключ получается из указанной переменной и декодируется в соответствии со специфическим кодированием.

 <SecretKey encoding='hex' ref='private.encodedsecretkey'/>

<Значение проверки>

<VerificationValue encoding='encoding_name' ref='variable_name'/>
or
<VerificationValue encoding='encoding_name'>string_value</VerificationValue>

(Необязательно) Указывает значение проверки, а также алгоритм кодирования, использованный для кодирования этого значения. Политика будет использовать этот алгоритм для декодирования значения.

<IgnoreUnresolvedVariables>

<IgnoreUnresolvedVariables>true|false</IgnoreUnresolvedVariables>

Установите значение false , если хотите, чтобы политика выдавала ошибку, если какая-либо указанная в политике переменная не может быть разрешена. Установите значение true , чтобы рассматривать любую неразрешимую переменную как пустую строку (null).

Логическая переменная IgnoreUnresolvedVariables влияет только на те переменные, на которые ссылается шаблон сообщения. Хотя SecretKey и VerificationValue могут ссылаться на переменную, обе они должны быть разрешаемыми, поэтому параметр ignore к ним не применяется.

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

Политика может устанавливать эти переменные во время выполнения.

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

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

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

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

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

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

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

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

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

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

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

<FaultRules>
    <FaultRule name="HMAC Policy Errors">
        <Step>
            <Name>AM-Unauthorized</Name>
            <Condition>(fault.name Matches "HmacVerificationFailed")</Condition>
        </Step>
        <Condition>hmac.HMAC-1.failed = true</Condition>
    </FaultRule>
</FaultRules>