Questa pagina descrive come supportare l'autenticazione utente in Cloud Endpoints.
Per autenticare un utente, un'applicazione client deve inviare un JSON Web Token (JWT) nell'intestazione di autorizzazione del file HTTP all'API backend. La Extensible Service Proxy (ESP) convalida il token per conto dell'API, quindi non è necessario aggiungere alcun codice l'API per elaborare l'autenticazione. Tuttavia, devi configurare il documento OpenAPI in modo che supporti i metodi di autenticazione che hai scelto.
ESP convalida un JWT in modo efficace utilizzando il linguaggio le chiavi pubbliche dell'emittente. ESP memorizza nella cache le chiavi pubbliche per cinque minuti. Inoltre, ESP memorizza nella cache i JWT convalidati per cinque minuti o fino alla scadenza del JWT, a seconda dell'evento che si verifica per primo.
Prima di iniziare
- Aggiungi il codice di autenticazione all'applicazione client, seguendo le istruzioni Auth0 documentazione.
-
Quando l'applicazione client invia una richiesta HTTP, l'intestazione di autorizzazione
la richiesta deve contenere le seguenti attestazioni JWT:
iss
(emittente)sub
(oggetto)aud
(pubblico)iat
(rilasciato il giorno)exp
(tempo di scadenza)
Configurazione di ESP per supportare l'autenticazione client
Per consentire a ESP di convalidare i claim nel JWT firmato, nel documento OpenAPI devi avere un oggetto security requirement e un oggetto security definitions.
Per supportare l'autenticazione Auth0:
Aggiungi quanto segue alla definizione di sicurezza in OpenAPI documento:
securityDefinitions: auth0_jwk: authorizationUrl: "" flow: "implicit" type: "oauth2" # Replace YOUR-ACCOUNT-NAME with your Auth0 account name. x-google-issuer: "https://YOUR-ACCOUNT-NAME.auth0.com/" x-google-jwks_uri: "https://YOUR-ACCOUNT-NAME.auth0.com/.well-known/jwks.json" # Optional. Replace YOUR-CLIENT-ID with your client ID x-google-audiences: "YOUR-CLIENT-ID"
Aggiungi una sezione di sicurezza a livello di API per applicarla all'intera API o a livello di metodo per applicarla a un metodo specifico.
security: - auth0_jwk: []
Puoi definire più definizioni di sicurezza nel documento OpenAPI, ma ogni definizione deve avere un emittente diverso. Se utilizzi le sezioni di sicurezza in a livello di API, mentre le impostazioni a livello di metodo hanno la precedenza Impostazioni a livello di API.
Il campo x-google-audiences
non è obbligatorio. ESP accetta tutti i JWT con il nome del servizio di backend sotto forma di https://SERVICE_NAME
nel claim aud
. Per consentire a ID client aggiuntivi di accedere al servizio di backend, puoi specificare gli ID client consentiti nel campo x-google-audiences
utilizzando valori separati da virgola. L'ESP accetta quindi i JWT con uno degli ID cliente specificati nel claim aud
.
Puoi anche personalizzare le località JWT aggiungendo x-google-extensions
. Per maggiori dettagli, vedi Estensioni openAPI.
Chiamata autenticata a un'API Endpoints
Per motivi di sicurezza, quando invii una richiesta utilizzando un token di autenticazione,
ti consigliamo di inserire il token nell'intestazione Authorization:Bearer
. Ad
esempio:
curl -H "Authorization: Bearer ${TOKEN}" "${ENDPOINTS_HOST}/echo"
In questo caso, ENDPOINTS_HOST
e TOKEN
sono variabili di ambiente contenenti
rispettivamente nome host e token di autenticazione dell'API. Consulta
Eseguire una richiesta autenticata a un'API Endpoints.
per il codice di esempio che invia una richiesta utilizzando l'intestazione Authorization:Bearer
.
Se non puoi utilizzare l'intestazione quando invii la richiesta, puoi inserire il
in un parametro di query chiamato access_token
. Ad esempio:
curl "${ENDPOINTS_HOST}/echo?access_token=${TOKEN}"
Ricezione di risultati autenticati nell'API
ESP di solito inoltra tutte le intestazioni che riceve. Tuttavia, sostituisce il
l'intestazione Authorization
originale quando l'indirizzo di backend è specificato da
x-google-backend
nella specifica OpenAPI o BackendRule
nella configurazione del servizio gRPC.
ESP invierà il risultato dell'autenticazione nell'X-Endpoint-API-UserInfo
all'API backend. Ti consigliamo di utilizzare questa intestazione anziché l'intestazione Authorization
originale. Questa intestazione è una stringa che base64url
codifica un oggetto JSON. Il formato dell'oggetto JSON è diverso tra ESPv2 ed ESP.
Per ESPv2, l'oggetto JSON è esattamente il payload JWT originale. Per ESP,
l'oggetto JSON utilizza nomi di campo diversi e inserisce il payload JWT originale nel campo claims
.
Consulta Gestire i JWT nel servizio di backend
per ulteriori informazioni sul formato.
Esempi
Passaggi successivi