搭配 JavaScript 使用 GitHub 進行驗證

您可以讓使用者利用 GitHub 帳戶向 Firebase 進行驗證 將 GitHub 驗證整合至應用程式中。您可以整合 GitHub 進行驗證,例如使用 Firebase SDK 執行登入流程 或手動執行 GitHub OAuth 2.0 流程,然後將產生的結果 存取權杖

事前準備

  1. 將 Firebase 新增至您的 JavaScript 專案
  2. Firebase 控制台中開啟「Auth」專區。
  3. 在「Sign in method」分頁中,啟用 GitHub 供應商。
  4. 將供應商開發人員主控台中的「用戶端 ID」和「用戶端密鑰」新增至 提供者設定:
    1. 註冊應用程式 下載為 GitHub 上的開發人員應用程式,並取得應用程式的 OAuth 2.0 用戶端 ID用戶端密鑰
    2. 請確認您的 Firebase OAuth 重新導向 URI (例如 my-app-12345.firebaseapp.com/__/auth/handler) 在應用程式「設定」頁面的「授權回呼網址」中, GitHub 應用程式的設定
  5. 按一下 [儲存]

使用 Firebase SDK 處理登入流程

如要建構網頁應用程式,驗證使用者最簡單的方法 使用 GitHub 帳戶處理登入流程 Firebase JavaScript SDK(如果您要在 Node.js 驗證使用者 或其他非瀏覽器環境,您必須手動處理登入流程)。

如要使用 Firebase JavaScript SDK 處理登入流程,請按照下列步驟操作: 步驟:

  1. 建立 GitHub 供應商物件的執行個體:
    WebWeb
    import { GithubAuthProvider } from "firebase/auth";
    
    const provider = new GithubAuthProvider();
    var provider = new firebase.auth.GithubAuthProvider();
  2. 選用:指定您打算的其他 OAuth 2.0 範圍 要求驗證服務供應商如要新增範圍,請呼叫 addScope。例如:
    WebWeb
    provider.addScope('repo');
    provider.addScope('repo');
    請參閱驗證供應商 說明文件
  3. 選用:指定其他自訂 OAuth 供應商參數 您傳送的 OAuth 要求部分。如要新增自訂參數,請呼叫 已初始化提供者的 setCustomParameters,其物件包含金鑰 如 OAuth 供應商說明文件所載,以及相應的值中。例如:
    WebWeb
    provider.setCustomParameters({
      'allow_signup': 'false'
    });
    provider.setCustomParameters({
      'allow_signup': 'false'
    });
    系統不允許保留的必要 OAuth 參數,因此會予以忽略。 請參閱 驗證供應商參考資料瞭解更多資訊。
  4. 使用 GitHub 供應商物件向 Firebase 進行驗證。你可以 提示使用者透過 彈出式視窗,或重新導向至登入頁面。重新導向方法是 在行動裝置上顯示。
    • 如要透過彈出式視窗登入,請呼叫 signInWithPopup
      WebWeb
      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);
          // ...
        });
      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 供應商的 OAuth 權杖,以便透過 GitHub API 擷取其他資料。

      您也能在這裡找出並處理錯誤。如需錯誤代碼清單,請參閱驗證參考文件

    • 如要重新導向至登入頁面,請呼叫 signInWithRedirect: 使用「signInWithRedirect」時,請遵循最佳做法
      WebWeb
      import { getAuth, signInWithRedirect } from "firebase/auth";
      
      const auth = getAuth();
      signInWithRedirect(auth, provider);
      firebase.auth().signInWithRedirect(provider);
      接著,您也可以呼叫 getRedirectResult
      WebWeb
      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);
          // ...
        });
      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) 時 也存在於其他 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) {
  // ...
}

重新導向模式

這項錯誤的處理方式與重新導向模式下相同,但有差異 憑證必須在網頁重新導向之間快取 (例如使用工作階段儲存空間)。

手動處理登入流程

您也可以使用 GitHub 帳戶進行 Firebase 驗證,方法是處理 登入流程,方法是呼叫 GitHub OAuth 2.0 端點:

  1. 按照下列步驟,將 GitHub 驗證整合至應用程式 開發人員說明文件GitHub 登入流程結束時, 會收到 OAuth 2.0 存取權杖。
  2. 如果您需要登入 Node.js 應用程式,請傳送 OAuth 存取權 權杖提供給 Node.js 應用程式
  3. 使用者成功登入 GitHub 後,交換 OAuth 2.0 Firebase 憑證的存取權杖:
    WebWeb
    import { GithubAuthProvider } from "firebase/auth";
    
    const credential = GithubAuthProvider.credential(token);
    var credential = firebase.auth.GithubAuthProvider.credential(token);
  4. 使用 Firebase 憑證向 Firebase 進行驗證:
    WebWeb
    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;
        // ...
      });
    // 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 擴充功能應用程式,請參閱 螢幕外文件指南

建立專案時,Firebase 會為您的專案佈建一個專屬的子網域: https://my-app-12345.firebaseapp.com

這也會用來做為 OAuth 登入的重新導向機制。網域 允許所有支援的 OAuth 供應商。不過,這表示使用者可能會看到 網域並重新導向到應用程式: 繼續前往:https://my-app-12345.firebaseapp.com

如要避免顯示子網域,你可以使用 Firebase Hosting 設定自訂網域:

  1. 按照以下步驟 1 到 3: Hosting 設定網域。完成驗證後的影響 您的網域擁有權,Hosting 會為自訂網域佈建 SSL 憑證。
  2. 將自訂網域新增至 Firebase 控制台auth.custom.domain.com
  3. 在 GitHub 開發人員主控台或 OAuth 設定頁面,將重新導向頁面的網址加入許可清單。 將可在自訂網域上存取: https://auth.custom.domain.com/__/auth/handler
  4. 初始化 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 DatabaseCloud Storage中 查看安全性規則 透過 auth 變數取得已登入使用者的不重複使用者 ID。 控管使用者可以存取的資料

您可以讓使用者透過多重驗證機制登入您的應用程式 將驗證供應商憑證連結至 現有的使用者帳戶

如要登出使用者,請呼叫 signOut

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

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