Zasada HMAC

Wyświetlasz dokumentację Apigee Edge.
Przejdź do dokumentacji Apigee X. info

Oblicza i weryfikuje kod uwierzytelniania wiadomości przy użyciu wartości hash (HMAC). HMAC, czasami nazywany kodem uwierzytelniania wiadomości przy użyciu wartości hash w formie klucza lub kodem uwierzytelniania wiadomości przy użyciu wartości hash w formie klucza, używa kryptograficznej funkcji skrótu, takiej jak SHA-1, SHA-224, SHA-256, SHA-384, SHA-512 lub MD-5, stosowanej do "wiadomości" wraz z kluczem tajnym, aby wygenerować podpis lub kod uwierzytelniania wiadomości. Termin "wiadomość" odnosi się tutaj do dowolnego strumienia bajtów. Nadawca wiadomości może też wysłać do odbiorcy kod HMAC, a odbiorca może go użyć do uwierzytelnienia wiadomości.

Więcej informacji o HMAC, znajdziesz w dokumencie HMAC: Keyed-Hashing for Message Authentication (rfc2104).

Przykłady

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

Dokumentacja elementu HMAC

Dokumentacja zasady opisuje elementy i atrybuty zasady HMAC.

Atrybuty, które mają zastosowanie do elementu najwyższego poziomu

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

Te atrybuty są wspólne dla wszystkich elementów nadrzędnych zasad.

<Algorithm>

<Algorithm>algorithm-name</Algorithm>

Określa algorytm skrótu do obliczania HMAC.

<DisplayName>

<DisplayName>Policy Display Name</DisplayName>

Użyj tego atrybutu oprócz atrybutu name, aby oznaczyć zasadę w edytorze proxy w interfejsie Apigee inną nazwą w języku naturalnym.

<Message>

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

Określa ładunek wiadomości do podpisania. Dane wejściowe tego elementu obsługują szablony wiadomości (podstawianie zmiennych), aby umożliwić dołączanie dodatkowych elementów w czasie działania, takich jak sygnatury czasowe, nonce, listy nagłówków lub inne informacje. Na przykład:

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

Szablon wiadomości może zawierać stałe i zmienne części, w tym nowe wiersze i funkcje statyczne. Białe znaki mają znaczenie.

<Output>

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

Określa nazwę zmiennej, którą zasada powinna ustawić na obliczoną wartość HMAC. Określa też kodowanie, które ma być używane w przypadku danych wyjściowych.

<SecretKey>

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

Określa klucz tajny używany do obliczania HMAC. Klucz jest pobierany z zmiennej, do której się odwołuje , i dekodowany zgodnie z określonym kodowaniem.

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

<VerificationValue>

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

(Opcjonalnie) Określa wartość weryfikacji oraz algorytm kodowania, który został użyty do zakodowania tej wartości. Zasada użyje tego algorytmu do zdekodowania wartości.

<IgnoreUnresolvedVariables>

<IgnoreUnresolvedVariables>true|false</IgnoreUnresolvedVariables>

Ustaw wartość false, jeśli chcesz, aby zasada zgłaszała błąd, gdy nie można rozpoznać żadnej zmiennej, do której się odwołuje. Ustaw wartość true, aby traktować każdą nierozpoznawalną zmienną jako pusty ciąg znaków (null).

Wartość logiczna IgnoreUnresolvedVariables wpływa tylko na zmienne, do których odwołuje się szablon wiadomości. Zarówno SecretKey jak i VerificationValue mogą odwoływać się do zmiennej, ale obie muszą być rozpoznawalne, więc ustawienie ignore nie ma do nich zastosowania.

Zmienne przepływu

Podczas wykonywania zasada może ustawiać te zmienne.

Informacje o błędach

W tej sekcji opisujemy kody błędów i komunikaty o błędach, które są zwracane, a także zmienne błędów ustawiane przez Apigee, gdy ta zasada wywołuje błąd. Te informacje są ważne, jeśli opracowujesz reguły dotyczące błędów do obsługi takich błędów. Więcej informacji znajdziesz w sekcjach Co musisz wiedzieć o błędach zasad i Postępowanie w przypadku błędów.

Błędy w czasie wykonywania

Te błędy mogą wystąpić podczas wykonywania zasady.

Błędy wdrażania

Te błędy mogą wystąpić podczas wdrażania serwera proxy zawierającego te zasady.

Zmienne błędów

Te zmienne są ustawiane po wystąpieniu błędu działania. Aby dowiedzieć się więcej, Więcej informacji znajdziesz w sekcji Co musisz wiedzieć o błędach związanych z naruszeniem zasad.

Przykładowa odpowiedź na błąd

W przypadku obsługi błędów sprawdzoną metodą jest przechwycenie części błędu errorcode. . Nie polegaj na tekście zawartym w pliku faultstring, ponieważ może się on zmienić.

Przykładowa reguła błędu

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