Podstawowe zasady uwierzytelniania

Przeglądasz dokumentację Apigee Edge.
Przejdź do Dokumentacja Apigee X. informacje.

Co

Umożliwia korzystanie z prostego uwierzytelniania podstawowego w bezpieczeństwa na ostatnim etapie. Zasada pobiera nazwę użytkownika i hasło, koduje je w Base64 i zapisuje wynikową wartość do zmiennej. Wynikowa wartość ma postać Basic Base64EncodedString. Wartość ta jest zazwyczaj zapisywana w nagłówku HTTP, jak nagłówka Authorization

Ta zasada umożliwia też dekodowanie danych logowania przechowywanych w ciągu zakodowanym w standardzie Base64 jako nazwy użytkownika i hasło.

Przykłady

<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 może działać w 2 trybach:

• Kodowanie: Base64 koduje nazwę użytkownika i hasło zapisane w zmienne
• Dekoduj: dekoduje nazwę użytkownika i hasło z Ciąg znaków zakodowany w standardzie Base64

Nazwa użytkownika i hasło są zwykle przechowywane w magazynie par klucz-wartość i są odczytywane z wartości w magazynie pary klucz-wartość w czasie działania. Szczegółowe informacje na temat korzystania z magazynu par klucz-wartość znajdziesz w artykule Operacje na mapie klucz-wartość .

Odwołanie do elementu

Dokumentacja elementu opisuje elementy i atrybuty uwierzytelniania 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> atrybuty

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

The following table describes attributes that are common to all policy parent elements:

<DisplayName> element

Use in addition to the name attribute to label the policy in the management UI proxy editor with a different, natural-language name.

<DisplayName>Policy Display Name</DisplayName>

&lt;Operation&gt; element

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

<Operation>Encode</Operation>

&lt;IgnoreUnresolvedVariables&gt; element

Gdy ustawisz wartość true, zasada nie zwróci błędu, jeśli zmiennej nie można . Gdy to ustawienie jest używane w kontekście zasady uwierzytelniania podstawowego, to ustawienie jest zwykle ustawiane do false, ponieważ zwykle warto zgłosić błąd w przypadku nazwy użytkownika lub nie można znaleźć hasła w podanych zmiennych.

<IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>

&lt;User&gt; element

• Do kodowania użyj elementu <User>, aby określić zmienną zawierający nazwę użytkownika. Wartości nazwy użytkownika i hasła są połączone dwukropkiem przed Kodowanie Base64.
• Na potrzeby dekodowania określ zmienną, w której jest zapisywana zdekodowana nazwa użytkownika.

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

Atrybuty

&lt;Password&gt; element

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

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

Atrybuty

&lt;AssignTo&gt; element

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

Poniższy przykład wskazuje, że zasada powinna ustawiać Authorization nagłówka wiadomości do wygenerowanej wartości:

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

Atrybuty

&lt;Source&gt; element

Do dekodowania zmienna zawierająca ciąg zakodowany algorytmem Base64 w elemencie formularz Basic Base64EncodedString. Przykład: wpisz request.header.Authorization, co odpowiada nagłówkowi Authorization.

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

Zmienne przepływu

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

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

Informacje o błędzie

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>

Schematy

Powiązane artykuły

Mapa par klucz-wartość Zasada operacji