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

Bạn đang xem tài liệu về Apigee Edge.
Chuyển đến Tài liệu về Apigee X. thông tin

Nội dung

Cho phép bạn sử dụng tính năng Xác thực cơ bản gọn nhẹ cho khả năng bảo mật ở bước cuối cùng. Chính sách này sẽ lấy tên người dùng và mật khẩu, Base64 mã hoá các thông tin này rồi ghi giá trị kết quả cho một biến. Giá trị thu được sẽ có dạng Basic Base64EncodedString. Bạn thường ghi giá trị này vào tiêu đề HTTP, chẳng hạn như tiêu đề Uỷ quyền.

Chính sách này cũng cho phép bạn giải mã thông tin xác thực lưu trữ trong chuỗi 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ó 2 chế độ hoạt động:

• Mã hoá: Base64 mã hoá tên người dùng và mật khẩu được lưu trữ trong biến
• Giải mã: Giải mã tên người dùng và mật khẩu 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 đọc từ kho khoá/giá trị trong thời gian chạy. Để biết thông tin chi tiết về cách sử dụng kho khoá/giá trị, hãy xem bài viết Hoạt động trên bản đồ giá trị khoá .

Tham chiếu phần tử

Tham chiếu phần tử mô tả các phần tử và thuộc tính của 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> thuộc tính

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

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

<Operation> phần tử

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

<Operation>Encode</Operation>

<IgnoreUnresolvedVariables> phần tử

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

<IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>

<User> phần tử

• Để 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 một dấu hai chấm trước Mã hoá Base64.
• Để giải mã, hãy chỉ định biến nơi ghi tên người dùng được giải mã.

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

Thuộc tính

<Password> phần tử

• Để mã hoá, hãy sử 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

<AssignTo> phần tử

Chỉ định biến mục tiêu cần đặt bằng giá trị được mã hoá hoặc giải mã do biến này tạo ra .

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

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

Thuộc tính

<Source> phần tử

Để giải mã, biến chứa chuỗi được mã hoá Base64, trong giá trị biểu mẫu 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 đượ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

Bản đồ giá trị chính Chính sách hoạt động