HMAC नीति

आपको Apigee Edge दस्तावेज़ दिख रहा है.
अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है इस पेज पर जाएं Apigee X दस्तावेज़. जानकारी

हैश पर आधारित मैसेज ऑथेंटिकेशन कोड (HMAC) की गिनती करता है और उसकी पुष्टि करता है. कभी-कभी इसे कीड मैसेज ऑथेंटिकेशन कोड या कीड हैश के नाम से जाना जाता है. एचएमएसी एक क्रिप्टोग्राफ़िक हैश का इस्तेमाल करता है SHA-1, SHA-224, SHA-256, SHA-384, SHA-512 या MD-5 जैसे फ़ंक्शन, किसी "मैसेज" पर लागू होते हैं, और साथ में सुरक्षा कुंजी भी हो सकती है. का इस्तेमाल करें. "मैसेज" शब्द यहां जाएं का मतलब बाइट की किसी भी स्ट्रीम से है. मैसेज भेजने वाला, पाने वाले को एचएमएसी भी भेज सकता है. और मैसेज को प्रमाणित करने के लिए वह एचएमएसी का इस्तेमाल कर सकता है.

एचएमएसी के बारे में ज़्यादा जानने के लिए, HMAC: कीड-हैशिंग देखें के लिए, 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 name="HMAC" continueOnError="false" enabled="true" async="false">

ये एट्रिब्यूट, नीति के सभी पैरंट एलिमेंट में एक जैसे होते हैं.

<Algorithm>

<Algorithm>algorithm-name</Algorithm>

एचएमएसी का हिसाब लगाने के लिए हैश एल्गोरिदम तय करता है.

<DisplayName>

<DisplayName>Policy Display Name</DisplayName>

Apigee यूज़र इंटरफ़ेस (यूआई) के प्रॉक्सी एडिटर में नीति को लेबल करने के लिए, नाम एट्रिब्यूट के अलावा इसका इस्तेमाल करें पर क्लिक करें.

<Message>

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

साइन करने के लिए मैसेज पेलोड के बारे में बताता है. इस एलिमेंट का इनपुट, मैसेज के टेंप्लेट (वैरिएबल प्रतिस्थापन) रनटाइम के दौरान अतिरिक्त आइटम शामिल करने की अनुमति देने के लिए, जैसे कि टाइमस्टैंप, नॉन्स, हेडर या अन्य जानकारी. उदाहरण के लिए:

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

मैसेज टेंप्लेट में, तय किए गए और वैरिएबल वाले हिस्से शामिल हो सकते हैं. इनमें नई लाइनें और स्टैटिक फ़ंक्शन शामिल हैं. व्हाइटस्पेस अहम है.

<Output>

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

उस वैरिएबल का नाम बताता है जिसे नीति को कंप्यूट किए गए एचएमएसी वैल्यू के साथ सेट करना चाहिए. आउटपुट में इस्तेमाल करने के लिए, कोड में बदलने का तरीका भी तय करता है.

<SecretKey>

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

एचएमएसी को कंप्यूट करने के लिए इस्तेमाल की जाने वाली सीक्रेट कुंजी के बारे में बताता है. कुंजी को रेफ़र किए गए रेफ़रंस से लिया गया है वैरिएबल को खास एन्कोडिंग के मुताबिक डिकोड किया जाता है.

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

<VerificationValue>

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

(वैकल्पिक) यह सत्यापन वैल्यू के साथ-साथ कोड में बदलने के एल्गोरिदम को दिखाता है, जो इसका इस्तेमाल पुष्टि की वैल्यू को कोड में बदलने के लिए किया जाता है. यह नीति, वैल्यू को डिकोड करने के लिए, इस एल्गोरिदम का इस्तेमाल करेगी.

<IgnoreUnresolvedVariables>

<IgnoreUnresolvedVariables>true|false</IgnoreUnresolvedVariables>

अगर आपको यह तय करना है कि किसी रेफ़र किए गए वैरिएबल के बताए जाने पर, नीति गड़बड़ी की सूचना दे, तो false पर सेट करें हल नहीं किया जा सकता. किसी ऐसे वैरिएबल को खाली स्ट्रिंग के तौर पर ट्रीट करने के लिए true पर सेट करें जिसे रिज़ॉल्व नहीं किया जा सकता (शून्य).

ignoreUnsolvedVariables बूलियन सिर्फ़ उन वैरिएबल पर असर डालता है जो मैसेज टेंप्लेट के तौर पर चला जाता है. हालांकि, SecretKey और VerificationValue किसी वैरिएबल का रेफ़रंस दे सकते हैं, दोनों उनमें से जिन्हें रिज़ॉल्व किया जा सकता हो, इसलिए ignore सेटिंग उन पर लागू नहीं होती.

फ़्लो वैरिएबल

एक्ज़ीक्यूशन के दौरान, नीति इन वैरिएबल को सेट कर सकती है.

Error reference

This section describes the fault codes and error messages that are returned and fault variables that are set by Apigee when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults.

Runtime errors

These errors can occur when the policy executes.

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Fault variables

These variables are set when a runtime error occurs. For more information, see What you need to know about policy errors.

Example error response

For error handling, the best practice is to trap the errorcode part of the error response. Do not rely on the text in the faultstring, because it could change.

Example fault rule

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