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

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

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

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

Добавьте Firebase в свой JavaScript-проект .
В консоли Firebase перейдите в раздел Безопасность > Аутентификация .
На вкладке «Способ входа» включите поставщика авторизации GitHub .
Добавьте идентификатор клиента (Client ID) и секретный ключ клиента (Client Secret) из консоли разработчика соответствующего поставщика в конфигурацию поставщика:
1. Зарегистрируйте свое приложение как приложение для разработчиков на GitHub и получите идентификатор клиента OAuth 2.0 и секретный ключ клиента .
2. Убедитесь, что URI перенаправления Firebase OAuth (например, my-app-12345.firebaseapp.com/__/auth/handler ) указан в качестве URL-адреса обратного вызова авторизации на странице настроек вашего приложения в конфигурации GitHub .
Нажмите « Сохранить ».

Обрабатывайте процесс авторизации с помощью Firebase SDK.

Если вы разрабатываете веб-приложение, самый простой способ аутентификации пользователей в Firebase с использованием их учетных записей GitHub — это обработка процесса входа в систему с помощью Firebase JavaScript SDK. (Если вы хотите аутентифицировать пользователя в Node.js или другой среде, отличной от браузера, вам необходимо обрабатывать процесс входа в систему вручную.)

Для обработки процесса авторизации с помощью Firebase JavaScript SDK выполните следующие действия:

Создайте экземпляр объекта поставщика GitHub:

Web

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
```
provider.addScope('repo');auth_github_provider_scopes.js
```
Web
```
provider.addScope('repo');github.js
```
См. документацию поставщика аутентификации .
Необязательно : укажите дополнительные параметры пользовательского поставщика OAuth, которые вы хотите отправить вместе с запросом OAuth. Чтобы добавить пользовательский параметр, вызовите метод setCustomParameters для инициализированного поставщика, передав ему объект, содержащий ключ, указанный в документации поставщика OAuth, и соответствующее значение. Например:
Web
```
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 в это приложение.

После успешного входа пользователя в GitHub, обменяйте токен доступа OAuth 2.0 на учетные данные Firebase:

Web

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, ознакомьтесь с руководством по работе с документами, отображаемыми вне экрана .

При создании проекта 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 'PROJECT_ID.firebaseapp.com'.
  authDomain: 'auth.custom.domain.com',
  databaseURL: 'https://PROJECT_ID.firebaseio.com',
  projectId: 'PROJECT_ID',
  storageBucket: 'PROJECT_ID.firebasestorage.app',
  messagingSenderId: 'SENDER_ID'
};
firebase.initializeApp(config);

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

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

В ваших приложениях рекомендуемый способ узнать статус авторизации пользователя — установить наблюдателя для объекта Auth . Затем вы можете получить основную информацию профиля пользователя из объекта User . См. раздел «Управление пользователями» .
В правилах безопасности Firebase Realtime Database и Cloud Storage вы можете получить уникальный идентификатор пользователя, вошедшего в систему, из переменной 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 Оптимизируйте свои подборки Сохраняйте и классифицируйте контент в соответствии со своими настройками.