BasicAuthentication ポリシー

このページの内容は Apigee と Apigee ハイブリッドに該当します。

Apigee Edge のドキュメントを表示する。

概要

ラストワンマイルセキュリティに軽量の基本認証を使用できます。このポリシーは、ユーザー名とパスワードを取得し、Base64 でエンコードして、生成された値を変数に書き込みます。生成された値の形式は Basic Base64EncodedString です。この値は一般に、HTTP ヘッダー（Authorization ヘッダーなど）に書き込まれます。

このポリシーでは、Base64 でエンコードされた文字列に保存された認証情報をユーザー名とパスワードにデコードすることもできます。

このポリシーは拡張可能なポリシーです。Apigee ライセンスによっては、このポリシーの使用によって費用や使用量に影響する場合があります。ポリシータイプと使用量への影響については、ポリシータイプをご覧ください。

動画: この動画では、基本認証ポリシーを使用して、ユーザー名とパスワードを Base64 でエンコードする方法を実演しています。

動画: この動画では、基本認証ポリシーを使用して、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>

上記のサンプルポリシーの構成では、エンコードするユーザー名とパスワードは <User> 要素と <Password> 要素の ref 属性で指定された変数から取得されます。これらの変数はポリシーの実行前に設定されている必要があります。一般に、変数には Key-Value マップから読み取られた値が挿入されます。KeyValueMapOperations ポリシーをご覧ください。

この構成では、Authorization という名前の HTTP ヘッダーが <AssignTo> 要素で指定され、バックエンドサーバーに送信されるアウトバウンドリクエストメッセージに追加されます。

Authorization: Basic TXlVc2VybmFtZTpNeVBhc3N3b3Jk

<User> と <Password> の値は、コロンで連結されてから Base64 でエンコードされます。

次のエントリを持つ Key-Value マップがあるとします。

{
  "encrypted" : true,
  "entry" : [ {
    "name" : "username",
    "value" : "MyUsername
  }, {
    "name" : "password",
    "value" : "MyPassword
  } ],
  "name" : "BasicAuthCredentials"
}

BasicAuthentication ポリシーの前に次の KeyValueMapOperations ポリシーを配置して、Key-Value ストアから <User> 要素と <Password> 要素の値を抽出し、変数 credentials.username と credentials.password に入力します。

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

このポリシーサンプルでは、Authorization HTTP ヘッダーのユーザー名とパスワードが <Source> 要素で指定されたとおりにデコードされます。Base64 でエンコードされた文字列は、Basic Base64EncodedString. という形式である必要があります。

このポリシーでは、デコードされたユーザー名は request.header.username 変数、デコードされたパスワードは request.header.password 変数にそれぞれ書き込まれます。

BasicAuthentication ポリシーについて

このポリシーには次の 2 つの操作モードがあります。

エンコード: 変数に格納されるユーザー名とパスワードを Base64 でエンコードします。
デコード: Base64 でエンコードされた文字列からユーザー名とパスワードをデコードします。

通常、ユーザー名とパスワードは、Key-Value ストアに格納され、ランタイム時に Key-Value ストアから読み取られます。Key-Value ストアの使用について詳しくは、KeyValueMapOperations ポリシーをご覧ください。

要素リファレンス

要素リファレンスでは、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">

次の表に、すべてのポリシーの親要素に共通する属性を示します。

属性	説明	デフォルト	要否
`name`	ポリシーの内部名。`name` 属性の値には、英字、数字、スペース、ハイフン、アンダースコア、ピリオドを使用できます。この値は 255 文字を超えることはできません。管理 UI プロキシエディタで `<DisplayName>` 要素を追加して、ポリシーのラベルに使用する別の自然言語名を指定することもできます。	なし	必須
`continueOnError`	ポリシーが失敗したときにエラーを返す場合は、`false` に設定します。これは、ほとんどのポリシーで想定される動作です。ポリシーが失敗した後もフローの実行を続行する場合は、`true` に設定します。関連項目: 障害ルールはエラー状態の場合にのみトリガーされる（continueOnError について）現在のフローにおける障害処理	false	省略可
`enabled`	ポリシーを適用するには、`true` に設定します。ポリシーを無効にするには、`false` に設定します。ポリシーがフローに接続されている場合でも適用されません。	true	省略可
`async`	この属性は非推奨となりました。	false	非推奨

<DisplayName> 要素

管理 UI プロキシエディタで name 属性と一緒に使用して、ポリシーのラベルに使用する自然言語名を指定します。

<DisplayName>Policy Display Name</DisplayName>

デフォルト

デフォルト	なしこの要素を省略した場合、ポリシーの `name` 属性の値が使用されます。
要否	省略可
タイプ	文字列

なし

この要素を省略した場合、ポリシーの name 属性の値が使用されます。

要否省略可

タイプ文字列

<Operation> 要素

認証情報を Base64 エンコードまたは Base64 デコードするかどうかを指定します。

<Operation>Encode</Operation>

デフォルト:

なし

要否:

必須

型:

文字列。

有効な値は次のとおりです。

Encode
Decode

<IgnoreUnresolvedVariables> 要素

true に設定すると、変数を解決できない場合でもポリシーはエラーを返しません。BasicAuthentication ポリシーのコンテキストで使用される場合、この値は通常、指定された変数にユーザー名またはパスワードが格納されていない場合にエラーを返すために、false に設定されます。

<IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>

デフォルト:	true
プレゼンス:	省略可
型:	ブール値

<User> 要素

エンコードの場合は、<User> 要素を使用してユーザー名を含む変数を指定します。ユーザー名とパスワードの値は、コロンで連結されてから、Base64 でエンコードされます。
デコードの場合は、デコードされたユーザー名が書き込まれる変数を指定します。

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

デフォルト:	なし
要否:	必須
型:	なし

属性

属性	説明	デフォルト	プレゼンス
ref	ポリシーが動的にユーザー名を読み取る変数（エンコードの場合）またはユーザー名を書き込む変数（デコードの場合）。	なし	必須

<Password> 要素

エンコードの場合は、<Password> 要素を使用してパスワードを含む変数を指定します。
デコードの場合は、デコードされたパスワードが書き込まれる変数を指定します。

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

デフォルト:	なし
要否:	必須
型:	なし

属性

属性	説明	デフォルト	プレゼンス
ref	ポリシーが動的にパスワードを読み取る変数（エンコードの場合）またはパスワードを書き込む変数（デコードの場合）。	なし	必須

<AssignTo> 要素

このポリシーで生成されたエンコード値またはデコード値を設定する際のターゲットの変数を指定します。

次の例は、ポリシーによってメッセージの Authorization ヘッダーが生成された値に設定されることを示しています。

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

デフォルト:	なし
要否:	必須
型:	文字列

属性

属性	説明	デフォルト	要否
createNew	変数がすでに設定されている場合に、その変数を上書きするかどうかを指定します。 false の場合、変数への割り当ては、変数が現在設定されていない（値が NULL）場合にのみ行われます。 true の場合は、常に変数の割り当てが行われます。この値は通常、false（デフォルト）に設定します。	false	省略可

説明

デフォルト

要否

createNew

変数がすでに設定されている場合に、その変数を上書きするかどうかを指定します。

false の場合、変数への割り当ては、変数が現在設定されていない（値が NULL）場合にのみ行われます。

true の場合は、常に変数の割り当てが行われます。

この値は通常、false（デフォルト）に設定します。

false

省略可

<Source> 要素

デコードの場合は、Base64 でエンコードされた文字列を含む変数（形式: Basic Base64EncodedString）。たとえば、Authorization ヘッダーに対応して request.header.Authorization を指定します。

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

デフォルト:	なし
要否:	デコード操作の場合は必須。
型:	なし

フロー変数

ポリシーが失敗した場合は、次のフロー変数が設定されます。

BasicAuthentication.{policy_name}.failed（値が true の場合）

エラーリファレンス

このセクションでは、このポリシーによってエラーがトリガーされたときに返される障害コードとエラーメッセージ、Apigee によって設定される障害変数について説明します。これは、エラーに対処する障害ルールを作成するうえで重要な情報です。詳細については、ポリシーエラーについて知っておくべきことと障害の処理をご覧ください。

ランタイムエラー

このエラーは、ポリシーの実行時に発生することがあります。

障害コード	HTTP ステータス	原因	修正
`steps.basicauthentication.InvalidBasicAuthenticationSource`	`500`	デコードで、`Base64` エンコードされた文字列に有効な値が含まれていない場合、またはヘッダーの形式が正しくない場合（たとえば、`Basic` で始まっていない場合）。
`steps.basicauthentication.UnresolvedVariable`	`500`	デコードまたはエンコードに必要なソース変数が存在しません。このエラーは、`IgnoreUnresolvedVariables` が false の場合にのみ発生する可能性があります。

デプロイエラー

以下のエラーは、このポリシーを含むプロキシをデプロイするときに発生することがあります。

エラー名	発生条件	修正
`UserNameRequired`	名前付きオペレーションに `<User>` 要素が存在する必要があります。
`PasswordRequired`	名前付きオペレーションに `<Password>` 要素が存在する必要があります。
`AssignToRequired`	名前付きオペレーションに `<AssignTo>` 要素が存在する必要があります。
`SourceRequired`	名前付きオペレーションに `<Source>` 要素が存在する必要があります。

障害変数

ランタイムエラーが発生すると、次の変数が設定されます。詳細については、ポリシーエラーについて知っておくべきことをご覧ください。

変数	説明	例
`fault.name="fault_name"`	`fault_name` は、上記のランタイムエラーの表に記載されている障害の名前です。障害名は、障害コードの最後の部分です。	`fault.name Matches "UnresolvedVariable"`
`BasicAuthentication.policy_name.failed`	`policy_name` は、障害が発生したポリシーのユーザー指定の名前です。	`BasicAuthentication.BA-Authenticate.failed = true`

エラーレスポンスの例

注: ベストプラクティスとして、エラー処理でエラーレスポンスの errorcode の部分をトラップすることをおすすめします。faultstring のテキストには依存しないでください。この部分は変更される可能性があります。

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

BasicAuthentication ポリシー

概要

サンプル

アウトバウンドエンコード

インバウンドデコード

BasicAuthentication ポリシーについて

要素リファレンス

<BasicAuthentication> 属性

<DisplayName> 要素

<Operation> 要素

<IgnoreUnresolvedVariables> 要素

<User> 要素

属性

<Password> 要素

属性

<AssignTo> 要素

属性

<Source> 要素

フロー変数

エラーリファレンス

ランタイムエラー

デプロイエラー

障害変数

エラーレスポンスの例

障害ルールの例

スキーマ

関連トピック

BasicAuthentication ポリシー

概要

サンプル

アウトバウンド エンコード

インバウンド デコード

BasicAuthentication ポリシーについて

要素リファレンス

<BasicAuthentication> 属性

<DisplayName> 要素

<Operation> 要素

<IgnoreUnresolvedVariables> 要素

<User> 要素

属性

<Password> 要素

属性

<AssignTo> 要素

属性

<Source> 要素

フロー変数

エラー リファレンス

ランタイム エラー

デプロイエラー

障害変数

エラー レスポンスの例

障害ルールの例

スキーマ

関連トピック

アウトバウンドエンコード

インバウンドデコード

エラーリファレンス

ランタイムエラー

エラーレスポンスの例