Podstawowe zasady uwierzytelniania

Wyświetlasz dokumentację Apigee Edge.
Przejdź do dokumentacji Apigee X. info

Co

Umożliwia korzystanie z uproszczonego podstawowego uwierzytelniania na potrzeby zabezpieczenia ostatniego etapu. Zasada pobiera nazwę użytkownika i hasło, koduje je w formacie Base64 i zapisuje wynikową wartość w zmiennej. Wynikowa wartość ma postać Basic Base64EncodedString. Zazwyczaj zapisujesz tę wartość w nagłówku HTTP, np. w nagłówku Authorization.

Zasada umożliwia też dekodowanie danych logowania przechowywanych w ciągu zakodowanym w formacie Base64 na nazwę użytkownika i hasło.

Przykłady

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

Informacje o zasadzie podstawowego uwierzytelniania

Zasada ma 2 tryby działania:

• Encode (Kodowanie): koduje nazwę użytkownika i hasło przechowywane w zmiennych w formacie Base64.
• Decode (Dekodowanie): dekoduje nazwę użytkownika i hasło z ciągu zakodowanego w formacie Base64.

Nazwa użytkownika i hasło są zwykle przechowywane w magazynie klucz-wartość, a następnie odczytywane z niego w czasie działania. Więcej informacji o korzystaniu z magazynu klucz-wartość znajdziesz w artykule Zasada operacji na mapach klucz-wartość policy.

Dokumentacja elementów

Dokumentacja elementów opisuje elementy i atrybuty zasady 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>

Atrybuty elementu <BasicAuthentication>

<BasicAuthentication async="false" continueOnError="false" enabled="true" name="Basic-Authentication-1">

W tej tabeli opisano atrybuty wspólne dla wszystkich elementów nadrzędnych zasad:

&lt;DisplayName&gt; element

Używaj oprócz atrybutu name do oznaczania zasady w edytor proxy interfejsu zarządzania z inną nazwą w języku naturalnym.

<DisplayName>Policy Display Name</DisplayName>

Element <Operation>

Określa, czy zasada ma kodować, czy dekodować dane logowania w formacie Base64.

<Operation>Encode</Operation>

Element <IgnoreUnresolvedVariables>

Jeśli ustawisz wartość true, zasada nie zgłosi błędu, jeśli nie będzie można rozpoznać zmiennej. W przypadku zasady BasicAuthentication to ustawienie jest zwykle ustawione na false ponieważ w przypadku nieznalezienia nazwy użytkownika lub hasła w określonych zmiennych zwykle korzystne jest zgłoszenie błędu.

<IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>

Element <User>

• W przypadku kodowania użyj elementu <User>, aby określić zmienną zawierającą nazwę użytkownika. Wartości nazwy użytkownika i hasła są łączone dwukropkiem przed zakodowaniem w formacie Base64.
• W przypadku dekodowania określ zmienną, w której ma zostać zapisana zdekodowana nazwa użytkownika.

<User ref="credentials.username" /> 

Atrybuty

Element <Password>

• W przypadku kodowania użyj elementu <Password>, aby określić zmienną zawierającą hasło.
• W przypadku dekodowania określ zmienną, w której ma zostać zapisane zdekodowane hasło.

<Password ref="credentials.password" />

Atrybuty

Element <AssignTo>

W przypadku operacji Encode określa zmienną docelową, w której ma zostać ustawiona zakodowana wartość wygenerowana przez tę zasadę.

Ten przykład pokazuje, że zasada powinna ustawić nagłówek Authorization wiadomości na wygenerowaną wartość:

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

Atrybuty

Element <Source>

W przypadku dekodowania zmienna zawierająca ciąg zakodowany w formacie Base64 w postaci Basic Base64EncodedString. Na przykład, określ request.header.Authorization, co odpowiada nagłówkowi Authorization.

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

Zmienne przepływu

Gdy zasada się nie powiedzie, ustawiana jest ta zmienna przepływu:

• BasicAuthentication.{policy_name}.failed (z wartością true)

Dokumentacja błędów

W tej sekcji opisano kody błędów i komunikaty o błędach, które są zwracane, oraz zmienne błędów ustawiane przez Edge, gdy ta zasada wyzwala błąd. Warto o tym wiedzieć, jeśli rozwijasz reguły błędów, aby obsługi błędów. Więcej informacji znajdziesz w artykule Co musisz wiedzieć o błędach związanych z zasadami i postępowaniu z błędami

Błędy w czasie wykonywania

Te błędy mogą wystąpić podczas wykonywania zasady.

Błędy wdrażania

Te błędy mogą wystąpić podczas wdrażania serwera proxy zawierającego tę zasadę.

Zmienne błędów

Te zmienne są ustawiane po wystąpieniu błędu działania. Więcej informacji znajdziesz w artykule Podstawowe informacje o błędach związanych z naruszeniem zasad.

Przykładowa odpowiedź na błąd

{  
   "fault":{  
      "detail":{  
         "errorcode":"steps.basicauthentication.UnresolvedVariable"
      },
      "faultstring":"Unresolved variable : request.queryparam.password"
   }
}

Przykładowa reguła błędu

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

Schematy

Powiązane artykuły

Zasada operacji na mapach klucz-wartość