S'authentifier auprès d'un serveur backend

Si vous utilisez Google Sign-In avec une application ou un site qui communique avec un serveur backend, vous devrez peut-être identifier l'utilisateur actuellement connecté sur le serveur. Pour ce faire de manière sécurisée, une fois qu'un utilisateur s'est connecté, envoyez le jeton d'ID de l'utilisateur à votre serveur via HTTPS. Ensuite, sur le serveur, vérifiez l'intégrité du jeton d'ID et utilisez les informations utilisateur contenues dans le jeton pour établir une session ou créer un compte.

Envoyer le jeton d'ID à votre serveur

Tout d'abord, lorsque l'utilisateur se connecte, récupérez son jeton d'ID:

  1. Lorsque vous configurez Google Sign-In, appelez la méthode requestIdToken et transmettez-lui l'ID client Web de votre serveur.

    // Request only the user's ID token, which can be used to identify the
    // user securely to your backend. This will contain the user's basic
    // profile (name, profile picture URL, etc) so you should not need to
    // make an additional call to personalize your application.
    GoogleSignInOptions gso = new GoogleSignInOptions.Builder(GoogleSignInOptions.DEFAULT_SIGN_IN)
            .requestIdToken(getString(R.string.server_client_id))
            .requestEmail()
            .build();
  2. Lorsque votre application démarre, vérifiez si l'utilisateur s'y est déjà connecté avec Google, sur cet appareil ou un autre, en appelant silentSignIn:

    GoogleSignIn.silentSignIn()
        .addOnCompleteListener(
            this,
            new OnCompleteListener<GoogleSignInAccount>() {
              @Override
              public void onComplete(@NonNull Task<GoogleSignInAccount> task) {
                handleSignInResult(task);
              }
            });
  3. Si l'utilisateur ne peut pas se connecter en mode silencieux, présentez votre expérience habituelle non connectée en lui donnant la possibilité de se connecter. Lorsque l'utilisateur se connecte, récupérez son GoogleSignInAccount dans le résultat de l'activité de l'intent de connexion:

    // This task is always completed immediately, there is no need to attach an
    // asynchronous listener.
    Task<GoogleSignInAccount> task = GoogleSignIn.getSignedInAccountFromIntent(data);
    handleSignInResult(task);
  4. Une fois que l'utilisateur s'est connecté en mode silencieux ou explicitement, récupérez le jeton d'ID à partir de l'objet GoogleSignInAccount:

    private void handleSignInResult(@NonNull Task<GoogleSignInAccount> completedTask) {
        try {
            GoogleSignInAccount account = completedTask.getResult(ApiException.class);
            String idToken = account.getIdToken();
    
            // TODO(developer): send ID Token to server and validate
    
            updateUI(account);
        } catch (ApiException e) {
            Log.w(TAG, "handleSignInResult:error", e);
            updateUI(null);
        }
    }

Envoyez ensuite le jeton d'ID à votre serveur avec une requête HTTPS POST:

HttpClient httpClient = new DefaultHttpClient();
HttpPost httpPost = new HttpPost("https://yourbackend.example.com/tokensignin");

try {
  List<NameValuePair> nameValuePairs = new ArrayList<NameValuePair>(1);
  nameValuePairs.add(new BasicNameValuePair("idToken", idToken));
  httpPost.setEntity(new UrlEncodedFormEntity(nameValuePairs));

  HttpResponse response = httpClient.execute(httpPost);
  int statusCode = response.getStatusLine().getStatusCode();
  final String responseBody = EntityUtils.toString(response.getEntity());
  Log.i(TAG, "Signed in as: " + responseBody);
} catch (ClientProtocolException e) {
  Log.e(TAG, "Error sending ID token to backend.", e);
} catch (IOException e) {
  Log.e(TAG, "Error sending ID token to backend.", e);
}

Vérifier l'intégrité du jeton d'ID

Après avoir reçu le jeton d'ID via HTTPS POST, vous devez vérifier son intégrité.

Pour vérifier que le jeton est valide, assurez-vous que les critères suivants sont remplis:

  • Le jeton d'ID est correctement signé par Google. Utilisez les clés publiques de Google (disponibles au format JWK ou PEM) pour vérifier la signature du jeton. Ces clés sont régulièrement alternées. Examinez l'en-tête Cache-Control dans la réponse pour déterminer quand vous devez les récupérer à nouveau.
  • La valeur de aud dans le jeton d'ID est égale à l'un des ID client de votre application. Cette vérification est nécessaire pour éviter que les jetons d'identification émis pour une application malveillante soient utilisés pour accéder aux données du même utilisateur sur le serveur backend de votre application.
  • La valeur de iss dans le jeton d'ID est égale à accounts.google.com ou https://accounts.google.com.
  • Le délai d'expiration (exp) du jeton d'ID n'a pas été dépassé.
  • Si vous devez vérifier que le jeton d'ID représente un compte d'organisation Google Workspace ou Cloud, vous pouvez vérifier la revendication hd, qui indique le domaine hébergé de l'utilisateur. Cette clé doit être utilisée lorsque vous restreignez l'accès à une ressource aux seuls membres de certains domaines. L'absence de cette revendication indique que le compte n'appartient pas à un domaine hébergé par Google.

Plutôt que d'écrire votre propre code pour effectuer ces étapes de validation, nous vous recommandons vivement d'utiliser une bibliothèque cliente de l'API Google pour votre plate-forme ou une bibliothèque JWT à usage général. Pour le développement et le débogage, vous pouvez appeler notre point de terminaison de validation tokeninfo.

Utiliser une bibliothèque cliente des API Google

Il est recommandé d'utiliser l'une des bibliothèques clientes des API Google (par exemple, Java, Node.js, PHP, Python) pour valider les jetons d'ID Google dans un environnement de production.

Java

Pour valider un jeton d'ID en Java, utilisez l'objet GoogleIdTokenVerifier. Exemple :

import com.google.api.client.googleapis.auth.oauth2.GoogleIdToken;
import com.google.api.client.googleapis.auth.oauth2.GoogleIdToken.Payload;
import com.google.api.client.googleapis.auth.oauth2.GoogleIdTokenVerifier;

...

GoogleIdTokenVerifier verifier = new GoogleIdTokenVerifier.Builder(transport, jsonFactory)
    // Specify the CLIENT_ID of the app that accesses the backend:
    .setAudience(Collections.singletonList(CLIENT_ID))
    // Or, if multiple clients access the backend:
    //.setAudience(Arrays.asList(CLIENT_ID_1, CLIENT_ID_2, CLIENT_ID_3))
    .build();

// (Receive idTokenString by HTTPS POST)

GoogleIdToken idToken = verifier.verify(idTokenString);
if (idToken != null) {
  Payload payload = idToken.getPayload();

  // Print user identifier
  String userId = payload.getSubject();
  System.out.println("User ID: " + userId);

  // Get profile information from payload
  String email = payload.getEmail();
  boolean emailVerified = Boolean.valueOf(payload.getEmailVerified());
  String name = (String) payload.get("name");
  String pictureUrl = (String) payload.get("picture");
  String locale = (String) payload.get("locale");
  String familyName = (String) payload.get("family_name");
  String givenName = (String) payload.get("given_name");

  // Use or store profile information
  // ...

} else {
  System.out.println("Invalid ID token.");
}

La méthode GoogleIdTokenVerifier.verify() vérifie la signature JWT, la revendication aud, la revendication iss et la revendication exp.

Pour confirmer que le jeton d'ID représente un compte d'organisation Google Workspace ou Cloud, vous pouvez valider la revendication hd en vérifiant le nom de domaine renvoyé par la méthode Payload.getHostedDomain(). Le domaine de la revendication email est insuffisant pour garantir que le compte est géré par un domaine ou une organisation.

Node.js

Pour valider un jeton d'ID en Node.js, utilisez la bibliothèque Google Auth pour Node.js. Installez la bibliothèque :

npm install google-auth-library --save
. Appelez ensuite la fonction verifyIdToken(). Exemple :

const {OAuth2Client} = require('google-auth-library');
const client = new OAuth2Client();
async function verify() {
  const ticket = await client.verifyIdToken({
      idToken: token,
      audience: CLIENT_ID,  // Specify the CLIENT_ID of the app that accesses the backend
      // Or, if multiple clients access the backend:
      //[CLIENT_ID_1, CLIENT_ID_2, CLIENT_ID_3]
  });
  const payload = ticket.getPayload();
  const userid = payload['sub'];
  // If request specified a G Suite domain:
  // const domain = payload['hd'];
}
verify().catch(console.error);

La fonction verifyIdToken vérifie la signature JWT, la revendication aud, la revendication exp et la revendication iss.

Si vous devez vérifier que le jeton d'ID représente un compte d'organisation Google Workspace ou Cloud, vous pouvez vérifier la revendication hd, qui indique le domaine hébergé de l'utilisateur. Cette clé doit être utilisée lorsque vous restreignez l'accès à une ressource aux seuls membres de certains domaines. L'absence de cette revendication indique que le compte n'appartient pas à un domaine hébergé par Google.

PHP

Pour valider un jeton d'ID en PHP, utilisez la bibliothèque cliente des API Google pour PHP. Installez la bibliothèque (par exemple, à l'aide de Composer) :

composer require google/apiclient
, appelez ensuite la fonction verifyIdToken(). Exemple :

require_once 'vendor/autoload.php';

// Get $id_token via HTTPS POST.

$client = new Google_Client(['client_id' => $CLIENT_ID]);  // Specify the CLIENT_ID of the app that accesses the backend
$payload = $client->verifyIdToken($id_token);
if ($payload) {
  $userid = $payload['sub'];
  // If request specified a G Suite domain:
  //$domain = $payload['hd'];
} else {
  // Invalid ID token
}

La fonction verifyIdToken vérifie la signature JWT, la revendication aud, la revendication exp et la revendication iss.

Si vous devez vérifier que le jeton d'ID représente un compte d'organisation Google Workspace ou Cloud, vous pouvez vérifier la revendication hd, qui indique le domaine hébergé de l'utilisateur. Cette clé doit être utilisée lorsque vous restreignez l'accès à une ressource aux seuls membres de certains domaines. L'absence de cette revendication indique que le compte n'appartient pas à un domaine hébergé par Google.

Python

Pour valider un jeton d'ID en Python, utilisez la fonction verify_oauth2_token. Exemple :

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

# (Receive token by HTTPS POST)
# ...

try:
    # Specify the CLIENT_ID of the app that accesses the backend:
    idinfo = id_token.verify_oauth2_token(token, requests.Request(), CLIENT_ID)

    # Or, if multiple clients access the backend server:
    # idinfo = id_token.verify_oauth2_token(token, requests.Request())
    # if idinfo['aud'] not in [CLIENT_ID_1, CLIENT_ID_2, CLIENT_ID_3]:
    #     raise ValueError('Could not verify audience.')

    # If auth request is from a G Suite domain:
    # if idinfo['hd'] != GSUITE_DOMAIN_NAME:
    #     raise ValueError('Wrong hosted domain.')

    # ID token is valid. Get the user's Google Account ID from the decoded token.
    userid = idinfo['sub']
except ValueError:
    # Invalid token
    pass

La fonction verify_oauth2_token vérifie la signature JWT, la revendication aud et la revendication exp. Vous devez également vérifier la revendication hd (le cas échéant) en examinant l'objet renvoyé par verify_oauth2_token. Si plusieurs clients accèdent au serveur backend, validez également manuellement la revendication aud.

Appeler le point de terminaison tokeninfo

Un moyen simple de valider une signature de jeton d'ID pour le débogage consiste à utiliser le point de terminaison tokeninfo. L'appel de ce point de terminaison implique une requête réseau supplémentaire qui effectue la majeure partie de la validation pendant que vous testez la validation et l'extraction de la charge utile appropriées dans votre propre code. Il n'est pas adapté à l'utilisation dans le code de production, car les requêtes peuvent être limitées ou soumises à des erreurs intermittentes.

Pour valider un jeton d'ID à l'aide du point de terminaison tokeninfo, envoyez une requête HTTPS POST ou GET au point de terminaison, puis transmettez votre jeton d'ID dans le paramètre id_token. Par exemple, pour valider le jeton "XYZ123", envoyez la requête GET suivante:

https://oauth2.googleapis.com/tokeninfo?id_token=XYZ123

Si le jeton est correctement signé et que les revendications iss et exp ont les valeurs attendues, vous obtiendrez une réponse HTTP 200, dont le corps contient les revendications de jeton d'ID au format JSON. Voici un exemple de réponse :

{
 // These six fields are included in all Google ID Tokens.
 "iss": "https://accounts.google.com",
 "sub": "110169484474386276334",
 "azp": "1008719970978-hb24n2dstb40o45d4feuo2ukqmcc6381.apps.googleusercontent.com",
 "aud": "1008719970978-hb24n2dstb40o45d4feuo2ukqmcc6381.apps.googleusercontent.com",
 "iat": "1433978353",
 "exp": "1433981953",

 // These seven fields are only included when the user has granted the "profile" and
 // "email" OAuth scopes to the application.
 "email": "testuser@gmail.com",
 "email_verified": "true",
 "name" : "Test User",
 "picture": "https://lh4.googleusercontent.com/-kYgzyAWpZzJ/ABCDEFGHI/AAAJKLMNOP/tIXL9Ir44LE/s99-c/photo.jpg",
 "given_name": "Test",
 "family_name": "User",
 "locale": "en"
}

Si vous devez vérifier que le jeton d'ID représente un compte Google Workspace, vous pouvez vérifier la revendication hd, qui indique le domaine hébergé de l'utilisateur. Cette clé doit être utilisée lorsque vous restreignez l'accès à une ressource aux seuls membres de certains domaines. L'absence de cette revendication indique que le compte n'appartient pas à un domaine hébergé par Google Workspace.

Créer un compte ou une session

Après avoir vérifié le jeton, vérifiez si l'utilisateur figure déjà dans votre base de données des utilisateurs. Le cas échéant, établissez une session authentifiée pour l'utilisateur. Si l'utilisateur ne figure pas encore dans votre base de données utilisateur, créez un enregistrement utilisateur à partir des informations contenues dans la charge utile du jeton d'ID, puis établissez une session pour l'utilisateur. Vous pouvez demander à l'utilisateur toute information de profil supplémentaire dont vous avez besoin lorsque vous détectez un nouvel utilisateur dans votre application.

Sécuriser les comptes de vos utilisateurs avec la protection multicompte

Lorsque vous utilisez Google pour connecter un utilisateur, vous bénéficiez automatiquement de toutes les fonctionnalités de sécurité et de l'infrastructure que Google a développées pour protéger les données de l'utilisateur. Toutefois, dans le cas peu probable où le compte Google de l'utilisateur serait compromis ou en cas d'autre événement de sécurité important, votre application pourrait être vulnérable aux attaques. Pour mieux protéger vos comptes contre les événements de sécurité majeurs, utilisez la protection multicompte afin de recevoir des alertes de sécurité de la part de Google. Lorsque vous recevez ces événements, vous gagnez en visibilité sur les modifications importantes apportées à la sécurité du compte Google de l'utilisateur. Vous pouvez ensuite prendre des mesures concernant votre service pour sécuriser vos comptes.