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

您可以通過使用 Firebase SDK 將通用 OAuth 登錄集成到您的應用中來執行端到端登錄流程，從而讓您的用戶使用 GitHub 等 OAuth 提供程序向 Firebase 進行身份驗證。

在你開始之前

要使用 GitHub 帳戶登錄用戶，您必須首先啟用 GitHub 作為 Firebase 項目的登錄提供程序：

使用 Swift Package Manager 安裝和管理 Firebase 依賴項。

1. 在 Xcode 中，打開您的應用項目，導航到File > Add Packages 。
2. 出現提示時，添加 Firebase Apple 平台 SDK 存儲庫：

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

3. 選擇 Firebase 身份驗證庫。
4. 完成後，Xcode 將在後台自動開始解析和下載您的依賴項。

現在，執行一些配置步驟：

1. 在Firebase 控制台中，打開Auth部分。
2. 在登錄方法選項卡上，啟用GitHub提供程序。
3. 將該提供者的開發者控制台中的客戶端 ID和客戶端密碼添加到提供者配置中：
   1. 在 GitHub 上將您的應用程序註冊為開發人員應用程序，並獲取您的應用程序的 OAuth 2.0客戶端 ID和客戶端密鑰。
   2. 確保您的 Firebase OAuth 重定向 URI （例如my-app-12345.firebaseapp.com/__/auth/handler ）在GitHub 應用程序的 config的應用程序設置頁面中設置為您的授權回調 URL 。
4. 單擊保存。

使用 Firebase SDK 處理登錄流程

要使用 Firebase Apple 平台 SDK 處理登錄流程，請執行以下步驟：

1. 將自定義 URL 方案添加到您的 Xcode 項目：

   1. 打開您的項目配置：雙擊左側樹視圖中的項目名稱。從TARGETS部分中選擇您的應用程序，然後選擇Info選項卡，然後展開URL Types部分。
   2. 單擊+按鈕，並為您的反向客戶端 ID 添加 URL 方案。要查找此值，請打開GoogleService-Info.plist配置文件，然後查找REVERSED_CLIENT_ID鍵。複製該鍵的值，並將其粘貼到配置頁面上的URL 方案框中。將其他字段留空。

      完成後，您的配置應類似於以下內容（但使用特定於應用程序的值）：

      

2. 使用提供者 ID github.com創建OAuthProvider的實例。

   迅速

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

   Objective-C

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

3. 可選：指定要隨 OAuth 請求一起發送的其他自定義 OAuth 參數。

   迅速

       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 權限中預配置的範圍完全匹配。

   迅速

       // 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的方式，請創建一個符合FIRAuthUIDelegate協議的自定義類，並將其傳遞給getCredentialWithUIDelegate:completion: 。

6. 使用 OAuth 提供程序對象向 Firebase 進行身份驗證。

   迅速

       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 提供程序鏈接到現有用戶。例如，您可以將多個提供商鏈接到同一個用戶，允許他們使用其中任何一個登錄。

   迅速

       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.accessToken
         // GitHub OAuth ID token can be retrieved by calling:
         // authResult.credential.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:
         // authResult.credential.accessToken
         // GitHub OAuth ID token can be retrieved by calling:
         // authResult.credential.idToken
       }];
       

8. 相同的模式可以與reauthenticateWithCredential一起使用，它可用於檢索需要最近登錄的敏感操作的新憑據。

   迅速

       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.accessToken
         // GitHub OAuth ID token can be retrieved by calling:
         // authResult.credential.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:
         // authResult.credential.accessToken
         // GitHub OAuth ID token can be retrieved by calling:
         // authResult.credential.idToken
       }];
       

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

  

  // 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 項目的一部分存儲，可用於在項目中的每個應用中識別用戶，無論用戶如何登錄。

• 在您的應用程序中，您可以從FIRUser對象獲取用戶的基本個人資料信息。請參閱管理用戶。

• 在您的 Firebase 實時數據庫和雲存儲安全規則中，您可以從auth變量中獲取登錄用戶的唯一用戶 ID，並使用它來控制用戶可以訪問哪些數據。

您可以通過將身份驗證提供程序憑據鏈接到現有用戶帳戶來允許用戶使用多個身份驗證提供程序登錄您的應用程序。

要註銷用戶，請調用signOut: 。

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

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

您可能還想為所有身份驗證錯誤添加錯誤處理代碼。請參閱處理錯誤。