Политика HMAC

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

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

Дополнительные сведения о HMAC см. в разделе HMAC: хеширование ключей для аутентификации сообщений (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>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>

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

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

<Игнорировать неразрешенные переменные>

<IgnoreUnresolvedVariables>true|false</IgnoreUnresolvedVariables>

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

Логическое значение 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>