Możesz umożliwić użytkownikom uwierzytelnianie w Firebase za pomocą kont GitHub, integrując uwierzytelnianie GitHub ze swoją aplikacją. Możesz zintegrować uwierzytelnianie GitHuba, korzystając z pakietu SDK Firebase, aby przeprowadzić logowanie, lub wykonując ręcznie przepływ OAuth 2.0 na GitHubie i przekazując powstały token dostępu do Firebase.
Zanim zaczniesz
- Dodaj Firebase do projektu JavaScript.
- W konsoli Firebase otwórz sekcję Uwierzytelnianie.
- Na karcie Metoda logowania włącz dostawcę GitHub.
- Dodaj Client ID (Identyfikator klienta) i Client Secret (Tajny klucz klienta) z konsoli programisty tego dostawcy do konfiguracji dostawcy:
- Zarejestruj swoją aplikację jako aplikację deweloperską na GitHubie i uzyskaj identyfikator klienta i tajny klucz klienta OAuth 2.0.
- Sprawdź, czy identyfikator URI przekierowania OAuth (np.
my-app-12345.firebaseapp.com/__/auth/handler
) jest ustawiony jako URL wywołania zwrotnego autoryzacji na stronie ustawień aplikacji w konfiguracji aplikacji GitHub.
- Kliknij Zapisz.
Zarejestruj się za pomocą pakietu SDK Firebase
Jeśli tworzysz aplikację internetową, najprostszym sposobem uwierzytelniania użytkowników w Firebase za pomocą ich kont na GitHubie jest obsługa logowania za pomocą pakietu SDK Firebase JavaScript. (Jeśli chcesz uwierzytelnić użytkownika w Node.js lub w środowisku innym niż przeglądarka, musisz to zrobić ręcznie).
Aby zalogować się za pomocą pakietu SDK Firebase JavaScript, wykonaj te czynności:
- Utwórz instancję obiektu dostawcy GitHub:
Web Modular API
import { GithubAuthProvider } from "firebase/auth"; const provider = new GithubAuthProvider();
Interfejs API internetowej przestrzeni nazw
var provider = new firebase.auth.GithubAuthProvider();
- Opcjonalnie: określ dodatkowe zakresy OAuth 2.0, o które chcesz żądać od dostawcy uwierzytelniania. Aby dodać zakres, wywołaj
addScope
. Przykład:Web Modular API
provider.addScope('repo');
Interfejs API internetowej przestrzeni nazw
provider.addScope('repo');
- Opcjonalnie: określ dodatkowe niestandardowe parametry dostawcy OAuth, które chcesz wysyłać z żądaniem OAuth. Aby dodać parametr niestandardowy, wywołaj
setCustomParameters
u zainicjowanego dostawcy za pomocą obiektu zawierającego klucz zgodnie z dokumentacją dostawcy OAuth i odpowiednią wartością. Przykład:Web Modular API
provider.setCustomParameters({ 'allow_signup': 'false' });
Interfejs API internetowej przestrzeni nazw
provider.setCustomParameters({ 'allow_signup': 'false' });
- Uwierzytelnij w Firebase za pomocą obiektu dostawcy GitHuba. Możesz poprosić użytkowników o zalogowanie się za pomocą kont GitHub przez otwarcie wyskakującego okienka lub przekierowanie na stronę logowania. Metoda przekierowania jest preferowana na urządzeniach mobilnych.
- Aby zalogować się za pomocą wyskakującego okienka, zadzwoń pod numer
signInWithPopup
:Web Modular API
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); // ... });
Interfejs API internetowej przestrzeni nazw
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; // ... });
Możesz w nim też wykrywać i poprawiać błędy. Listę kodów błędów znajdziesz w dokumentacji referencyjnej uwierzytelniania.
- Aby zalogować się przez przekierowanie na stronę logowania, wywołaj
signInWithRedirect
: postępuj zgodnie ze sprawdzonymi metodami w przypadku korzystania z metody „signInWithRedirect”.Web Modular API
import { getAuth, signInWithRedirect } from "firebase/auth"; const auth = getAuth(); signInWithRedirect(auth, provider);
Interfejs API internetowej przestrzeni nazw
firebase.auth().signInWithRedirect(provider);
getRedirectResult
podczas wczytywania strony:Web Modular API
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); // ... });
Interfejs API internetowej przestrzeni nazw
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; // ... });
- Aby zalogować się za pomocą wyskakującego okienka, zadzwoń pod numer
Zarejestruj się ręcznie
Możesz też uwierzytelnić się w Firebase za pomocą konta GitHub, uruchamiając proces logowania przez wywołanie punktów końcowych OAuth 2.0 GitHuba:
- Zintegruj uwierzytelnianie GitHub z aplikacją, postępując zgodnie z dokumentacją dla programistów. Na koniec procesu logowania się do GitHuba otrzymasz token dostępu OAuth 2.0.
- Jeśli musisz zalogować się w aplikacji Node.js, wyślij do niej token dostępu OAuth.
- Gdy użytkownik zaloguje się przez GitHuba, wymień token dostępu OAuth 2.0 dla danych logowania Firebase:
Web Modular API
import { GithubAuthProvider } from "firebase/auth"; const credential = GithubAuthProvider.credential(token);
Interfejs API internetowej przestrzeni nazw
var credential = firebase.auth.GithubAuthProvider.credential(token);
- Uwierzytelnij w Firebase za pomocą danych logowania Firebase:
Web Modular API
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; // ... });
Interfejs API internetowej przestrzeni nazw
// 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; // ... });
Uwierzytelnianie za pomocą Firebase w rozszerzeniu do Chrome
Jeśli tworzysz aplikację rozszerzenia do Chrome, zapoznaj się z przewodnikiem po dokumentach poza ekranem.
Dalsze kroki
Gdy użytkownik loguje się po raz pierwszy, tworzone jest nowe konto użytkownika, które jest łączone z danymi logowania (nazwa użytkownika i hasło, numer telefonu lub informacje o dostawcy uwierzytelniania). Nowe konto jest przechowywane w ramach Twojego projektu Firebase i może być używane do identyfikowania użytkowników we wszystkich aplikacjach w Twoim projekcie niezależnie od tego, jak się on loguje.
-
Zalecanym sposobem na poznanie stanu uwierzytelniania użytkownika w aplikacjach jest ustawienie obserwatora w obiekcie
Auth
. Dzięki temu można uzyskać podstawowe informacje o profilu użytkownika z obiektuUser
. Zobacz Zarządzanie użytkownikami. W regułach zabezpieczeń Bazy danych czasu rzeczywistego Firebase i Cloud Storage możesz pobrać ze zmiennej
auth
unikalny identyfikator użytkownika zalogowanego użytkownika i użyć go do kontrolowania, do jakich danych użytkownik ma dostęp.
Możesz zezwolić użytkownikom na logowanie się w aplikacji przy użyciu różnych dostawców uwierzytelniania, łącząc dane logowania dostawcy uwierzytelniania z istniejącym kontem użytkownika.
Aby wylogować użytkownika, wywołaj
signOut
:
Web Modular API
import { getAuth, signOut } from "firebase/auth"; const auth = getAuth(); signOut(auth).then(() => { // Sign-out successful. }).catch((error) => { // An error happened. });
Interfejs API internetowej przestrzeni nazw
firebase.auth().signOut().then(() => { // Sign-out successful. }).catch((error) => { // An error happened. });