Базовая политика аутентификации

Вы просматриваете документацию Apigee Edge .
Перейдите в документацию Apigee X.info

Что

Позволяет использовать облегченную базовую аутентификацию для обеспечения безопасности на последнем этапе. Политика принимает имя пользователя и пароль, кодирует их в Base64 и записывает полученное значение в переменную. Полученное значение имеет формат Basic Base64EncodedString . Обычно это значение записывается в заголовок HTTP, например, в заголовок Authorization .

Данная политика также позволяет декодировать учетные данные, хранящиеся в строке, закодированной в Base64, в имя пользователя и пароль.

Образцы

<BasicAuthentication name="ApplyBasicAuthHeader">
   <DisplayName>ApplyBasicAuthHeader</DisplayName>
   <Operation>Encode</Operation>
   <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
   <User ref="credentials.username" />
   <Password ref="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 кодирует имя пользователя и пароль, хранящиеся в переменных.
• Decode : Декодирует имя пользователя и пароль из строки, закодированной в 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="credentials.username" />
   <Password ref="credentials.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 , чтобы пометить политику в редакторе прокси-сервера пользовательского интерфейса управления другим именем на естественном языке.

<DisplayName>Policy Display Name</DisplayName>

Элемент <Операция>

Определяет, будет ли политика кодировать или декодировать учетные данные в формате Base64.

<Operation>Encode</Operation>

элемент <IgnoreUnresolvedVariables>

Если установить значение true , политика не будет выдавать ошибку, если переменная не может быть разрешена. При использовании в контексте политики BasicAuthentication этот параметр обычно устанавливается в false поскольку, как правило, выгодно выдавать ошибку, если имя пользователя или пароль не найдены в указанных переменных.

<IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>

элемент <Пользователь>

• Для кодирования используйте элемент <User> , чтобы указать переменную, содержащую имя пользователя. Значения имени пользователя и пароля объединяются с помощью двоеточия перед кодированием Base64.
• Для декодирования укажите переменную, в которую записано декодированное имя пользователя.

<User ref="credentials.username" /> 

Атрибуты

<Пароль> элемент

• Для кодировки используйте элемент <Password> , чтобы указать переменную, содержащую пароль.
• Для декодирования укажите переменную, в которую будет записан декодированный пароль.

<Password ref="credentials.password" />

Атрибуты

элемент <AssignTo>

Для операции Encode указывается целевая переменная, которой будет присвоено закодированное значение, сгенерированное данной политикой.

Следующий пример показывает, что политика должна установить заголовок Authorization сообщения в сгенерированное значение:

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

Атрибуты

<Исходный> элемент

Для декодирования используется переменная, содержащая закодированную в Base64 строку, в формате Basic Base64EncodedString . Например, укажите request.header.Authorization , соответствующую заголовку Authorization .

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

Переменные потока

При сбое политики устанавливается следующая переменная потока:

• BasicAuthentication.{policy_name}.failed (with a value true)

Ссылка на ошибку

В этом разделе описаны коды ошибок и сообщения об ошибках, которые возвращаются, а также переменные ошибок, которые устанавливаются Edge, когда эта политика вызывает ошибку. Эту информацию важно знать, если вы разрабатываете правила обработки ошибок. Дополнительные сведения см. в разделах Что нужно знать об ошибках политики и Обработка ошибок .

Ошибки выполнения

Эти ошибки могут возникать при выполнении политики.

Ошибки развертывания

Эти ошибки могут возникнуть при развертывании прокси-сервера, содержащего эту политику.

Переменные неисправности

Эти переменные устанавливаются при возникновении ошибки во время выполнения. Дополнительные сведения см. в разделе Что нужно знать об ошибках политики .

Пример ответа об ошибке

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

Схемы

Связанные темы

Политика операций по созданию карты ключевых значений