पुष्टि करने की बुनियादी नीति

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

क्या

इस कुकी की मदद से, लास्ट-माइल सिक्योरिटी के लिए सामान्य पुष्टि का इस्तेमाल किया जा सकता है. यह नीति, उपयोगकर्ता नाम और पासवर्ड लेती है. इसके बाद, उन्हें Base64 में एन्कोड करती है और नतीजे के तौर पर मिली वैल्यू को किसी वैरिएबल में लिखती है. इससे मिलने वाली वैल्यू, Basic Base64EncodedString के फ़ॉर्मैट में होती है. आम तौर पर, इस वैल्यू को एचटीटीपी हेडर में लिखा जाता है. जैसे, Authorization हेडर.

इस नीति की मदद से, Base64 एन्कोड की गई स्ट्रिंग में सेव किए गए क्रेडेंशियल को उपयोगकर्ता नाम और पासवर्ड में डिकोड किया जा सकता है.

सैंपल

<BasicAuthentication name="ApplyBasicAuthHeader">
   <DisplayName>ApplyBasicAuthHeader</DisplayName>
   <Operation>Encode</Operation>
   <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
   <User ref="credentials.username" />
   <Password ref="credentials.password" />
   <AssignTo createNew="false">request.header.Authorization</AssignTo>
</BasicAuthentication>

{
  "encrypted" : true,
  "entry" : [ {
    "name" : "username",
    "value" : "MyUsername"
  }, {
    "name" : "password",
    "value" : "MyPassword"
  } ],
  "name" : "BasicAuthCredentials"
}
      

<KeyValueMapOperations name="getCredentials" mapIdentifier="BasicAuthCredentials">
  <Scope>apiproxy</Scope>
  <Get assignTo="credentials.username" index='1'>
    <Key>
      <Parameter>username</Parameter>
    </Key>
  </Get>
  <Get assignTo="credentials.password" index='1'>
    <Key>
      <Parameter>password</Parameter>
    </Key>
  </Get>
</KeyValueMapOperations>
      

<BasicAuthentication name="DecodeBaseAuthHeaders">
   <DisplayName>Decode Basic Authentication Header</DisplayName>
   <Operation>Decode</Operation>
   <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
   <User ref="request.header.username" />
   <Password ref="request.header.password" />
   <Source>request.header.Authorization</Source>
</BasicAuthentication>

बुनियादी पुष्टि करने की नीति के बारे में जानकारी

इस नीति के तहत, दो मोड में काम किया जाता है:

• Encode: यह फ़ंक्शन, वैरिएबल में सेव किए गए उपयोगकर्ता नाम और पासवर्ड को Base64 में बदलता है
• डिकोड करना: Base64 एन्कोड की गई स्ट्रिंग से उपयोगकर्ता नाम और पासवर्ड को डिकोड करता है

उपयोगकर्ता नाम और पासवर्ड को आम तौर पर, कुंजी/वैल्यू स्टोर में सेव किया जाता है. इसके बाद, रनटाइम में कुंजी/वैल्यू स्टोर से इन्हें पढ़ा जाता है. कुंजी/वैल्यू स्टोर का इस्तेमाल करने के बारे में ज़्यादा जानने के लिए, Key Value Map Operations policy देखें.

एलिमेंट का रेफ़रंस

इस एलिमेंट रेफ़रंस में, BasicAuthentication नीति के एलिमेंट और एट्रिब्यूट के बारे में बताया गया है.

<BasicAuthentication async="false" continueOnError="false" enabled="true" name="Basic-Authentication-1">
   <DisplayName>Basic Authentication 1</DisplayName>
   <Operation>Encode</Operation>
   <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
   <User ref="credentials.username" />
   <Password ref="credentials.password" />
   <AssignTo createNew="false">request.header.Authorization</AssignTo>
   <Source>request.header.Authorization</Source> 
</BasicAuthentication>

<BasicAuthentication> एट्रिब्यूट

<BasicAuthentication async="false" continueOnError="false" enabled="true" name="Basic-Authentication-1">

यहां दी गई टेबल में, ऐसे एट्रिब्यूट के बारे में बताया गया है जो नीति के सभी पैरंट एलिमेंट में एक जैसे होते हैं:

&lt;DisplayName&gt; एलिमेंट

इस कॉलम में नीति को लेबल करने के लिए, name एट्रिब्यूट के साथ-साथ इस्तेमाल करें मैनेजमेंट यूज़र इंटरफ़ेस (यूआई) प्रॉक्सी एडिटर, जिसका नाम अलग और सामान्य भाषा में है.

<DisplayName>Policy Display Name</DisplayName>

<Operation> एलिमेंट

इससे यह तय होता है कि नीति, क्रेडेंशियल को Base64 कोड में बदलती है या उसे डिकोड करती है.

<Operation>Encode</Operation>

<IgnoreUnresolvedVariables> एलिमेंट

true पर सेट होने पर, अगर किसी वैरिएबल को हल नहीं किया जा सकता, तो नीति कोई गड़बड़ी नहीं दिखाएगी. BasicAuthentication नीति के संदर्भ में इस्तेमाल किए जाने पर, इस सेटिंग को आम तौर पर false पर सेट किया जाता है. ऐसा इसलिए, क्योंकि अगर बताए गए वैरिएबल में उपयोगकर्ता नाम या पासवर्ड नहीं मिलता है, तो गड़बड़ी दिखाना आम तौर पर फ़ायदेमंद होता है.

<IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>

<User> एलिमेंट

• एन्कोडिंग के लिए, <User> एलिमेंट का इस्तेमाल करके उस वैरिएबल के बारे में बताएं जिसमें उपयोगकर्ता नाम मौजूद है. Base64 एन्कोडिंग से पहले, उपयोगकर्ता नाम और पासवर्ड की वैल्यू को कोलन के साथ जोड़ा जाता है.
• डिकोड करने के लिए, वह वैरिएबल डालें जिसमें डिकोड किया गया उपयोगकर्ता नाम लिखा गया है.

<User ref="credentials.username" /> 

विशेषताएं

<Password> एलिमेंट

• एन्कोडिंग के लिए, <Password> एलिमेंट का इस्तेमाल करके, पासवर्ड वाला वैरिएबल तय करें.
• डिकोड करने के लिए, उस वैरिएबल के बारे में बताएं जिसमें डिकोड किया गया पासवर्ड लिखा गया है.

<Password ref="credentials.password" />

विशेषताएं

<AssignTo> एलिमेंट

Encode ऑपरेशन के लिए, यह नीति टारगेट वैरिएबल तय करती है. इस वैरिएबल को इस नीति से जनरेट की गई कोड में बदली गई वैल्यू के साथ सेट किया जाता है.

यहां दिए गए उदाहरण से पता चलता है कि नीति को, मैसेज के Authorization हेडर को जनरेट की गई वैल्यू पर सेट करना चाहिए:

<AssignTo createNew="false">request.header.Authorization</AssignTo>

विशेषताएं

<Source> एलिमेंट

डिकोड करने के लिए, Base64 एन्कोड की गई स्ट्रिंग वाला वैरिएबल, Basic Base64EncodedString के फ़ॉर्म में. उदाहरण के लिए, Authorization हेडर के लिए, request.header.Authorization तय करें.

<Source>request.header.Authorization</Source>

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

नीति के लागू न होने पर, यह फ़्लो वैरिएबल सेट किया जाता है:

• BasicAuthentication.{policy_name}.failed (जिसकी वैल्यू सही है)

गड़बड़ी की जानकारी

This section describes the fault codes and error messages that are returned and fault variables that are set by Edge when this policy triggers an error. This information is important to know if you are developing fault rules to handle errors. 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

{  
   "fault":{  
      "detail":{  
         "errorcode":"steps.basicauthentication.UnresolvedVariable"
      },
      "faultstring":"Unresolved variable : request.queryparam.password"
   }
}

Example fault rule

<FaultRule name="Basic Authentication Faults">
    <Step>
        <Name>AM-UnresolvedVariable</Name>
        <Condition>(fault.name Matches "UnresolvedVariable") </Condition>
    </Step>
    <Step>
        <Name>AM-AuthFailedResponse</Name>
        <Condition>(fault.name = "InvalidBasicAuthenticationSource")</Condition>
    </Step>
    <Condition>(BasicAuthentication.BA-Authentication.failed = true) </Condition>
</FaultRule>

स्कीमा

मिलते-जुलते विषय

Key Value Map Operations policy