Obsługa wielokrotnego logowania

Python

Przejdź do definicji swoich tras Flask (routes.py, jeśli korzystasz z naszego przykładu). Na górze trasy docelowej dodatku (w tym przykładzie /classroom-addon) pobierz i zapisz parametry zapytania login_hint i hd:

# Retrieve the login_hint and hd query parameters.
login_hint = flask.request.args.get("login_hint")
hd = flask.request.args.get("hd")

Sprawdź, czy login_hint i hd są przechowywane w sesji. To odpowiednie miejsce do przechowywania tych wartości. Są one efemeryczne i po otwarciu dodatku otrzymujesz nowe wartości.

# 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.

# If neither query parameter is available, use the values in the session.
if login_hint is None and hd is None:
    login_hint = flask.session.get("login_hint")
    hd = flask.session.get("hd")

# If there's no login_hint query parameter, then check for hd.
# Send the user to the sign in page.
elif hd is not None:
    flask.session["hd"] = hd
    return start_auth_flow()

# If the login_hint query parameter is available, we'll store it in the
# session.
else:
    flask.session["login_hint"] = login_hint

Java

Przejdź do trasy docelowej dodatku w klasie kontrolera (w podanym przykładzie /addon-discovery w obiekcie AuthController.java). Na początku tej trasy pobierz i zapisz parametry zapytania login_hint i hd.

/** Retrieve the login_hint or hd query parameters from the request URL. */
String login_hint = request.getParameter("login_hint");
String hd = request.getParameter("hd");

Sprawdź, czy login_hint i hd są przechowywane w sesji. To odpowiednie miejsce do przechowywania tych wartości. Są one efemeryczne i po otwarciu dodatku otrzymujesz nowe wartości.

/** If neither query parameter is sent, use the values in the session. */
if (login_hint == null && hd == null) {
    login_hint = (String) session.getAttribute("login_hint");
    hd = (String) session.getAttribute("hd");
}

/** If the hd query parameter is provided, add hd to the session and route
*   the user to the authorization page. */
else if (hd != null) {
    session.setAttribute("hd", hd);
    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

Przejdź do trasy autoryzacji w pliku serwera Flask (/authorize w podanym przykładzie). Dodaj argumenty login_hint i hd do wywołania funkcji 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"),
    # If we don't have login_hint, passing hd will reduce the list of
    # accounts in the account chooser to only those with the same domain.
    hd=flask.session.get("hd"))

Java

Przejdź do metody authorize() w klasie AuthService.java. Dodaj do metody parametry login_hint i hd oraz dodaj argumenty login_hint i hd do kreatora adresów URL autoryzacji.

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

Python

Zdefiniuj schemat użytkownika

User zawiera te atrybuty:

• id: identyfikator Google użytkownika. Powinny one odpowiadać wartościom podanym w parametrze zapytania login_hint.
• display_name: imię i nazwisko użytkownika, na przykład „Aleksander Kowalski”.
• email: adres e-mail użytkownika.
• portrait_url: adres URL zdjęcia profilowego użytkownika.
• refresh_token: wcześniej uzyskany token odświeżania.

W tym przykładzie implementujemy pamięć masową przy użyciu języka SQLite, który jest natywnie obsługiwany przez Pythona. Wykorzystuje moduł flask_sqlalchemy do zarządzania bazą danych.

Konfigurowanie bazy danych

Najpierw określ lokalizację pliku dla naszej bazy danych. Przejdź do pliku konfiguracyjnego serwera (config.py w podanym przykładzie) i dodaj podany niżej kod.

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

Spowoduje to przekierowanie platformy Flask do pliku data.sqlite w tym samym katalogu, w którym znajduje się plik main.py.

Następnie przejdź do katalogu modułu i utwórz nowy plik models.py. Jeśli stosujesz się do naszego przykładu, to webapp/models.py. Dodaj do nowego pliku ten kod, aby zdefiniować tabelę User. W razie potrzeby zastąp nazwę modułu nazwą webapp.

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())

Na koniec w pliku __init__.py modułu dodaj poniższy kod, aby zaimportować nowe modele i utworzyć bazę danych.

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

Zdefiniuj schemat użytkownika

User zawiera te atrybuty:

• id: identyfikator Google użytkownika. Powinna pasować do wartości podanej w parametrze zapytania login_hint.
• email: adres e-mail użytkownika.

Utwórz plik schema.sql w katalogu resources modułu. Spring odczytuje ten plik i generuje schemat dla bazy danych. Zdefiniuj tabelę za pomocą nazwy tabeli, users i kolumn reprezentujących atrybuty User: id i email.

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

Utwórz klasę Java, aby zdefiniować model User dla bazy danych. W podanym przykładzie jest to wartość User.java.

Dodaj adnotację @Entity, aby wskazać, że jest to POJO, które można zapisać w bazie danych. Dodaj adnotację @Table z odpowiednią nazwą tabeli skonfigurowaną w schema.sql.

Zwróć uwagę, że przykładowy kod zawiera konstruktora i ustawienia ustawiające 2 atrybuty. Konstruktor i metody ustawiające są używane w AuthController.java do tworzenia lub aktualizowania użytkownika w bazie danych. Możesz też dołączyć metody getter i metodę toString, jeśli uznasz to za stosowne, ale w tym konkretnym przewodniku metody te nie są używane i są pomijane w przykładowym kodzie na tej stronie ze względu na ich długość.

/** 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; }
}

Utwórz interfejs o nazwie UserRepository.java do obsługi operacji CRUD w bazie danych. Ten interfejs stanowi rozszerzenie interfejsu CrudRepository.

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

Klasa kontrolera ułatwia komunikację między klientem a repozytorium. Dlatego zaktualizuj konstruktor klas kontrolera tak, aby wstrzykiwał klasę 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;
}

Konfigurowanie bazy danych

Do przechowywania informacji dotyczących użytkowników używaj bazy danych H2, która jest od razu obsługiwana w aplikacji Spring Boot. Ta baza danych jest też używana w kolejnych przewodnikach do przechowywania innych informacji związanych z Classroom. Konfigurowanie bazy danych H2 wymaga dodania do application.properties konfiguracji podanej poniżej.

# 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

Konfiguracja spring.datasource.url tworzy katalog o nazwie h2 z umieszczonym w nim plikiem userdb. Dodaj ścieżkę do bazy danych H2 do pliku .gitignore. Przed uruchomieniem aplikacji musisz zaktualizować spring.datasource.username i spring.datasource.password, aby ustawić w bazie danych dowolną nazwę użytkownika i hasło. Aby po uruchomieniu aplikacji zaktualizować nazwę użytkownika i hasło do bazy danych, usuń wygenerowany katalog h2, zaktualizuj konfigurację i uruchom aplikację ponownie.

Ustawienie konfiguracji spring.jpa.hibernate.ddl-auto na update zapewnia, że dane przechowywane w bazie danych są zachowywane po ponownym uruchomieniu aplikacji. Aby wyczyścić bazę danych przy każdym ponownym uruchomieniu aplikacji, ustaw tę konfigurację na create.

Ustaw konfigurację spring.jpa.open-in-view na false. Ta konfiguracja jest domyślnie włączona i może powodować problemy z wydajnością trudne do zdiagnozowania w środowisku produkcyjnym.

Jak opisano wcześniej, musisz mieć możliwość pobrania danych logowania użytkownika powracającego. Ułatwia to dostęp do wbudowanej obsługi magazynu danych logowania oferowanej przez GoogleAuthorizationCodeFlow.

W klasie AuthService.java określ ścieżkę do pliku, w którym jest przechowywana klasa danych logowania. W tym przykładzie plik jest tworzony w katalogu /credentialStore. Dodaj ścieżkę do magazynu danych logowania do instancji .gitignore. Ten katalog jest generowany, gdy użytkownik rozpocznie proces autoryzacji.

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

Następnie utwórz w pliku AuthService.java metodę, która tworzy i zwraca obiekt FileDataStoreFactory. To magazyn danych, w którym są przechowywane dane logowania.

/** 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;
}

Zaktualizuj metodę getFlow() w AuthService.java, aby uwzględnić setDataStoreFactory w metodzie GoogleAuthorizationCodeFlow Builder() i wywołać getCredentialDataStore(), aby ustawić magazyn danych.

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

Następnie zaktualizuj metodę getAndSaveCredentials(String authorizationCode). Wcześniej ta metoda uzyskiwała dane logowania bez zapisywania ich w dowolnym miejscu. Zaktualizuj metodę przechowywania danych logowania w magazynie danych indeksowanych według identyfikatora użytkownika.

Identyfikator użytkownika można uzyskać z obiektu TokenResponse za pomocą id_token, ale najpierw należy go zweryfikować. W przeciwnym razie aplikacje klienckie mogą podszywać się pod użytkowników, wysyłając zmodyfikowane identyfikatory użytkowników do serwera. Zalecamy używanie bibliotek klienta interfejsów API Google do weryfikacji id_token. Więcej informacji znajdziesz na [stronie tożsamości Google poświęconej weryfikacji tokena tożsamości 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.");
}

Po zweryfikowaniu id_token uzyskaj userId do zapisania wraz z uzyskanymi danymi logowania.

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

Zmień wywołanie do flow.createAndStoreCredential, aby uwzględnić userId.

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

Dodaj do klasy AuthService.java metodę, która zwraca dane logowania określonego użytkownika, jeśli istnieje on w magazynie danych.

/** 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

W klasie AuthController.java określ metodę pobierania użytkownika z bazy danych na podstawie jego identyfikatora.

/** 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

Najpierw zdefiniuj metodę narzędzia, która wdroży zachowanie pamięci lub aktualizacji.

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()

Istnieją 2 sytuacje, w których możesz zapisać dane logowania w bazie danych: gdy użytkownik wraca do aplikacji na końcu procesu autoryzacji i podczas wywołania interfejsu API. W tym miejscu wcześniej ustawialiśmy klucz credentials sesji.

Zadzwoń pod numer save_user_credentials na końcu trasy callback. Zachowaj obiekt user_info, zamiast wyodrębniać tylko nazwę użytkownika.

# 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)

Należy też zaktualizować dane logowania następujące po wywołaniach interfejsu API. W tym przypadku możesz podać zaktualizowane dane logowania jako argumenty metody save_user_credentials.

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

Java

Najpierw zdefiniuj metodę, która przechowuje lub aktualizuje obiekt User w bazie danych 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);
    }
}

Istnieją 2 sytuacje, w których możesz zapisać dane logowania w bazie danych: gdy użytkownik wraca do aplikacji na końcu procesu autoryzacji i podczas wywołania interfejsu API. W tym miejscu wcześniej ustawialiśmy klucz credentials sesji.

Zadzwoń pod numer saveUser na końcu trasy /callback. Zachowaj obiekt user_info, zamiast wyodrębniać tylko adres e-mail użytkownika.

/** 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);

Należy też zaktualizować dane logowania następujące po wywołaniach interfejsu API. W takim przypadku możesz podać zaktualizowane dane logowania jako argumenty metody saveUser.

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

Python

Sprawdź, czy po uruchomieniu aplikacji został utworzony plik bazy danych. Wstaw kod do inicjatora modułu (takiego jak webapp/__init__.py w podanym przykładzie) lub w głównej metodzie, która uruchamia serwer.

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

Twoja metoda powinna następnie obsługiwać parametry zapytania login_hint i hd zgodnie z opisem powyżej. Następnie wczytaj dane logowania do sklepu, jeśli jest to powracający użytkownik. Wiesz, że jest to powracający użytkownik, jeśli został wysłany login_hint. Pobierz wszystkie zapisane dane logowania dla tego użytkownika i wczytaj je w sesji.

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

Jeśli nie ma danych logowania, przekieruj użytkownika na stronę logowania. Jeśli tak, przekieruj ich na stronę główną dodatku.

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

Przejdź do trasy docelowej dodatku (/addon-discovery w podanym przykładzie). Jak wspomnieliśmy powyżej, tu właśnie były obsługiwane parametry zapytania login_hint i hd.

Najpierw sprawdź, czy sesja ma dane logowania. Jeśli tak nie jest, przekieruj użytkownika przez proces uwierzytelniania, wywołując metodę 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);
}

Następnie wczytaj użytkownika z bazy danych H2, jeśli jest to powracający użytkownik. Jeśli otrzymasz parametr zapytania login_hint, oznacza to, że użytkownik powraca do witryny. Jeśli użytkownik znajduje się już w bazie danych H2, wczytaj dane logowania ze skonfigurowanego wcześniej magazynu danych logowania i ustaw je w ramach sesji. Jeśli dane logowania nie zostały uzyskane z magazynu danych logowania, przekieruj użytkownika przez proces uwierzytelniania, wywołując funkcję 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);
    }
}

Na koniec przekieruj użytkownika na stronę docelową dodatku.

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