Questa pagina descrive come aggiungere all'API il supporto per l'autenticazione utente da applicazioni client utilizzando i framework Cloud Endpoints. Tieni presente che al momento sono supportati i client Android e JavaScript.
Endpoints Frameworks supporta l'autenticazione degli utenti da applicazioni client che utilizzano una delle seguenti metodologie:
Indipendentemente dal metodo di autenticazione utilizzato, in ogni metodo dell'API in cui vuoi verificare l'autenticazione corretta, devi verificare la presenza di un User
valido come descritto nelle seguenti sezioni:
- Autenticazione con Firebase Authentication
- Autenticazione con Auth0
- Autenticazione con token ID Google
Prerequisiti
Questa pagina presuppone che tu abbia già:
Hai creato un progetto Google Cloud.
- Se utilizzi JWT nel client per inviare richieste autenticate all'API, il JWT deve trovarsi nell'intestazione di autorizzazione di una richiesta HTTP. Il JWT deve avere i seguenti claim obbligatori:
-
iss
-
sub
-
aud
-
iat
-
exp
-
Autenticazione con Firebase Auth
Per supportare le chiamate da client che utilizzano Firebase Auth:
Importa l'API Cloud Endpoints di App Engine nella classe API:
import endpoints
Aggiungi un oggetto emittente Firebase per ogni client al decoratore API. Ad esempio:
@endpoints.api( name='YOUR_API_NAME', version='VERSION_NUMBER', issuers={'firebase': endpoints.Issuer( 'https://securetoken.google.com/YOUR_PROJECT_ID, 'https://www.googleapis.com/service_accounts/v1/metadata/x509/securetoken@system.gserviceaccount.com')})
- Sostituisci
YOUR_API_NAME
con il nome della tua API. - Sostituisci
VERSION_NUMBER
con la versione dell'API, ad esempiov1
. - Sostituisci code>YOUR_PROJECT_ID con l'ID del progetto Google Cloud del cliente.
- Sostituisci
In ogni metodo API in cui vuoi verificare l'autenticazione corretta, controlla la presenza di un
User
valido e generaerror 401
se non è presente, come mostrato in questa definizione di metodo di esempio:user = endpoints.get_current_user() # If there's no user defined, the request was unauthenticated, so we # raise 401 Unauthorized.
Esegui il deployment dell'API Endpoints. Devi eseguire nuovamente il deployment dell'API Endpoints ogni volta che aggiungi nuovi clienti.
Aggiunta dell'autenticazione Firebase a un client
Puoi aggiungere l'autenticazione Firebase al tuo codice come descritto nella documentazione di Firebase. Il cliente deve avere un progetto Google Cloud associato e l'ID progetto deve essere elencato nella configurazione del gestore Firebase dell'API.
Autenticazione con Auth0
Per supportare le chiamate da client che utilizzano Auth0:
Importa l'API App Engine Endpoints nella classe API:
import endpoints
Aggiungi un oggetto emittente Auth0 per ogni client al decoratore API. Ad esempio:
@endpoints.api( name='YOUR_API_NAME', version='VERSION_NUMBER', issuers={'auth0': endpoints.Issuer( 'https://YOUR_ACCOUNT_NAME.auth0.com', 'https://YOUR_ACCOUNT_NAME.auth0.com/.well-known/jwks.json')})
- Sostituisci
YOUR_API_NAME
con il nome della tua API. - Sostituisci
VERSION_NUMBER
con la versione dell'API, ad esempiov1
. - Sostituisci
YOUR_ACCOUNT_NAME
con il nome dell'account Auth0 utilizzato per il cliente.
- Sostituisci
In ogni metodo API in cui vuoi verificare l'autenticazione corretta, controlla la presenza di un
User
valido e generaerror 401
se non è presente, come mostrato in questa definizione di metodo di esempio:user = endpoints.get_current_user() # If there's no user defined, the request was unauthenticated, so we # raise 401 Unauthorized.
Distribuisci l'API . Devi eseguire nuovamente il deployment dell'API ogni volta che aggiungi nuovi client.
Aggiunta dell'autenticazione Auth0 a un client
Puoi aggiungere l'autenticazione Auth0 al tuo codice come descritto nella documentazione di Auth0. Il client deve essere elencato nella configurazione dell'emittente Auth0 dell'API.
Autenticazione con token ID Google
Per supportare le chiamate da client che si autenticano utilizzando token ID Google:
Ottieni un ID client OAuth 2 per ogni applicazione client. Il proprietario dell'applicazione cliente deve generare l'ID client dalla console Google Cloud. Per le istruzioni, consulta Creare ID client.
Importa l'API App Engine Endpoints nella classe API:
import endpoints
Specifica tutti gli ID client a cui vuoi concedere l'accesso alla tua API nel campo
allowed_client_ids
e specifica anche gli ID client appartenenti ai client Android nel campoaudiences
del decoratore API. Ad esempio:@endpoints.api( name='YOUR_API_NAME', version='VERSION_NUMBER', allowed_client_ids=ALLOWED_CLIENT_IDS, audiences=[ANDROID_AUDIENCE]) class AuthedGreetingApi(remote.Service): # ...
Sostituisci
ALLOWED_CLIENT_IDS
con l'elenco di ID client OAuth 2 generati dal progetto di ciascun cliente eANDROID_AUDIENCE
con l'elenco di ID client web Android. L'ID client web è l'ID client a cui è stato aggiunto.apps.googleusercontent.com
, ad esempio:YOUR_CLIENT_ID.apps.googleusercontent.com
.In ogni metodo API in cui vuoi verificare l'autenticazione corretta, controlla se è presente un
User
valido e generaerror 401
se non è presente, come mostrato in questa definizione di metodo di esempio:user = endpoints.get_current_user() # If there's no user defined, the request was unauthenticated, so we # raise 401 Unauthorized.
Esegui il deployment dell'API Endpoints. Devi eseguire nuovamente il deployment dell'API Endpoints ogni volta che aggiungi nuovi clienti.
Aggiunta dell'autenticazione tramite token ID Google a un client
Per informazioni sull'aggiunta del codice di autenticazione ai client, consulta quanto segue:
Passaggi successivi
Per informazioni di base sull'autenticazione utente e sulle differenze rispetto all'autorizzazione delle chiavi API, consulta Quando e perché utilizzare le chiavi API.