Google 致力于为黑人社区推动种族平等。查看具体举措

使用 GitHub 和 JavaScript 进行身份验证

您可以通过将 GitHub 身份验证集成到您的应用中,让您的用户使用他们的 GitHub 帐户向 Firebase 进行身份验证。您可以通过使用 Firebase SDK 执行登录流程或手动执行 GitHub OAuth 2.0 流程并将生成的访问令牌传递给 Firebase 来集成 GitHub 身份验证。

在你开始之前

  1. 将 Firebase 添加到您的 JavaScript 项目中。
  2. Firebase 控制台中,打开Auth部分。
  3. 登录方法选项卡上,启用GitHub提供程序。
  4. 将该提供者的开发者控制台中的客户端 ID客户端密码添加到提供者配置中:
    1. 在 GitHub 上将您的应用程序注册为开发人员应用程序,并获取您的应用程序的 OAuth 2.0客户端 ID客户端密钥
    2. 确保您的 Firebase OAuth 重定向 URI (例如my-app-12345.firebaseapp.com/__/auth/handler )在GitHub 应用程序的 config的应用程序设置页面中设置为您的授权回调 URL
  5. 单击保存

使用 Firebase SDK 处理登录流程

如果您正在构建 Web 应用程序,使用 Firebase 的 GitHub 帐户对用户进行身份验证的最简单方法是使用 Firebase JavaScript SDK 处理登录流程。 (如果要在 Node.js 或其他非浏览器环境中对用户进行身份验证,则必须手动处理登录流程。)

要使用 Firebase JavaScript SDK 处理登录流程,请按以下步骤操作:

  1. 创建 GitHub 提供程序对象的实例:

    Web version 9

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

    Web version 8

    var provider = new firebase.auth.GithubAuthProvider();
  2. 可选:指定要从身份验证提供程序请求的其他 OAuth 2.0 范围。要添加范围,请调用addScope 。例如:

    Web version 9

    provider.addScope('repo');

    Web version 8

    provider.addScope('repo');
    请参阅身份验证提供程序文档
  3. 可选:指定要与 OAuth 请求一起发送的其他自定义 OAuth 提供程序参数。要添加自定义参数,请使用包含 OAuth 提供程序文档指定的键和相应值的对象对已初始化的提供程序调用setCustomParameters 。例如:

    Web version 9

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

    Web version 8

    provider.setCustomParameters({
      'allow_signup': 'false'
    });
    不允许保留所需的 OAuth 参数,将被忽略。有关更多详细信息,请参阅身份验证提供程序参考
  4. 使用 GitHub 提供程序对象向 Firebase 进行身份验证。您可以通过打开一个弹出窗口或重定向到登录页面来提示您的用户使用他们的 GitHub 帐户登录。重定向方法在移动设备上是首选。
    • 要使用弹出窗口登录,请调用signInWithPopup

      Web version 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;
          // ...
        }).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 version 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;
          // ...
        }).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 提供者的 OAuth 令牌,该令牌可用于使用 GitHub API 获取其他数据。

      这也是您可以捕获和处理错误的地方。有关错误代码的列表,请查看Auth Reference Docs

    • 要通过重定向到登录页面进行登录,请调用signInWithRedirect

      Web version 9

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

      Web version 8

      firebase.auth().signInWithRedirect(provider);
      然后,您还可以通过在页面加载时调用getRedirectResult来检索 GitHub 提供程序的 OAuth 令牌:

      Web version 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;
        }).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 version 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;
        }).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;
          // ...
        });
      这也是您可以捕获和处理错误的地方。有关错误代码的列表,请查看Auth Reference Docs

手动处理登录流程

您还可以通过调用 GitHub OAuth 2.0 端点处理登录流程,使用 GitHub 帐户向 Firebase 进行身份验证:

  1. 按照开发人员的文档将 GitHub 身份验证集成到您的应用程序中。在 GitHub 登录流程结束时,您将收到一个 OAuth 2.0 访问令牌。
  2. 如果您需要登录 Node.js 应用程序,请将 OAuth 访问令牌发送到 Node.js 应用程序。
  3. 用户成功登录 GitHub 后,将 OAuth 2.0 访问令牌交换为 Firebase 凭据:

    Web version 9

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

    Web version 8

    var credential = firebase.auth.GithubAuthProvider.credential(token);
  4. 使用 Firebase 凭据向 Firebase 进行身份验证:

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

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

在 Chrome 扩展程序中使用 Firebase 进行身份验证

如果您正在构建 Chrome 扩展应用程序,则必须添加您的 Chrome 扩展 ID:

  1. Firebase 控制台中打开您的项目。
  2. 身份验证部分中,打开登录方法页面。
  3. 将如下 URI 添加到授权域列表中:
    chrome-extension://CHROME_EXTENSION_ID

Chrome 扩展程序只能使用弹出操作( signInWithPopuplinkWithPopupreauthenticateWithPopup ),因为 Chrome 扩展程序不能使用 HTTP 重定向。您应该从后台页面脚本而不是浏览器操作弹出窗口调用这些方法,因为身份验证弹出窗口将取消浏览器操作弹出窗口。弹出方法只能用于使用Manifest V2的扩展。较新的Manifest V3只允许服务工作者形式的后台脚本,根本无法执行弹出操作。

在 Chrome 扩展程序的清单文件中,确保将https://apis.google.com URL 添加到content_security_policy许可名单。

下一步

用户首次登录后,会创建一个新用户帐户并将其链接到凭据(即用户名和密码、电话号码或身份验证提供商信息),即用户登录时使用的凭据。这个新帐户作为 Firebase 项目的一部分存储,可用于在项目中的每个应用中识别用户,无论用户如何登录。

  • 在您的应用程序中,了解用户身份验证状态的推荐方法是在Auth对象上设置观察者。然后,您可以从User对象中获取用户的基本配置文件信息。请参阅管理用户

  • 在您的 Firebase 实时数据库和云存储安全规则中,您可以从auth变量中获取登录用户的唯一用户 ID,并使用它来控制用户可以访问哪些数据。

您可以通过将身份验证提供程序凭据链接到现有用户帐户来允许用户使用多个身份验证提供程序登录您的应用程序。

要注销用户,请调用signOut

Web version 9

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

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

Web version 8

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