在 iOS 上使用 GitHub 進行身份驗證

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

在你開始之前

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

  1. 添加火力地堡到iOS項目

  2. 包括在你的下面的吊艙Podfile

    pod 'Firebase/Auth'
    
  3. 火力地堡控制台,打開驗證部分。
  4. 登錄方法選項卡,選中GitHub的供應商。
  5. 添加來自供應商的開發者控制台提供者配置的客戶端ID客戶端密鑰
    1. 註冊您的應用程序作為在GitHub上開發的應用程序,讓你的應用程序的OAuth 2.0客戶端ID客戶端密鑰
    2. 確保你的火力地堡的OAuth重定向URI(my-app-12345.firebaseapp.com/__/auth/handler )設置為你的應用程序的設置頁面的授權回調網址,您的GitHub上的應用程序的配置
  6. 單擊保存

使用 Firebase SDK 處理登錄流程

要使用 Firebase iOS SDK 處理登錄流程,請按以下步驟操作:

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

    1. 打開您的項目配置:雙擊左側樹視圖中的項目名稱。從選擇目標部分的應用程序,然後選擇信息選項卡,並展開URL類型部分。
    2. 點擊+按鈕,添加一個網址方案,為您的反向客戶端ID。為了找到這個值,打開GoogleService-Info.plist的配置文件,並查找REVERSED_CLIENT_ID關鍵。複製鍵的值,並將它粘貼到URL方案的配置頁面框。將其他字段留空。

      完成後,您的配置應類似於以下內容(但具有特定於應用程序的值):

  2. 創建使用提供商ID github.comOAuthProvider的實例。

    迅速

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

    目標-C

        FIROAuthProvider *provider = [FIROAuthProvider providerWithProviderID:@"github.com"];
        
  3. 可選:指定其他定制的OAuth參數要使用OAuth發送請求。

    迅速

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

    目標-C

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

    對於GitHub的支持參數,請參見GitHub的OAuth的文檔。請注意,您不能通過火力地堡要求的參數與setCustomParameters 。這些參數是CLIENT_ID,REDIRECT_URI,RESPONSE_TYPE,範圍狀態

  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"]
        

    目標-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. 可選:如果您想自定義您的應用程序的呈現方式SFSafariViewControllerUIWebView顯示的驗證碼給用戶時,創建一個自定義類,符合的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
            }
          }
        }
        

    目標-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
        }
        

    目標-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
        }
        

    目標-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
        }];
        

下一步

用戶首次登錄後,將創建一個新用戶帳戶並將其鏈接到用戶登錄時使用的憑據(即用戶名和密碼、電話號碼或身份驗證提供商信息)。這個新帳戶作為 Firebase 項目的一部分存儲,可用於識別項目中每個應用中的用戶,無論用戶如何登錄。

  • 在您的應用程序,你可以從用戶的基本資料信息FIRUser對象。請參閱管理用戶

  • 在你的火力地堡實時數據庫和雲存儲安全規則,你可以得到簽署的,從用戶的唯一的用戶ID auth的變量,並用它來控制哪些數據的用戶可以訪問。

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

要註銷用戶,請撥打signOut:

迅速

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

目標-C

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

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