Chính sách Xác thực Cơ bản

Bạn đang xem tài liệu về Apigee Edge.
Truy cập vào tài liệu Apigee X. thông tin

Nội dung

Cho phép bạn sử dụng phương thức Xác thực cơ bản đơn giản để bảo mật ở chặng cuối. Chính sách này lấy tên người dùng và mật khẩu, mã hoá chúng bằng Base64 và ghi giá trị kết quả vào một biến. Giá trị thu được có dạng Basic Base64EncodedString. Thông thường, bạn sẽ ghi giá trị này vào một tiêu đề HTTP, chẳng hạn như tiêu đề Authorization.

Chính sách này cũng cho phép bạn giải mã thông tin đăng nhập được lưu trữ trong một chuỗi được mã hoá Base64 thành tên người dùng và mật khẩu.

Mẫu

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

Giới thiệu về chính sách Xác thực cơ bản

Chính sách này có hai chế độ hoạt động:

• Mã hoá: Mã hoá Base64 cho tên người dùng và mật khẩu được lưu trữ trong các biến
• Giải mã: Giải mã tên người dùng và mật khẩu từ một chuỗi được mã hoá Base64

Tên người dùng và mật khẩu thường được lưu trữ trong kho khoá/giá trị rồi đọc từ kho khoá/giá trị tại thời gian chạy. Để biết thông tin chi tiết về cách sử dụng khoá/giá trị, hãy xem Chính sách về các thao tác trên bản đồ khoá giá trị.

Tham chiếu phần tử

Tài liệu tham khảo về phần tử mô tả các phần tử và thuộc tính của chính sách 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>

Thuộc tính <BasicAuthentication>

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

Bảng sau đây mô tả những thuộc tính chung cho tất cả phần tử mẹ của chính sách:

&lt;DisplayName&gt; phần tử

Hãy sử dụng cùng với thuộc tính name để gắn nhãn chính sách trong phần trình chỉnh sửa proxy giao diện người dùng quản lý có tên ngôn ngữ tự nhiên khác.

<DisplayName>Policy Display Name</DisplayName>

Phần tử <Operation>

Xác định xem chính sách có mã hoá Base64 hay giải mã thông tin đăng nhập hay không.

<Operation>Encode</Operation>

Phần tử <IgnoreUnresolvedVariables>

Khi được đặt thành true, chính sách sẽ không báo lỗi nếu không thể phân giải một biến. Khi được dùng trong bối cảnh của chính sách BasicAuthentication, chế độ cài đặt này thường được đặt thành false vì việc gửi lỗi nếu không tìm thấy tên người dùng hoặc mật khẩu trong các biến được chỉ định thường có lợi.

<IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>

Phần tử <User>

• Để mã hoá, hãy sử dụng phần tử <User> để chỉ định biến chứa tên người dùng. Các giá trị tên người dùng và mật khẩu được nối với dấu hai chấm trước khi mã hoá Base64.
• Để giải mã, hãy chỉ định biến nơi tên người dùng đã giải mã được ghi.

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

Thuộc tính

Phần tử <Password>

• Để mã hoá, hãy dùng phần tử <Password> để chỉ định biến chứa mật khẩu.
• Để giải mã, hãy chỉ định biến nơi mật khẩu đã giải mã được ghi.

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

Thuộc tính

Phần tử <AssignTo>

Đối với thao tác Encode, hãy chỉ định biến mục tiêu cần đặt bằng giá trị được mã hoá do chính sách này tạo.

Ví dụ sau đây cho biết rằng chính sách này sẽ đặt tiêu đề Authorization của thông báo thành giá trị được tạo:

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

Thuộc tính

Phần tử <Source>

Để giải mã, biến chứa chuỗi được mã hoá Base64, ở dạng Basic Base64EncodedString. Ví dụ: chỉ định request.header.Authorization, tương ứng với tiêu đề Uỷ quyền.

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

Biến luồng

Biến luồng sau đây được đặt khi chính sách không thành công:

• BasicAuthentication.{policy_name}.failed (có giá trị là true)

Tham chiếu lỗi

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>

Giản đồ

Chủ đề có liên quan

Chính sách về các thao tác trên Bản đồ khoá-giá trị