Questa pagina è stata tradotta dall'API Cloud Translation.

Migrazione dell'identità delle app ai token ID OIDC

Quando un'app in esecuzione nel runtime di Python 2 invia una richiesta a un'altra app App Engine, può utilizzare l'API App Identity di App Engine per affermare la propria identità. L'app che riceve la richiesta può utilizzare questa identità per determinare se deve elaborarla.

Se le tue applicazioni Python 3 devono affermare la propria identità quando inviano richieste ad altre applicazioni App Engine, puoi utilizzare i token ID OpenID Connect (OIDC) emessi e decodificati dalle API OAuth 2.0 di Google.

Ecco una panoramica dell'utilizzo dei token ID OIDC per affermare e verificare l'identità:

Un'app App Engine denominata "App A" recupera un token ID dall'ambiente di runtime Google Cloud.
L'app A aggiunge questo token a un'intestazione della richiesta appena prima di inviare la richiesta all'app B, un'altra app App Engine.
L'app B utilizza le API OAuth 2.0 di Google per verificare il payload del token. Il payload decodificato contiene l'identità verificata dell'app A sotto forma di indirizzo email dell'account di servizio predefinito dell'app A.
L'app B confronta l'identità nel payload con un elenco di identità a cui è autorizzata a rispondere. Se la richiesta proviene da un'app consentita, l'app B la elabora e risponde.

Procedura OAuth 2.0

Questa guida descrive come aggiornare le app App Engine in modo che utilizzino i token ID OpenID Connect (OIDC) per affermare l'identità e aggiornare le altre app App Engine in modo che utilizzino i token ID per verificare l'identità prima di elaborare una richiesta.

Differenze principali tra le API App Identity e OIDC

Le app nel runtime di Python 2 non devono dichiarare esplicitamente l'identità. Quando un'app utilizza le librerie Python httplib, urllib o urllib2 o il servizio di recupero URL di App Engine per inviare richieste in uscita, il runtime utilizza il servizio di recupero URL di App Engine per effettuare la richiesta. Se la richiesta viene inviata al dominio appspot.com, URL Fetch verifica automaticamente l'identità dell'app richiedente aggiungendo l'intestazione X-Appengine-Inbound-Appid alla richiesta. L'intestazione contiene l'ID applicazione dell'app (chiamato anche ID progetto).

Le app nel runtime di Python 3 devono affermare esplicitamente l'identità recuperando un token ID OIDC dall'ambiente di runtime di Google Cloud e aggiungendolo all'intestazione della richiesta. Dovrai aggiornare tutto il codice che invia richieste ad altre app App Engine in modo che le richieste contengano un token ID OIDC.
L'intestazione X-Appengine-Inbound-Appid in una richiesta contiene l'ID progetto dell'app che ha inviato la richiesta.

Il payload del token ID OIDC di Google non identifica direttamente l'ID progetto dell'app stessa. Il token identifica invece l'account di servizio in cui viene eseguita l'app, fornendo l'indirizzo email dell'account di servizio. Dovrai aggiungere del codice per estrarre il nome utente dal payload del token.

Se questo account di servizio è l'account di servizio App Engine predefinito a livello di app per il progetto, l'ID progetto è disponibile nell'indirizzo email dell'account di servizio. La parte del nome utente dell'indirizzo corrisponde all'ID progetto. In questo caso, il codice dell'app di ricezione può cercarlo nell'elenco degli ID progetto da cui consentirà le richieste.

Tuttavia, se l'app richiedente utilizza un account di servizio gestito dall'utente anziché il service account predefinito di App Engine, l'app di destinazione può verificare solo l'identità di quell'account di servizio, che non definirà necessariamente l'ID progetto dell'app richiedente. In questo caso, l'app di ricezione dovrà gestire un elenco di indirizzi email degli account di servizio consentiti anziché un elenco di ID progetto consentiti.
Le quote per le chiamate all'API URL Fetch sono diverse da quelle delle API OAuth 2.0 di Google per la concessione dei token. Puoi vedere il numero massimo di token che puoi concedere al giorno nella schermata per il consenso OAuth della console Google Cloud. Né URL Fetch, né l'API App Identity né le API OAuth 2.0 di Google comportano fatturazione.

Panoramica del processo di migrazione

Per eseguire la migrazione delle app Python in modo che utilizzino le API OIDC per affermare e verificare l'identità:

Nelle app che devono affermare l'identità quando inviano richieste ad altre app App Engine:
1. Attendi che l'app sia in esecuzione in un ambiente Python 3 per eseguire la migrazione ai token ID.
  
  Sebbene sia possibile utilizzare gli ID token nel runtime Python 2, i passaggi in Python 2 sono complessi e sono necessari solo temporaneamente fino a quando non aggiorni l'app in modo che venga eseguita nel runtime Python 3.
2. Una volta che l'app è in esecuzione in Python 3, aggiornala per richiedere un token ID e aggiungilo a un'intestazione di richiesta.
Nelle app che devono verificare l'identità prima di elaborare una richiesta:
1. Inizia eseguendo l'upgrade delle app Python 2 per supportare sia i token ID sia le identità dell'API App Identity. In questo modo, le tue app potranno verificare ed elaborare le richieste provenienti da app Python 2 che utilizzano l'API App Identity o da app Python 3 che utilizzano token ID.
2. Una volta che le app Python 2 di cui è stato eseguito l'upgrade sono stabili, esegui la migrazione al runtime Python 3. Continua a supportare sia gli ID token sia le identità dell'API App Identity fino a quando non avrai la certezza che le app non debbano più supportare le richieste provenienti dalle app precedenti.
3. Quando non hai più bisogno di elaborare richieste da app App Engine legacy, rimuovi il codice che verifica le identità dell'API App Identity.
Dopo aver testato le app, deploy dell'app che elabora le richieste in primo luogo. Poi esegui il deployment dell'app Python 3 aggiornata che utilizza i token ID per affermare l'identità.

Affermazione dell'identità

Attendi che l'app venga eseguita in un ambiente Python 3, quindi segui questi passaggi per eseguire l'upgrade dell'app in modo da affermare l'identità con i token ID:

Installa la libreria client google-auth.
Aggiungi codice per richiedere un token ID dalle API OAuth 2.0 di Google e aggiungi il token a un'intestazione della richiesta prima di inviare una richiesta.
Prova gli aggiornamenti.

Installazione della libreria client `google-auth` per le app Python 3

Per rendere disponibile la libreria client google-auth per la tua app Python3, crea un file requirements.txt nella stessa cartella del file app.yaml e aggiungi la riga seguente:

     google-auth

Quando esegui il deployment dell'app, App Engine scarica tutte le dipendenze definite nel file requirements.txt.

Per lo sviluppo locale, ti consigliamo di installare le dipendenze in un ambiente virtuale come venv.

Aggiunta di codice per l'affermazione dell'identità

Cerca nel codice e trova tutte le istanze di invio di richieste ad altre app App Engine. Aggiorna queste istanze per eseguire quanto segue prima di inviare la richiesta:

Aggiungi le seguenti importazioni:

from google.auth.transport import requests as reqs
from google.oauth2 import id_token

Utilizza google.oauth2.id_token.fetch_id_token(request, audience) per recuperare un token ID. Includi i seguenti parametri nella chiamata al metodo:
- request: passa l'oggetto della richiesta che stai per inviare.
- audience: passa l'URL dell'app a cui stai inviando la richiesta. In questo modo il token viene associato alla richiesta e ne impedisce l'utilizzo da parte di un'altra app.
  
  Per chiarezza e specificità, ti consigliamo di passare l'URL appspot.com creato da App Engine per il servizio specifico che riceve la richiesta, anche se utilizzi un dominio personalizzato per l'app.
Nell'oggetto della richiesta, imposta la seguente intestazione:
```
'Authorization': 'ID {}'.format(token)
```

Ad esempio:

# Copyright 2020 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

from flask import Flask, render_template, request
from google.auth.transport import requests as reqs
from google.oauth2 import id_token
import requests

app = Flask(__name__)


@app.route("/", methods=["GET"])
def index():
    return render_template("index.html")


@app.route("/", methods=["POST"])
def make_request():
    url = request.form["url"]
    token = id_token.fetch_id_token(reqs.Request(), url)

    resp = requests.get(url, headers={"Authorization": f"Bearer {token}"})

    message = f"Response when calling {url}:\n\n"
    message += resp.text

    return message, 200, {"Content-type": "text/plain"}

Aggiornamenti dei test per l'affermazione dell'identità

Per eseguire l'app in locale e verificare se l'app può inviare correttamente i token ID:

Segui questi passaggi per rendere disponibili le credenziali dell'account di servizio App Engine predefinito nel tuo ambiente locale (le API OAuth di Google richiedono queste credenziali per generare un token ID):
1. Inserisci il seguente comando gcloud per recuperare la chiave dell'account di servizio per l'account App Engine predefinito del progetto:
  
  gcloud iam service-accounts keys create ~/key.json --iam-account project-ID@appspot.gserviceaccount.com
  
  Sostituisci project-ID con l'ID del tuo progetto Google Cloud.
  
  Il file della chiave dell'account di servizio è stato scaricato sul computer. Puoi spostare e rinominare il file come preferisci. Assicurati di archiviare questo file in modo sicuro perché può essere utilizzato per l'autenticazione come account di servizio. Se perdi il file o se è esposto a utenti non autorizzati, elimina la chiave dell'account di servizio e creane una nuova.
2. Inserisci questo comando:
```
<code>export GOOGLE_APPLICATION_CREDENTIALS=<var>service-account-key</var></code>
```
Sostituisci service-account-key con il percorso assoluto del file che contiene la chiave dell'account di servizio che hai scaricato.
Nella stessa shell in cui hai esportato la variabile di ambiente GOOGLE_APPLICATION_CREDENTIALS, avvia l'app Python.
Invia una richiesta dall'app e verifica che l'operazione vada a buon fine. Se non hai già un'app che può ricevere richieste e utilizzare token ID per verificare le identità:
1. Scarica l'app di esempio "in entrata".
2. Nel file main.py del Sample, aggiungi l'ID del tuo progetto Google Cloud al allowed_app_ids. Ad esempio:
```
 allowed_app_ids = [
    '<APP_ID_1>',
    '<APP_ID_2>',
    'my-project-id'
  ]
```
3. Esegui l'esempio aggiornato nel server di sviluppo locale Python 2.

Verifica ed elaborazione delle richieste

Per eseguire l'upgrade delle app Python 2 in modo che utilizzino gli ID token o le identità dell'API App Identity prima di elaborare le richieste:

Installa la libreria client google-auth.
Aggiorna il codice per eseguire le seguenti operazioni:
1. Se la richiesta contiene l'intestazione X-Appengine-Inbound-Appid, utilizzala per verificare l'identità. Le app in esecuzione in un runtime precedente come Python 2 conterranno questa intestazione.
2. Se la richiesta non contiene l'intestazione X-Appengine-Inbound-Appid, controlla se è presente un token ID OIDC. Se il token esiste, verifica il relativo payload e controlla l'identità del mittente.
Prova gli aggiornamenti.

Installazione della libreria client google-auth per le app Python 2

Per rendere disponibile la libreria client google-auth per la tua app Python 2:

Crea un file requirements.txt nella stessa cartella del file app.yaml e aggiungi la seguente riga:
```
 google-auth==1.19.2
```
Ti consigliamo di utilizzare la versione 1.19.2 della libreria client di Cloud Logging poiché supporta le app Python 2.7.
Nel file app.yaml della tua app, specifica la libreria SSL nella sezione libraries se non è già stata specificata:
```
libraries:
- name: ssl
  version: latest
```
Crea una directory per archiviare le librerie di terze parti, ad esempio lib/. Quindi utilizza pip install per installare le librerie nella directory. Ad esempio:
```
pip install -t lib -r requirements.txt
```

Crea un file appengine_config.py nella stessa cartella del file app.yaml. Aggiungi quanto segue al tuo file appengine_config.py:

# appengine_config.py
import pkg_resources
from google.appengine.ext import vendor

# Set path to your libraries folder.
path = 'lib'
# Add libraries installed in the path folder.
vendor.add(path)
# Add libraries to pkg_resources working set to find the distribution.
pkg_resources.working_set.add_entry(path)

Il file appengine_config.py nell'esempio precedente presuppone che la la cartella lib si trovi nella directory di lavoro corrente. Se non puoi garantire che lib si trovi sempre nella directory di lavoro corrente, specifica il percorso completo della cartella lib. Ad esempio:

import os
path = os.path.join(os.path.dirname(os.path.realpath(__file__)), 'lib')

Per lo sviluppo locale, ti consigliamo di installare le dipendenze in un ambiente virtuale come virtualenv per Python 2.

Aggiornamento del codice per la verifica delle richieste

Cerca nel codice e trova tutte le istanze di recupero del valore dell'X-Appengine-Inbound-Appid intestazione. Aggiorna queste istanze per eseguire le seguenti operazioni:

Aggiungi le seguenti importazioni:

from google.auth.transport import requests as reqs
from google.oauth2 import id_token

Se la richiesta in arrivo non contiene l'intestazione X-Appengine-Inbound-Appid, cerca l'intestazione Authorization e recupera il relativo valore.

Il valore dell'intestazione è formattato come "ID: token".
Utilizza google.oauth2.id_token.verify_oauth2_token(token, request, audience) per verificare e recuperare il payload del token decodificato. Includi i seguenti parametri nella chiamata al metodo:
- token: passa il token estratto dalla richiesta in arrivo.
- request: passa un nuovo oggetto google.auth.transport.Request.
- audience: passa l'URL dell'app corrente (l'app che invia la richiesta di verifica). Il server di autorizzazione di Google confronterà questo URL con quello fornito al momento della generazione originale del token. Se gli URL non corrispondono, il token non verrà verificato e il server di autorizzazione restituirà un errore.
Il metodo verify_oauth2_token restituisce il payload del token decodificato, che contiene diverse coppie nome/valore, tra cui l'indirizzo email dell'account di servizio predefinito per l'app che ha generato il token.
Estrai il nome utente dall'indirizzo email nel payload del token.

Il nome utente corrisponde all'ID progetto dell'app che ha inviato la richiesta. Si tratta dello stesso valore restituito in precedenza nell'intestazione X-Appengine-Inbound-Appid.
Se il nome utente/l'ID progetto è presente nell'elenco degli ID progetto consentiti, elabora la richiesta.

Ad esempio:

# Copyright 2020 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

"""
Authenticate requests coming from other App Engine instances.
"""

from google.oauth2 import id_token
from google.auth.transport import requests

import logging
import webapp2


def get_app_id(request):
    # Requests from App Engine Standard for Python 2.7 will include a
    # trustworthy X-Appengine-Inbound-Appid. Other requests won't have
    # that header, as the App Engine runtime will strip it out
    incoming_app_id = request.headers.get("X-Appengine-Inbound-Appid", None)
    if incoming_app_id is not None:
        return incoming_app_id

    # Other App Engine apps can get an ID token for the App Engine default
    # service account, which will identify the application ID. They will
    # have to include at token in an Authorization header to be recognized
    # by this method.
    auth_header = request.headers.get("Authorization", None)
    if auth_header is None:
        return None

    # The auth_header must be in the form Authorization: Bearer token.
    bearer, token = auth_header.split()
    if bearer.lower() != "bearer":
        return None

    try:
        info = id_token.verify_oauth2_token(token, requests.Request())
        service_account_email = info["email"]
        incoming_app_id, domain = service_account_email.split("@")
        if domain != "appspot.gserviceaccount.com":  # Not App Engine svc acct
            return None
        else:
            return incoming_app_id
    except Exception as e:
        # report or log if desired, as here:
        logging.warning("Request has bad OAuth2 id token: {}".format(e))
        return None


class MainPage(webapp2.RequestHandler):
    allowed_app_ids = ["other-app-id", "other-app-id-2"]

    def get(self):
        incoming_app_id = get_app_id(self.request)

        if incoming_app_id is None:
            self.abort(403)

        if incoming_app_id not in self.allowed_app_ids:
            self.abort(403)

        self.response.write("This is a protected page.")


app = webapp2.WSGIApplication([("/", MainPage)], debug=True)

Aggiornamenti sui test per la verifica dell'identità

Per verificare che la tua app possa utilizzare un token ID o il X-Appengine-Inbound-Appid header per verificare le richieste, esegui l'app nel server di sviluppo locale di Python 2 e invia richieste da app Python 2 (che utilizzeranno l'API App Identity) e da app Python 3 che inviano token ID.

Se non hai aggiornato le tue app per inviare token ID:

Scarica la app "richiedente" di esempio.
Aggiungi le credenziali dell'account di servizio al tuo ambiente locale come descritto in Aggiornamenti di test per l'affermazione delle app.
Utilizza i comandi standard di Python 3 per avviare l'app di esempio Python 3.
Invia una richiesta dall'app di esempio e verifica che venga eseguita correttamente.

Deployment delle app

Quando è tutto pronto per il deployment delle app, devi:

Testa le app su App Engine.
Se le app funzionano senza errori, utilizza la suddivisione del traffico per aumentare gradualmente il traffico per le app aggiornate. Monitora attentamente le app per rilevare eventuali problemi prima di indirizzare altro traffico alle app aggiornate.

Utilizzo di un account di servizio diverso per l'affermazione dell'identità

Quando richiedi un token ID, per impostazione predefinita la richiesta utilizza l'identità dell'account di servizio predefinito di App Engine. Quando verifichi il token, il relativo payload contiene l'indirizzo email dell'account servizio predefinito, che corrisponde all'ID progetto della tua app.

Il service account predefinito di App Engine ha un livello di autorizzazione molto elevato per impostazione predefinita. Può visualizzare e modificare l'intero progetto Google Cloud, pertanto nella maggior parte dei casi non è appropriato utilizzarlo quando l'app deve autenticarsi con i servizi Cloud.

Tuttavia, l'account di servizio predefinito è sicuro da utilizzare per affermare l'identità dell'app perché utilizzi il token ID solo per verificare l'identità dell'app che ha inviato una richiesta. Le autorizzazioni effettive concesse all'account di servizio non vengono prese in considerazione o non sono necessarie durante questa procedura.

Se preferisci comunque utilizzare un account di servizio diverso per le richieste di token di abilitazione, procedi nel seguente modo:

Imposta una variabile di ambiente denominata GOOGLE_APPLICATION_CREDENTIALS sul percorso di un file JSON contenente le credenziali dell'account di servizio. Consulta i nostri consigli per conservare al sicuro queste credenziali.
Utilizza google.oauth2.id_token.fetch_id_token(request, audience) per recuperare un token ID.
Quando verifichi questo token, il relativo payload conterrà l'indirizzo email del nuovo account di servizio.