HMAC नीति

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

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

एचएमएसी के बारे में ज़्यादा जानने के लिए, 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 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 पर सेट करें, ताकि किसी भी ऐसे वैरिएबल को खाली स्ट्रिंग (शून्य) के तौर पर माना जा सके जिसे हल नहीं किया जा सकता.

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>