Criterio BasicAuthentication

Stai visualizzando la documentazione di Apigee Edge.
Vai alla sezione Documentazione di Apigee X. Informazioni

Cosa

Consente di utilizzare l'autenticazione di base leggera per sicurezza dell'ultimo miglio. Il criterio accetta un nome utente e una password, li codifica in Base64 e scrive come valore generato da una variabile. Il valore risultante è nel formato Basic Base64EncodedString. In genere questo valore viene scritto in un'intestazione HTTP, come l'intestazione Authorization

Il criterio consente inoltre di decodificare le credenziali archiviate in una stringa codificata Base64 in un nome utente e password.

Esempi

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

Informazioni sul criterio di autenticazione di base

Il criterio ha due modalità di funzionamento:

• Codifica: Base64 codifica un nome utente e una password memorizzati in variabili
• Decode: decodifica il nome utente e la password da un Stringa codificata Base64

Il nome utente e la password vengono comunemente memorizzati nell'archivio chiave/valore e quindi vengono letti dal di archiviazione di coppie chiave/valore al momento dell'attivazione. Per informazioni dettagliate sull'utilizzo dell'archivio chiavi-valore, consulta Operazioni della mappa valori-chiave .

Riferimento elemento

Il riferimento agli elementi descrive gli elementi e gli attributi dell'API 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> attributi

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

La tabella seguente descrive gli attributi comuni a tutti gli elementi principali del criterio:

<DisplayName> elemento

Da utilizzare in aggiunta all'attributo name per etichettare il criterio in editor proxy della UI di gestione con un nome diverso e in linguaggio naturale.

<DisplayName>Policy Display Name</DisplayName>

<Operation> elemento

Determina se il criterio Base64 codifica o decodifica le credenziali.

<Operation>Encode</Operation>

<IgnoreUnresolvedVariables> elemento

Se viene impostato su true, il criterio non genera un errore se una variabile non può essere risolto. Se utilizzata nel contesto di un criterio BasicAuthentication, in genere questa impostazione viene impostata a false perché generalmente è utile generare un errore se un nome utente o impossibile trovare password nelle variabili specificate.

<IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>

<User> elemento

• Per la codifica, utilizza l'elemento <User> per specificare la variabile contenente il nome utente. I valori del nome utente e della password sono concatenati con i due punti prima di Codifica Base64.
• Per la decodifica, specifica la variabile in cui è scritto il nome utente decodificato.

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

Attributi

<Password> elemento

• Per la codifica, utilizza l'elemento <Password> per specificare la variabile contenente la password.
• Per la decodifica, specifica la variabile in cui viene scritta la password decodificata.

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

Attributi

<AssignTo> elemento

Specifica la variabile target da impostare con il valore codificato o decodificato generato da questo .

L'esempio seguente indica che il criterio deve impostare Authorization intestazione del messaggio al valore generato:

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

Attributi

<Source> elemento

Per la decodifica, la variabile contenente la stringa codificata Base64, nel modulo Basic Base64EncodedString. Ad esempio: specificare request.header.Authorization, corrispondente all'intestazione Authorization.

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

Variabili di flusso

Quando il criterio non riesce, viene impostata la seguente variabile di flusso:

• BasicAuthentication.{policy_name}.failed (con valore true)

Messaggi di errore

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>

Schemi

Argomenti correlati

Mappa valori-chiave Norme relative alle operazioni