S'authentifier à l'aide de Yahoo! avec JavaScript

Vous pouvez permettre à vos utilisateurs de s'authentifier auprès de Firebase à l'aide de fournisseurs OAuth tels que Yahoo en intégrant la connexion OAuth générique à votre application à l'aide du SDK Firebase pour effectuer le flux de connexion de bout en bout.

Avant de commencer

Pour connecter des utilisateurs à l'aide de comptes Yahoo, vous devez d'abord activer Yahoo comme fournisseur de connexion pour votre projet Firebase :

Ajoutez Firebase à votre projet JavaScript.
Dans la Firebase console, ouvrez la section Auth (Authentification).
Dans l'onglet Sign in method (Méthode de connexion), activez le fournisseur Yahoo.
Ajoutez l'ID client et le code secret du client de la console pour développeurs de ce fournisseur à la configuration du fournisseur :
1. Pour enregistrer un client OAuth Yahoo, suivez la documentation pour les développeurs Yahoo sur l'enregistrement d'une application Web auprès de Yahoo.
  
  Veillez à sélectionner les deux autorisations d'API OpenID Connect : profile et email.
2. Lorsque vous enregistrez des applications auprès de ces fournisseurs, veillez à enregistrer le *.firebaseapp.com domaine de votre projet comme domaine de redirection pour votre application.
Cliquez sur Enregistrer.

Gérer le flux de connexion avec le SDK Firebase

Si vous créez une application Web, le moyen le plus simple d'authentifier vos utilisateurs auprès de Firebase à l'aide de leurs comptes Yahoo consiste à gérer l'intégralité du flux de connexion avec le SDK Firebase JavaScript.

Pour gérer le flux de connexion avec le SDK Firebase JavaScript, procédez comme suit :

Créez une instance d'OAuthProvider à l'aide de l'ID de fournisseur yahoo.com.

Web

import { OAuthProvider } from "firebase/auth";

const provider = new OAuthProvider('yahoo.com');auth_yahoo_provider_create.js

Web

var provider = new firebase.auth.OAuthProvider('yahoo.com');yahoo-oauth.js

Facultatif : Spécifiez des paramètres OAuth personnalisés supplémentaires que vous souhaitez envoyer avec la requête OAuth.
Web
```
provider.setCustomParameters({
  // Prompt user to re-authenticate to Yahoo.
  prompt: 'login',
  // Localize to French.
  language: 'fr'
});  auth_yahoo_provider_params.js
```
Web
```
provider.setCustomParameters({
  // Prompt user to re-authenticate to Yahoo.
  prompt: 'login',
  // Localize to French.
  language: 'fr'
});  yahoo-oauth.js
```
Pour connaître les paramètres compatibles avec Yahoo, consultez la documentation OAuth de Yahoo. Notez que vous ne pouvez pas transmettre les paramètres requis par Firebase avec setCustomParameters(). Ces paramètres sont client_id, redirect_uri, response_type, scope et state.
Facultatif : Spécifiez des champs d'application OAuth 2.0 supplémentaires au-delà de profile et email que vous souhaitez demander au fournisseur d'authentification. Si votre application nécessite d'accéder à des données utilisateur privées à partir des API Yahoo, vous devrez demander des autorisations aux API Yahoo sous API Permissions (Autorisations d'API) dans la console pour développeurs Yahoo. Les champs d'application OAuth demandés doivent correspondre exactement à ceux préconfigurés dans les autorisations d'API de l'application. Par exemple, si un accès en lecture/écriture est demandé aux contacts de l'utilisateur et préconfiguré dans les autorisations d'API de l'application, sdct-w doit être transmis à la place du champ d'application OAuth en lecture seule sdct-r. Sinon, le flux échouera et une erreur s'affichera pour l' utilisateur final.
Web
```
// Request access to Yahoo Mail API.
provider.addScope('mail-r');
// Request read/write access to user contacts.
// This must be preconfigured in the app's API permissions.
provider.addScope('sdct-w');auth_yahoo_provider_scopes.js
```
Web
```
// Request access to Yahoo Mail API.
provider.addScope('mail-r');
// Request read/write access to user contacts.
// This must be preconfigured in the app's API permissions.
provider.addScope('sdct-w');yahoo-oauth.js
```
Pour en savoir plus, consultez la documentation sur les champs d'application Yahoo.

Authentifiez-vous auprès de Firebase à l'aide de l'objet fournisseur OAuth. Vous pouvez inviter vos utilisateurs à se connecter avec leurs comptes Yahoo en ouvrant une fenêtre pop-up ou en les redirigeant vers la page de connexion. La méthode de redirection est préférable sur les appareils mobiles.

Pour vous connecter avec une fenêtre pop-up, appelez signInWithPopup :

Web

import { getAuth, signInWithPopup, OAuthProvider } from "firebase/auth";

const auth = getAuth();
signInWithPopup(auth, provider)
  .then((result) => {
    // IdP data available in result.additionalUserInfo.profile
    // ...

    // Yahoo OAuth access token and ID token can be retrieved by calling:
    const credential = OAuthProvider.credentialFromResult(result);
    const accessToken = credential.accessToken;
    const idToken = credential.idToken;
  })
  .catch((error) => {
    // Handle error.
  });auth_yahoo_signin_popup.js

Web

firebase.auth().signInWithPopup(provider)
  .then((result) => {
    // IdP data available in result.additionalUserInfo.profile
    // ...

    /** @type {firebase.auth.OAuthCredential} */
    const credential = result.credential;

    // Yahoo OAuth access token and ID token can be retrieved by calling:
    var accessToken = credential.accessToken;
    var idToken = credential.idToken;
  })
  .catch((error) => {
    // Handle error.
  });yahoo-oauth.js

Pour vous connecter en redirigeant vers la page de connexion, appelez signInWithRedirect :

  firebase.auth().signInWithRedirect(provider);

Une fois que l'utilisateur s'est connecté et est revenu sur la page, vous pouvez obtenir le résultat de la connexion en appelant getRedirectResult.

Web

import { getAuth, signInWithRedirect } from "firebase/auth";

const auth = getAuth();
signInWithRedirect(auth, provider);auth_yahoo_signin_redirect.js

Web

firebase.auth().signInWithRedirect(provider);yahoo-oauth.js

Une fois l'opération terminée, le jeton d'ID OAuth et le jeton d'accès associés au fournisseur peuvent être récupérés à partir de l'firebase.auth.UserCredential objet renvoyé.

À l'aide du jeton d'accès OAuth, vous pouvez appeler l' API Yahoo.

Par exemple, pour obtenir les informations de base du profil, vous pouvez appeler l'API REST suivante :

curl -i -H "Authorization: Bearer ACCESS_TOKEN" https://social.yahooapis.com/v1/user/YAHOO_USER_UID/profile?format=json

Où YAHOO_USER_UID est l'ID de l'utilisateur Yahoo, qui peut être récupéré à partir de le champ firebase.auth().currentUser.providerData[0].uid ou de result.additionalUserInfo.profile.

Bien que les exemples ci-dessus se concentrent sur les flux de connexion, vous avez également la possibilité d'associer un fournisseur Yahoo à un utilisateur existant à l'aide de linkWithPopup/linkWithRedirect. Par exemple, vous pouvez associer plusieurs fournisseurs au même utilisateur, ce qui lui permet de se connecter avec l'un ou l'autre.

Web

import { getAuth, linkWithPopup, OAuthProvider } from "firebase/auth";

const provider = new OAuthProvider('yahoo.com');
const auth = getAuth();
linkWithPopup(auth.currentUser, provider)
    .then((result) => {
      // Yahoo credential is linked to the current user.
      // IdP data available in result.additionalUserInfo.profile.

      // Get the OAuth access token and ID Token
      const credential = OAuthProvider.credentialFromResult(result);
      const accessToken = credential.accessToken;
      const idToken = credential.idToken;
    })
    .catch((error) => {
      // Handle error.
    });auth_yahoo_link_popup.js

Web

var provider = new firebase.auth.OAuthProvider('yahoo.com');
firebase.auth().currentUser.linkWithPopup(provider)
    .then((result) => {
      // Yahoo credential is linked to the current user.
      // IdP data available in result.additionalUserInfo.profile.
      // Yahoo OAuth access token can be retrieved by calling:
      // result.credential.accessToken
      // Yahoo OAuth ID token can be retrieved by calling:
      // result.credential.idToken
    })
    .catch((error) => {
      // Handle error.
    });yahoo-oauth.js

Le même schéma peut être utilisé avec reauthenticateWithPopup/reauthenticateWithRedirect, qui peuvent être utilisés pour récupérer de nouveaux identifiants pour les opérations sensibles nécessitant une connexion récente.

Web

import { getAuth, reauthenticateWithPopup, OAuthProvider } from "firebase/auth";

const provider = new OAuthProvider('yahoo.com');
const auth = getAuth();
reauthenticateWithPopup(auth.currentUser, provider)
    .then((result) => {
      // User is re-authenticated with fresh tokens minted and
      // should be able to perform sensitive operations like account
      // deletion and email or password update.
      // IdP data available in result.additionalUserInfo.profile.

      // Get the OAuth access token and ID Token
      const credential = OAuthProvider.credentialFromResult(result);
      const accessToken = credential.accessToken;
      const idToken = credential.idToken;
    })
    .catch((error) => {
      // Handle error.
    });auth_yahoo_reauth_popup.js

Web

var provider = new firebase.auth.OAuthProvider('yahoo.com');
firebase.auth().currentUser.reauthenticateWithPopup(provider)
    .then((result) => {
      // User is re-authenticated with fresh tokens minted and
      // should be able to perform sensitive operations like account
      // deletion and email or password update.
      // IdP data available in result.additionalUserInfo.profile.
      // Yahoo OAuth access token can be retrieved by calling:
      // result.credential.accessToken
      // Yahoo OAuth ID token can be retrieved by calling:
      // result.credential.idToken
    })
    .catch((error) => {
      // Handle error.
    });yahoo-oauth.js

Gérer les erreurs de compte existant avec un identifiant différent

Si vous avez activé le paramètre One account per email address dans la console Firebase, lorsqu'un utilisateur tente de se connecter à un fournisseur (tel que Yahoo) avec une adresse e-mail existant déjà pour un autre fournisseur d'un utilisateur Firebase (tel que Google), l'erreur auth/account-exists-with-different-credential est générée avec un objet AuthCredential (identifiant Yahoo). Pour terminer la connexion au fournisseur désiré, l'utilisateur doit d'abord se connecter au fournisseur existant (Google), puis l'associer à l' ancien AuthCredential (identifiant Yahoo).

Si vous utilisez signInWithPopup, vous pouvez gérer auth/account-exists-with-different-credential les erreurs avec un code semblable à l'exemple suivant :

import {
  getAuth,
  linkWithCredential,
  signInWithPopup,
  OAuthProvider,
} from "firebase/auth";

try {
  // Step 1: User tries to sign in using Yahoo.
  let result = await signInWithPopup(getAuth(), new OAuthProvider());
} catch (error) {
  // Step 2: User's email already exists.
  if (error.code === "auth/account-exists-with-different-credential") {
    // The pending Yahoo credential.
    let pendingCred = error.credential;

    // Step 3: Save the pending credential in temporary storage,

    // Step 4: Let the user know that they already have an account
    // but with a different provider, and let them choose another
    // sign-in method.
  }
}

// ...

try {
  // Step 5: Sign the user in using their chosen method.
  let result = await signInWithPopup(getAuth(), userSelectedProvider);

  // Step 6: Link to the Yahoo credential.
  // TODO: implement `retrievePendingCred` for your app.
  let pendingCred = retrievePendingCred();

  if (pendingCred !== null) {
    // As you have access to the pending credential, you can directly call the
    // link method.
    let user = await linkWithCredential(result.user, pendingCred);
  }

  // Step 7: Continue to app.
} catch (error) {
  // ...
}

Mode de redirection

Cette erreur est gérée de la même manière en mode de redirection, à la différence que l'identifiant en attente doit être mis en cache entre les redirections de pages (par exemple, à l'aide de l'espace de stockage de session).

Contrairement à d'autres fournisseurs OAuth compatibles avec Firebase, tels que Google, Facebook, et Twitter, où la connexion peut être effectuée directement avec des identifiants basés sur un jeton d'accès OAuth, Firebase Authentication n'est pas compatible avec la même fonctionnalité pour les fournisseurs tels que Yahoo, car le serveur Firebase Authentication ne peut pas vérifier l'audience des jetons d'accès OAuth Yahoo. Il s'agit d'une exigence de sécurité essentielle qui pourrait exposer les applications et les sites Web à des attaques par relecture, où un jeton d'accès OAuth Yahoo obtenu pour un projet (attaquant) peut être utilisé pour se connecter à un autre projet (victime). Au lieu de cela, Firebase Authentication offre la possibilité de gérer l'intégralité du flux OAuth et l'échange de code d'autorisation à l'aide de l'ID client OAuth et du code secret configurés dans la console Firebase. Étant donné que le code d'autorisation ne peut être utilisé qu'avec un ID client/code secret spécifique, un code d'autorisation obtenu pour un projet ne peut pas être utilisé avec un autre.

Si ces fournisseurs doivent être utilisés dans des environnements non compatibles, vous devez utiliser une bibliothèque OAuth tierce et l'authentification personnalisée Firebase. La première est nécessaire pour s'authentifier auprès du fournisseur et la seconde pour échanger l'identifiant du fournisseur contre un jeton personnalisé.

S'authentifier auprès de Firebase dans une extension Chrome

Si vous créez une application d'extension Chrome, consultez le guide Documents hors écran.

Lors de la création du projet, Firebase provisionne un sous-domaine unique pour votre projet : https://my-app-12345.firebaseapp.com.

Il sera également utilisé comme mécanisme de redirection pour la connexion OAuth. Ce domaine devra être autorisé pour tous les fournisseurs OAuth compatibles. Toutefois, cela signifie que les utilisateurs peuvent voir ce domaine lorsqu'ils se connectent à Yahoo avant d'être redirigés vers l'application : Continue to: https://my-app-12345.firebaseapp.com (Continuer vers : https://my-app-12345.firebaseapp.com).

Pour éviter d'afficher votre sous-domaine, vous pouvez configurer un domaine personnalisé avec Firebase Hosting :

Suivez les étapes 1 à 3 de la section Configurer votre domaine pour Hosting. Lorsque vous validez la propriété de votre domaine, Hosting provisionne un certificat SSL pour votre domaine personnalisé.
Ajoutez votre domaine personnalisé à la liste des domaines autorisés dans la Firebase console : auth.custom.domain.com.
Dans la console pour développeurs Yahoo ou sur la page de configuration OAuth, ajoutez l'URL de la page de redirection à la liste blanche, qui sera accessible sur votre domaine personnalisé : https://auth.custom.domain.com/__/auth/handler.

Lorsque vous initialisez la bibliothèque JavaScript, spécifiez votre domaine personnalisé avec le authDomain champ :

var config = {
  apiKey: '...',
  // Changed from 'PROJECT_ID.firebaseapp.com'.
  authDomain: 'auth.custom.domain.com',
  databaseURL: 'https://PROJECT_ID.firebaseio.com',
  projectId: 'PROJECT_ID',
  storageBucket: 'PROJECT_ID.firebasestorage.app',
  messagingSenderId: 'SENDER_ID'
};
firebase.initializeApp(config);

Étapes suivantes

Lorsqu'un utilisateur se connecte pour la première fois, un compte utilisateur est créé et associé aux identifiants (nom d'utilisateur et mot de passe, numéro de téléphone ou informations du fournisseur d'authentification) avec lesquels il s'est connecté. Ce nouveau compte est stocké dans votre projet Firebase et peut être utilisé pour identifier un utilisateur dans chaque application de votre projet, quelle que soit la méthode de connexion utilisée.

Dans vos applications, la méthode recommandée pour connaître l'état d'authentification de votre utilisateur consiste à définir un observateur sur l'objet Auth. Vous pouvez ensuite obtenir les informations de base du profil de l'utilisateur à partir de l'objet User. Consultez la section Gérer les utilisateurs.
Dans vos Firebase Realtime Database et Cloud Storage règles de sécurité, vous pouvez obtenir l'ID utilisateur unique de l'utilisateur connecté à partir de la variable auth, et l'utiliser pour contrôler les données auxquelles un utilisateur peut accéder.

Vous pouvez autoriser les utilisateurs à se connecter à votre application à l'aide de plusieurs fournisseurs d'authentification en associant les identifiants du fournisseur d'authentification à un compte utilisateur existant.

Pour déconnecter un utilisateur, appelez signOut :

Web

import { getAuth, signOut } from "firebase/auth";

const auth = getAuth();
signOut(auth).then(() => {
  // Sign-out successful.
}).catch((error) => {
  // An error happened.
});auth_sign_out.js

Web

firebase.auth().signOut().then(() => {
  // Sign-out successful.
}).catch((error) => {
  // An error happened.
});index.js

S'authentifier à l'aide de Yahoo! avec JavaScript Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.