让用户通过 GitHub 登录

本文档介绍如何使用 Identity Platform 让用户通过 GitHub 登录。

准备工作

本教程假定您已启用 Identity Platform，并且拥有一个使用 HTML 和 JavaScript 编写的基本 Web 应用。如需了解具体方法，请参阅快速入门。

将 GitHub 配置为提供商

如需将 GitHub 配置为身份提供商，请执行以下操作：

  1. 前往 Google Cloud 控制台中的身份提供商页面。

    转到“身份提供商”页面

  2. 点击添加提供商。

  3. 从列表中选择 GitHub。

  4. 输入您的 GitHub 客户端 ID 和客户端密钥。如果您还没有 ID 和密钥，则可以从 GitHub 应用页面获取一个。

  5. 将配置 GitHub 下列出的 URI 配置为您的 GitHub 应用的有效 OAuth 重定向 URI。如果您在身份平台中配置了自定义网域，请更新 GitHub 应用配置中的重定向 URI，以使用自定义网域（而非默认网域）。例如，将 https://myproject.firebaseapp.com/__/auth/handler 更改为 https://auth.myownpersonaldomain.com/__/auth/handler。

  6. 点击已获授权的网域下的添加网域，以注册您应用的网域。出于开发目的，localhost 默认处于启用状态。

  7. 在配置您的应用下，点击设置详情。将代码段复制到应用的代码中，以初始化 Identity Platform Client SDK。

  8. 点击保存。

让用户通过 Client SDK 登录

  1. 创建 GitHub 提供商对象实例：

    Web 版本 9

    import { GithubAuthProvider } from "firebase/auth";

const provider = new GithubAuthProvider();
    auth_github_provider_create.js

    Web 版本 8

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

  1. 可选：添加 OAuth 范围。范围指定您要从 GitHub 请求哪些数据。更敏感的数据可能需要特定范围。如需确定您的应用所需的范围，请参阅提供商的文档。

    Web 版本 9

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

    Web 版本 8

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

  1. 可选：对身份验证流程进行本地化。您可以指定语言，也可以使用设备的默认语言：

    Web 版本 9

    import { getAuth } from "firebase/auth";

const auth = getAuth();
auth.languageCode = 'it';
// To apply the default browser preference instead of explicitly setting it.
// auth.useDeviceLanguage();
    auth_set_language_code.js

    Web 版本 8

    firebase.auth().languageCode = 'it';
// To apply the default browser preference instead of explicitly setting it.
// firebase.auth().useDeviceLanguage();
    index.js

  2. 可选：指定其他自定义 OAuth 参数。这些参数是针对 GitHub 的，通常用于自定义身份验证体验。您无法传递 OAuth 或 Identity Platform 预留的参数。

Web 版本 9

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

Web 版本 8

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

  1. 使用 GitHub 提供商对象让用户登录。您可以打开一个弹出式窗口，也可以重定向当前网页。对于移动设备用户而言，重定向更为便捷。

    如需显示弹出式窗口，请调用 signInWithPopup()：

    Web 版本 9

    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 版本 8

    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

    如需重定向页面，请先调用 signInWithRedirect()。

    使用 signInWithRedirect、linkWithRedirect 或 reauthenticateWithRedirect 时，请遵循最佳实践。

    Web 版本 9

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

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

    Web 版本 8

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

    然后，在网页加载时调用 getRedirectResult() 来检索 GitHub 令牌：

    Web 版本 9

    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 版本 8

    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

获得访问令牌后，您就可以使用它来调用 GitHub API。例如：

REST

curl -H "Authorization: Bearer [TOKEN]" https://api.github.com/gists/starred

手动让用户登录

如果您不想使用 Client SDK，也可以手动处理登录流程：

  1. 按照开发者文档中的步骤将 GitHub 身份验证机制集成到您的应用中。

  2. 使用您在上一步中实现的流程让用户通过 GitHub 登录。

  3. 用您从 GitHub 收到的令牌交换 Identity Platform 凭据：

    Web 版本 9

    import { GithubAuthProvider } from "firebase/auth";

const credential = GithubAuthProvider.credential(token);
    auth_github_provider_credential.js

    Web 版本 8

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

  4. 使用该凭据让用户通过 Identity Platform 登录：

    Web 版本 9

    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 版本 8

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

后续步骤