Cette page a été traduite par l'API Cloud Translation.

Authentification à l'aide de GitHub avec JavaScript

Vous pouvez laisser vos utilisateurs 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

Ajoutez Firebase à votre projet JavaScript .
Dans la console Firebase , ouvrez la section Auth .
Dans l'onglet Méthode de connexion, activez le fournisseur GitHub .
Ajoutez l' ID client et la clé secrète 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 et le secret client OAuth 2.0 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 votre URL de rappel d'autorisation dans la page des paramètres de votre application sur la configuration de votre application GitHub .
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 un autre environnement sans navigateur, vous devez gérer manuellement le flux de connexion.)

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

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

Web version 9

import { GithubAuthProvider } from "firebase/auth";

const provider = new GithubAuthProvider();auth_github_provider_create.js

Web version 8

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

Facultatif : spécifiez des étendues OAuth 2.0 supplémentaires que vous souhaitez demander au fournisseur d'authentification. Pour ajouter une étendue, appelez addScope . Par example:
Web version 9
En savoir plus sur le SDK modulaire Web v9 arborescent et la mise à niveau à partir de la version 8.
```
provider.addScope('repo');auth_github_provider_scopes.js
```
Web version 8
```
provider.addScope('repo');github.js
```
Consultez la documentation du fournisseur d'authentification .
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 example:
Web version 9
En savoir plus sur le SDK modulaire Web v9 arborescent et la mise à niveau à partir de la version 8.
```
provider.setCustomParameters({
  'allow_signup': 'false'
});auth_github_provider_params.js
```
Web version 8
```
provider.setCustomParameters({
  'allow_signup': 'false'
});github.js
```
Les paramètres OAuth obligatoires réservés ne sont pas autorisés et seront ignorés. Voir la référence du fournisseur d'authentification pour plus de détails.

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 pop-up, soit 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 pop-up, appelez signInWithPopup :

Web version 9

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 version 8

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

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

Web version 9

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

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

Web version 8

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 version 9

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 version 8

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 une liste des codes d'erreur, consultez la documentation de référence Auth .

Gestion des erreurs account-exists-with-different-credential

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 créer un lien vers l'ancien AuthCredential (jeton d'accès GitHub).

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


// Step 1.
// User tries to sign in to GitHub.
auth.signInWithPopup(new firebase.auth.GithubAuthProvider()).catch(function(error) {
  // An error happened.
  if (error.code === 'auth/account-exists-with-different-credential') {
    // Step 2.
    // User's email already exists.
    // The pending GitHub credential.
    var pendingCred = error.credential;
    // The provider account's email address.
    var email = error.email;
    // Get sign-in methods for this email.
    auth.fetchSignInMethodsForEmail(email).then(function(methods) {
      // Step 3.
      // If the user has several sign-in methods,
      // the first method in the list will be the "recommended" method to use.
      if (methods[0] === 'password') {
        // Asks the user their password.
        // In real scenario, you should handle this asynchronously.
        var password = promptUserForPassword(); // TODO: implement promptUserForPassword.
        auth.signInWithEmailAndPassword(email, password).then(function(result) {
          // Step 4a.
          return result.user.linkWithCredential(pendingCred);
        }).then(function() {
          // GitHub account successfully linked to the existing Firebase user.
          goToApp();
        });
        return;
      }
      // All the other cases are external providers.
      // Construct provider object for that provider.
      // TODO: implement getProviderForProviderId.
      var provider = getProviderForProviderId(methods[0]);
      // At this point, you should let the user know that they already have an account
      // but with a different provider, and let them validate the fact they want to
      // sign in with this provider.
      // Sign in to provider. Note: browsers usually block popup triggered asynchronously,
      // so in real scenario you should ask the user to click on a "continue" button
      // that will trigger the signInWithPopup.
      auth.signInWithPopup(provider).then(function(result) {
        // Remember that the user may have signed in with an account that has a different email
        // address than the first one. This can happen as Firebase doesn't control the provider's
        // sign in flow and the user is free to login using whichever account they own.
        // Step 4b.
        // Link to GitHub credential.
        // As we have access to the pending credential, we can directly call the link method.
        result.user.linkAndRetrieveDataWithCredential(pendingCred).then(function(usercred) {
          // GitHub account successfully linked to the existing Firebase user.
          goToApp();
        });
      });
    });
  }
});

Mode de redirection

Cette erreur est gérée de la même manière en mode de redirection, à la différence que les informations d'identification en attente doivent être mises en cache entre les redirections de page (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 :

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.
Si vous devez vous connecter à une application Node.js, envoyez le jeton d'accès OAuth à l'application Node.js.
Une fois qu'un utilisateur s'est connecté avec succès à GitHub, échangez le jeton d'accès OAuth 2.0 contre un identifiant Firebase :
Web version 9
En savoir plus sur le SDK modulaire Web v9 arborescent et la mise à niveau à partir de la version 8.
```
import { GithubAuthProvider } from "firebase/auth";

const credential = GithubAuthProvider.credential(token);auth_github_provider_credential.js
```
Web version 8
```
var credential = firebase.auth.GithubAuthProvider.credential(token);github.js
```

Authentifiez-vous auprès de Firebase à l'aide des informations d'identification Firebase :

Web version 9

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 version 8

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

Authentification avec Firebase dans une extension Chrome

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

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

Seules les opérations contextuelles ( signInWithPopup , linkWithPopup et reauthenticateWithPopup ) 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 de page 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. Les méthodes contextuelles ne peuvent être utilisées que dans les extensions utilisant Manifest V2 . Le nouveau Manifest V3 n'autorise que les scripts d'arrière-plan sous la forme de travailleurs de service, qui ne peuvent pas du tout effectuer les opérations contextuelles.

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 .

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 se rediriger 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 :

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 provisionne un certificat SSL pour votre domaine personnalisé.
Ajoutez votre domaine personnalisé à la liste des domaines autorisés dans la console Firebase : auth.custom.domain.com .
Dans la console développeur GitHub ou la page de configuration OAuth, mettez en liste blanche l'URL de la page de redirection, 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 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

Lorsqu'un utilisateur se connecte pour la première fois, un nouveau compte d'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 lesquelles 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 base du profil de l' User à partir de l'objet Utilisateur. 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 signOut :

Web version 9

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 version 8

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

Authentification à l'aide de GitHub avec JavaScript

Avant que tu commences

Gérer le flux de connexion avec le SDK Firebase

Web version 9

Web version 8

Web version 9

Web version 8

Web version 9

Web version 8

Web version 9

Web version 8

Web version 9

Web version 8

Web version 9

Web version 8

Gestion des erreurs account-exists-with-different-credential

Mode contextuel

Mode de redirection

Gérer manuellement le flux de connexion

Web version 9

Web version 8

Web version 9

Web version 8

Authentification avec Firebase dans une extension Chrome

Personnalisation du domaine de redirection pour la connexion à GitHub

Prochaines étapes

Web version 9

Web version 8