Вы можете разрешить своим пользователям аутентифицироваться в Firebase, используя их учетные записи GitHub, интегрировав аутентификацию GitHub в свое приложение. Вы можете интегрировать аутентификацию GitHub либо с помощью Firebase SDK для выполнения процесса входа, либо выполнив поток GitHub OAuth 2.0 вручную и передав полученный токен доступа в Firebase.
Прежде чем вы начнете
- Добавьте Firebase в свой проект JavaScript .
- В консоли Firebase откройте раздел Auth .
- На вкладке «Метод входа» включите поставщик GitHub .
- Добавьте идентификатор клиента и секрет клиента из консоли разработчика этого поставщика в конфигурацию поставщика:
- Зарегистрируйте свое приложение в качестве приложения разработчика на GitHub и получите идентификатор клиента OAuth 2.0 и секрет клиента .
- Убедитесь, что ваш URI перенаправления OAuth Firebase (например,
my-app-12345.firebaseapp.com/__/auth/handler
) установлен в качестве URL-адреса обратного вызова авторизации на странице настроек вашего приложения в конфигурации вашего приложения GitHub .
- Нажмите Сохранить .
Управляйте процессом входа в систему с помощью Firebase SDK
Если вы создаете веб-приложение, самый простой способ аутентификации ваших пользователей в Firebase с использованием их учетных записей GitHub — это обработка процесса входа с помощью Firebase JavaScript SDK. (Если вы хотите аутентифицировать пользователя в Node.js или другой среде, отличной от браузера, вам придется обрабатывать процесс входа вручную.)
Чтобы обработать процесс входа с помощью Firebase JavaScript SDK, выполните следующие действия:
- Создайте экземпляр объекта провайдера GitHub:
Web modular API
import { GithubAuthProvider } from "firebase/auth"; const provider = new GithubAuthProvider();
Web namespaced API
var provider = new firebase.auth.GithubAuthProvider();
- Необязательно : укажите дополнительные области OAuth 2.0, которые вы хотите запросить у поставщика аутентификации. Чтобы добавить область, вызовите
addScope
. Например:См. документацию поставщика аутентификации .Web modular API
provider.addScope('repo');
Web namespaced API
provider.addScope('repo');
- Необязательно : укажите дополнительные пользовательские параметры поставщика OAuth, которые вы хотите отправить с запросом OAuth. Чтобы добавить настраиваемый параметр, вызовите
setCustomParameters
у инициализированного поставщика с объектом, содержащим ключ, указанный в документации поставщика OAuth, и соответствующее значение. Например:Зарезервированные обязательные параметры OAuth не разрешены и будут игнорироваться. Дополнительные сведения см. в справочнике по поставщику аутентификации .Web modular API
provider.setCustomParameters({ 'allow_signup': 'false' });
Web namespaced API
provider.setCustomParameters({ 'allow_signup': 'false' });
- Аутентификация в Firebase с использованием объекта провайдера GitHub. Вы можете предложить своим пользователям войти в систему с помощью своих учетных записей GitHub, открыв всплывающее окно или перенаправив на страницу входа. Метод перенаправления предпочтителен на мобильных устройствах.
- Чтобы войти в систему с помощью всплывающего окна, вызовите
signInWithPopup
:Также обратите внимание, что вы можете получить токен OAuth поставщика GitHub, который можно использовать для получения дополнительных данных с помощью API GitHub.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); // ... });
Web namespaced API
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; // ... });
Здесь также можно ловить и обрабатывать ошибки. Список кодов ошибок можно найти в справочной документации по аутентификации .
- Чтобы войти в систему путем перенаправления на страницу входа, вызовите
signInWithRedirect
: следуйте рекомендациям при использовании `signInWithRedirect`.Затем вы также можете получить токен OAuth провайдера GitHub, вызвавWeb modular API
import { getAuth, signInWithRedirect } from "firebase/auth"; const auth = getAuth(); signInWithRedirect(auth, provider);
Web namespaced API
firebase.auth().signInWithRedirect(provider);
getRedirectResult
при загрузке страницы:Здесь также можно ловить и обрабатывать ошибки. Список кодов ошибок можно найти в справочной документации по аутентификации .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); // ... });
Web namespaced API
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; // ... });
- Чтобы войти в систему с помощью всплывающего окна, вызовите
Обработка процесса входа вручную
Вы также можете пройти аутентификацию в Firebase, используя учетную запись GitHub, обработав процесс входа, вызвав конечные точки GitHub OAuth 2.0:
- Интегрируйте аутентификацию GitHub в свое приложение, следуя документации разработчика . В конце процесса входа в GitHub вы получите токен доступа OAuth 2.0.
- Если вам нужно войти в приложение Node.js, отправьте токен доступа OAuth в приложение Node.js.
- После того как пользователь успешно войдет в систему с помощью GitHub, замените токен доступа OAuth 2.0 на учетные данные Firebase:
Web modular API
import { GithubAuthProvider } from "firebase/auth"; const credential = GithubAuthProvider.credential(token);
Web namespaced API
var credential = firebase.auth.GithubAuthProvider.credential(token);
- Выполните аутентификацию в Firebase, используя учетные данные 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; // ... });
Web namespaced API
// 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; // ... });
Аутентификация с помощью Firebase в расширении Chrome
Если вы создаете приложение расширения Chrome, вам необходимо добавить свой идентификатор расширения Chrome:
- Откройте свой проект в консоли Firebase .
- В разделе Аутентификация откройте страницу Способ входа .
- Добавьте в список авторизованных доменов URI, подобный следующему:
chrome-extension://CHROME_EXTENSION_ID
Расширениям Chrome доступны только всплывающие операции ( signInWithPopup
, linkWithPopup
и reauthenticateWithPopup
), поскольку расширения Chrome не могут использовать перенаправления HTTP. Вам следует вызывать эти методы из сценария фоновой страницы, а не из всплывающего окна действия браузера, поскольку всплывающее окно аутентификации отменит всплывающее окно действия браузера. Методы всплывающих окон можно использовать только в расширениях, использующих Manifest V2 . Более новый Манифест V3 допускает только фоновые сценарии в виде сервисных работников, которые вообще не могут выполнять операции со всплывающими окнами.
В файле манифеста расширения Chrome обязательно добавьте URL-адрес https://apis.google.com
в список разрешений content_security_policy
.
Следующие шаги
После того, как пользователь входит в систему в первый раз, создается новая учетная запись пользователя, которая связывается с учетными данными (то есть именем пользователя и паролем, номером телефона или информацией поставщика аутентификации), с которыми пользователь вошел в систему. Эта новая учетная запись хранится как часть вашего проекта Firebase и может использоваться для идентификации пользователя в каждом приложении вашего проекта, независимо от того, как пользователь входит в систему.
В ваших приложениях рекомендуемый способ узнать статус аутентификации вашего пользователя — установить наблюдателя на объекте
Auth
. Затем вы можете получить базовую информацию профиля пользователя из объектаUser
. См. Управление пользователями .В правилах безопасности базы данных реального времени и облачного хранилища Firebase вы можете получить уникальный идентификатор пользователя, вошедшего в систему, из переменной
auth
и использовать его для управления тем, к каким данным пользователь может получить доступ.
Вы можете разрешить пользователям входить в ваше приложение с использованием нескольких поставщиков аутентификации, привязав учетные данные поставщика аутентификации к существующей учетной записи пользователя.
Чтобы выйти из системы, вызовите signOut
:
Web modular API
import { getAuth, signOut } from "firebase/auth"; const auth = getAuth(); signOut(auth).then(() => { // Sign-out successful. }).catch((error) => { // An error happened. });
Web namespaced API
firebase.auth().signOut().then(() => { // Sign-out successful. }).catch((error) => { // An error happened. });