سياسة المصادقة الأساسية

أنت الآن بصدد الاطّلاع على مستندات Apigee Edge.
انتقِل إلى مستندات Apigee X. info

الأدوات المستخدمة

يتيح لك استخدام المصادقة الأساسية البسيطة لتوفير الأمان في المرحلة الأخيرة. تتلقّى السياسة اسم مستخدم وكلمة مرور، وتشفّرهما باستخدام Base64، ثم تكتب القيمة الناتجة في متغيّر. تكون القيمة الناتجة بالتنسيق Basic Base64EncodedString. عادةً ما تكتب هذه القيمة في عنوان HTTP، مثل عنوان Authorization.

تتيح لك السياسة أيضًا فك ترميز بيانات الاعتماد المخزَّنة في سلسلة مرمّزة بتنسيق Base64 إلى اسم مستخدم وكلمة مرور.

نماذج

<BasicAuthentication name="ApplyBasicAuthHeader">
   <DisplayName>ApplyBasicAuthHeader</DisplayName>
   <Operation>Encode</Operation>
   <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
   <User ref="BasicAuth.credentials.username" />
   <Password ref="BasicAuth.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>

لمحة عن سياسة المصادقة الأساسية

تتضمّن السياسة وضعَين للعمليات:

• الترميز: يُرمّز Base64 اسم المستخدم وكلمة المرور المخزّنتَين في المتغيّرات
• فك الترميز: يفك ترميز اسم المستخدم وكلمة المرور من سلسلة مرمّزة باستخدام Base64

يتم عادةً تخزين اسم المستخدم وكلمة المرور في مخزن المفتاح/القيمة، ثم تتم قراءتهما من مخزن المفتاح/القيمة في وقت التشغيل. للحصول على تفاصيل حول استخدام مخزن المفتاح/القيمة، يُرجى الاطّلاع على سياسة عمليات خريطة المفتاح والقيمة.

مرجع العنصر

يصف مرجع العنصر عناصر وسمات سياسة 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="request.queryparam.username" />
   <Password ref="request.queryparam.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="request.queryparam.username" /> 

السمات

عنصر <Password>

• بالنسبة إلى الترميز، استخدِم العنصر <Password> لتحديد المتغيّر الذي يحتوي على كلمة المرور.
• بالنسبة إلى فك الترميز، حدِّد المتغيّر الذي تتم كتابة كلمة المرور التي تم فك ترميزها فيه.

<Password ref="request.queryparam.password" />

السمات

العنصر <AssignTo>

بالنسبة إلى عملية Encode، تحدّد هذه السمة المتغيّر المستهدَف الذي سيتم ضبطه باستخدام القيمة المشفرة التي تم إنشاؤها بواسطة هذه السياسة.

يوضّح المثال التالي أنّ السياسة يجب أن تضبط عنوان Authorization الرسالة على القيمة التي تم إنشاؤها:

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

السمات

العنصر <Source>

لإجراء فك الترميز، يجب استخدام المتغير الذي يحتوي على السلسلة المرمّزة بتنسيق Base64، وذلك بالشكل Basic Base64EncodedString. على سبيل المثال، حدِّد request.header.Authorization، بما يتوافق مع العنوان Authorization.

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

متغيرات التدفق

يتم ضبط متغيّر التدفق التالي عند تعذُّر تنفيذ السياسة:

• ‫BasicAuthentication.{policy_name}.failed (بقيمة "صحيح")

مرجع الخطأ

يصف هذا القسم رموز الخطأ ورسائل الخطأ التي يتم عرضها ومتغيرات الأخطاء التي تم ضبطها من خلال Edge عندما تؤدي هذه السياسة إلى ظهور خطأ. من المهم معرفة هذه المعلومات إذا كنت تضع قواعد خطأ معالجة الأخطاء. للحصول على مزيد من المعلومات، يمكنك الاطّلاع على ما تحتاج إلى معرفته حول أخطاء السياسة والتعامل مع المعالجة والأخطاء.

أخطاء بيئة التشغيل

يمكن أن تحدث هذه الأخطاء عند تنفيذ السياسة.

أخطاء النشر

يمكن أن تحدث هذه الأخطاء عند نشر خادم وكيل يحتوي على هذه السياسة.

متغيّرات الأخطاء

يتم ضبط هذه المتغيّرات عند حدوث خطأ في بيئة التشغيل. يمكنك الاطّلاع على مقالة ما تحتاج إلى معرفته للحصول على مزيد من المعلومات. حول أخطاء السياسة.

مثال على استجابة الخطأ

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

مثال على قاعدة الخطأ

<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