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 effectuer 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 de développement de ce fournisseur à la configuration du fournisseur :
   1. Enregistrez votre application en tant qu'application de développement 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 dans la configuration de votre application GitHub .
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 auprès de 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 sans 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 :

   Web modular API

   Apprenez-en davantage sur l’API Web modulaire arborescente et effectuez une mise à niveau à partir de l’API avec espace de noms.

   import { GithubAuthProvider } from "firebase/auth";
   
   const provider = new GithubAuthProvider();
   auth_github_provider_create.js

   Web namespaced API

   var provider = new firebase.auth.GithubAuthProvider();
   github.js

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:

   Web modular API

   Apprenez-en davantage sur l’API Web modulaire arborescente et effectuez une mise à niveau à partir de l’API avec espace de noms.

   provider.addScope('repo');
   auth_github_provider_scopes.js

   Web namespaced API

   provider.addScope('repo');
   github.js

   Consultez la documentation du fournisseur d'authentification .
3. Facultatif : Spécifiez les paramètres supplémentaires du fournisseur OAuth personnalisé 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é spécifiée par la documentation du fournisseur OAuth et la valeur correspondante. Par exemple:

   Web modular API

   Apprenez-en davantage sur l’API Web modulaire arborescente et effectuez une mise à niveau à partir de l’API avec espace de noms.

   provider.setCustomParameters({
     'allow_signup': 'false'
   });
   auth_github_provider_params.js

   Web namespaced API

   provider.setCustomParameters({
     'allow_signup': 'false'
   });
   github.js

   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 auprès de Firebase à l'aide de l'objet fournisseur GitHub. Vous pouvez inviter vos utilisateurs à se connecter avec leurs comptes GitHub soit en ouvrant une fenêtre contextuelle, soit en redirigeant vers la page de connexion. La méthode de redirection est privilégiée sur les appareils mobiles.
   • Pour vous connecter avec une fenêtre pop-up, appelez signInWithPopup :

     Web modular API

     Apprenez-en davantage sur l’API Web modulaire arborescente et effectuez une mise à niveau à partir de l’API avec espace de noms.

     import { getAuth, signInWithPopup, GithubAuthProvider } from "firebase/auth";
     
     const auth = getAuth();
     signInWithPopup(auth, provider)
       .then((result) => {
         // This gives you a GitHub Access Token. You can use it to access the GitHub API.
         const credential = GithubAuthProvider.credentialFromResult(result);
         const token = credential.accessToken;
     
         // The signed-in user info.
         const user = result.user;
         // IdP data available using getAdditionalUserInfo(result)
         // ...
       }).catch((error) => {
         // Handle Errors here.
         const errorCode = error.code;
         const errorMessage = error.message;
         // The email of the user's account used.
         const email = error.customData.email;
         // The AuthCredential type that was used.
         const credential = GithubAuthProvider.credentialFromError(error);
         // ...
       });
     auth_github_signin_popup.js

     Web namespaced API

     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;
         // IdP data available in result.additionalUserInfo.profile.
           // ...
       }).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;
         // ...
       });
     github.js

     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 ici que vous pouvez détecter et gérer les erreurs. Pour une liste des codes d'erreur, consultez la documentation de référence d'authentification .

   • Pour vous connecter en redirigeant vers la page de connexion, appelez signInWithRedirect : suivez les meilleures pratiques lors de l'utilisation de `signInWithRedirect`.

     Web modular API

     Apprenez-en davantage sur l’API Web modulaire arborescente et effectuez une mise à niveau à partir de l’API avec espace de noms.

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

     Web namespaced API

     firebase.auth().signInWithRedirect(provider);
     index.js

     Ensuite, vous pouvez également récupérer le jeton OAuth du fournisseur GitHub en appelant getRedirectResult lors du chargement de votre page :

     Web modular API

     Apprenez-en davantage sur l’API Web modulaire arborescente et effectuez une mise à niveau à partir de l’API avec espace de noms.

     import { getAuth, getRedirectResult, GithubAuthProvider } from "firebase/auth";
     
     const auth = getAuth();
     getRedirectResult(auth)
       .then((result) => {
         const credential = GithubAuthProvider.credentialFromResult(result);
         if (credential) {
           // This gives you a GitHub Access Token. You can use it to access the GitHub API.
           const token = credential.accessToken;
           // ...
         }
     
         // The signed-in user info.
         const user = result.user;
         // IdP data available using getAdditionalUserInfo(result)
         // ...
       }).catch((error) => {
         // Handle Errors here.
         const errorCode = error.code;
         const errorMessage = error.message;
         // The email of the user's account used.
         const email = error.customData.email;
         // The AuthCredential type that was used.
         const credential = GithubAuthProvider.credentialFromError(error);
         // ...
       });
     auth_github_signin_redirect_result.js

     Web namespaced API

     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;
         // IdP data available in result.additionalUserInfo.profile.
           // ...
       }).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;
         // ...
       });
     github.js

     C'est également ici que vous pouvez détecter et gérer les erreurs. Pour une liste des codes d'erreur, consultez la documentation de référence d'authentification .

Gestion des erreurs de compte existant avec des informations d'identification différentes

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 GitHub) avec une adresse e-mail qui existe déjà pour le fournisseur d'un autre utilisateur Firebase (tel que Google), l'erreur auth/account-exists-with-different-credential est lancé avec un objet AuthCredential (jeton d'accès GitHub). Pour terminer la connexion au fournisseur prévu, l'utilisateur doit d'abord se connecter au fournisseur existant (Google), puis se connecter à l'ancien AuthCredential (jeton d'accès GitHub).

Mode contextuel

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

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

try {
  // Step 1: User tries to sign in using GitHub.
  let result = await signInWithPopup(getAuth(), new GitHubAuthProvider());
} catch (error) {
  // Step 2: User's email already exists.
  if (error.code === "auth/account-exists-with-different-credential") {
    // The pending GitHub 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 GitHub 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 redirection, à la différence que les informations d'identification en attente doivent être mises en cache entre les redirections de pages (par exemple, en utilisant le stockage de session).

Gérer manuellement le flux de connexion

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 à une application Node.js, envoyez le jeton d'accès OAuth à l'application Node.js.
3. Une fois qu'un utilisateur s'est connecté avec GitHub, échangez le jeton d'accès OAuth 2.0 contre un identifiant Firebase :

   Web modular API

   Apprenez-en davantage sur l’API Web modulaire arborescente et effectuez une mise à niveau à partir de l’API avec espace de noms.

   import { GithubAuthProvider } from "firebase/auth";
   
   const credential = GithubAuthProvider.credential(token);
   auth_github_provider_credential.js

   Web namespaced API

   var credential = firebase.auth.GithubAuthProvider.credential(token);
   github.js

4. Authentifiez-vous auprès de Firebase à l'aide des identifiants Firebase :

   Web modular API

   Apprenez-en davantage sur l’API Web modulaire arborescente et effectuez une mise à niveau à partir de l’API avec espace de noms.

   import { getAuth, signInWithCredential } from "firebase/auth";
   
   // Sign in with the credential from the user.
   const auth = getAuth();
   signInWithCredential(auth, 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.customData.email;
       // ...
     });
   auth_signin_credential.js

   Web namespaced API

   // 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;
       // ...
     });
   index.js

Authentifiez-vous avec Firebase dans une extension Chrome

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

Personnalisation du domaine de redirection pour la connexion à GitHub

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

Cela sera également utilisé comme mécanisme de redirection pour la connexion OAuth. Ce domaine devra être autorisé pour tous les fournisseurs OAuth pris en charge. Cependant, cela signifie que les utilisateurs peuvent voir ce domaine lorsqu'ils se connectent à GitHub avant de revenir vers l'application : Continuez vers : 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 dans Configurer votre domaine pour l'hébergement . Lorsque vous vérifiez la propriété de votre domaine, l'hébergement fournit 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 du développeur GitHub 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 'my-app-12345.firebaseapp.com'.
     authDomain: 'auth.custom.domain.com',
     databaseURL: 'https://my-app-12345.firebaseio.com',
     projectId: 'my-app-12345',
     storageBucket: 'my-app-12345.appspot.com',
     messagingSenderId: '1234567890'
   };
   firebase.initializeApp(config);
   

Prochaines étapes

Après qu'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 manière dont l'utilisateur se connecte.

• Dans vos applications, la méthode recommandée pour connaître le statut 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 . 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 associant les informations d'identification du fournisseur d'authentification à un compte utilisateur existant.

Pour déconnecter un utilisateur, appelez signOut :

Web modular API

Apprenez-en davantage sur l’API Web modulaire arborescente et effectuez une mise à niveau à partir de l’API avec espace de noms.

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 namespaced API

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