Podstawowe zasady uwierzytelniania

Przeglądasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. Informacje

Co

Umożliwia użycie lekkiego uwierzytelniania podstawowego, które zapewnia najwyższy poziom bezpieczeństwa. Zasada pobiera nazwę użytkownika i hasło, koduje je w standardzie Base64 i zapisuje wynikową wartość w zmiennej. Wynikowa wartość ma postać Basic Base64EncodedString. Tę wartość zwykle zapisuje się w nagłówku HTTP, np. w nagłówku Authorization.

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

Sample

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

Informacje o zasadach uwierzytelniania podstawowego

Zasada ma 2 tryby działania:

• Kodowanie: Base64 koduje nazwę użytkownika i hasło przechowywane w zmiennych
• Dekoduj: dekoduje nazwę użytkownika i hasło z ciągu zakodowanego w standardzie Base64.

Nazwa użytkownika i hasło są zwykle przechowywane w magazynie par klucz-wartość, a następnie odczytywane z magazynu w czasie działania. Więcej informacji o używaniu magazynu klucz-wartość znajdziesz w zasadach operacji mapowania par klucz-wartość.

Odwołanie do elementu

Dokumentacja elementów opisuje elementy i atrybuty zasady uwierzytelniania podstawowego.

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

Atrybuty <podstawowe uwierzytelnianie>

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

Tabela poniżej zawiera opis atrybutów wspólnych dla wszystkich elementów nadrzędnych zasad:

Element <DisplayName>

Użyj oprócz atrybutu name, aby oznaczyć zasadę w edytorze serwera proxy interfejsu zarządzania inną nazwą w języku naturalnym.

<DisplayName>Policy Display Name</DisplayName>

Element <Operation>

Określa, czy zasada Base64 koduje, czy dekoduje dane logowania.

<Operation>Encode</Operation>

Element <IgnorujNierozpoznane zmienne>

Gdy ma wartość true, zasada nie zgłasza błędu, jeśli nie można znaleźć zmiennej. Jeśli to ustawienie jest używane w kontekście zasady uwierzytelniania podstawowego, to ustawienie ma zwykle wartość false, ponieważ zalecane jest zgłoszenie błędu, gdy w podanych zmiennych nie można znaleźć nazwy użytkownika lub hasła.

<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ą połączone dwukropkiem przed kodowaniem Base64.
• Na potrzeby dekodowania podaj zmienną, w której zapisana jest zdekodowana nazwa użytkownika.

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

Atrybuty

Element <Password>

• W przypadku kodowania użyj elementu <Password>, aby określić zmienną zawierającą hasło.
• Na potrzeby dekodowania podaj zmienną, w której zapisywane jest zdekodowane hasło.

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

Atrybuty

Element <AssignTo>

Określa zmienną docelową do ustawienia zakodowaną lub zdekodowaną wartością wygenerowaną przez tę zasadę.

Ten przykład wskazuje, że zasada powinna ustawić wygenerowaną wartość w nagłówku Authorization wiadomości:

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

Atrybuty

Element <Source>

Do dekodowania: zmienna zawierająca ciąg zakodowany w standardzie Base64 w formacie Basic Base64EncodedString. Na przykład wpisz request.header.Authorization, odpowiadający nagłówekowi Authorization.

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

Zmienne przepływu

W przypadku niepowodzenia zasady ustawiana jest ta zmienna przepływu:

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

Informacje o błędach

W tej sekcji opisujemy kody błędów i komunikaty o błędach, które są zwracane, oraz zmienne błędów ustawiane przez Edge, gdy ta zasada wywołuje błąd. Te informacje są ważne, jeśli opracowujesz reguły błędów do obsługi błędów. Więcej informacji znajdziesz w sekcjach Co musisz wiedzieć o błędach zasad i Postępowanie w przypadku błędów.

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 te zasady.

Zmienne błędów

Te zmienne są ustawiane, gdy wystąpi błąd środowiska wykonawczego. Więcej informacji znajdziesz w artykule Co musisz wiedzieć 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 związanych z mapą klucz-wartość