Google is committed to advancing racial equity for Black communities. See how.
Cette page a été traduite par l'API Cloud Translation.
Switch to English

S'authentifier à l'aide de GitHub avec JavaScript

Vous pouvez permettre à vos utilisateurs de s'authentifier auprès de Firebase à l'aide de leurs comptes GitHub en intégrant l'authentification GitHub dans votre application. Vous pouvez intégrer l'authentification GitHub soit en utilisant le SDK Firebase pour exécuter le flux de connexion, soit en exécutant manuellement le flux GitHub OAuth 2.0 et en transmettant le jeton d'accès résultant à Firebase.

Avant que tu commences

  1. Ajoutez Firebase à votre projet JavaScript .
  2. Dans la console Firebase , ouvrez la section Auth .
  3. Dans l'onglet Méthode de connexion, activez le fournisseur GitHub .
  4. Ajoutez l' ID client et le secret client de la console développeur de ce fournisseur à la configuration du fournisseur:
    1. Enregistrez votre application en tant qu'application de développeur sur GitHub et obtenez l' ID client OAuth 2.0 et le secret client de votre application.
    2. Assurez-vous que votre URI de redirection Firebase OAuth (par exemple my-app-12345.firebaseapp.com/__/auth/handler ) est défini comme URL de rappel d'autorisation dans la page des paramètres de votre application sur la configuration de votre application GitHub .
  5. Cliquez sur Enregistrer .

Gérez 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 GitHub consiste à gérer le flux de connexion avec le SDK JavaScript Firebase. (Si vous souhaitez authentifier un utilisateur dans Node.js ou dans un autre environnement non-navigateur, vous devez gérer le flux de connexion manuellement.)

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

  1. Créez une instance de l'objet fournisseur GitHub:
    var provider = new firebase.auth.GithubAuthProvider();
  2. Facultatif : spécifiez les étendues OAuth 2.0 supplémentaires que vous souhaitez demander au fournisseur d'authentification. Pour ajouter une étendue, appelez addScope . Par exemple:
    provider.addScope('repo');
    Consultez la documentation du fournisseur d'authentification .
  3. Facultatif : spécifiez des paramètres de fournisseur OAuth personnalisés supplémentaires que vous souhaitez envoyer avec la requête OAuth. Pour ajouter un paramètre personnalisé, appelez setCustomParameters sur le fournisseur initialisé avec un objet contenant la clé comme spécifié par la documentation du fournisseur OAuth et la valeur correspondante. Par exemple:
    provider.setCustomParameters({
      'allow_signup': 'false'
    });
    Les paramètres OAuth obligatoires réservés ne sont pas autorisés et seront ignorés. Consultez la référence du fournisseur d'authentification pour plus de détails.
  4. Authentifiez-vous avec Firebase à l'aide de l'objet fournisseur GitHub. Vous pouvez inviter vos utilisateurs à se connecter avec leurs comptes GitHub en ouvrant une fenêtre contextuelle ou en les redirigeant vers la page de connexion. La méthode de redirection est préférée sur les appareils mobiles.
    • Pour vous connecter avec une fenêtre signInWithPopup , appelez signInWithPopup :
      firebase
        .auth()
        .signInWithPopup(provider)
        .then((result) => {
          /** @type {firebase.auth.OAuthCredential} */
          var credential = result.credential;
      
          // This gives you a GitHub Access Token. You can use it to access the GitHub API.
          var token = credential.accessToken;
      
          // The signed-in user info.
          var user = result.user;
          // ...
        }).catch((error) => {
          // Handle Errors here.
          var errorCode = error.code;
          var errorMessage = error.message;
          // The email of the user's account used.
          var email = error.email;
          // The firebase.auth.AuthCredential type that was used.
          var credential = error.credential;
          // ...
        });
      Notez également que vous pouvez récupérer le jeton OAuth du fournisseur GitHub qui peut être utilisé pour récupérer des données supplémentaires à l'aide des API GitHub.

      C'est également là que vous pouvez détecter et gérer les erreurs. Pour obtenir la liste des codes d'erreur, consultez les documents de référence sur l'authentification .

    • Pour vous connecter en redirigeant vers la page de signInWithRedirect , appelez signInWithRedirect :
      firebase.auth().signInWithRedirect(provider);
      Ensuite, vous pouvez également récupérer le jeton OAuth du fournisseur GitHub en appelant getRedirectResult lorsque votre page se charge:
      firebase.auth()
        .getRedirectResult()
        .then((result) => {
          if (result.credential) {
            /** @type {firebase.auth.OAuthCredential} */
            var credential = result.credential;
      
            // This gives you a GitHub Access Token. You can use it to access the GitHub API.
            var token = credential.accessToken;
            // ...
          }
      
          // The signed-in user info.
          var user = result.user;
        }).catch((error) => {
          // Handle Errors here.
          var errorCode = error.code;
          var errorMessage = error.message;
          // The email of the user's account used.
          var email = error.email;
          // The firebase.auth.AuthCredential type that was used.
          var credential = error.credential;
          // ...
        });
      C'est également là que vous pouvez détecter et gérer les erreurs. Pour obtenir la liste des codes d'erreur, consultez les documents de référence sur l'authentification .

Gérez le flux de connexion manuellement

Vous pouvez également vous authentifier auprès de Firebase à l'aide d'un compte GitHub en gérant le flux de connexion en appelant les points de terminaison GitHub OAuth 2.0:

  1. Intégrez l'authentification GitHub dans votre application en suivant la documentation du développeur . À la fin du flux de connexion GitHub, vous recevrez un jeton d'accès OAuth 2.0.
  2. Si vous devez vous connecter sur une application Node.js, envoyez le jeton d'accès OAuth à l'application Node.js.
  3. Une fois qu'un utilisateur se connecte avec GitHub, échangez le jeton d'accès OAuth 2.0 contre un identifiant Firebase:
    var credential = firebase.auth.GithubAuthProvider.credential(token);
  4. Authentifiez-vous avec Firebase en utilisant les informations d'identification Firebase:
    // Sign in with the credential from the user.
    firebase.auth()
      .signInWithCredential(credential)
      .then((result) => {
        // Signed in 
        // ...
      })
      .catch((error) => {
        // Handle Errors here.
        const errorCode = error.code;
        const errorMessage = error.message;
        // The email of the user's account used.
        const email = error.email;
        // ...
      });

S'authentifier avec Firebase dans une extension Chrome

Si vous créez une application d'extension Chrome, vous devez ajouter votre ID d'extension Chrome:

  1. Ouvrez votre projet dans la console Firebase .
  2. Dans la section Authentification , ouvrez la page Méthode de connexion.
  3. Ajoutez un URI comme le suivant à la liste des domaines autorisés:
    chrome-extension://CHROME_EXTENSION_ID

Seules les opérations contextuelles ( signInWithPopup et linkWithPopup ) sont disponibles pour les extensions Chrome, car les extensions Chrome ne peuvent pas utiliser les redirections HTTP. Vous devez appeler ces méthodes à partir d'un script d'arrière-plan plutôt que d'une fenêtre contextuelle d'action du navigateur, car la fenêtre contextuelle d'authentification annulera la fenêtre contextuelle d'action du navigateur.

Dans le fichier manifeste de votre extension Chrome, assurez-vous d'ajouter l'URL https://apis.google.com à la liste d'autorisation content_security_policy .

Prochaines étapes

Lorsqu'un utilisateur se connecte pour la première fois, un nouveau compte utilisateur est créé et lié aux informations d'identification (c'est-à-dire le nom d'utilisateur et le mot de passe, le numéro de téléphone ou les informations du fournisseur d'authentification) avec lesquels l'utilisateur s'est connecté. Ce nouveau compte est stocké dans le cadre de votre projet Firebase et peut être utilisé pour identifier un utilisateur dans chaque application de votre projet, quelle que soit la façon dont l'utilisateur 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' User partir de l'objet User . Voir 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 liant les informations d'identification du fournisseur d'authentification à un compte d'utilisateur existant.

Pour déconnecter un utilisateur, appelez l' signOut

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