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

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

Подготовка

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

Как обрабатывать процесс входа с помощью Firebase SDK

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

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

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

    Web

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

    Web

    var provider = new firebase.auth.GithubAuthProvider();
  2. Необязательно. Укажите дополнительные области действия OAuth 2.0, которые вы хотите запросить у поставщика услуг аутентификации. Чтобы добавить область действия, вызовите метод addScope. Пример:

    Web

    provider.addScope('repo');

    Web

    provider.addScope('repo');
    Ознакомьтесь с документацией поставщика услуг аутентификации.
  3. Необязательно. Укажите дополнительные специальные параметры поставщика OAuth, которые вы хотите отправлять с запросом OAuth. Чтобы добавить специальный параметр, вызовите метод setCustomParameters для инициализированного поставщика, передав объект, содержащий ключ, указанный в документации поставщика OAuth, и соответствующее значение. Пример:

    Web

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

    Web

    provider.setCustomParameters({
      'allow_signup': 'false'
    });
    Зарезервированные обязательные параметры OAuth не допускаются и будут игнорироваться. Подробнее о поставщике аутентификации…
  4. Выполните аутентификацию в 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);
          // ...
        });

      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;
          // ...
        });
      Обратите внимание, что вы можете получить токен OAuth поставщика GitHub, который можно использовать для получения дополнительных данных с помощью API GitHub.

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

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

      Web

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

      Web

      firebase.auth().signInWithRedirect(provider);
      Затем вы можете получить токен 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);
          // ...
        });

      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;
          // ...
        });
      Здесь же можно выявлять и обрабатывать ошибки. Список кодов ошибок можно найти в справочной документации по аутентификации.

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

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

  1. Интегрируйте аутентификацию GitHub в приложение, следуя документации для разработчиков. В конце процесса входа в GitHub вы получите токен доступа OAuth 2.0.
  2. Если вам нужно войти в приложение Node.js, отправьте ему токен доступа OAuth.
  3. После того как пользователь успешно войдет в аккаунт GitHub, обменяйте токен доступа OAuth 2.0 на учетные данные Firebase:

    Web

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

    Web

    var credential = firebase.auth.GithubAuthProvider.credential(token);
  4. Выполните аутентификацию в 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;
        // ...
      });

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

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

Если вы создаете приложение для расширения Chrome, ознакомьтесь с руководством по работе с документами вне экрана.

Дальнейшие действия

После первого входа пользователя создается новый аккаунт, связанный с учетными данными, которые он использовал (именем пользователя и паролем, номером телефона или информацией поставщика услуг аутентификации). Этот новый аккаунт хранится в проекте 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.
});

Web

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