HMAC नीति

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

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

एचएमएसी के बारे में ज़्यादा जानने के लिए, HMAC: Message Authentication (rfc2104) के लिए HMAC: Keyed-Ha मुफ़्तिंग देखें.

सैंपल

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