Implementazione del tipo di concessione della password

Questa pagina si applica a Apigee e Apigee ibrido.

Visualizza la documentazione di Apigee Edge.

Il tipo di autorizzazione del proprietario della risorsa (o "password") viene utilizzato principalmente nei casi in cui l'app è altamente affidabile. In questa configurazione, l'utente fornisce le credenziali del server di risorse (nome utente/password) all'app client, che le invia in una richiesta di token di accesso ad Apigee. Un server di identità convalida le credenziali e, se sono valide, Apigee passa a creare un token di accesso e lo restituisce all'app.

Informazioni su questo argomento

Questo argomento offre una descrizione generale e una panoramica del flusso del tipo di autorizzazione della password per il proprietario della risorsa OAuth 2.0 e illustra come implementare questo flusso su Apigee.

Esempi che potrebbero esserti utili

  • Utilizza il tipo di autorizzazione della password: mostra come creare una richiesta di token, configurare il criterio OAuthV2 per il tipo di concessione della password e come configurare un endpoint per il criterio in Apigee.
  • oauth-validate-key-secret: un proxy di esempio in GitHub di cui puoi eseguire il deployment su Apigee e provarlo. È un esempio end-to-end che illustra il tipo di concessione della password. Illustra una best practice, ovvero autenticare le credenziali dell'app client (chiave/segreto) prima di inviare le credenziali dell'utente a un provider di identità.

Video

Video: guarda questo video sull'implementazione del tipo di concessione della password.

Casi d'uso

Questo tipo di autorizzazione è destinato alle app altamente affidabili o con privilegi, perché l'utente è tenuto a fornire le credenziali del proprio server di risorse all'app. In genere, l'app fornisce una schermata di accesso in cui l'utente inserisce le proprie credenziali.

Diagramma di flusso

Il seguente diagramma di flusso illustra il flusso del tipo di concessione della password del proprietario della risorsa con Apigee che funge da server di autorizzazione.

Suggerimento: per visualizzare una versione più grande di questo diagramma, fai clic con il tasto destro del mouse sul diagramma e aprilo in una nuova scheda oppure salvalo e aprilo in un visualizzatore di immagini.

Il flusso del tipo di autorizzazione della password del proprietario della risorsa.

Passaggi nel flusso del tipo di autorizzazione della password

Ecco un riepilogo dei passaggi necessari per implementare il tipo di concessione della password in cui Apigee funge da server di autorizzazione.

Prerequisito: l'app client deve essere registrata con Apigee per ottenere l'ID client e le chiavi client secret. Per maggiori dettagli, consulta la sezione Registrazione di app client.

1. L'utente avvia il flusso e inserisce le credenziali

Quando l'app deve accedere alle risorse protette dell'utente (ad esempio, l'utente fa clic su un pulsante all'interno dell'app), l'utente viene reindirizzato a un modulo di accesso.

2. L'app richiede un token di accesso ad Apigee

L'app invia una richiesta di token di accesso, incluse le credenziali dell'utente, a un endpoint CreateAccessToken su Apigee.

Ecco un esempio di richiesta POST, che include i parametri richiesti per questo tipo di concessione:

$ curl -i \
  -X POST \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -H 'Authorization: Basic c3FIOG9vSGV4VHo4QzAySVg5T1JvNnJoZ3ExaVNyQWw6WjRsanRKZG5lQk9qUE1BVQ' \
  -d 'grant_type=password&username=the-user-name&password=the-users-password' \
  https://docs-test.apigee.net/oauth/token

In alternativa, questo comando può essere eseguito come segue, utilizzando l'opzione -u per il comando curl per creare automaticamente l'intestazione Basic Authentication con codifica base64.

$ curl -i \
  -X POST \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -u sqH8ooHexTz8C02IX9ORo6rhgq1iSrAl:Z4ljtJdneBOjPMAU \
  -d 'grant_type=password&username=the-user-name&password=the-users-password' \
  https://docs-test.apigee.net/oauth/token

(ognuno di questi comandi dovrebbe essere su un'unica riga).

Le credenziali utente sono contenute nei parametri del modulo, mentre le credenziali client sono codificate nell'intestazione dell'autenticazione di base HTTP. Per una descrizione dettagliata di questa chiamata API, inclusi i dettagli sull'intestazione richiesta di autenticazione di base, consulta la sezione per la concessione della password di "Scaricare token OAuth 2.0".

3. Apigee convalida l'app client

Prima di inviare il nome utente e la password dell'utente a un provider di identità, Edge deve sapere che l'app client che effettua la richiesta è un'app valida e attendibile. Un modo per farlo è utilizzare l'autenticazione della chiave API nella chiamata API. In alcuni casi, potresti voler convalidare sia la chiave client sia il secret. È disponibile un proxy di esempio che illustra questa tecnica allterna nel repository api-platform-samples su GitHub.

4. Apigee elabora le credenziali di accesso

Dopo aver convalidato l'app client, puoi utilizzare un criterio di callout di servizio o JavaScript per chiamare il servizio di identità, inviando le credenziali dell'utente. Ad esempio, può trattarsi di un servizio LDAP o di qualsiasi servizio che vuoi utilizzare per convalidare le credenziali. Per maggiori dettagli su questi criteri, consulta il criterio Estrai le variabili e il criterio JavaScript.

Se il servizio di identità convalida le credenziali e restituisce una risposta 200, Apigee continuerà a elaborare la richiesta; in caso contrario, Apigee interrompe l'elaborazione e restituisce un errore all'app client.

5. Il criterio OAuthV2 viene eseguito

Se le credenziali sono valide, il passaggio di elaborazione successivo prevede l'esecuzione di un criterio OAuthV2 configurato per il tipo di concessione della password. Ecco un esempio. Gli elementi <UserName> e <PassWord> sono obbligatori e puoi recuperarli dalle variabili di flusso salvate con il criterio ExtractVariables. Per informazioni di riferimento dettagliate su questo criterio, consulta la sezione Criterio OAuthV2.

<OAuthV2 name="GetAccessToken">
  <Operation>GenerateAccessToken</Operation>
  <ExpiresIn>360000000</ExpiresIn> 
  <SupportedGrantTypes> 
     <GrantType>password</GrantType> 
  </SupportedGrantTypes> 
  <GrantType>request.queryparam.grant_type</GrantType> 
  <UserName>login</UserName>
  <PassWord>password</PassWord>
  <GenerateResponse/> 
</OAuthV2>

Se questo criterio ha esito positivo, viene generata una risposta al client contenente un token di accesso. La risposta è in formato JSON. Ecco un esempio. Tieni presente che access_token è uno degli elementi:

{
    "issued_at": "1420258685042",
    "scope": "READ",
    "application_name": "ce1e94a2-9c3e-42fa-a2c6-1ee01815476b",
    "refresh_token_issued_at": "1420258685042",
    "status": "approved",
    "refresh_token_status": "approved",
    "api_product_list": "[PremiumWeatherAPI]",
    "expires_in": "1799",
    "developer.email": "tesla@weathersample.com",
    "organization_id": "0",
    "token_type": "BearerToken",
    "refresh_token": "IFl7jlijYuexu6XVSSjLMJq8SVXGOAAq",
    "client_id": "5jUAdGv9pBouF0wOH5keAVI35GBtx3dT",
    "access_token": "I6daIgMSiUgYX1K2qgQWPi37ztS6",
    "organization_name": "docs",
    "refresh_token_expires_in": "0",
    "refresh_count": "0"
}

6. Il client chiama l'API protetta

Ora, con un codice di accesso valido, il client può effettuare chiamate all'API protetta. In questo scenario, le richieste vengono effettuate ad Apigee (il proxy) e Apigee è responsabile della convalida del token di accesso prima di passare la chiamata API al server di risorse di destinazione. I token di accesso vengono passati in un'intestazione Autorizzazione. Ad esempio:

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