Правила 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="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.
• Декодировать. Декодирует имя пользователя и пароль из строки в кодировке 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>

Элемент <Operation>

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

<Operation>Encode</Operation>

Элемент <IgnoreUnresolvedVariables>

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

<IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>

Элемент <User>

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

<User ref="credentials.username" /> 

Атрибуты

Элемент <Password>

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

<Password ref="credentials.password" />

Атрибуты

Элемент <AssignTo>

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

В примере ниже показано, что правило должно задать для заголовка 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)

Справочник по ошибкам

В этом разделе описаны коды ошибок и сообщения об ошибках, которые возвращаются, а также переменные ошибок, которые задаются 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>

Схемы

Статьи по теме

Правила использования карт ключей-значений