S'authentifier à l'aide de GitHub avec JavaScript

Vous pouvez autoriser vos utilisateurs à s'authentifier auprès de Firebase à l'aide de leur compte GitHub. en intégrant l'authentification GitHub à votre application. Vous pouvez intégrer GitHub l'authentification à l'aide du SDK Firebase pour effectuer le flux de connexion, ou en exécutant manuellement le flux GitHub OAuth 2.0 et en transmettant le code un jeton d'accès à Firebase.

Avant de commencer

1. Ajoutez Firebase à votre projet JavaScript.
2. Dans la console Firebase, ouvrez la section Authentification.
3. Dans l'onglet Sign in method (Mode de connexion), activez le fournisseur GitHub.
4. Ajoutez l'ID client et le code secret du client de la console pour développeur de ce fournisseur au configuration du fournisseur:
   1. Enregistrez votre application en tant qu'application de développement sur GitHub, puis obtenez son ID client et son code secret client OAuth 2.0.
   2. Assurez-vous que votre URI de redirection OAuth Firebase (par exemple, my-app-12345.firebaseapp.com/__/auth/handler) est défini comme URL de rappel d'autorisation sur 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 avec Firebase à l'aide de son compte GitHub est de gérer le flux de connexion le SDK JavaScript Firebase. (Si vous souhaitez authentifier un utilisateur dans Node.js ou un autre environnement hors navigateur, vous devez gérer le flux de connexion manuellement.)

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

1. Créez une instance de l'objet de fournisseur GitHub :

   Web

   <ph type="x-smartling-placeholder">

   </ph> Apprendre en savoir plus sur l'API Web modulaire en arbre et les arbres mise à niveau à partir de l'API d'espace de noms.

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

   Web

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

2. Facultatif: spécifiez des habilitations OAuth 2.0 supplémentaires que vous voulez demander au fournisseur d'authentification. Pour ajouter un champ d'application, appelez addScope. Exemple :

   Web

   <ph type="x-smartling-placeholder">

   </ph> Apprendre en savoir plus sur l'API Web modulaire en arbre et les arbres mise à niveau à partir de l'API d'espace de noms.

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

   Web

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

   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 indiqué dans la documentation du fournisseur OAuth et la valeur correspondante. Exemple :

   Web

   En savoir plus sur l'API Web modulaire pouvant être allégée par "tree shaking" et sur la mise à niveau depuis l'API avec espace de noms

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

   Web

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

   Les paramètres OAuth obligatoires réservés ne sont pas autorisés et seront ignorés. Pour en savoir plus, consultez la documentation de référence sur le fournisseur d'authentification.
4. Authentifiez-vous avec Firebase à l'aide de l'objet du fournisseur GitHub. Vous pouvez inviter vos utilisateurs à se connecter avec leur compte GitHub en ouvrant un ou en vous redirigeant vers la page de connexion. La méthode de redirection est de préférence sur les appareils mobiles.
   • Pour vous connecter via une fenêtre pop-up, appelez signInWithPopup:

     Web

     <ph type="x-smartling-placeholder">

     </ph> Apprendre en savoir plus sur l'API Web modulaire en arbre et les arbres mise à niveau à partir de l'API d'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

     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 extraire 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 la documentation de référence sur Auth.

   • Pour vous connecter en redirigeant l'utilisateur vers la page de connexion, appelez signInWithRedirect: Suivez les bonnes pratiques lorsque vous utilisez "signInWithRedirect".

     Web

     <ph type="x-smartling-placeholder">

     </ph> Apprendre en savoir plus sur l'API Web modulaire en arbre et les arbres mise à niveau à partir de l'API d'espace de noms.

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

     Web

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

     Ensuite, vous pouvez également récupérer le jeton OAuth du fournisseur GitHub en appelant getRedirectResult lorsque votre page se charge:

     Web

     En savoir plus sur l'API Web modulaire pouvant être allégée par "tree shaking" et sur la mise à niveau depuis 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

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

Gérer les erreurs de type "compte existant avec des identifiants différents"

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 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 (jeton d'accès GitHub). Pour finaliser la connexion l'utilisateur doit d'abord se connecter au fournisseur existant (Google), puis l'associer Ancien AuthCredential (jeton d'accès GitHub).

Mode pop-up

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,
  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 de redirection, à la différence que le bloc "Pending" Les identifiants doivent être mis en cache entre les redirections de page (par exemple, en utilisant le stockage de session).

Gérer le flux de connexion manuellement

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

1. Intégrez l'authentification GitHub dans votre application en suivant le <ph type="x-smartling-placeholder"></ph> pour les développeurs. À 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 des identifiants Firebase :

   Web

   En savoir plus sur l'API Web modulaire pouvant être allégée par "tree shaking" et sur la mise à niveau depuis l'API avec espace de noms

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

   Web

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

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

   Web

   <ph type="x-smartling-placeholder">

   </ph> Apprendre en savoir plus sur l'API Web modulaire en arbre et les arbres mise à niveau à partir de l'API d'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

   // 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

S'authentifier avec Firebase dans une extension Chrome

Si vous développez une application d'extension Chrome, consultez la Guide des documents hors écran

Personnaliser le domaine de redirection pour la connexion à GitHub

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

Il servira également de mécanisme de redirection pour la connexion OAuth. Ce domaine devrait être autorisé pour tous les fournisseurs OAuth compatibles. Toutefois, cela signifie que les utilisateurs peuvent voir que domaine lors de la connexion à GitHub avant de rediriger vers l'application: Accédez à la page 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. Lors de la validation 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 GitHub ou sur la page de configuration OAuth, ajoutez l'URL de la page de redirection à la liste blanche. Elle 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és aux identifiants, c'est-à-dire au nom d'utilisateur et au mot de passe, ou des informations sur le fournisseur d'authentification, c'est-à-dire l'utilisateur avec lequel l'utilisateur s'est connecté. Cette nouvelle est stocké dans votre projet Firebase et peut servir à identifier un utilisateur dans toutes les applications de votre projet, quelle que soit la façon dont l'utilisateur se connecte.

• Pour connaître l'état d'authentification de vos utilisateurs dans vos applications, définissez 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 identifiants du fournisseur d'authentification à un compte utilisateur existant.

Pour déconnecter un utilisateur, appelez signOut :

Web

<ph type="x-smartling-placeholder">

</ph> Apprendre en savoir plus sur l'API Web modulaire en arbre et les arbres mise à niveau à partir de l'API d'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

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