Эта страница переведена с помощью Cloud Translation API.

Аутентификация с использованием GitHub с JavaScript

Вы можете разрешить своим пользователям аутентифицироваться в Firebase, используя их учетные записи GitHub, интегрировав аутентификацию GitHub в свое приложение. Вы можете интегрировать аутентификацию GitHub либо с помощью Firebase SDK для выполнения процесса входа, либо выполнив поток GitHub OAuth 2.0 вручную и передав полученный токен доступа в Firebase.

Прежде чем начать

Добавьте Firebase в свой проект JavaScript .
В консоли Firebase откройте раздел Auth .
На вкладке «Метод входа» включите поставщик GitHub .
Добавьте идентификатор клиента и секрет клиента из консоли разработчика этого поставщика в конфигурацию поставщика:
1. Зарегистрируйте свое приложение в качестве приложения разработчика на GitHub и получите идентификатор клиента OAuth 2.0 и секрет клиента .
2. Убедитесь, что ваш 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
Узнайте больше о модульном веб-API, поддерживающем древовидную структуру, и обновите API с пространством имен.
```
import { GithubAuthProvider } from "firebase/auth";

const provider = new GithubAuthProvider();auth_github_provider_create.js
```
Web
```
var provider = new firebase.auth.GithubAuthProvider();github.js
```
Необязательно : укажите дополнительные области OAuth 2.0, которые вы хотите запросить у поставщика аутентификации. Чтобы добавить область, вызовите addScope . Например:
Web
Узнайте больше о модульном веб-API, поддерживающем древовидную структуру, и обновите API с пространством имен.
```
provider.addScope('repo');auth_github_provider_scopes.js
```
Web
```
provider.addScope('repo');github.js
```
См. документацию поставщика аутентификации .
Необязательно : укажите дополнительные пользовательские параметры поставщика OAuth, которые вы хотите отправить с запросом OAuth. Чтобы добавить настраиваемый параметр, вызовите setCustomParameters у инициализированного поставщика с объектом, содержащим ключ, указанный в документации поставщика OAuth, и соответствующее значение. Например:
Web
Узнайте больше о модульном веб-API, поддерживающем древовидную структуру, и обновите API с пространством имен.
```
provider.setCustomParameters({
  'allow_signup': 'false'
});auth_github_provider_params.js
```
Web
```
provider.setCustomParameters({
  'allow_signup': 'false'
});github.js
```
Зарезервированные обязательные параметры OAuth не разрешены и будут игнорироваться. Дополнительные сведения см. в справочнике по поставщику аутентификации .

Аутентификация в Firebase с использованием объекта провайдера GitHub. Вы можете предложить своим пользователям войти в систему с помощью своих учетных записей GitHub, открыв всплывающее окно или перенаправив на страницу входа. Метод перенаправления предпочтителен на мобильных устройствах.

Чтобы войти в систему с помощью всплывающего окна, вызовите signInWithPopup :

Web

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

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

Также обратите внимание, что вы можете получить токен OAuth поставщика GitHub, который можно использовать для получения дополнительных данных с помощью API GitHub.

Здесь также можно ловить и обрабатывать ошибки. Список кодов ошибок можно найти в справочной документации по аутентификации .

Чтобы войти в систему путем перенаправления на страницу входа, вызовите signInWithRedirect : следуйте рекомендациям при использовании `signInWithRedirect`.

Web

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

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

Web

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

Затем вы также можете получить токен OAuth провайдера GitHub, вызвав getRedirectResult при загрузке страницы:

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

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

Обработка ошибок «учетная запись существует с разными учетными данными»

Если вы включили параметр «Одна учетная запись на адрес электронной почты» в консоли Firebase , когда пользователь пытается войти в систему у провайдера (например, GitHub) с адресом электронной почты, который уже существует для другого провайдера пользователя Firebase (например, Google), возникает ошибка. auth/account-exists-with-different-credential выбрасывается вместе с объектом AuthCredential (токен доступа GitHub). Чтобы завершить вход в систему предполагаемого поставщика, пользователь должен сначала войти в систему существующего поставщика (Google), а затем связать его с бывшим AuthCredential (токеном доступа GitHub).

Если вы используете signInWithPopup , вы можете обрабатывать ошибки auth/account-exists-with-different-credential с помощью кода, подобного следующему примеру:

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

Режим перенаправления

Эта ошибка обрабатывается аналогичным образом в режиме перенаправления, с той разницей, что ожидающие учетные данные должны кэшироваться между перенаправлениями страниц (например, с использованием хранилища сеансов).

Обработка процесса входа вручную

Вы также можете пройти аутентификацию в Firebase, используя учетную запись GitHub, обработав процесс входа, вызвав конечные точки GitHub OAuth 2.0:

Интегрируйте аутентификацию GitHub в свое приложение, следуя документации разработчика . В конце процесса входа в GitHub вы получите токен доступа OAuth 2.0.
Если вам нужно войти в приложение Node.js, отправьте токен доступа OAuth в приложение Node.js.
После того как пользователь успешно войдет в систему с помощью GitHub, замените токен доступа OAuth 2.0 на учетные данные Firebase:
Web
Узнайте больше о модульном веб-API, поддерживающем древовидную структуру, и обновите API с пространством имен.
```
import { GithubAuthProvider } from "firebase/auth";

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

Выполните аутентификацию в Firebase, используя учетные данные Firebase:

Web

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

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

Аутентификация с помощью Firebase в расширении Chrome

Если вы создаете приложение-расширение Chrome, см. руководство по Offscreen Documents .

При создании проекта Firebase предоставит для вашего проекта уникальный субдомен: https://my-app-12345.firebaseapp.com .

Это также будет использоваться в качестве механизма перенаправления для входа в систему OAuth. Этот домен необходимо будет разрешить для всех поддерживаемых поставщиков OAuth. Однако это означает, что пользователи могут видеть этот домен при входе в GitHub перед перенаправлением обратно в приложение: Продолжите: https://my-app-12345.firebaseapp.com .

Чтобы не отображать свой субдомен, вы можете настроить собственный домен с помощью Firebase Hosting :

Выполните шаги 1–3 в разделе «Настройка домена для Hosting . Когда вы подтверждаете право собственности на домен, Hosting предоставляет сертификат SSL для вашего личного домена.
Добавьте свой собственный домен в список авторизованных доменов в консоли Firebase : auth.custom.domain.com .
В консоли разработчика GitHub или на странице настройки OAuth добавьте в белый список URL-адрес страницы перенаправления, которая будет доступна в вашем личном домене: https://auth.custom.domain.com/__/auth/handler .

При инициализации библиотеки JavaScript укажите свой личный домен в поле 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);

Следующие шаги

После того, как пользователь входит в систему в первый раз, создается новая учетная запись пользователя, которая связывается с учетными данными (то есть именем пользователя и паролем, номером телефона или информацией поставщика аутентификации), с которыми пользователь вошел в систему. Эта новая учетная запись хранится как часть вашего проекта Firebase и может использоваться для идентификации пользователя в каждом приложении вашего проекта, независимо от того, как пользователь входит в систему.

В ваших приложениях рекомендуемый способ узнать статус аутентификации вашего пользователя — установить наблюдателя на объекте Auth . Затем вы можете получить базовую информацию профиля пользователя из объекта User . См. Управление пользователями .
В правилах безопасности Firebase Realtime Database и Cloud Storage Firebase вы можете получить уникальный идентификатор пользователя, вошедшего в систему, из переменной auth и использовать его для управления тем, к каким данным пользователь может получить доступ.

Вы можете разрешить пользователям входить в ваше приложение с использованием нескольких поставщиков аутентификации , связав учетные данные поставщика аутентификации с существующей учетной записью пользователя.

Чтобы выйти из системы, вызовите signOut :

Web

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

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

Аутентификация с использованием GitHub с JavaScript

Прежде чем начать

Управляйте процессом входа с помощью Firebase SDK

Web

Web

Web

Web

Web

Web

Web

Web

Web

Web

Web

Web

Обработка ошибок «учетная запись существует с разными учетными данными»

Всплывающий режим

Режим перенаправления

Обработка процесса входа вручную

Web

Web

Web

Web

Аутентификация с помощью Firebase в расширении Chrome

Настройка домена перенаправления для входа в GitHub

Следующие шаги

Web

Web