HMAC politikası

Apigee Edge belgelerini görüntülüyorsunuz.
Apigee X belgelerine gidin. bilgi

Karma tabanlı mesaj doğrulama kodu (HMAC) hesaplar ve doğrular. Bazen Anahtarlı Mesaj Kimlik Doğrulama Kodu veya Anahtarlı Karma olarak da bilinen HMAC, bir "mesaja" uygulanan SHA-1, SHA-224, SHA-256, SHA-384, SHA-512 veya MD-5 gibi bir şifreleme karma işlevini gizli bir anahtarla birlikte kullanarak bu mesajda bir imza veya mesaj kimlik doğrulama kodu oluşturur. Buradaki "mesaj" terimi, herhangi bir bayt akışını ifade eder. Bir iletinin göndereni, alıcıya HMAC da gönderebilir ve alıcı, iletiyi doğrulamak için HMAC'yi kullanabilir.

HMAC hakkında daha fazla bilgi edinmek için HMAC: Keyed-Hashing for Message Authentication (rfc2104) başlıklı makaleyi inceleyin.

Örnekler

<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 için öğe referansı

Politika referansında, HMAC politikasının öğeleri ve özellikleri açıklanır.

En üst düzey öğeye uygulanan özellikler

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

Aşağıdaki özellikler tüm politika üst öğeleri için ortaktır.

<Algorithm>

<Algorithm>algorithm-name</Algorithm>

HMAC'yi hesaplamak için karma algoritmasını belirtir.

<DisplayName>

<DisplayName>Policy Display Name</DisplayName>

Apigee kullanıcı arayüzü proxy düzenleyicisinde politikayı farklı ve doğal dilde bir adla etiketlemek için ad özelliğiyle birlikte kullanılır.

<Message>

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

İmzalanacak ileti yükünü belirtir. Bu öğenin girişi, çalışma zamanında ek öğelerin (ör. zaman damgaları, tek kullanımlık sayılar, üstbilgi listeleri veya diğer bilgiler) dahil edilmesine olanak tanımak için ileti şablonlarını (değişken değiştirme) destekler. Örneğin:

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

İleti şablonu, yeni satırlar ve statik işlevler de dahil olmak üzere sabit ve değişken bölümler içerebilir. Boşluk önemlidir.

<Output>

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

Politikanın hesaplanan HMAC değeriyle ayarlaması gereken değişkenin adını belirtir. Ayrıca çıktı için kullanılacak kodlamayı da belirtir.

<SecretKey>

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

HMAC'yi hesaplamak için kullanılan gizli anahtarı belirtir. Anahtar, referans verilen değişkenden alınır ve belirli kodlamaya göre çözülür.

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

<VerificationValue>

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

(İsteğe bağlı) Doğrulama değerinin yanı sıra doğrulama değerini kodlamak için kullanılan kodlama algoritmasını belirtir. Politika, değeri kod çözmek için bu algoritmayı kullanır.

<IgnoreUnresolvedVariables>

<IgnoreUnresolvedVariables>true|false</IgnoreUnresolvedVariables>

Politikada belirtilen referans verilen değişkenlerden herhangi biri çözümlenemediğinde politikanın hata vermesini istiyorsanız false olarak ayarlayın. Çözülemeyen değişkenleri boş dize (null) olarak değerlendirmek için true değerine ayarlayın.

IgnoreUnresolvedVariables boole'u yalnızca mesaj şablonu tarafından referans verilen değişkenleri etkiler. SecretKey ve VerificationValue bir değişkene referans verebilir ancak her ikisinin de çözümlenebilir olması gerekir. Bu nedenle, ignore ayarı bunlar için geçerli değildir.

Akış değişkenleri

Politika, yürütme sırasında bu değişkenleri ayarlayabilir.

Hata referansı

Bu bölümde, bu politika bir hata tetiklediğinde gönderilen hata kodları ve hata mesajları ile Apigee tarafından ayarlanan hata değişkenleri açıklanmaktadır. Bu bilgiyi, hataları ele almak için hata kuralları geliştirip geliştirmediğinizi bilmeniz önemlidir. Daha fazla bilgi için Politika hataları hakkında bilmeniz gerekenler ve Hataları işleme bölümlerine bakın.

Çalışma zamanı hataları

Politika yürütüldüğünde bu hatalar ortaya çıkabilir.

Dağıtım hataları

Bu hatalar, bu politikayı içeren bir proxy dağıttığınızda ortaya çıkabilir.

Hata değişkenleri

Bu değişkenler, çalışma zamanı hatası oluştuğunda ayarlanır. Daha fazla bilgi için Bilmeniz gerekenler hakkında daha fazla bilgi edinin.

Örnek hata yanıtı

Hata giderme için en iyi uygulama, hatanın errorcode kısmını yakalamaktır tıklayın. Değişebileceği için faultstring içindeki metne güvenmeyin.

Örnek hata kuralı

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