BasicAuthentication 政策

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

關於「基本驗證」政策

這項政策有兩種作業模式：

• 編碼：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 屬性外，一併使用 管理 UI Proxy 編輯器，使用不同的自然語言名稱。

<DisplayName>Policy Display Name</DisplayName>

<Operation>元素

決定政策 Base64 是否會對憑證進行編碼或解碼。

<Operation>Encode</Operation>

<IgnoreUnresolvedVariables>元素

設為 true 時，如果變數無法，則不會擲回錯誤 均已解決。如果用於基本驗證政策，通常會進行這項設定 對 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，對應 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>

結構定義

相關主題

鍵/值對應 作業政策