Criterio OAuthV2

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

Cosa

OAuthV2 è un criterio sfaccettato per eseguire operazioni relative ai tipi di autorizzazione OAuth 2.0. Questo è il criterio primario utilizzato per configurare gli endpoint OAuth 2.0 su Apigee Edge.

Suggerimento: per saperne di più su OAuth su Apigee Edge, consulta alla home page di OAuth. Fornisce link alle risorse, agli esempi, ai video e altro ancora. Vedi le funzioni avanzate Esempio di OAuth su GitHub per una buona dimostrazione di come questo criterio viene utilizzato in un ambiente un'applicazione.

Campioni

<OAuthV2 async="false" continueOnError="false" enabled="true" name="OAuth-v20-2">
    <DisplayName>OAuth v2.0 2</DisplayName>
    <Operation>VerifyAccessToken</Operation>
    <AccessTokenPrefix>Bearer</AccessTokenPrefix> <!-- Optional, default is Bearer -->
</OAuthV2>

$ curl -H "Authorization: Bearer ylSkZIjbdWybfsUQe9BqP0LH5Z" http://{org_name}-test.apigee.net/weather/forecastrss?w=12797282

<OAuthV2 enabled="true" continueOnError="false" async="false" name="generateAccessToken">
    <Operation>GenerateAccessToken</Operation>
    <AppEndUser>Doe</AppEndUser>
    <UserName>jdoe</UserName>
    <PassWord>jdoe</PassWord>
    <GrantType>grant_type</GrantType>
    <ClientId>a_valid_client_id</ClientId>
    <SupportedGrantTypes>
        <GrantType>password</GrantType>
    </SupportedGrantTypes>
</OAuthV2>

var client_id = context.getVariable("local_clientid");
var client_secret = context.getVariable("local_secret");
context.setVariable("request.header.Authorization","Basic "+CryptoJS.enc.Base64.stringify(CryptoJS.enc.Latin1
                                      .parse(client_id + ':' + client_secret)));

Consulta anche "Codifica di base credenziali di autenticazione".

Riferimento dell'elemento

Il riferimento al criterio descrive gli elementi e gli attributi del criterio OAuthV2.

Il criterio di esempio mostrato di seguito è una delle tante configurazioni possibili. Questo esempio mostra un Criterio OAuthV2 configurato per l'operazioneGenerateAccessToken. Comprende i campi obbligatori e elementi facoltativi. Per maggiori dettagli, consulta le descrizioni degli elementi in questa sezione.

<OAuthV2 name="GenerateAccessToken">
  <!-- This policy generates an OAuth 2.0 access token using the client_credentials grant type -->
  <Operation>GenerateAccessToken</Operation>
  <!-- This is in millseconds, so expire in an hour -->
  <ExpiresIn>3600000</ExpiresIn>
  <SupportedGrantTypes>
    <GrantType>client_credentials</GrantType>
  </SupportedGrantTypes>
  <GrantType>request.queryparam.grant_type</GrantType>
  <GenerateResponse/>
</OAuthV2>

<OAuthV2> attributi

<OAuthV2 async="false" continueOnError="false" enabled="true" name="MyOAuthPolicy">

La tabella seguente descrive gli attributi comuni a tutti gli elementi principali dei criteri:

Elemento <DisplayName>

Utilizzalo in aggiunta all'attributo name per etichettare il criterio nell'editor proxy dell'interfaccia utente di gestione con un nome diverso in linguaggio naturale.

<DisplayName>Policy Display Name</DisplayName>

&lt;AccessToken&gt; elemento

<AccessToken>request.header.access_token</AccessToken>

Per impostazione predefinita, VerifyAccessToken prevede che il token di accesso venga inviato nel Authorization intestazione. Puoi modificare il valore predefinito utilizzando questo elemento. Per L'esempio request.queryparam.access_token indica che il token di accesso deve essere presente come un parametro di query denominato access_token.

curl https://myorg-myenv.apigee.net/oauth2/validate -H "access_token:Rft3dqrs56Blirls56a"

curl "https://myorg-myenv.apigee.net/oauth2/validate?access_token:Rft3dqrs56Blirls56a"

&lt;AccessTokenPrefix&gt; elemento

<AccessTokenPrefix>Bearer</AccessTokenPrefix>

Per impostazione predefinita, VerifyAccessToken prevede che il token di accesso venga inviato in un'intestazione Autorizzazione come token di connessione. Ad esempio:

-H "Authorization: Bearer Rft3dqrs56Blirls56a"

Attualmente, l'unico prefisso supportato è Bearer.

&lt;AppEndUser&gt; elemento

<AppEndUser>request.queryparam.app_enduser</AppEndUser>

Nei casi in cui l'ID utente finale dell'app deve essere inviato al server di autorizzazione, questo elemento consente specifichi dove Edge deve cercare l'ID utente finale. Ad esempio, potrebbe essere inviato come query o in un'intestazione HTTP.

Ad esempio request.queryparam.app_enduser indica che AppEndUser deve essere presente come parametro di query, ad esempio ad esempio ?app_enduser=ntesla@theramin.com. Per richiedere AppEndUser in un messaggio HTTP ad esempio, imposta questo valore su request.header.app_enduser.

Se fornisci questa impostazione, puoi includere un ID utente finale dell'app nel token di accesso. Questo è utile se vuoi poter recuperare o revocare i token di accesso OAuth 2.0 entro ID utente. Per ulteriori informazioni, vedi Abilita il recupero e la revoca dei token di accesso OAuth 2.0 per ID utente finale, ID app o entrambi.

&lt;Attributes/Attribute&gt;

<Attributes>
    <Attribute name="attr_name1" ref="flow.variable" display="true|false">value1</Attribute>
    <Attribute name="attr_name2" ref="flow.variable" display="true|false">value2</Attribute>
</Attributes>

Utilizza questo elemento per aggiungere attributi personalizzati a un token di accesso o a un codice di autorizzazione. Per Ad esempio, potresti voler incorporare un ID utente o un identificatore di sessione in un token di accesso che può essere vengono estratti e controllati durante il runtime.

Questo elemento consente di specificare un valore in una variabile di flusso o da una stringa letterale. Se specificare sia una variabile sia una stringa, viene utilizzato il valore specificato nella variabile di flusso. Se non può essere risolta, la stringa è quella predefinita.

Per ulteriori informazioni sull'uso di questo elemento, consulta Personalizzazione di token e Codici di autorizzazione.

Mostrare o nascondere gli attributi personalizzati nel risposta

Ricorda che se imposti l'elemento CreateResponse di questo criterio su true, la rappresentazione JSON completa del token viene restituita nella risposta, incluse le eventuali che hai impostato. In alcuni casi, potresti voler nascondere alcuni o tutti i tuoi nella risposta in modo che non siano visibili alle app client.

Per impostazione predefinita, gli attributi personalizzati vengono visualizzati nella risposta. Se vuoi nasconderli, puoi impostare Il parametro display diventa false. Ad esempio:

<Attributes>
    <Attribute name="employee_id" ref="employee.id" display="false"/>
    <Attribute name="employee_name" ref="employee.name" display="false"/>
</Attributes>

Il valore dell'attributo display non è persistenti. Supponiamo di generare un token di accesso con attributi personalizzati che vuoi nascondere nel generata. L'impostazione di display=false consente di raggiungere l'obiettivo. Tuttavia, se un nuovo viene generato in un secondo momento utilizzando un token di aggiornamento, ovvero gli attributi personalizzati originali Il token di accesso verrà visualizzato nella risposta del token di aggiornamento. Questo perché Edge non ricorda che l'attributo display era originariamente impostato su false nel criterio di generazione del token di accesso, è semplicemente parte dei metadati del token di accesso.

Il comportamento sarà lo stesso se aggiungi attributi personalizzati a un codice di autorizzazione, quando il token di accesso generato utilizzando questo codice. Gli attributi personalizzati verranno visualizzati nel token di accesso risposta. Anche in questo caso, potrebbe non essere il comportamento previsto.

Per nascondere i segmenti di pubblico in questi casi, hai le seguenti opzioni:

• Reimposta in modo esplicito gli attributi personalizzati nel criterio del token di aggiornamento e impostane la visualizzazione su false. In questo caso, potresti dover recuperare i valori personalizzati originali di accesso a un token usando il criterio GetOAuthV2Info.
• Utilizza un criterio JavaScript di post-elaborazione per estrarre manualmente gli attributi personalizzati che non che vuoi vedere nella risposta.

Vedi anche Personalizzazione di token e Codici di autorizzazione.

&lt;ClientId&gt; elemento

<ClientId>request.formparam.client_id</ClientId>

In alcuni casi, l'app client deve inviare l'ID client al server di autorizzazione. Questo consente di specificare dove Edge deve cercare l'ID client. L'unico valore la località che puoi impostare è quella predefinita posizione, la variabile di flusso request.formparam.client_id. Impostazione di ClientId a qualsiasi altra variabile non è supportato. Vedi anche Richiesta di token di accesso e autorizzazione .

&lt;Code&gt; elemento

<Code>request.queryparam.code</Code>

Nel flusso del tipo di concessione dell'autorizzazione, il client deve inviare un codice di autorizzazione alla di autorizzazione (Apigee Edge). Questo elemento consente di specificare dove Edge deve cercare codice di autorizzazione. Ad esempio, può essere inviato come parametro di query, intestazione HTTP o modulo predefinito (predefinito).

La variabile request.queryparam.auth_code indica che la variabile il codice di autorizzazione deve essere presente come parametro di query, ad esempio ad esempio ?auth_code=AfGlvs9. Per richiedere il codice di autorizzazione in una richiesta ad esempio, imposta questo valore su request.header.auth_code. Vedi anche La richiesta di token di accesso e codici di autorizzazione.

&lt;ExpiresIn&gt; elemento

<ExpiresIn>10000</ExpiresIn> 

Applica la scadenza dei token di accesso e dei codici di autorizzazione in millisecondi. (Per di aggiornamento, utilizza <RefreshTokenExpiresIn>. Il valore della data di scadenza è un valore generato dal sistema più il valore di <ExpiresIn>. Se <ExpiresIn> è impostato su -1, il token o il codice scade in base alla scadenza massima del token di accesso OAuth. Se <ExpiresIn> non viene specificato, il sistema applica un valore predefinito configurato a livello di sistema.

La data di scadenza può essere impostata anche in fase di runtime, utilizzando un valore predefinito hardcoded o facendo riferimento a una variabile di flusso. Ad esempio, puoi archiviare un valore di scadenza del token in una coppia chiave-valore mappare, recuperarlo, assegnarlo a una variabile e farvi riferimento nel criterio. Ad esempio: kvm.oauth.expires_in.

Con Apigee Edge per il cloud pubblico, Edge mantiene le seguenti entità nella cache per almeno 180 secondi dopo l'accesso alle entità.

• Token di accesso OAuth. Ciò significa che un token revocato potrebbe comunque avere esito positivo per un massimo di minuti, fino alla scadenza del limite di cache.
• Entità Key Management Service (KMS) (app, sviluppatori, prodotti API).
• Attributi personalizzati su token OAuth ed entità KMS.

La stanza seguente specifica una variabile di flusso e anche un valore predefinito. Tieni presente che il flusso ha la precedenza sul valore predefinito specificato.

<ExpiresIn ref="kvm.oauth.expires_in">
    3600000 <!--default value in milliseconds-->
</ExpiresIn>

Edge non supporta un modo per forzare la scadenza di un token dopo la sua creazione. Se devi forzare la scadenza del token (ad esempio, in base a una condizione), una possibile soluzione è descritto in in questo post della community Apigee.

Per impostazione predefinita, i token di accesso scaduti vengono eliminati definitivamente da Apigee Edge system automaticamente 3 giorni dopo la scadenza. Vedi anche Eliminare definitivamente l'accesso di token

Private Cloud: per un'installazione Edge per il cloud privato, il valore predefinito è impostato dalla proprietà conf_keymanagement_oauth_auth_code_expiry_time_in_millis. Per impostare questa proprietà:

1. Apri il file message-processor.properties in un editor. Se il file non esiste, crealo:

   vi /opt/apigee/customer/application/message-processor.properties

2. Imposta la proprietà come preferisci:

   conf_keymanagement_oauth_auth_code_expiry_time_in_millis=3600000

3. Assicurati che il file delle proprietà appartenga all'elemento "apigee" utente:

   chown apigee:apigee /opt/apigee/customer/application/message-processor.properties

4. Riavvia il processore di messaggi.

   /opt/apigee/apigee-service/bin/apigee-service edge-message-processor restart

&lt;ExternalAccessToken&gt; elemento

<ExternalAccessToken>request.queryparam.external_access_token</ExternalAccessToken>

Indica ad Apigee Edge dove trovare un token di accesso esterno (un token di accesso non generato Apigee Edge).

La variabile request.queryparam.external_access_token indica che il token di accesso esterno deve essere presente come parametro di query, ad esempio ad esempio ?external_access_token=12345678. Per richiedere il token di accesso esterno in un'intestazione HTTP, ad esempio, imposta questo valore a request.header.external_access_token. Vedi anche Utilizzo di OAuth di terze parti Token.

&lt;ExternalAuthorization&gt; elemento

<ExternalAuthorization>true</ExternalAuthorization>

Se questo elemento è false o non è presente, Edge convalida client_id e client_secret con l'archivio di autorizzazioni Apigee Edge. Usa questo elemento quando vuoi lavorare con di terze parti. Per maggiori dettagli sull'uso di questo elemento, consulta Utilizzo di OAuth di terze parti. Token.

&lt;ExternalAuthorizationCode&gt; elemento

<ExternalAuthorizationCode>request.queryparam.external_auth_code</ExternalAuthorizationCode>

Indica ad Apigee Edge dove trovare un codice di autorizzazione esterno (un codice di autenticazione non generato Apigee Edge).

La variabile request.queryparam.external_auth_code indica che il codice di autorizzazione esterno deve essere presente come parametro di query, ad esempio ad esempio ?external_auth_code=12345678. Per richiedere l'autorizzazione esterna codice in un'intestazione HTTP, ad esempio, imposta questo valore a request.header.external_auth_code. Vedi anche Utilizzo di OAuth di terze parti Token.

&lt;ExternalRefreshToken&gt; elemento

<ExternalRefreshToken>request.queryparam.external_refresh_token</ExternalRefreshToken>

Indica ad Apigee Edge dove trovare un token di aggiornamento esterno (un token di aggiornamento non generato Apigee Edge).

La variabile request.queryparam.external_refresh_token indica che il token di aggiornamento esterno deve essere presente come parametro di query, ad esempio ad esempio ?external_refresh_token=12345678. Per richiedere il token di aggiornamento esterno in un'intestazione HTTP, ad esempio, imposta questo valore a request.header.external_refresh_token. Vedi anche Utilizzo di OAuth di terze parti Token.

&lt;GenerateResponse&gt; elemento

<GenerateResponse enabled='true'/>

Se viene impostato su true, il criterio genera e restituisce una risposta. Ad esempio, per GeneraAccessToken, la risposta potrebbe essere simile a:

{
  "issued_at" : "1467841035013",
  "scope" : "read",
  "application_name" : "e31b8d06-d538-4f6b-9fe3-8796c11dc930",
  "refresh_token_issued_at" : "1467841035013",
  "status" : "approved",
  "refresh_token_status" : "approved",
  "api_product_list" : "[Product1, nhl_product]",
  "expires_in" : "1799",
  "developer.email" : "edward@slalom.org",
  "token_type" : "BearerToken",
  "refresh_token" : "rVSmm3QaNa0xBVFbUISz1NZI15akvgLJ",
  "client_id" : "Adfsdvoc7KX5Gezz9le745UEql5dDmj",
  "access_token" : "AnoHsh2oZ6EFWF4h0KrA0gC5og3a",
  "organization_name" : "cerruti",
  "refresh_token_expires_in" : "0",
  "refresh_count" : "0"
}

Se false, non viene inviata alcuna risposta. Viene invece compilato un insieme di variabili di flusso con valori correlati alla funzione del criterio. Ad esempio, una variabile di flusso denominata Il campo oauthv2authcode.OAuthV2-GenerateAuthorizationCode.code viene compilato con nuovo codice di autorizzazione. Tieni presente che expires_in è espresso in secondi nella risposta.

&lt;GenerateErrorResponse&gt; elemento

<GenerateErrorResponse enabled='true'/>

Se impostato su true, il criterio genera e restituisce una risposta se il criterio L'attributo ContinueOnError è impostato su true. Se false (valore predefinito), viene inviata una risposta. Un insieme di variabili di flusso viene invece compilato con i valori relativi ai parametri encoder-decoder.

&lt;GrantType&gt;

<GrantType>request.queryparam.grant_type</GrantType>

Indica al criterio dove trovare il parametro del tipo di concessione passato in una richiesta. In base alle nella specifica OAuth 2.0, il tipo di autorizzazione deve essere fornito con le richieste per i token di accesso e codici di autorizzazione. La variabile può essere un'intestazione, un parametro di query o un parametro del modulo (impostazione predefinita).

Ad esempio request.queryparam.grant_type indica che la password deve essere presente come parametro di query, ad esempio ?grant_type=password. Per richiedere il tipo di autorizzazione in un'intestazione HTTP, ad esempio, imposta questo valore a request.header.grant_type. Vedi anche Richiesta di token di accesso e autorizzazione .

&lt;Operation&gt; elemento

<Operation>GenerateAuthorizationCode</Operation>

L'operazione OAuth 2.0 eseguita dal criterio.

&lt;PassWord&gt; elemento

<PassWord>request.queryparam.password</PassWord>

Questo elemento viene utilizzato solo con il tipo di concessione della password. Con il tipo di concessione della password, le credenziali utente (password e nome utente) devono essere messe a disposizione del Criterio OAuthV2. Gli elementi <PassWord> e <UserName> sono utilizzato per specificare le variabili in cui Edge può trovare questi valori. Se questi elementi non sono specificati, il criterio prevede di trovare i valori (per impostazione predefinita) nei parametri del modulo denominati username e password. Se i valori non vengono trovati, il criterio genera un errore. Puoi utilizzare la modalità gli elementi <PassWord> e <UserName> per fare riferimento a qualsiasi di flusso contenente le credenziali.

Ad esempio, puoi passare la password in una richiesta di token utilizzando un parametro di query e impostare come questo: <PassWord>request.queryparam.password</PassWord>. a richiedi la password in un'intestazione HTTP, imposta questo valore a request.header.password.

Il criterio OAuthV2 non fa altro con questi valori delle credenziali; Edge è semplicemente per verificare la loro presenza. Spetta allo sviluppatore dell'API recuperare la richiesta di valori e e li invii a un provider di identità prima dell'esecuzione del criterio di generazione dei token.

Vedi anche Richiesta di token di accesso. e codici di autorizzazione.

&lt;RedirectUri&gt; elemento

<RedirectUri>request.queryparam.redirect_uri</RedirectUri>

Specifica dove Edge deve cercare il parametro redirect_uri nella richiesta.

Informazioni sugli URI di reindirizzamento

Gli URI di reindirizzamento vengono utilizzati con il codice di autorizzazione e i tipi di concessioni implicite. Il reindirizzamento L'URI indica al server di autorizzazione (Edge) dove inviare un codice di autorizzazione (per il codice di autorizzazione) tipo di autorizzazione) o token di accesso (per il tipo di autorizzazione implicita). È importante capire quando questo parametro è obbligatorio, quando è facoltativo e come viene utilizzato:

• (obbligatorio) Se un URL di callback è registrato con l'app sviluppatore associata a le chiavi client della richiesta e, se redirect_uri è presente nella richiesta, allora i due devono corrispondere esattamente. Se non corrispondono, viene restituito un errore. Per informazioni sulla registrazione di app sviluppatore su Edge e sulla specifica di un URL di callback, consulta Registrare app e gestire API chiave.

• (Facoltativo) Se è stato registrato un URL di callback e redirect_uri non è presente dalla richiesta, Edge reindirizzerà all'URL di callback registrato.
• (obbligatorio) Se un URL di callback non è registrato, redirect_uri è obbligatorio. Tieni presente che in questo caso Edge accetterà QUALSIASI URL. Questo caso può presentare problema di sicurezza e pertanto deve essere utilizzato solo con client attendibili app. Se le app client non sono attendibili, la best practice è quella di richiedere sempre registrazione di un URL di callback.

Puoi inviare questo parametro in un parametro di query o in un'intestazione. La la variabile request.queryparam.redirect_uri indica che la proprietà RedirectUri deve essere presente come parametro di query, ad esempio ad esempio ?redirect_uri=login.myapp.com. Per richiedere RedirectUri in un HTTP ad esempio, imposta questo valore su request.header.redirect_uri. Consulta anche la richiesta di token di accesso codici di autorizzazione.

&lt;RefreshToken&gt; elemento

<RefreshToken>request.queryparam.refreshtoken</RefreshToken>

Quando richiedi un token di accesso utilizzando un token di aggiornamento, devi fornire il token di aggiornamento nel la richiesta. Questo elemento consente di specificare dove Edge deve cercare il token di aggiornamento. Per può essere inviato come parametro di query, intestazione HTTP o parametro modulo (predefinito).

La variabile request.queryparam.refreshtoken indica che l'aggiornamento il token deve essere presente come parametro di query, ad esempio ad esempio ?refresh_token=login.myapp.com. Per richiedere RefreshToken in una finestra HTTP ad esempio, imposta questo valore su request.header.refresh_token. Consulta anche la richiesta di token di accesso codici di autorizzazione.

&lt;RefreshTokenExpiresIn&gt; elemento

<RefreshTokenExpiresIn>1000</RefreshTokenExpiresIn>

Applica la scadenza dei token di aggiornamento in millisecondi. Il valore della data di scadenza è un sistema generato più il valore <RefreshTokenExpiresIn>. Se <RefreshTokenExpiresIn> è impostato su -1, il token di aggiornamento scade in base alla scadenza massima del token di aggiornamento OAuth. Se <RefreshTokenExpiresIn> non è specificato, il sistema applica un valore predefinito configurato a livello di sistema. Contatta l'assistenza Apigee Edge per ulteriori informazioni informazioni sulle impostazioni predefinite di sistema.

La data di scadenza può essere impostata anche in fase di runtime, utilizzando un valore predefinito hardcoded o facendo riferimento a una variabile di flusso. Ad esempio, puoi archiviare un valore di scadenza del token in una coppia chiave-valore mappare, recuperarlo, assegnarlo a una variabile e farvi riferimento nel criterio. Per ad esempio kvm.oauth.expires_in.

La stanza seguente specifica una variabile di flusso e anche un valore predefinito. Tieni presente che il flusso ha la precedenza sul valore predefinito specificato.

<RefreshTokenExpiresIn ref="kvm.oauth.expires_in">
    3600000 <!--default value in milliseconds-->
</RefreshTokenExpiresIn>

Private Cloud: per un'installazione Edge per Private Cloud, il valore predefinito è impostato dalla proprietà conf_keymanagement_oauth_refresh_token_expiry_time_in_millis. Per impostare questa proprietà:

1. Apri il file message-processor.properties in un editor. Se il file non esiste, crealo:

   vi /opt/apigee/customer/application/message-processor.properties

2. Imposta la proprietà come preferisci:

   conf_keymanagement_oauth_refresh_token_expiry_time_in_millis=3600000

3. Assicurati che il file delle proprietà appartenga all'elemento "apigee" utente:

   chown apigee:apigee /opt/apigee/customer/application/message-processor.properties

4. Riavvia il processore di messaggi.

   /opt/apigee/apigee-service/bin/apigee-service edge-message-processor restart

&lt;ResponseType&gt; elemento

<ResponseType>request.queryparam.response_type</ResponseType>

Questo elemento indica a Edge il tipo di concessione richiesto dall'app client. Viene utilizzato solo con il codice di autorizzazione e i flussi di tipo di autorizzazione implicita.

Per impostazione predefinita, Edge cerca il valore del tipo di risposta in una query response_type . Se desideri eseguire l'override di questo comportamento predefinito, utilizza lo strumento <ResponseType> in configurare una variabile di flusso contenente il valore del tipo di risposta. Ad esempio, se imposti questo su request.header.response_type, Edge cerca il tipo di risposta da nell'intestazione della richiesta. Vedi anche Richiesta di token di accesso e autorizzazione .

&lt;ReuseRefreshToken&gt; elemento

<ReuseRefreshToken>true</ReuseRefreshToken>

Se impostato su true, il token di aggiornamento esistente viene riutilizzato fino alla scadenza. Se false, viene emesso un nuovo token di aggiornamento da Apigee Edge quando viene eseguito un token di aggiornamento valido presentati.

&lt;Scope&gt; elemento

<Scope>request.queryparam.scope</Scope>

Se questo elemento è presente in uno dei valori e i criteri, viene utilizzato per specificare gli ambiti in cui concedere il token o il codice. Questi valori sono vengono generalmente trasmessi alle norme nella richiesta da un'app client. Puoi configurare l'elemento una variabile di flusso, per darti la possibilità di scegliere come vengono passati gli ambiti in una richiesta. Nel nell'esempio seguente, request.queryparam.scope indica che l'ambito deve Essere presente come parametro di query, come, ad esempio, ?scope=READ. Per richiedere il scope in un'intestazione HTTP, ad esempio imposta questo valore a request.header.scope.

Se questo elemento viene visualizzato in "VerifyAccessToken" viene usato per specificare quale gli ambiti che il criterio deve applicare. In questo tipo di criterio, il valore deve essere impostato come hardcoded ambito non puoi usare le variabili. Ad esempio:

<Scope>A B</Scope>

Vedi anche Utilizzo di OAuth2 ambiti e Richiesta di token di accesso e codici di autorizzazione.

&lt;State&gt; elemento

<State>request.queryparam.state</State>

Nei casi in cui l'app client deve inviare le informazioni sullo stato al server di autorizzazione, questo elemento consente di specificare dove Edge deve cercare i valori dello stato. Ad esempio, come parametro di query o in un'intestazione HTTP. Il valore dello stato viene generalmente utilizzato come misura di sicurezza per prevenire gli attacchi CSRF.

Ad esempio request.queryparam.state indica che lo stato deve essere presente come parametro di query, come, ad esempio, ?state=HjoiuKJH32. Per richiedere lo stato in un'intestazione HTTP, ad esempio imposta questo valore a request.header.state. Vedi anche Richiesta di token di accesso e autorizzazione .

&lt;StoreToken&gt; elemento

 <StoreToken>true</StoreToken> 

Imposta questo elemento su true quando <ExternalAuthorization> è true. L'elemento <StoreToken> comunica ad Apigee Edge per archiviare il token di accesso esterno. In caso contrario, non verrà mantenuto.

&lt;SupportedGrantTypes&gt;/&lt;GrantType&gt; elemento

<SupportedGrantTypes>
    <GrantType>authorization_code</GrantType>
    <GrantType>client_credentials</GrantType>
    <GrantType>implicit</GrantType>
    <GrantType>password</GrantType>
</SupportedGrantTypes>

Specifica i tipi di autorizzazione supportati da un endpoint del token OAuth su Apigee Edge. Un endpoint può supportare più tipi di autorizzazione (ovvero, un singolo endpoint può essere configurato per distribuire l'accesso per più tipi di concessioni). Per ulteriori informazioni sugli endpoint, consulta Informazioni su OAuth endpoint. Il tipo di concessione viene passato nelle richieste di token in un grant_type .

Se non viene specificato alcun tipo di autorizzazione supportato, gli unici tipi di autorizzazione consentiti sono authorization_code e implicit. Vedi anche l'elemento &lt;GrantType&gt; (un elemento di livello superiore utilizzato per specifica dove Apigee Edge deve cercare il parametro grant_type che viene passato una richiesta del client. Edge verificherà che il valore del parametro grant_type corrisponde a uno dei tipi di autorizzazione supportati).

&lt;Tokens&gt;/&lt;Token&gt; elemento

Utilizzato con le operazioni ConvalidaToken e InvalidateToken. Vedi anche Approvazione e revoca dei token di accesso. Il <Token> identifica la variabile di flusso che definisce l'origine del token da revocare. Se gli sviluppatori devono inviare i token di accesso come parametri di ricerca denominati access_token, ad esempio utilizza request.queryparam.access_token.

&lt;UserName&gt; elemento

<UserName>request.queryparam.user_name</UserName>

Questo elemento viene utilizzato solo con il tipo di concessione della password. Con il tipo di concessione della password, le credenziali utente (password e nome utente) devono essere messe a disposizione del Criterio OAuthV2. Gli elementi <PassWord> e <UserName> sono utilizzato per specificare le variabili in cui Edge può trovare questi valori. Se questi elementi non sono specificati, il criterio prevede di trovare i valori (per impostazione predefinita) nei parametri del modulo denominati username e password. Se i valori non vengono trovati, il criterio genera un errore. Puoi utilizzare la modalità gli elementi <PassWord> e <UserName> per fare riferimento a qualsiasi di flusso contenente le credenziali.

Ad esempio, puoi passare il nome utente in un parametro di query e impostare <UserName> elemento come questo: <UserName>request.queryparam.username</UserName>.Da richiedere il nome utente in un'intestazione HTTP, imposta questo valore a request.header.username.

Il criterio OAuthV2 non fa altro con questi valori delle credenziali; Edge è semplicemente per verificare la loro presenza. Spetta allo sviluppatore dell'API recuperare la richiesta di valori e e li invii a un provider di identità prima dell'esecuzione del criterio di generazione dei token.

Vedi anche Richiesta di token di accesso. e codici di autorizzazione.

Verificare l'accesso token

Una volta configurato un endpoint token per un proxy API, un criterio OAuthV2 corrispondente che specifica che l'operazione VerifyAccessToken è collegata al flusso che espone risorsa protetta.

Ad esempio, per garantire che tutte le richieste a un'API siano autorizzate, il seguente criterio forza la verifica del token di accesso:

<OAuthV2 name="VerifyOAuthAccessToken">
  <Operation>VerifyAccessToken</Operation>
</OAuthV2>

Il criterio è associato alla risorsa API da proteggere. Per garantire che tutte le richieste a un Le API sono state verificate. Collega il criterio alla richiesta ProxyEndpoint PreFlow come segue:

<PreFlow>
  <Request>
    <Step><Name>VerifyOAuthAccessToken</Name></Step>
  </Request>
</PreFlow>

I seguenti elementi facoltativi possono essere utilizzati per sostituire le impostazioni predefinite per Operazione VerifyAccessToken.

<OAuthV2 name="ValidateOauthScopePolicy">
  <Operation>VerifyAccessToken</Operation>
  <Scope>READ WRITE</Scope>
</OAuthV2>

Vedi anche Verifica dell'accesso di token e Richiesta di token di accesso. e codici di autorizzazione.

Specificare le posizioni delle variabili di richiesta

Per ogni tipo di concessione, le norme fanno ipotesi sulla località o sulle informazioni richieste. nei messaggi di richiesta. Queste ipotesi si basano sulla specifica OAuth 2.0. Se le tue app devi deviare dalla specifica OAuth 2.0, puoi specificare le località previste per ogni parametro. Ad esempio, quando gestisci un codice di autorizzazione, puoi specificare la posizione il codice di autorizzazione, l'ID client, l'URI di reindirizzamento e l'ambito. Queste possono essere specificate come Intestazioni HTTP, parametri di ricerca o parametri del modulo.

L'esempio seguente mostra come specificare la località del codice di autorizzazione richiesto come intestazioni HTTP:

  ...
  <GrantType>request.header.grant_type</GrantType>
  <Code>request.header.code</Code>
  <ClientId>request.header.client_id</ClientId>
  <RedirectUri>request.header.redirect_uri</RedirectUri>
  <Scope>request.header.scope</Scope>
  ...

In alternativa, se necessario per supportare la base di app client, puoi combinare intestazioni e query parametri:

  ...
  <GrantType>request.header.grant_type</GrantType>
  <Code>request.header.code</Code>
  <ClientId>request.queryparam.client_id</ClientId>
  <RedirectUri>request.queryparam.redirect_uri</RedirectUri>
  <Scope>request.queryparam.scope</Scope>
  ...

È possibile configurare una sola località per parametro.

Variabili di flusso

Le variabili di flusso definite in questa tabella vengono compilate quando i rispettivi criteri OAuth vengono e, di conseguenza, sono disponibili per altri criteri o applicazioni in esecuzione nel proxy API flusso di lavoro.

Operazione VerifyAccessToken

Viene eseguita l'operazione VerifyAccessToken, viene compilata un numero elevato di variabili di flusso nel contesto di esecuzione del proxy. Queste variabili forniscono proprietà correlate all'accesso token, app sviluppatore, sviluppatore e società. Puoi usare un criterioAssignMessage o JavaScript, ad esempio per leggere una qualsiasi di queste variabili e utilizzarle in base alle esigenze più avanti nel flusso. Questi possono essere utili anche per il debug.

Variabili specifiche per i token

Variabili specifiche per app

Queste variabili sono correlate all'app sviluppatore associata al token.

Variabili specifiche per sviluppatori

Se app.appType è "Company", gli attributi dell'azienda vengono compilati, mentre se app.appType è "Sviluppatore", gli attributi sviluppatore vengono compilati.

Variabili specifiche dell'azienda

Se app.appType è "Company", gli attributi dell'azienda vengono compilati, mentre se app.appType è "Sviluppatore", gli attributi sviluppatore vengono compilati.

GenerateAuthorizationCode operazione

Queste variabili vengono impostate quando viene eseguita l'operazione generateAuthorizationCode correttamente:

Prefisso: oauthv2authcode.{policy_name}.{variable_name}

Esempio: oauthv2authcode.GenerateCodePolicy.code

GeneraAccessToken e Operazioni di RefreshAccessToken

Queste variabili vengono impostate quando vengono eseguite le operazioni generativeAccessToken e RefreshAccessToken correttamente. Tieni presente che le variabili token di aggiornamento non si applicano alla concessione delle credenziali del client un tipo di flusso.

Prefisso: oauthv2accesstoken.{policy_name}.{variable_name}

Esempio: oauthv2accesstoken.GenerateTokenPolicy.access_token

GenerateAccessTokenImplicitGrant

Queste variabili vengono impostate quando l'operazioneGenerateAccessTokenImplicit viene eseguita correttamente per il flusso dei tipi di autorizzazione implicita.

Prefisso: oauthv2accesstoken.{policy_name}.{variable_name}

Esempio: oauthv2accesstoken.RefreshTokenPolicy.access_token

Informazioni sugli errori

Questa sezione descrive i codici e i messaggi di errore restituiti e le variabili di errore impostate da Edge quando questo criterio attiva un errore. Queste informazioni sono importanti per sapere se si stanno sviluppando regole di errore per gestire gli errori. Per scoprire di più, consulta gli articoli Cosa devi sapere sugli errori relativi alle norme e Gestione degli errori.

Errori di runtime

Questi errori possono verificarsi quando il criterio viene eseguito.

Errori di deployment

Questi errori possono verificarsi quando esegui il deployment di un proxy contenente questo criterio.

Variabili di errore

Queste variabili vengono impostate quando questo criterio attiva un errore in fase di runtime.

Esempio di risposta di errore

Queste risposte vengono rinviate al client se l'elemento <GenerateResponse> è true.

Se <GenerateResponse> è true, il criterio restituisce errori in questo formato per le operazioni che generano token e codici. Per un elenco completo, consulta il riferimento della risposta agli errori HTTP OAuth.

{"ErrorCode" : "invalid_client", "Error" :"ClientId is Invalid"}

Se <GenerateResponse> è true, il criterio restituisce errori in questo formato per le operazioni di verifica e convalida. Per un elenco completo, consulta il riferimento sulla risposta agli errori HTTP OAuth.

{  
   {  
      "fault":{  
         "faultstring":"Invalid Access Token",
         "detail":{  
            "errorcode":"keymanagement.service.invalid_access_token"
         }
      }
   }

Esempio di regola di errore

<FaultRule name=OAuthV2 Faults">
    <Step>
        <Name>AM-InvalidClientResponse</Name>
        <Condition>(fault.name = "invalid_client") OR (fault.name = "InvalidClientIdentifier")</Condition>
    </Step>
    <Step>
        <Name>AM-InvalidTokenResponse</Name>
        <Condition>(fault.name = "invalid_access_token")</Condition>
    </Step>
    <Condition>(oauthV2.failed = true) </Condition>
</FaultRule>

Schema dei criteri

Ogni tipo di criterio è definito da uno schema XML (.xsd). Come riferimento, le norme gli schemi sono disponibili su GitHub.

Utilizzare il protocollo OAuth predefinito configurazione

A ogni organizzazione (anche in prova senza costi) su Apigee Edge viene eseguito il provisioning di un token OAuth endpoint. L'endpoint è preconfigurato con criteri nel proxy API chiamato oauth. Puoi iniziare a utilizzare l'endpoint del token non appena lo crei un account su Apigee Edge. Per Per maggiori dettagli, consulta la pagina Informazioni su OAuth endpoint.

Eliminare definitivamente i token di accesso

Per impostazione predefinita, i token OAuth2 vengono eliminati definitivamente dal sistema Apigee Edge per 3 giorni (259.200 secondi) dopo che il token di accesso e il token di aggiornamento (se esistente) sono scaduti. In alcuni casi, potresti voler modificare questa impostazione predefinita. Ad esempio, potresti voler ridurre il tempo di eliminazione definitiva risparmiare spazio su disco se viene generato un numero elevato di token.

Se ti trovi su Edge per il cloud privato, puoi modificare questa impostazione predefinita delle proprietà dell'organizzazione, come spiegato in questa sezione. (l'eliminazione definitiva dei token scaduti di 3 giorni si applica a Edge per il cloud privato versione 4.19.01 e successive. Per le versioni precedenti, intervallo di eliminazione definitiva predefinito è 180 giorni).

Aggiornamento delle impostazioni di eliminazione definitiva per Edge Private Cloud 4.16.01 e versioni successive

Nota: vengono generati solo i token dopo queste impostazioni. applicati sono interessati: le impostazioni non si applicano ai token generati in precedenza.

Aggiornamento dell'eliminazione definitiva in corso... impostazioni per Edge Private Cloud 4.15.07

Nota: solo i token generati dopo l'applicazione di queste impostazioni sono interessati; le impostazioni non si applicano ai token generati in precedenza.

Comportamento non conforme a RFC

Il criterio OAuthV2 restituisce una risposta del token che contiene alcune proprietà non compatibili con RFC. La tabella seguente mostra le non conformi proprietà restituite dal criterio OAuthV2 e dalle corrispondenti proprietà conformi.

Inoltre, la risposta di errore per un token di aggiornamento scaduto quando grant_type = refresh_token:

{"ErrorCode" : "invalid_request", "Error" :"Refresh Token expired"}

Tuttavia, la risposta conforme alla specifica RFC è:

{"error" : "invalid_grant", "error_description" :"refresh token expired"}

Argomenti correlati

• Introduzione a OAuth 2,0