Gestire gli accessi ripetuti

Python

Vai alle definizioni delle route Flask (routes.py se segui il nostro esempio fornito). Nella parte superiore del percorso di destinazione del componente aggiuntivo (/classroom-addon nel nostro esempio fornito), recupera e memorizza il login_hint parametro di query:

# If the login_hint query parameter is available, we'll store it in the session.
if flask.request.args.get("login_hint"):
    flask.session["login_hint"] = flask.request.args.get("login_hint")

Assicurati che login_hint (se presente) sia archiviato nella sessione. Questo è un luogo appropriato per archiviare questi valori, che sono effimeri e ricevi nuovi valori quando il componente aggiuntivo viene aperto.

# It's possible that we might return to this route later, in which case the
# parameters will not be passed in. Instead, use the values cached in the
# session.
login_hint = flask.session.get("login_hint")

# If there's still no login_hint query parameter, this must be their first
# time signing in, so send the user to the sign in page.
if login_hint is None:
    return start_auth_flow()

Java

Vai al percorso di destinazione del componente aggiuntivo nella classe del controller (/addon-discovery in AuthController.java nell'esempio fornito). All'inizio di questo percorso, recupera e memorizza il parametro di query login_hint.

/** Retrieve the login_hint query parameter from the request URL if present. */
String login_hint = request.getParameter("login_hint");

Assicurati che login_hint (se presente) sia archiviato nella sessione. Questo è un luogo appropriato per archiviare questi valori, che sono effimeri e ricevi nuovi valori quando il componente aggiuntivo viene aperto.

/** If login_hint wasn't sent, use the values in the session. */
if (login_hint == null) {
    login_hint = (String) session.getAttribute("login_hint");
}

/** If the there is still no login_hint, route the user to the authorization
 *  page. */
if (login_hint == null) {
    return startAuthFlow(model);
}

/** If the login_hint query parameter is provided, add it to the session. */
else if (login_hint != null) {
    session.setAttribute("login_hint", login_hint);
}

Python

Vai alla route di autorizzazione nel file del server Flask (/authorize nel nostro esempio fornito). Aggiungi l'argomento login_hint alla chiamata a flow.authorization_url.

authorization_url, state = flow.authorization_url(
    # Enable offline access so that you can refresh an access token without
    # re-prompting the user for permission. Recommended for web server apps.
    access_type="offline",
    # Enable incremental authorization. Recommended as a best practice.
    include_granted_scopes="true",
    # The user will automatically be selected if we have the login_hint.
    login_hint=flask.session.get("login_hint"),

Java

Vai al metodo authorize() nella classe AuthService.java. Aggiungi login_hint come parametro al metodo e l'argomento login_hint al generatore di URL di autorizzazione.

String authUrl = flow
    .newAuthorizationUrl()
    .setState(state)
    .set("login_hint", login_hint)
    .setRedirectUri(REDIRECT_URI)
    .build();

Python

Definisci lo schema utente

Un User contiene i seguenti attributi:

• id: l'ID Google dell'utente. Deve corrispondere ai valori forniti nel parametro di query login_hint.
• display_name: il nome e il cognome dell'utente, ad esempio "Alex Smith".
• email: l'indirizzo email dell'utente.
• portrait_url: l'URL dell'immagine del profilo dell'utente.
• refresh_token: il token di aggiornamento acquisito in precedenza.

Questo esempio implementa lo spazio di archiviazione utilizzando SQLite, supportato in modo nativo da Python. Utilizza il modulo flask_sqlalchemy per semplificare la gestione del database.

Configura il database

Innanzitutto, specifica la posizione del file per il nostro database. Vai al file di configurazione del server (config.py nell'esempio fornito) e aggiungi quanto segue.

import os

# Point to a database file in the project root.
DATABASE_FILE_NAME = os.path.join(
    os.path.abspath(os.path.dirname(__file__)), 'data.sqlite')

class Config(object):
    SQLALCHEMY_DATABASE_URI = f"sqlite:///{DATABASE_FILE_NAME}"
    SQLALCHEMY_TRACK_MODIFICATIONS = False

In questo modo, Flask viene indirizzato al file data.sqlite nella stessa directory del file main.py.

Poi, vai alla directory del modulo e crea un nuovo file models.py. Si tratta di webapp/models.py se stai seguendo l'esempio che ti abbiamo fornito. Aggiungi quanto segue al nuovo file per definire la tabella User, sostituendo il nome del modulo al posto di webapp, se diverso.

from webapp import db

# Database model to represent a user.
class User(db.Model):
    # The user's identifying information:
    id = db.Column(db.String(120), primary_key=True)
    display_name = db.Column(db.String(80))
    email = db.Column(db.String(120), unique=True)
    portrait_url = db.Column(db.Text())

    # The user's refresh token, which will be used to obtain an access token.
    # Note that refresh tokens will become invalid if:
    # - The refresh token has not been used for six months.
    # - The user revokes your app's access permissions.
    # - The user changes passwords.
    # - The user belongs to a Google Cloud organization
    #   that has session control policies in effect.
    refresh_token = db.Column(db.Text())

Infine, nel file __init__.py del modulo, aggiungi quanto segue per importare i nuovi modelli e creare il database.

from webapp import models
from os import path
from flask_sqlalchemy import SQLAlchemy

db = SQLAlchemy(app)

# Initialize the database file if not created.
if not path.exists(config.DATABASE_FILE_NAME):
    db.create_all()

Java

Definisci lo schema utente

Un User contiene i seguenti attributi:

• id: l'ID Google dell'utente. Deve corrispondere al valore fornito nel login_hint parametro di query.
• email: l'indirizzo email dell'utente.

Crea un file schema.sql nella directory resources del modulo. Spring legge questo file e genera uno schema per il database di conseguenza. Definisci la tabella con un nome, users, e le colonne per rappresentare gli attributi User, id e email.

CREATE TABLE IF NOT EXISTS users (
    id VARCHAR(255) PRIMARY KEY, -- user's unique Google ID
    email VARCHAR(255), -- user's email address
);

Crea una classe Java per definire il modello User per il database. Si tratta di User.java nell'esempio fornito.

Aggiungi l'annotazione @Entity per indicare che si tratta di un POJO che può essere salvato nel database. Aggiungi l'annotazione @Table con il nome della tabella corrispondente che hai configurato in schema.sql.

Tieni presente che l'esempio di codice include i costruttori e i setter per i due attributi. Il costruttore e i setter vengono utilizzati in AuthController.java per creare o aggiornare un utente nel database. Puoi anche includere getter e un metodo toString come preferisci, ma per questa procedura dettagliata in particolare, questi metodi non vengono utilizzati e sono omessi dall'esempio di codice in questa pagina per brevità.

/** An entity class that provides a model to store user information. */
@Entity
@Table(name = "users")
public class User {
    /** The user's unique Google ID. The @Id annotation specifies that this
     *   is the primary key. */
    @Id
    @Column
    private String id;

    /** The user's email address. */
    @Column
    private String email;

    /** Required User class no args constructor. */
    public User() {
    }

    /** The User class constructor that creates a User object with the
    *   specified parameters.
    *   @param id the user's unique Google ID
    *   @param email the user's email address
    */
    public User(String id, String email) {
        this.id = id;
        this.email = email;
    }

    public void setId(String id) { this.id = id; }

    public void setEmail(String email) { this.email = email; }
}

Crea un'interfaccia denominata UserRepository.java per gestire le operazioni CRUD sul database. Questa interfaccia estende l'interfaccia CrudRepository.

/** Provides CRUD operations for the User class by extending the
 *   CrudRepository interface. */
@Repository
public interface UserRepository extends CrudRepository<User, String> {
}

La classe del controller facilita la comunicazione tra il client e il repository. Pertanto, aggiorna il costruttore della classe del controller per iniettare la classe UserRepository.

/** Declare UserRepository to be used in the Controller class constructor. */
private final UserRepository userRepository;

/**
*   ...
*   @param userRepository the class that interacts with User objects stored in
*   persistent storage.
*/
public AuthController(AuthService authService, UserRepository userRepository) {
    this.authService = authService;
    this.userRepository = userRepository;
}

Configura il database

Per archiviare le informazioni relative all'utente, utilizza un database H2 supportato intrinsecamente in Spring Boot. Questo database viene utilizzato anche nelle walkthrough successive per archiviare altre informazioni relative a Classroom. La configurazione del database H2 richiede l'aggiunta della seguente configurazione a application.properties.

# Enable configuration for persistent storage using an H2 database
spring.datasource.driver-class-name=org.h2.Driver
spring.datasource.url=jdbc:h2:file:./h2/userdb
spring.datasource.username=<USERNAME>
spring.datasource.password=<PASSWORD>
spring.jpa.hibernate.ddl-auto=update
spring.jpa.open-in-view=false

La configurazione spring.datasource.url crea una directory, denominata h2, con il file userdb al suo interno. Aggiungi il percorso al database H2 al .gitignore. Devi aggiornare spring.datasource.username e spring.datasource.password prima di eseguire l'applicazione per impostare il database con un nome utente e una password a tua scelta. Per aggiornare il nome utente e la password per il database dopo l'esecuzione dell'applicazione, elimina la directory h2 generata, aggiorna la configurazione ed esegui di nuovo l'applicazione.

L'impostazione della configurazione spring.jpa.hibernate.ddl-auto su update garantisce che i dati archiviati nel database vengano conservati al riavvio dell'applicazione. Per cancellare il database ogni volta che l'applicazione viene riavviata, imposta questa configurazione su create.

Imposta la configurazione spring.jpa.open-in-view su false. Questa configurazione è attivata per impostazione predefinita e può causare problemi di prestazioni difficili da diagnosticare in produzione.

Come descritto in precedenza, devi essere in grado di recuperare le credenziali di un utente abituale. Questa operazione è facilitata dal supporto del gestore delle credenziali integratoofferto da GoogleAuthorizationCodeFlow.

Nella classe AuthService.java, definisci un percorso al file in cui è memorizzata la classe delle credenziali. In questo esempio, il file viene creato nella directory /credentialStore. Aggiungi il percorso all'archivio delle credenziali a .gitignore. Questa directory viene generata quando l'utente inizia il flusso di autorizzazione.

private static final File dataDirectory = new File("credentialStore");

Quindi, crea un metodo nel file AuthService.java che crei e restituisce un oggetto FileDataStoreFactory. Si tratta del datastore che memorizza le credenziali.

/** Creates and returns FileDataStoreFactory object to store credentials.
 *   @return FileDataStoreFactory dataStore used to save and obtain users ids
 *   mapped to Credentials.
 *   @throws IOException if creating the dataStore is unsuccessful.
 */
public FileDataStoreFactory getCredentialDataStore() throws IOException {
    FileDataStoreFactory dataStore = new FileDataStoreFactory(dataDirectory);
    return dataStore;
}

Aggiorna il metodo getFlow() in AuthService.java in modo da includere setDataStoreFactory nel metodo GoogleAuthorizationCodeFlow Builder() e chiama getCredentialDataStore() per impostare il datastore.

GoogleAuthorizationCodeFlow authorizationCodeFlow =
    new GoogleAuthorizationCodeFlow.Builder(
        HTTP_TRANSPORT,
        JSON_FACTORY,
        getClientSecrets(),
        getScopes())
    .setAccessType("offline")
    .setDataStoreFactory(getCredentialDataStore())
    .build();

Aggiorna il metodo getAndSaveCredentials(String authorizationCode). In precedenza, questo metodo otteneva le credenziali senza memorizzarle da nessuna parte. Aggiorna il metodo per memorizzare le credenziali nel datastore indicizzato dall'ID utente.

L'ID utente può essere ottenuto dall'oggetto TokenResponse utilizzando id_token, ma deve essere verificato prima. In caso contrario, le applicazioni client potrebbero essere in grado di rubare l'identità degli utenti inviando al server ID utente modificati. Ti consigliamo di utilizzare le librerie client dell'API di Google per convalidare id_token. Per ulteriori informazioni, consulta la [pagina di Google Identity sulla verifica del token ID Google].

// Obtaining the id_token will help determine which user signed in to the application.
String idTokenString = tokenResponse.get("id_token").toString();

// Validate the id_token using the GoogleIdTokenVerifier object.
GoogleIdTokenVerifier googleIdTokenVerifier = new GoogleIdTokenVerifier.Builder(
        HTTP_TRANSPORT,
        JSON_FACTORY)
    .setAudience(Collections.singletonList(
        googleClientSecrets.getWeb().getClientId()))
    .build();

GoogleIdToken idToken = googleIdTokenVerifier.verify(idTokenString);

if (idToken == null) {
    throw new Exception("Invalid ID token.");
}

Una volta verificato il id_token, ottieni il userId da archiviare insieme alle credenziali ottenute.

// Obtain the user id from the id_token.
Payload payload = idToken.getPayload();
String userId = payload.getSubject();

Aggiorna la chiamata a flow.createAndStoreCredential in modo da includere userId.

// Save the user id and credentials to the configured FileDataStoreFactory.
Credential credential = flow.createAndStoreCredential(tokenResponse, userId);

Aggiungi un metodo alla classe AuthService.java che restituisce le credenziali per un utente specifico, se esistente nel data store.

/** Find credentials in the datastore based on a specific user id.
*   @param userId key to find in the file datastore.
*   @return Credential object to be returned if a matching key is found in the datastore. Null if
*   the key doesn't exist.
*   @throws Exception if building flow object or checking for userId key is unsuccessful. */
public Credential loadFromCredentialDataStore(String userId) throws Exception {
    try {
        GoogleAuthorizationCodeFlow flow = getFlow();
        Credential credential = flow.loadCredential(userId);
        return credential;
    } catch (Exception e) {
        e.printStackTrace();
        throw e;
    }
}

Python

def get_credentials_from_storage(id):
    """
    Retrieves credentials from the storage and returns them as a dictionary.
    """
    return User.query.get(id)

Java

Nella classe AuthController.java, definisci un metodo per recuperare un utente dal database in base al suo ID utente.

/** Retrieves stored credentials based on the user id.
*   @param id the id of the current user
*   @return User the database entry corresponding to the current user or null
*   if the user doesn't exist in the database.
*/
public User getUser(String id) {
    if (id != null) {
        Optional<User> user = userRepository.findById(id);
        if (user.isPresent()) {
            return user.get();
        }
    }
    return null;
}

Python

Innanzitutto, definisci un metodo di utilità che implementi il comportamento di archiviazione o aggiornamento.

def save_user_credentials(credentials=None, user_info=None):
    """
    Updates or adds a User to the database. A new user is added only if both
    credentials and user_info are provided.

    Args:
        credentials: An optional Credentials object.
        user_info: An optional dict containing user info returned by the
            OAuth 2.0 API.
    """

    existing_user = get_credentials_from_storage(
        flask.session.get("login_hint"))

    if existing_user:
        if user_info:
            existing_user.id = user_info.get("id")
            existing_user.display_name = user_info.get("name")
            existing_user.email = user_info.get("email")
            existing_user.portrait_url = user_info.get("picture")

        if credentials and credentials.refresh_token is not None:
            existing_user.refresh_token = credentials.refresh_token

    elif credentials and user_info:
        new_user = User(id=user_info.get("id"),
                        display_name=user_info.get("name"),
                        email=user_info.get("email"),
                        portrait_url=user_info.get("picture"),
                        refresh_token=credentials.refresh_token)

        db.session.add(new_user)

    db.session.commit()

Esistono due casi in cui potresti salvare le credenziali nel database: quando l'utente torna alla tua applicazione al termine del flusso di autorizzazione e quando emetti una chiamata API. Qui abbiamo impostato in precedenza la chiave credentials della sessione.

Chiama save_user_credentials al termine del percorso callback. Mantieni l'oggetto user_info anziché estrarne solo il nome dell'utente.

# The flow is complete! We'll use the credentials to fetch the user's info.
user_info_service = googleapiclient.discovery.build(
    serviceName="oauth2", version="v2", credentials=credentials)

user_info = user_info_service.userinfo().get().execute()

flask.session["username"] = user_info.get("name")

save_user_credentials(credentials, user_info)

Dovresti anche aggiornare le credenziali dopo le chiamate all'API. In questo caso puoi fornire le credenziali aggiornate come argomenti al metodo save_user_credentials.

# Save credentials in case access token was refreshed.
flask.session["credentials"] = credentials_to_dict(credentials)
save_user_credentials(credentials)

Java

Innanzitutto, definisci un metodo che memorizzi o aggiorni un oggetto User nel database H2.

/** Adds or updates a user in the database.
*   @param credential the credentials object to save or update in the database.
*   @param userinfo the userinfo object to save or update in the database.
*   @param session the current session.
*/
public void saveUser(Credential credential, Userinfo userinfo, HttpSession session) {
    User storedUser = null;
    if (session != null && session.getAttribute("login_hint") != null) {
        storedUser = getUser(session.getAttribute("login_hint").toString());
    }

    if (storedUser != null) {
        if (userinfo != null) {
            storedUser.setId(userinfo.getId());
            storedUser.setEmail(userinfo.getEmail());
        }
        userRepository.save(storedUser);
    } else if (credential != null && userinfo != null) {
        User newUser = new User(
            userinfo.getId(),
            userinfo.getEmail(),
        );
        userRepository.save(newUser);
    }
}

Esistono due casi in cui potresti salvare le credenziali nel database: quando l'utente torna alla tua applicazione al termine del flusso di autorizzazione e quando emetti una chiamata API. Qui abbiamo impostato in precedenza la chiave credentials della sessione.

Chiama saveUser alla fine del percorso /callback. Devi conservare l'oggettouser_info anziché semplicemente estrarre l'email dell'utente.

/** This is the end of the auth flow. We should save user info to the database. */
Userinfo userinfo = authService.getUserInfo(credentials);
saveUser(credentials, userinfo, session);

Dovresti anche aggiornare le credenziali dopo le chiamate all'API. In questo caso, puoi fornire le credenziali aggiornate come argomenti al metodo saveUser.

/** Save credentials in case access token was refreshed. */
saveUser(credentials, null, session);

Python

Assicurati che il file del database sia stato creato al momento del lanciamento dell'applicazione. Inserisci quanto segue in un'inizializzazione del modulo (ad esempio webapp/__init__.py nell'esempio fornito) o nel metodo principale che avvia il server.

# Initialize the database file if not created.
if not os.path.exists(DATABASE_FILE_NAME):
    db.create_all()

Il metodo deve quindi gestire il parametro di query login_hint come discusso sopra. Quindi, carica le credenziali del negozio se si tratta di un visitatore abituale. Sai che si tratta di un visitatore abituale se hai ricevuto login_hint. Recupera le credenziali archiviate per questo utente e caricale nella sessione.

stored_credentials = get_credentials_from_storage(login_hint)

# If we have stored credentials, store them in the session.
if stored_credentials:
    # Load the client secrets file contents.
    client_secrets_dict = json.load(
        open(CLIENT_SECRETS_FILE)).get("web")

    # Update the credentials in the session.
    if not flask.session.get("credentials"):
        flask.session["credentials"] = {}

    flask.session["credentials"] = {
        "token": stored_credentials.access_token,
        "refresh_token": stored_credentials.refresh_token,
        "token_uri": client_secrets_dict["token_uri"],
        "client_id": client_secrets_dict["client_id"],
        "client_secret": client_secrets_dict["client_secret"],
        "scopes": SCOPES
    }

    # Set the username in the session.
    flask.session["username"] = stored_credentials.display_name

Infine, indirizza l'utente alla pagina di accesso se non disponiamo delle sue credenziali. In questo caso, indirizzalo alla pagina principale del componente aggiuntivo.

if "credentials" not in flask.session or \
    flask.session["credentials"]["refresh_token"] is None:
    return flask.render_template("authorization.html")

return flask.render_template(
    "addon-discovery.html",
    message="You've reached the addon discovery page.")

Java

Vai alla pagina di destinazione del componente aggiuntivo (/addon-discovery nell'esempio fornito). Come discusso sopra, è qui che hai gestito il parametro di query login_hint.

Innanzitutto, controlla se le credenziali esistono nella sessione. In caso contrario, indirizza l'utente attraverso il flusso di autenticazione chiamando il metodo startAuthFlow.

/** Check if the credentials exist in the session. The session could have
 *   been cleared when the user clicked the Sign-Out button, and the expected
 *   behavior after sign-out would be to display the sign-in page when the
 *   iframe is opened again. */
if (session.getAttribute("credentials") == null) {
    return startAuthFlow(model);
}

Quindi, carica l'utente dal database H2 se si tratta di un visitatore abituale. Si tratta di un visitatore abituale se ricevi il parametro di query login_hint. Se l'utente esiste nel database H2, carica le credenziali dal datastore delle credenziali configurato in precedenza e impostale nella sessione. Se le credenziali non sono state ottenute dal datastore delle credenziali, indirizza l'utente tramite il flusso di autenticazione chiamando startAuthFlow.

/** At this point, we know that credentials exist in the session, but we
 *   should update the session credentials with the credentials in persistent
 *   storage in case they were refreshed. If the credentials in persistent
 *   storage are null, we should navigate the user to the authorization flow
 *   to obtain persisted credentials. */

User storedUser = getUser(login_hint);

if (storedUser != null) {
    Credential credential = authService.loadFromCredentialDataStore(login_hint);
    if (credential != null) {
        session.setAttribute("credentials", credential);
    } else {
        return startAuthFlow(model);
    }
}

Infine, indirizza l'utente alla pagina di destinazione del componente aggiuntivo.

/** Finally, if there are credentials in the session and in persistent
 *   storage, direct the user to the addon-discovery page. */
return "addon-discovery";