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

Vous pouvez permettre à vos utilisateurs de s'authentifier avec Firebase à l'aide de fournisseurs OAuth tels que Yahoo en intégrant une 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 permettre aux utilisateurs de se connecter à l'aide de comptes Yahoo, vous devez d'abord activer Yahoo comme fournisseur de connexion pour votre projet Firebase:

  1. Ajoutez Firebase à votre projet JavaScript.
  2. Dans la console Firebase, ouvrez la section Authentification.
  3. Dans l'onglet Mode de connexion, activez le fournisseur Yahoo.
  4. Ajoutez l'ID client et le code secret du client de la console de développement du 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 de l'API OpenID Connect : profile et email.

    2. Lorsque vous enregistrez des applications auprès de ces fournisseurs, veillez à enregistrer le domaine *.firebaseapp.com de votre projet comme domaine de redirection de votre application.
  5. 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 avec Firebase à l'aide de leurs comptes Yahoo consiste à gérer l'intégralité du flux de connexion avec le SDK JavaScript Firebase.

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

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

    WebWeb
    import { OAuthProvider } from "firebase/auth";
    
    const provider = new OAuthProvider('yahoo.com');
    var provider = new firebase.auth.OAuthProvider('yahoo.com');
  2. Facultatif: spécifiez des paramètres OAuth personnalisés supplémentaires que vous souhaitez envoyer avec la requête OAuth.

    WebWeb
    provider.setCustomParameters({
      // Prompt user to re-authenticate to Yahoo.
      prompt: 'login',
      // Localize to French.
      language: 'fr'
    });  
    provider.setCustomParameters({
      // Prompt user to re-authenticate to Yahoo.
      prompt: 'login',
      // Localize to French.
      language: 'fr'
    });  

    Pour connaître les paramètres acceptés par Yahoo, consultez la documentation Yahoo OAuth. Notez que vous ne pouvez pas transmettre de paramètres requis par Firebase avec setCustomParameters(). Ces paramètres sont client_id, redirect_uri, response_type, scope et state.

  3. 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 l'accès aux données utilisateur privées des API Yahoo, vous devez demander des autorisations aux API Yahoo sous Autorisations API dans la console pour les 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 de l'API de l'application, sdct-w doit être transmis au lieu de l'étendue OAuth en lecture seule sdct-r. Sinon, le flux échouera et une erreur s'affichera pour l'utilisateur final.

    WebWeb
    // 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');
    // 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');

    Pour en savoir plus, consultez la documentation sur les champs d'application Yahoo.

  4. Authentifiez-vous avec Firebase à l'aide de l'objet du fournisseur OAuth. Vous pouvez inviter vos utilisateurs à se connecter avec leur compte 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 à l'aide d'une fenêtre pop-up, appelez signInWithPopup:

      WebWeb
      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.
        });
      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.
        });
    • Pour vous connecter en redirigeant vers la page de connexion, appelez signInWithRedirect:

    Suivez les bonnes pratiques lorsque vous utilisez signInWithRedirect, linkWithRedirect ou reauthenticateWithRedirect.

      firebase.auth().signInWithRedirect(provider);
      

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

    WebWeb
    import { getAuth, signInWithRedirect } from "firebase/auth";
    
    const auth = getAuth();
    signInWithRedirect(auth, provider);
    firebase.auth().signInWithRedirect(provider);

    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'objet firebase.auth.UserCredential renvoyé.

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

    Par exemple, pour obtenir les informations de base sur le 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

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

  5. Bien que les exemples ci-dessus se concentrent sur les flux de connexion, vous pouvez également 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.

    WebWeb
    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.
        });
    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.
        });
  6. Le même schéma peut être utilisé avec reauthenticateWithPopup/reauthenticateWithRedirect, qui permet de récupérer de nouveaux identifiants pour les opérations sensibles qui nécessitent une connexion récente.

    WebWeb
    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.
        });
    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.
        });

Si vous avez activé le paramètre Un compte par adresse e-mail 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 le fournisseur d'un autre utilisateur Firebase (tel que Google), l'erreur auth/account-exists-with-different-credential est générée avec un objet AuthCredential (identifiants Yahoo). Pour terminer la connexion au fournisseur souhaité, 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 les erreurs auth/account-exists-with-different-credential 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 manière similaire en mode redirection, à la différence que les identifiants en attente doivent être mis en cache entre les redirections de pages (par exemple, en utilisant l'espace de stockage de session).

Contrairement aux 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 des jetons d'accès OAuth, Firebase Authentication n'offre pas 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é critique qui pourrait exposer les applications et les sites Web à des attaques par rejeu, où un jeton d'accès OAuth Yahoo obtenu pour un projet (pirate informatique) peut être utilisé pour se connecter à un autre projet (victime). Firebase Auth permet plutôt de gérer l'ensemble du flux OAuth et l'échange du code d'autorisation à l'aide de l'ID client OAuth et du secret configurés dans la console Firebase. Comme le code d'autorisation ne peut être utilisé qu'avec un ID client/secret spécifique, un code d'autorisation obtenu pour un projet ne peut pas être utilisé avec un autre.

Si vous devez utiliser ces fournisseurs dans des environnements non compatibles, vous devez utiliser une bibliothèque OAuth tierce et l'authentification personnalisée Firebase. Le premier est nécessaire pour s'authentifier auprès du fournisseur, et le second pour échanger les identifiants du fournisseur contre un jeton personnalisé.

S'authentifier avec Firebase dans une extension Chrome

Si vous créez une application d'extension Chrome, consultez le guide sur les 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 doit ê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 : Continuer à: https://my-app-12345.firebaseapp.com.

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

  1. 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é.
  2. Ajoutez votre domaine personnalisé à la liste des domaines autorisés dans la console Firebase: auth.custom.domain.com.
  3. Dans la console de développement Yahoo ou sur la page de configuration OAuth, ajoutez à la liste blanche l'URL de la page de redirection, qui sera accessible sur votre domaine personnalisé : https://auth.custom.domain.com/__/auth/handler.
  4. Lorsque vous initialisez la bibliothèque JavaScript, spécifiez votre domaine personnalisé avec le champ authDomain:
    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 l'utilisateur s'est connecté. Ce nouveau compte est stocké dans votre projet Firebase et peut être utilisé pour identifier un utilisateur dans toutes les applications de votre projet, quelle que soit la manière dont il se connecte.

  • 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 profil de base de l'utilisateur à partir de l'objet User. Consultez la section Gérer les utilisateurs.

  • Dans vos règles de sécurité Firebase Realtime Database et Cloud Storage, 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:

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

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