Uwierzytelniaj za pomocą GitHuba z JavaScriptem

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

1. Dodaj Firebase do projektu JavaScript.
2. W konsoli Firebase otwórz sekcję Uwierzytelnianie.
3. Na karcie Metoda logowania włącz dostawcę GitHub.
4. Dodaj Client ID (Identyfikator klienta) i Client Secret (Tajny klucz klienta) z konsoli programisty tego dostawcy do konfiguracji dostawcy:
   1. Zarejestruj swoją aplikację jako aplikację deweloperską na GitHubie i uzyskaj identyfikator klienta i tajny klucz klienta OAuth 2.0.
   2. 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.
5. 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:

1. Utwórz instancję obiektu dostawcy GitHub:

   Web Modular API

   Dowiedz się więcej o modułowym interfejsie Web API z możliwością potrząsania drzewem i uaktualnianiu interfejsu API z przestrzenią nazw.

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

   Interfejs API internetowej przestrzeni nazw

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

2. 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

   Dowiedz się więcej o modułowym interfejsie Web API z możliwością potrząsania drzewem i uaktualnianiu interfejsu API z przestrzenią nazw.

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

   Interfejs API internetowej przestrzeni nazw

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

   Zobacz dokumentację dostawcy uwierzytelniania.
3. 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

   Dowiedz się więcej o modułowym interfejsie Web API z możliwością potrząsania drzewem i uaktualnianiu interfejsu API z przestrzenią nazw.

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

   Interfejs API internetowej przestrzeni nazw

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

   Zarezerwowane wymagane parametry OAuth są niedozwolone i będą ignorowane. Więcej informacji znajdziesz w dokumentacji dostawcy uwierzytelniania.
4. 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

     Dowiedz się więcej o modułowym interfejsie Web API z możliwością potrząsania drzewem i uaktualnianiu interfejsu API z przestrzenią nazw.

     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

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

     Zwróć też uwagę, że możesz pobrać token OAuth dostawcy GitHuba, którego można użyć do pobrania dodatkowych danych za pomocą interfejsów GitHub API.

     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

     Dowiedz się więcej o modułowym interfejsie Web API z możliwością potrząsania drzewem i uaktualnianiu interfejsu API z przestrzenią nazw.

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

     Interfejs API internetowej przestrzeni nazw

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

     Następnie możesz też pobrać token OAuth dostawcy GitHuba, wywołując getRedirectResult podczas wczytywania strony:

     Web Modular API

     Dowiedz się więcej o modułowym interfejsie Web API z możliwością potrząsania drzewem i uaktualnianiu interfejsu API z przestrzenią nazw.

     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

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

     Możesz w nim też wykrywać i poprawiać błędy. Listę kodów błędów znajdziesz w dokumentacji referencyjnej uwierzytelniania.

Postępowanie w przypadku błędów dotyczących konta z innymi danymi logowania

Jeśli w konsoli Firebase masz włączone ustawienie Jedno konto na adres e-mail, to gdy użytkownik próbuje zalogować się w usłudze dostawcy (np. GitHub) przy użyciu adresu e-mail, który już istnieje dla dostawcy innego użytkownika Firebase (np. Google), pojawia się błąd auth/account-exists-with-different-credential wraz z obiektem AuthCredential (token dostępu GitHub). Aby zalogować się u docelowego dostawcy, użytkownik musi najpierw zalogować się u dotychczasowego dostawcy (Google), a następnie utworzyć link do dawnego dostawcy AuthCredential (tokena dostępu GitHub).

Tryb wyskakującego okienka

Jeśli użyjesz signInWithPopup, możesz naprawić błędy (auth/account-exists-with-different-credential) za pomocą kodu takiego jak ten przykład:

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) {
  // ...
}

Tryb przekierowania

Ten błąd jest obsługiwany w podobny sposób w trybie przekierowania z tą różnicą, że oczekujące dane uwierzytelniające muszą być zapisane w pamięci podręcznej między przekierowaniami stron (na przykład przy użyciu pamięci sesji).

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:

1. 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.
2. Jeśli musisz zalogować się w aplikacji Node.js, wyślij do niej token dostępu OAuth.
3. Gdy użytkownik zaloguje się przez GitHuba, wymień token dostępu OAuth 2.0 dla danych logowania Firebase:

   Web Modular API

   Dowiedz się więcej o modułowym interfejsie Web API z możliwością potrząsania drzewem i uaktualnianiu interfejsu API z przestrzenią nazw.

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

   Interfejs API internetowej przestrzeni nazw

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

4. Uwierzytelnij w Firebase za pomocą danych logowania Firebase:

   Web Modular API

   Dowiedz się więcej o modułowym interfejsie Web API z możliwością potrząsania drzewem i uaktualnianiu interfejsu API z przestrzenią nazw.

   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

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

Uwierzytelnianie za pomocą Firebase w rozszerzeniu do Chrome

Jeśli tworzysz aplikację rozszerzenia do Chrome, zapoznaj się z przewodnikiem po dokumentach poza ekranem.

Dostosowywanie domeny przekierowania na potrzeby logowania się przez GitHuba

Podczas tworzenia projektu Firebase udostępni dla Twojego projektu unikalną subdomenę: https://my-app-12345.firebaseapp.com.

Będzie ona również używana jako mechanizm przekierowania logowania OAuth. Ta domena musi być dozwolona w przypadku wszystkich obsługiwanych dostawców protokołu OAuth. Oznacza to jednak, że użytkownicy mogą zobaczyć tę domenę podczas logowania się do GitHuba, zanim zostaną przekierowani z powrotem do aplikacji: Przejdź na stronę https://my-app-12345.firebaseapp.com.

Aby uniknąć wyświetlania subdomeny, możesz skonfigurować domenę niestandardową w Hostingu Firebase:

1. Wykonaj kroki 1–3 z artykułu Konfigurowanie domeny na potrzeby Hostingu. Gdy potwierdzisz własność domeny, Hosting udostępnia certyfikat SSL dla Twojej domeny niestandardowej.
2. Dodaj swoją domenę niestandardową do listy autoryzowanych domen w konsoli Firebase: auth.custom.domain.com.
3. W konsoli programisty GitHuba lub na stronie konfiguracji OAuth umieść na białej liście adres URL strony przekierowania, która będzie dostępna w Twojej domenie niestandardowej: https://auth.custom.domain.com/__/auth/handler.
4. Po zainicjowaniu biblioteki JavaScript określ domenę niestandardową w polu 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);
   

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 obiektu User. 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

Dowiedz się więcej o modułowym interfejsie Web API z możliwością potrząsania drzewem i uaktualnianiu interfejsu API z przestrzenią nazw.

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

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

Interfejs API internetowej przestrzeni nazw

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