使用 GitHub 进行身份验证 (JavaScript)

您可以将 GitHub 身份验证机制集成到您的应用中，让您的用户可使用自己的 GitHub 账号进行 Firebase 身份验证。集成 GitHub 身份验证的方法有两种：使用 Firebase SDK 执行登录流程；手动执行 GitHub OAuth 2.0 流程并将生成的访问令牌传递给 Firebase。

准备工作

将 Firebase 添加至您的 JavaScript 项目。
在 Firebase 控制台中，打开 Auth 部分。
在 Sign in method（登录方法）标签页中，启用 GitHub 提供方。
将该提供方的开发者控制台中的客户端 ID 和客户端密钥添加至提供方配置：
1. 在 GitHub 上将您的应用注册为开发者应用，并获取应用的 OAuth 2.0 客户端 ID 和客户端密钥。
2. 请务必前往 GitHub 应用配置界面，在您应用的设置页面中，将 Firebase OAuth 重定向 URI（例如 my-app-12345.firebaseapp.com/__/auth/handler）设置为您的授权回调网址。
点击保存。

使用 Firebase SDK 处理登录流程

如果您是在构建 Web 应用，想要通过用户的 GitHub 账号对其进行 Firebase 身份验证，最简单的方法是使用 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

详细了解可实现摇树优化的模块化 Web API，并从命名空间型 API 升级。
```
provider.addScope('repo');auth_github_provider_scopes.js
```
Web
```
provider.addScope('repo');github.js
```
请参阅身份验证提供方文档。
可选：指定您希望通过 OAuth 请求发送的其他自定义 OAuth 提供方参数。如需添加自定义参数，请使用包含 OAuth 提供方文档中指定的键及相应值的对象，对已初始化的提供方调用 setCustomParameters 方法。例如：
Web

详细了解可实现摇树优化的模块化 Web API，并从命名空间型 API 升级。
```
provider.setCustomParameters({
  'allow_signup': 'false'
});auth_github_provider_params.js
```
Web
```
provider.setCustomParameters({
  'allow_signup': 'false'
});github.js
```
禁止使用保留的必需 OAuth 参数，系统将忽略此类参数。如需了解详情，请参阅身份验证提供方参考文档。

使用 GitHub 提供方对象进行 Firebase 身份验证。您可以打开弹出式窗口或将用户重定向至登录页面，提示用户使用自己的 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

此外请注意，您可以检索 GitHub 提供方的 OAuth 令牌，使用该令牌可通过 GitHub API 提取额外数据。

您还可以在此处捕获并处理错误。如需获取错误代码列表，请参阅身份验证参考文档。

需重定向到登录页面进行登录，请调用 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

此外，您还可以在页面加载时，调用 getRedirectResult 来检索 GitHub 提供方的 OAuth 令牌：

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

您还可以在此处捕获并处理错误。如需获取错误代码列表，请参阅身份验证参考文档。

处理“account-exists-with-different-credential”错误

如果您在 Firebase 控制台中启用了每个电子邮件地址一个账号设置，当用户尝试使用一个 Firebase 用户的提供方（例如 Google）中已存在的电子邮件地址登录另一个提供方（例如 GitHub）时，系统会抛出 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) {
  // ...
}

重定向模式

在重定向模式下，处理该错误的方法类似，不同的是待处理凭据必须在页面重定向之间缓存（例如，使用会话存储空间缓存）。

手动处理登录流程

您还可以通过调用 GitHub OAuth 2.0 端点来处理登录流程，从而使用 GitHub 账号进行 Firebase 身份验证：

按开发者文档中的说明操作，将 GitHub 身份验证机制集成到您的应用中。在 GitHub 登录流程结束后，您会收到一个 OAuth 2.0 访问令牌。
如果您需要在 Node.js 应用上登录，请将 OAuth 访问令牌发送到 Node.js 应用。

在用户使用 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

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

如果您正在构建 Chrome 扩展程序应用，请参阅“屏幕外文档”指南。

在创建项目时，Firebase 将为您的项目预配一个唯一的子网域：https://my-app-12345.firebaseapp.com。

它也将用作 OAuth 登录的重定向机制。该网域需要列入所有受支持的 OAuth 提供方的许可名单。但是，这意味着用户在登录 GitHub 时可能会先看到该网域（前往：https://my-app-12345.firebaseapp.com），然后才重定向回应用。

如需避免显示子网域，您可以使用 Firebase Hosting 设置自定义网域：

按照设置您的 Hosting 网域中的第 1 步到第 3 步执行操作。当您验证网域所有权时，Hosting 会为您的自定义网域预配一个 SSL 证书。
在 Firebase 控制台中，将您的自定义域名添加到已获授权的域名列表：auth.custom.domain.com。
在 GitHub 开发者控制台或 OAuth 设置页面中，将可通过该自定义网域访问的重定向页面的网址 (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 安全规则中，您可以从 auth 变量获取已登录用户的唯一用户 ID，然后利用此 ID 来控制用户可以访问哪些数据。

您可以通过将身份验证提供方凭据关联至现有用户账号，让用户可以使用多个身份验证提供方登录您的应用。

如需将用户退出登录，请调用 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

处理“account-exists-with-different-credential”错误

弹出模式

重定向模式

手动处理登录流程

Web

Web

Web

Web

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

为 GitHub 登录服务自定义重定向网域

后续步骤

Web

Web