在 Apple 平台上使用 GitHub 進行驗證

您可以使用 Firebase SDK 將通用 OAuth 登入功能整合至應用程式，執行端對端登入流程，讓使用者透過 GitHub 等 OAuth 提供者驗證 Firebase。

事前準備

如要使用 GitHub 帳戶登入使用者，您必須先將 GitHub 設為 Firebase 專案的登入服務供應器：

使用 Swift Package Manager 安裝及管理 Firebase 依附元件。

請參閱安裝指南，瞭解如何將 Firebase SDK 新增至 Apple 專案，包括直接匯入架構和使用 CocoaPods。

1. 在 Xcode 中保持開啟應用程式專案，然後依序點選「File」>「Add Packages」。
2. 系統提示時，請新增 Firebase Apple 平台 SDK 存放區：

  https://github.com/firebase/firebase-ios-sdk.git

注意：新專案應使用預設 (最新) SDK 版本，但您可以視需要選擇舊版。
3. 選擇 Firebase Authentication 程式庫。
4. 將 -ObjC 標記新增至目標的建構設定「Other Linker Flags」部分。
5. 完成後，Xcode 就會自動開始在背景中解析並下載依附元件。

接著，請執行一些設定步驟：

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

使用 Firebase SDK 處理登入流程

如要使用 Firebase Apple 平台 SDK 處理登入流程，請按照下列步驟操作：

1. 在 Xcode 專案中新增自訂網址配置：

   1. 開啟專案設定：在左側樹狀檢視畫面中，按兩下專案名稱。從「TARGETS」部分選取應用程式，然後選取「Info」分頁標籤，並展開「URL Types」部分。
   2. 按一下「+」按鈕，然後將已編碼的應用程式 ID 新增為網址配置。您可以在 Firebase 控制台的「General Settings」頁面中，找到 iOS 應用程式的「Encoded App ID」部分。請將其他欄位留空。

      完成後，設定應類似於下列內容 (但會顯示應用程式專屬的值)：

      

2. 使用提供者 ID github.com 建立 OAuthProvider 例項。

   Swift

       var provider = OAuthProvider(providerID: "github.com")
       

   Objective-C

       FIROAuthProvider *provider = [FIROAuthProvider providerWithProviderID:@"github.com"];
       

3. 選用：指定您要透過 OAuth 要求傳送的其他自訂 OAuth 參數。

   Swift

       provider.customParameters = [
         "allow_signup": "false"
       ]
       

   Objective-C

       [provider setCustomParameters:@{@"allow_signup": @"false"}];
       

   如要瞭解 GitHub 支援的參數，請參閱 GitHub OAuth 說明文件。請注意，您無法使用 setCustomParameters 傳遞 Firebase 必要參數。這些參數包括 client_id、redirect_uri、response_type、scope 和 state。

4. 選用：指定您要向驗證服務供應器要求的其他 OAuth 2.0 範圍，除了基本設定檔之外。如果您的應用程式需要存取 GitHub API 中的私人使用者資料，您必須在 GitHub 開發人員工作室的「API 權限」下方，要求存取 GitHub API 的權限。要求的 OAuth 範圍必須與應用程式 API 權限中預先設定的範圍完全相符。

   Swift

       // Request read access to a user's email addresses.
       // This must be preconfigured in the app's API permissions.
       provider.scopes = ["user:email"]
       

   Objective-C

       // Request read access to a user's email addresses.
       // This must be preconfigured in the app's API permissions.
       [provider setScopes:@[@"user:email"]];
       

   詳情請參閱 GitHub 範圍說明文件。

5. 選用：如果您想自訂應用程式向使用者顯示 reCAPTCHA 時，呈現 SFSafariViewController 或 UIWebView 的方式，請建立符合 AuthUIDelegate 通訊協定的自訂類別，並將其傳遞至 credentialWithUIDelegate。

6. 使用 OAuth 提供者物件，透過 Firebase 進行驗證。

   Swift

       provider.getCredentialWith(nil) { credential, error in
         if error != nil {
           // Handle error.
         }
         if credential != nil {
           Auth().signIn(with: credential) { authResult, error in
             if error != nil {
               // Handle error.
             }
             // User is signed in.
             // IdP data available in authResult.additionalUserInfo.profile.
   
             guard let oauthCredential = authResult.credential as? OAuthCredential else { return }
             // GitHub OAuth access token can also be retrieved by:
             // oauthCredential.accessToken
             // GitHub OAuth ID token can be retrieved by calling:
             // oauthCredential.idToken
           }
         }
       }
       

   Objective-C

       [provider getCredentialWithUIDelegate:nil
                                  completion:^(FIRAuthCredential *_Nullable credential,
                                               NSError *_Nullable error) {
         if (error) {
          // Handle error.
         }
         if (credential) {
           [[FIRAuth auth] signInWithCredential:credential
                                     completion:^(FIRAuthDataResult *_Nullable authResult,
                                               NSError *_Nullable error) {
             if (error) {
               // Handle error.
             }
             // User is signed in.
             // IdP data available in authResult.additionalUserInfo.profile.
   
             FIROAuthCredential *oauthCredential = (FIROAuthCredential *)authResult.credential;
             // GitHub OAuth access token can also be retrieved by:
             // oauthCredential.accessToken
             // GitHub OAuth ID token can be retrieved by calling:
             // oauthCredential.idToken
           }];
         }
       }];
       

   您可以使用 OAuth 存取權杖呼叫 GitHub API。

   舉例來說，如要取得基本設定檔資訊，您可以呼叫 REST API，並在 Authorization 標頭中傳遞存取權權杖：

   https://api.github.com/user

7. 雖然上述範例著重於登入流程，但您也可以將 GitHub 供應者連結至現有使用者。舉例來說，您可以將多個提供者連結至同一位使用者，讓他們使用任一提供者登入。

   Swift

       Auth().currentUser.link(withCredential: credential) { authResult, error in
         if error != nil {
           // Handle error.
         }
         // GitHub credential is linked to the current user.
         // IdP data available in authResult.additionalUserInfo.profile.
         // GitHub OAuth access token can also be retrieved by:
         // (authResult.credential as? OAuthCredential)?.accessToken
         // GitHub OAuth ID token can be retrieved by calling:
         // (authResult.credential as? OAuthCredential)?.idToken
       }
       

   Objective-C

       [[FIRAuth auth].currentUser
           linkWithCredential:credential
                   completion:^(FIRAuthDataResult * _Nullable authResult, NSError * _Nullable error) {
         if (error) {
           // Handle error.
         }
         // GitHub credential is linked to the current user.
         // IdP data available in authResult.additionalUserInfo.profile.
         // GitHub OAuth access token is can also be retrieved by:
         // ((FIROAuthCredential *)authResult.credential).accessToken
         // GitHub OAuth ID token can be retrieved by calling:
         // ((FIROAuthCredential *)authResult.credential).idToken
       }];
       

8. reauthenticateWithCredential 可用於擷取敏感作業的最新憑證，而這類作業需要最近登入。因此，您可以使用相同的模式搭配 reauthenticateWithCredential。

   Swift

       Auth().currentUser.reauthenticateWithCredential(withCredential: credential) { authResult, error in
         if error != nil {
           // Handle error.
         }
         // User is re-authenticated with fresh tokens minted and
         // should be able to perform sensitive operations like account
         // deletion and email or password update.
         // IdP data available in result.additionalUserInfo.profile.
         // Additional OAuth access token is can also be retrieved by:
         // (authResult.credential as? OAuthCredential)?.accessToken
         // GitHub OAuth ID token can be retrieved by calling:
         // (authResult.credential as? OAuthCredential)?.idToken
       }
       

   Objective-C

       [[FIRAuth auth].currentUser
           reauthenticateWithCredential:credential
                             completion:^(FIRAuthDataResult * _Nullable authResult, NSError * _Nullable error) {
         if (error) {
           // Handle error.
         }
         // User is re-authenticated with fresh tokens minted and
         // should be able to perform sensitive operations like account
         // deletion and email or password update.
         // IdP data available in result.additionalUserInfo.profile.
         // Additional OAuth access token is can also be retrieved by:
         // ((FIROAuthCredential *)authResult.credential).accessToken
         // GitHub OAuth ID token can be retrieved by calling:
         // ((FIROAuthCredential *)authResult.credential).idToken
       }];
       

處理「帳戶已存在，但憑證不同」錯誤

如果您在 Firebase 控制台中啟用「每個電子郵件地址只能建立一個帳戶」設定，當使用者嘗試使用另一個 Firebase 使用者供應商 (例如 Google) 的電子郵件地址登入供應商 (例如 GitHub) 時，系統會擲回錯誤 FIRAuthErrorCodeAccountExistsWithDifferentCredential，並附帶臨時 FIRAuthCredential 物件 (GitHub 憑證)。如要完成登入指定提供者的程序，使用者必須先登入現有提供者 (Google)，然後連結至前述的 FIRAuthCredential (GitHub 憑證)。如下所示：

Swift

  // Sign-in with an OAuth credential.
  provider.getCredentialWith(nil) { credential, error in
    // An account with the same email already exists.
    if (error as NSError?)?.code == AuthErrorCode.accountExistsWithDifferentCredential.rawValue {
      // Get pending credential and email of existing account.
      let existingAcctEmail = (error! as NSError).userInfo[AuthErrorUserInfoEmailKey] as! String
      let pendingCred = (error! as NSError).userInfo[AuthErrorUserInfoUpdatedCredentialKey] as! AuthCredential
      // Lookup existing account identifier by the email.
      Auth.auth().fetchProviders(forEmail:existingAcctEmail) { providers, error in
        // Existing email/password account.
        if (providers?.contains(EmailAuthProviderID))! {
          // Existing password account for email. Ask user to provide the password of the
          // existing account.
          // Sign in with existing account.
          Auth.auth().signIn(withEmail:existingAcctEmail, password:password) { user, error in
            // Successfully signed in.
            if user != nil {
              // Link pending credential to account.
              Auth.auth().currentUser?.linkAndRetrieveData(with: pendingCred) { result, error in
                // ...
              }
            }
          }
        }
      }
      return
    }

    // Other errors.
    if error != nil {
      // handle the error.
      return
    }

    // Sign in with the credential.
    if credential != nil {
      Auth.auth().signInAndRetrieveData(with: credential!) { result, error in
        if error != nil {
          // handle the error.
          return
        }
      }
    }
  }

  

Objective-C

  // Sign-in with an OAuth credential.
  [provider getCredentialWithUIDelegate:nil
                             completion:^(FIRAuthCredential *_Nullable credential, NSError *_Nullable error) {
    // An account with the same email already exists.
    if (error.code == FIRAuthErrorCodeAccountExistsWithDifferentCredential) {
      // Get pending credential and email of existing account.
      NSString *existingAcctEmail = error.userInfo[FIRAuthErrorUserInfoEmailKey];
      FIRAuthCredential *pendingCred = error.userInfo[FIRAuthErrorUserInfoUpdatedCredentialKey];
      // Lookup existing account identifier by the email.
      [[FIRAuth auth] fetchProvidersForEmail:existingAcctEmail
                                 completion:^(NSArray<NSString *> *_Nullable providers,
                                              NSError *_Nullable error) {
        // Existing email/password account.
        if ( [providers containsObject:FIREmailAuthProviderID] ) {
          // Existing password account for email. Ask user to provide the password of the
          // existing account.

          // Sign in with existing account.
          [[FIRAuth auth] signInWithEmail:existingAcctEmail
                                 password:password
                               completion:^(FIRUser *user, NSError *error) {
            // Successfully signed in.
            if (user) {
              // Link pending credential to account.
              [[FIRAuth auth].currentUser linkWithCredential:pendingCred
                                                  completion:^(FIRUser *_Nullable user,
                                                               NSError *_Nullable error) {
                // ...
              }];
            }
          }];
        }
      }];
      return;
    }

    // Other errors.
    if (error) {
      // handle the error.
      return;
    }

    // Sign in with the credential.
    if (credential) {
      [[FIRAuth auth] signInAndRetrieveDataWithCredential:credential
          completion:^(FIRAuthDataResult *_Nullable authResult,
                       NSError *_Nullable error) {
        if (error) {
          // handle the error.
          return;
        }
      }];
    }
  }];
  

後續步驟

使用者首次登入後，系統會建立新使用者帳戶，並連結至使用者登入時所用的憑證 (即使用者名稱和密碼、電話號碼或驗證服務提供者資訊)。這個新帳戶會儲存在 Firebase 專案中，無論使用者如何登入，都可以用於在專案中的每個應用程式中識別使用者。

• 在應用程式中，您可以從 User 物件取得使用者的個人資料基本資訊。請參閱「管理使用者」。

• 在 Firebase Realtime Database 和 Cloud Storage 安全性規則中，您可以從 auth 變數取得已登入使用者的專屬使用者 ID，並利用該 ID 控管使用者可存取的資料。

您可以將驗證服務供應商憑證連結至現有使用者帳戶，讓使用者使用多個驗證服務供應商登入應用程式。

如要讓使用者登出，請呼叫 signOut:。

Swift

let firebaseAuth = Auth.auth()
do {
  try firebaseAuth.signOut()
} catch let signOutError as NSError {
  print("Error signing out: %@", signOutError)
}

Objective-C

NSError *signOutError;
BOOL status = [[FIRAuth auth] signOut:&signOutError];
if (!status) {
  NSLog(@"Error signing out: %@", signOutError);
  return;
}

您可能還想為各種驗證錯誤新增錯誤處理程式碼。請參閱「處理錯誤」。