Guide de migration du flux Out-of-Band (OOB)

Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.

Présentation

Le 16 février 2022, nous avons annoncé notre intention de renforcer la sécurité des interactions OAuth de Google en utilisant des flux OAuth plus sécurisés. Ce guide vous aide à comprendre les modifications et étapes nécessaires pour migrer le flux hors bande OAuth vers des alternatives compatibles.

Cette démarche vise à protéger les tentatives d'hameçonnage et d'usurpation d'identité des applications lors des interactions avec les points de terminaison Google OAuth 2.0.

Qu'est-ce que la fonctionnalité OOB ?

OAuth (hors bande, également appelée option de copier/coller manuelle) est un ancien processus conçu pour prendre en charge les clients natifs qui n'ont pas d'URI de redirection et qui acceptent les identifiants après qu'un utilisateur a approuvé une demande de consentement OAuth. Le flux OOB présente un risque d'hameçonnage à distance, et les clients doivent migrer vers une autre méthode pour se protéger de cette faille.

Le processus OOB va être abandonné pour tous les types de clients : applications Web, Android, iOS, plates-formes Windows universelles (UWP), applications Chrome, téléviseurs, appareils à saisie limitée et applications de bureau.

Dates clés de conformité

  • 28 février 2022 : utilisation du nouveau protocole OAuth pour le flux OOB
  • 5 septembre 2022 : un message d'avertissement peut s'afficher pour les requêtes OAuth non conformes
  • 3 octobre 2022 : le flux OOB est obsolète pour les clients OAuth créés avant le 28 février 2022.
  • 31 janvier 2023 : tous les clients existants sont bloqués (y compris les clients exemptés) Les clients peuvent demander une extension unique pour continuer à utiliser le flux OOB jusqu'au 31 janvier 2023, comme indiqué dans l'e-mail envoyé aux clients concernés.

Un message d'avertissement peut s'afficher un mois avant l'affichage de requêtes non conformes. Par exemple, le 5 septembre 2022, le flux OOB est entièrement obsolète. Le message indiquera aux utilisateurs que l'application peut être bloquée rapidement en affichant l'adresse e-mail d'assistance que vous avez enregistrée dans l'écran de consentement OAuth dans la console Google APIs.

Vous pouvez accuser réception et supprimer le message d'avertissement en transmettant un paramètre de requête dans l'appel d'autorisation, comme indiqué ci-dessous :
  • Accédez au code de votre application où vous envoyez des requêtes au point de terminaison d'autorisation OAuth 2.0 de Google.
  • Ajoutez un paramètre ack_oob_shutdown avec la valeur d'application: 2022-10-03 à votre requête de flux de redirection. Exemple :
    ack_oob_shutdown=2022-10-03
Le processus de migration comporte deux étapes principales :
  1. Déterminez si vous êtes concerné.
  2. Passez à une solution plus sécurisée si vous êtes concerné.

Déterminez si vous êtes concerné

Cet abandon ne s'applique qu'aux applications de production (c'est-à-dire aux applications dont l'état de publication est défini sur En production). Le flux continue de fonctionner pour les applications dont l'état de publication est Test.

Vérifiez l'état de publication dans le Consent Screen pageOAuth de Google API Console et passez à l'étape suivante si vous utilisez le flux OOB dans un projet dont l'état de publication est "En production".

Déterminer si votre application utilise le flux OOB

Inspectez le code de votre application ou l'appel réseau sortant (si votre application utilise une bibliothèque OAuth) pour déterminer si la demande d'autorisation Google OAuth effectuée par votre application utilise une valeur d'URI de redirection OOB.

Inspecter le code de votre application

Examinez la section du code de votre application dans laquelle vous appelez les points de terminaison d'autorisation Google OAuth, et déterminez si le paramètre redirect_uri comporte l'une des valeurs suivantes :
  • redirect_uri=urn:ietf:wg:oauth:2.0:oob
  • redirect_uri=urn:ietf:wg:oauth:2.0:oob:auto
  • redirect_uri=oob
Voici un exemple de requête de flux de redirection OOB :
https://accounts.google.com/o/oauth2/v2/auth?
response_type=code&
scope=<SCOPES>&
state=<STATE>&
redirect_uri=urn:ietf:wg:oauth:2.0:oob&
client_id=<CLIENT_ID>

Inspecter l'appel réseau sortant

La méthode d'inspection des appels réseau dépend du type de client de votre application.
Lors de l'inspection des appels réseau, recherchez les requêtes envoyées aux points de terminaison d'autorisation Google OAuth et déterminez si le paramètre redirect_uri comporte l'une des valeurs suivantes :
  • redirect_uri=urn:ietf:wg:oauth:2.0:oob
  • redirect_uri=urn:ietf:wg:oauth:2.0:oob:auto
  • redirect_uri=oob
Voici un exemple de requête de flux de redirection OOB :
https://accounts.google.com/o/oauth2/v2/auth?
response_type=code&
scope=<SCOPES>&
state=<STATE>&
redirect_uri=urn:ietf:wg:oauth:2.0:oob&
client_id=<CLIENT_ID>

Migrer vers une alternative sécurisée

Clients mobiles (Android / iOS)

Si vous constatez que votre application utilise le flux OOB avec un type de client OAuth Android ou iOS, vous devez migrer vers nos SDK pour mobile Google Sign-In (Android, iOS).

Le SDK facilite l'accès aux API Google et gère tous les appels vers les points de terminaison d'autorisation OAuth 2.0 de Google.

Les liens vers la documentation ci-dessous expliquent comment utiliser les SDK Google Sign-In pour accéder aux API Google sans utiliser d'URI de redirection OOB.

Accéder aux API Google sur Android

Accès côté serveur (hors connexion)
L'exemple ci-dessous montre comment accéder aux API Google côté serveur sous Android.
Task<GoogleSignInAccount> task = GoogleSignIn.getSignedInAccountFromIntent(data);
try {
  GoogleSignInAccount account = task.getResult(ApiException.class);
  
  // request a one-time authorization code that your server exchanges for an
  // access token and sometimes refresh token
  String authCode = account.getServerAuthCode();
  
  // Show signed-in UI
  updateUI(account);

  // TODO(developer): send code to server and exchange for access/refresh/ID tokens
} catch (ApiException e) {
  Log.w(TAG, "Sign-in failed", e);
  updateUI(null);
}

Consultez le guide d'accès côté serveur pour découvrir comment accéder aux API Google côté serveur.

Accéder aux API Google dans une application iOS

Accès côté client

L'exemple ci-dessous montre comment accéder aux API Google côté client sur iOS.

user.authentication.do { authentication, error in
  guard error == nil else { return }
  guard let authentication = authentication else { return }
  
  // Get the access token to attach it to a REST or gRPC request.
  let accessToken = authentication.accessToken
  
  // Or, get an object that conforms to GTMFetcherAuthorizationProtocol for
  // use with GTMAppAuth and the Google APIs client library.
  let authorizer = authentication.fetcherAuthorizer()
}

Utilisez le jeton d'accès pour appeler l'API, soit en l'incluant dans l'en-tête d'une requête REST ou gRPC (Authorization: Bearer ACCESS_TOKEN), soit en utilisant l'outil d'autorisation de récupération (GTMFetcherAuthorizationProtocol) avec la bibliothèque cliente des API Google pour Objective-C pour REST.

Consultez le guide d'accès côté client pour découvrir comment accéder aux API Google côté client. sur l'accès aux API Google côté client.

Accès côté serveur (hors connexion)
L'exemple ci-dessous montre comment accéder aux API Google côté serveur pour prendre en charge un client iOS.
GIDSignIn.sharedInstance.signIn(with: signInConfig, presenting: self) { user, error in
  guard error == nil else { return }
  guard let user = user else { return }
  
  // request a one-time authorization code that your server exchanges for
  // an access token and refresh token
  let authCode = user.serverAuthCode
}

Consultez le guide d'accès côté serveur pour découvrir comment accéder aux API Google côté serveur.

Client de l'application Chrome

Si vous constatez que votre application utilise le flux OOB sur le client de l'application Chrome, vous devez migrer vers l'API Chrome Identity.

L'exemple ci-dessous montre comment obtenir tous les contacts utilisateur sans utiliser d'URI de redirection OOB.

window.onload = function() {
  document.querySelector('button').addEventListener('click', function() {

  
  // retrieve access token
  chrome.identity.getAuthToken({interactive: true}, function(token) {
  
  // ..........


  // the example below shows how to use a retrieved access token with an appropriate scope
  // to call the Google People API contactGroups.get endpoint

  fetch(
    'https://people.googleapis.com/v1/contactGroups/all?maxMembers=20&key=API_KEY',
    init)
    .then((response) => response.json())
    .then(function(data) {
      console.log(data)
    });
   });
 });
};

Consultez le guide de l'API Chrome Identity pour savoir comment accéder aux utilisateurs authentifiés et appeler les points de terminaison Google avec l'API Chrome Identity.

Application Web

Si vous déterminez que votre application utilise le flux OOB pour une application Web, vous devez migrer vers l'une de nos bibliothèques clientes des API Google. Les bibliothèques clientes pour différents langages de programmation sont répertoriées sur cette page.

Les bibliothèques permettent d'accéder facilement aux API Google et de traiter tous les appels vers les points de terminaison Google.

Accès côté serveur (hors connexion)
Le mode d'accès côté serveur (hors connexion) nécessite les opérations suivantes :
  • Mettez en place un serveur et définissez un point de terminaison accessible au public (l'URI de redirection) pour recevoir le code d'autorisation.
  • Configurez l'URI de redirection dans le Credentials page du Google API Console

L'extrait de code ci-dessous illustre un exemple d'utilisation de l'API Google Drive pour répertorier les fichiers Google Drive d'un utilisateur côté serveur sans utiliser d'URI de redirection OOB.

async function main() {
  const server = http.createServer(async function (req, res) {

  if (req.url.startsWith('/oauth2callback')) {
    let q = url.parse(req.url, true).query;

    if (q.error) {
      console.log('Error:' + q.error);
    } else {
      
      // Get access and refresh tokens (if access_type is offline)
      let { tokens } = await oauth2Client.getToken(q.code);
      oauth2Client.setCredentials(tokens);

      // Example of using Google Drive API to list filenames in user's Drive.
      const drive = google.drive('v3');
      drive.files.list({
        auth: oauth2Client,
        pageSize: 10,
        fields: 'nextPageToken, files(id, name)',
      }, (err1, res1) => {
        // TODO(developer): Handle response / error.
      });
    }
  }
}

Consultez le guide de l'application Web côté serveur pour découvrir comment accéder aux API Google côté serveur.

Accès côté client

L'extrait de code ci-dessous, en JavaScript, montre un exemple d'utilisation de l'API Google pour accéder aux événements d'agenda de l'utilisateur côté client.


// initTokenClient() initializes a new token client with your
// web app's client ID and the scope you need access to

const client = google.accounts.oauth2.initTokenClient({
  client_id: 'YOUR_GOOGLE_CLIENT_ID',
  scope: 'https://www.googleapis.com/auth/calendar.readonly',
  
  // callback function to handle the token response
  callback: (tokenResponse) => {
    if (tokenResponse && tokenResponse.access_token) { 
      gapi.client.setApiKey('YOUR_API_KEY');
      gapi.client.load('calendar', 'v3', listUpcomingEvents);
    }
  },
});

function listUpcomingEvents() {
  gapi.client.calendar.events.list(...);
}

Consultez le guide de l'application Web côté client pour découvrir comment accéder aux API Google côté client.

Client de bureau

Si vous constatez que votre application utilise le flux OOB sur un client de bureau, vous devez migrer vers le flux d'adresse IP de rebouclage (localhost ou 127.0.0.1).