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

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

المزايا

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

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

يصف الجدول التالي السمات المشتركة بين جميع العناصر الرئيسية للسياسة:

<DisplayName> عنصر

استخدِمه مع السمة 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> عنصر

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

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

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

السمات

<Source> عنصر

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

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

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

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

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

مرجع الخطأ

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>

المخططات

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

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