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 chế độ Xác thực cơ bản gọn nhẹ để bảo mật bước cuối. 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 giá trị này và ghi giá trị kết quả vào một biến. Giá trị thu được có dạng Basic Base64EncodedString. Bạn thường ghi giá trị này vào một tiêu đề HTTP, chẳng hạn như tiêu đề Authorize (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 đượ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á: Base64 mã hoá 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ữ vào kho khoá/giá trị, sau đó được đọc từ kho lưu trữ 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ị, vui lòng xem Chính sách về hoạt động ánh xạ 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 chính sách BasicConfirm.

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

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

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

Phần tử <DisplayName>

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

<DisplayName>Policy Display Name</DisplayName>

Phần tử <Operation>

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

<Operation>Encode</Operation>

Phần tử <IgnoreUnresolvedVariables>

Khi bạn đặt thành true, chính sách này sẽ không báo lỗi nếu không thể phân giải một biến. Khi được sử dụng trong ngữ cảnh của chính sách Basicxác thực, chế độ cài đặt này thường được đặt thành false vì thường sẽ có lợi cho việc báo 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.

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

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

Thuộc tính

Phần tử <Password>

• Để 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 viết.

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

Thuộc tính

Phần tử <assignTo>

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

Ví dụ sau đây cho biết rằng chính sách nên đặ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 mã hoá Base64, ở dạng Basic Base64EncodedString. Ví dụ: chỉ định request.header.Authorization, tương ứng với tiêu đề Authorize (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 này không thành công:

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

Tham chiếu lỗi

Phần này mô tả các mã lỗi và thông báo lỗi được trả về, cũng như các biến lỗi do Edge đặt khi chính sách này kích hoạt lỗi. Đây là thông tin quan trọng mà bạn cần biết nếu đang phát triển các quy tắc lỗi để xử lý lỗi. Để tìm hiểu thêm, hãy xem Những điều bạn cần biết về lỗi chính sách và Xử lý lỗi.

Lỗi thời gian chạy

Những lỗi này có thể xảy ra khi thực thi chính sách.

Lỗi triển khai

Những lỗi này có thể xảy ra khi bạn triển khai proxy chứa chính sách này.

Biến lỗi

Các biến này được đặt khi xảy ra lỗi thời gian chạy. Để biết thêm thông tin, hãy xem Những điều bạn cần biết về lỗi chính sách.

Ví dụ về phản hồi lỗi

{  
   "fault":{  
      "detail":{  
         "errorcode":"steps.basicauthentication.UnresolvedVariable"
      },
      "faultstring":"Unresolved variable : request.queryparam.password"
   }
}

Ví dụ về quy tắc lỗi

<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ề hoạt động của bản đồ giá trị chính