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
- Ajoutez Firebase à votre projet JavaScript.
- Dans la console Firebase, ouvrez la section Authentification.
- Dans l'onglet Sign in method (Mode de connexion), activez le fournisseur GitHub.
- Ajoutez l'ID client et le code secret du client de la console pour développeur de ce fournisseur au
configuration du fournisseur:
- 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.
- 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.
- 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:
- Créez une instance de l'objet de fournisseur GitHub :
Web
<ph type="x-smartling-placeholder">import { GithubAuthProvider } from "firebase/auth"; const provider = new GithubAuthProvider();
Web
var provider = new firebase.auth.GithubAuthProvider();
- 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">provider.addScope('repo');
Web
provider.addScope('repo');
- 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
provider.setCustomParameters({ 'allow_signup': 'false' });
Web
provider.setCustomParameters({ 'allow_signup': 'false' });
- 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">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); // ... });
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; // ... });
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">import { getAuth, signInWithRedirect } from "firebase/auth"; const auth = getAuth(); signInWithRedirect(auth, provider);
Web
firebase.auth().signInWithRedirect(provider);
getRedirectResult
lorsque votre page se charge:Web
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); // ... });
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; // ... });
- Pour vous connecter via une fenêtre pop-up, appelez
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 :
- 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.
- 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 GitHub, échangez le jeton d'accès OAuth 2.0 contre des identifiants Firebase :
Web
import { GithubAuthProvider } from "firebase/auth"; const credential = GithubAuthProvider.credential(token);
Web
var credential = firebase.auth.GithubAuthProvider.credential(token);
- Authentifiez-vous auprès de Firebase à l'aide des identifiants Firebase:
Web
<ph type="x-smartling-placeholder">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; // ... });
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; // ... });
S'authentifier avec Firebase dans une extension Chrome
Si vous développez une application d'extension Chrome, consultez la Guide des documents hors écran
É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'objetUser
. 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">import { getAuth, signOut } from "firebase/auth"; const auth = getAuth(); signOut(auth).then(() => { // Sign-out successful. }).catch((error) => { // An error happened. });
Web
firebase.auth().signOut().then(() => { // Sign-out successful. }).catch((error) => { // An error happened. });