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

يتم الآن عرض مستندات Apigee Edge.
انتقِل إلى مستندات Apigee X. المعلومات

الموضوع

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

تتيح لك السياسة أيضًا فك ترميز بيانات الاعتماد المخزّنة في سلسلة 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 مرمّزة

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

مرجع العنصر

يصف مرجع العناصر عناصر وسمات سياسة BasicAuth.

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

سمات < BasicAuth>

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

يوضِّح الجدول التالي السمات الشائعة لجميع العناصر الرئيسية للسياسة:

العنصر <DisplayName>

استخدِم هذه السمة بالإضافة إلى السمة name لتصنيف السياسة في محرِّر الخادم الوكيل لواجهة المستخدم الإدارية باستخدام اسم مختلف بلغة طبيعية.

<DisplayName>Policy Display Name</DisplayName>

العنصر <Operation>

تحدِّد السياسة ما إذا كانت سياسة Base64 تعمل على ترميز بيانات الاعتماد أو فك ترميزها.

<Operation>Encode</Operation>

عنصر <تجاهلUnresolvedVariables>

عند ضبط السياسة على true، لن تعرض السياسة أي خطأ إذا تعذّر حلّ المتغيّر. عند استخدام هذا الإعداد في سياق سياسة Basic Authenticator، يتم عادةً ضبط هذا الإعداد على false لأنه من المفيد بشكل عام عرض خطأ إذا تعذّر العثور على اسم المستخدم أو كلمة المرور في المتغيّرات المحددة.

<IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>

عنصر <User>

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

<User ref="request.queryparam.username" /> 

السمات

عنصر <كلمة المرور>

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

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

السمات

عنصر <AssignTo>

تحدّد هذه السمة المتغيّر المستهدف المطلوب ضبطه باستخدام القيمة المشفرة أو فك ترميزها التي تم إنشاؤها بواسطة هذه السياسة.

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

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

السمات

عنصر <المصدر>

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

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

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

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

• BasicAuthentication.{policy_name}.failed (بالقيمة true)

مرجع الخطأ

يصف هذا القسم رموز الأخطاء ورسائل الخطأ التي يتم عرضها ومتغيرات الأخطاء التي تضبطها 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>

المخططات

مواضيع ذات صلة

سياسة عمليات "خريطة القيم الرئيسية"