BasicAuthentication 정책

<ph type="x-smartling-placeholder"></ph> 현재 Apigee Edge 문서를 보고 있습니다.
Apigee X 문서. 정보

대상

라스트 마일 보안의 경우 경량 기본 인증을 사용할 수 있습니다. 정책은 사용자 이름과 비밀번호를 사용하고, Base64는 이를 인코딩하고, 결과 값을 변수에 작성합니다. 결과 값은 Basic Base64EncodedString 형식입니다. 이 값은 일반적으로 Authorization 헤더와 같이 HTTP 헤더에 작성됩니다.

이 정책을 사용하면 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 프록시 편집기의 정책에 다른 자연어 이름으로 라벨을 지정합니다.

<DisplayName>Policy Display Name</DisplayName>

<Operation> 요소

정책이 사용자 인증 정보를 Base64로 인코딩 또는 디코딩할지 결정합니다.

<Operation>Encode</Operation>

<IgnoreUnresolvedVariables> 요소

true로 설정하면 변수를 확인할 수 없는 경우 정책에서 오류를 생성하지 않습니다. BasicAuthentication 정책의 컨텍스트에서 사용되는 경우 일반적으로 이는 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을 지정합니다.

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

스키마

관련 주제

키 값 맵 작업 정책