นโยบายการตรวจสอบสิทธิ์พื้นฐาน

คุณกำลังดูเอกสารประกอบของ Apigee Edge
ไปที่เอกสารประกอบของ Apigee X ข้อมูล

อะไร

ทำให้คุณใช้การตรวจสอบสิทธิ์พื้นฐานขนาดเล็กเพื่อรักษาความปลอดภัยในขั้นตอนสุดท้ายได้ นโยบายจะใช้ชื่อผู้ใช้และรหัสผ่าน จากนั้นเข้ารหัส 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>

เกี่ยวกับนโยบายการตรวจสอบสิทธิ์ขั้นพื้นฐาน

นโยบายมีการทำงาน 2 โหมด ได้แก่

• เข้ารหัส: Base64 เข้ารหัสชื่อผู้ใช้และรหัสผ่านที่เก็บไว้ในตัวแปร
• ถอดรหัส: ถอดรหัสชื่อผู้ใช้และรหัสผ่านจากสตริงที่เข้ารหัส Base64

โดยทั่วไประบบจะเก็บชื่อผู้ใช้และรหัสผ่านไว้ในที่เก็บคีย์/ค่า จากนั้นอ่านจากที่เก็บคีย์/ค่าระหว่างรันไทม์ ดูรายละเอียดเกี่ยวกับการใช้ที่เก็บคีย์/ค่าได้ที่นโยบายการดำเนินการแมปค่าคีย์

การอ้างอิงองค์ประกอบ

การอ้างอิงองค์ประกอบจะอธิบายองค์ประกอบและแอตทริบิวต์ของนโยบาย Basic Authentication

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

แอตทริบิวต์ <Basic Authentication>

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

ตารางต่อไปนี้อธิบายแอตทริบิวต์ที่ใช้ร่วมกันในองค์ประกอบระดับบนสุดของนโยบายทั้งหมด

องค์ประกอบ <DisplayName>

ใช้เพิ่มเติมจากแอตทริบิวต์ name เพื่อติดป้ายกำกับนโยบายในเครื่องมือแก้ไขพร็อกซี UI การจัดการด้วยชื่อที่เป็นภาษาธรรมชาติที่แตกต่างออกไป

<DisplayName>Policy Display Name</DisplayName>

องค์ประกอบ <การดำเนินการ>

กำหนดว่านโยบาย Base64 จะเข้ารหัสหรือถอดรหัสข้อมูลเข้าสู่ระบบหรือไม่

<Operation>Encode</Operation>

องค์ประกอบ < ignoreUnresolvedVariable>

เมื่อตั้งค่าเป็น true นโยบายจะไม่แสดงข้อผิดพลาดหากแก้ไขตัวแปรไม่ได้ เมื่อใช้ในบริบทของนโยบาย Basic Authentication การตั้งค่านี้มักจะตั้งไว้ที่ false เพราะปกติแล้วการแสดงข้อผิดพลาดจะเป็นประโยชน์ในกรณีที่ไม่พบชื่อผู้ใช้หรือรหัสผ่านในตัวแปรที่ระบุ

<IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>

องค์ประกอบของ <User>

• สำหรับการเข้ารหัส ให้ใช้องค์ประกอบ <User> เพื่อระบุตัวแปรที่มีชื่อผู้ใช้ ค่าของชื่อผู้ใช้และรหัสผ่านจะต่อกันด้วยโคลอนก่อนการเข้ารหัส Base64
• สำหรับการถอดรหัส ให้ระบุตัวแปรที่ใช้เขียนชื่อผู้ใช้ที่ถอดรหัส

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

Attributes

องค์ประกอบของ <Password>

• สำหรับการเข้ารหัส ให้ใช้องค์ประกอบ <Password> เพื่อระบุตัวแปรที่มีรหัสผ่าน
• สำหรับการถอดรหัส ให้ระบุตัวแปรที่ใช้เขียนรหัสผ่านที่ถอดรหัส

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

Attributes

องค์ประกอบ <AssignTo>

ระบุตัวแปรเป้าหมายที่จะตั้งค่าด้วยค่าที่เข้ารหัสหรือถอดรหัสที่นโยบายนี้สร้างขึ้น

ตัวอย่างต่อไปนี้ระบุว่านโยบายควรตั้งค่าส่วนหัว Authorization ของข้อความเป็นค่าที่สร้างขึ้น

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

Attributes

องค์ประกอบ <Source>

สำหรับการถอดรหัส ตัวแปรที่มีสตริงที่เข้ารหัส Base64 ในรูปแบบ Basic Base64EncodedString ตัวอย่างเช่น ระบุ request.header.Authorization ที่สอดคล้องกับส่วนหัว 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>

สคีมา

หัวข้อที่เกี่ยวข้อง

นโยบายการดำเนินการของแมปค่าคีย์