使用 Apple 和 Unity 進行身份驗證

您可以使用 Firebase SDK 執行端對端 OAuth 2.0 登入流程,讓使用者使用其 Apple ID 透過 Firebase 進行身份驗證。

在你開始之前

若要使用 Apple 登入用戶,請先在 Apple 開發者網站上設定 Sign In with Apple,然後啟用 Apple 作為 Firebase 專案的登入提供者。

加入蘋果開發者計劃

「使用 Apple 登入」只能由Apple 開發者計畫的成員進行設定。

配置使用 Apple 登入

必須在您的 Firebase 專案中啟用並正確配置 Apple Sign In。 Apple Developer 配置因 Android 和 Apple 平台而異。請先依照iOS+和/或Android指南的「設定使用 Apple 登入」部分進行操作,然後再繼續。

啟用 Apple 作為登入供應商

  1. Firebase 控制台中,開啟「驗證」部分。在「登入方法」標籤上,啟用Apple提供者。
  2. 配置 Apple 登入提供者設定:
    1. 如果您僅在 Apple 平台上部署應用程序,則可以將服務 ID、Apple 團隊 ID、私鑰和金鑰 ID 欄位留空。
    2. 對於 Android 裝置的支援:
      1. 將 Firebase 新增到您的 Android 專案。在 Firebase 控制台中設定應用程式時,請務必註冊應用程式的 SHA-1 簽章。
      2. Firebase 控制台中,開啟「驗證」部分。在「登入方法」標籤上,啟用Apple提供者。指定您在上一部分中建立的服務 ID。此外,在 OAuth 程式碼流配置部分中,指定您的 Apple 團隊 ID 以及您在上一部分中建立的私鑰和金鑰 ID。

遵守 Apple 匿名資料要求

「使用 Apple 登入」為使用者提供了在登入時對其資料(包括電子郵件地址)進行匿名化的選項。選擇此選項的使用者的電子郵件地址的網域為privaterelay.appleid.com 。當您在應用程式中使用「透過 Apple 登入」時,您必須遵守 Apple 關於這些匿名 Apple ID 的任何適用的開發者政策或條款。

這包括在將任何直接識別個人資訊與匿名 Apple ID 關聯之前獲得任何所需的用戶同意。使用 Firebase 身份驗證時,這可能包括以下操作:

  • 將電子郵件地址連結到匿名 Apple ID,反之亦然。
  • 將電話號碼連結到匿名 Apple ID,反之亦然
  • 將非匿名社交憑證(Facebook、Google 等)連結到匿名 Apple ID,反之亦然。

上述列表並非詳盡無遺。請參閱開發者帳戶的「會員資格」部分中的 Apple 開發者計畫許可協議,以確保您的應用程式符合 Apple 的要求。

存取Firebase.Auth.FirebaseAuth

FirebaseAuth類別是所有 API 呼叫的網關。它可以透過FirebaseAuth.DefaultInstance存取。
Firebase.Auth.FirebaseAuth auth = Firebase.Auth.FirebaseAuth.DefaultInstance;

使用 Firebase SDK 處理登入流程

登入 Apple 的過程因 Apple 和 Android 平台而異。

在蘋果平台上

  1. 安裝第三方外掛程式來處理 Apple 登入隨機數和令牌生成,例如Unity 的 Sign In With Apple Asset Storage Package 。您可能需要變更程式碼,以在原始字串狀態下偵測產生的隨機數字串,以便在 Firebase 作業中使用(即,在建立隨機數的 SHA256 摘要形式之前儲存其副本)。

  2. 使用產生的令牌字串和原始隨機數建立 Firebase 憑證並登入 Firebase。

    Firebase.Auth.Credential credential =
        Firebase.Auth.OAuthProvider.GetCredential("apple.com", appleIdToken, rawNonce, null);
    auth.SignInAndRetrieveDataWithCredentialAsync(credential).ContinueWith(task => {
      if (task.IsCanceled) {
        Debug.LogError("SignInAndRetrieveDataWithCredentialAsync was canceled.");
        return;
      }
      if (task.IsFaulted) {
        Debug.LogError("SignInAndRetrieveDataWithCredentialAsync encountered an error: " + task.Exception);
        return;
      }
    
      Firebase.Auth.AuthResult result = task.Result;
      Debug.LogFormat("User signed in successfully: {0} ({1})",
          result.User.DisplayName, result.User.UserId);
    });
    

  3. 相同的模式可用於ReauthenticateAsync ,它可用於檢索需要最近登入的敏感操作的新憑證。有關詳細信息,請參閱管理用戶

  4. 在 Apple 平台上連結 Apple Sign In 時,您可能會遇到錯誤,提示現有 Firebase 帳戶已連結至 Apple 帳戶。發生這種情況時,將拋出Firebase.Auth.FirebaseAccountLinkException而不是標準的Firebase.FirebaseException 。在這種情況下,異常包括UserInfo.UpdatedCredential屬性,如果有效,則可用於透過FirebaseAuth.SignInAndRetrieveDataWithCredentialAsync登入 Apple 連結的使用者。更新後的憑證無需為登入操作產生帶有隨機數的新 Apple 登入令牌。

    auth.CurrentUser.LinkWithCredentialAsync(
      Firebase.Auth.OAuthProvider.GetCredential("apple.com", idToken, rawNonce, null))
        .ContinueWithOnMainThread( task => {
          if (task.IsCompletedSuccessfully) {
            // Link Success
          } else {
            if (task.Exception != null) {
              foreach (Exception exception in task.Exception.Flatten().InnerExceptions) {
                Firebase.Auth.FirebaseAccountLinkException firebaseEx =
                  exception as Firebase.Auth.FirebaseAccountLinkException;
                if (firebaseEx != null && firebaseEx.UserInfo.UpdatedCredential.IsValid()) {
                  // Attempt to sign in with the updated credential.
                  auth.SignInAndRetrieveDataWithCredentialAsync(firebaseEx.UserInfo.UpdatedCredential).
                    ContinueWithOnMainThread( authResultTask => {
                      // Handle Auth result.
                    });
                } else {
                  Debug.Log("Link with Apple failed:" + firebaseEx );
                }
              } // end for loop
            }
          }
        });
    

在安卓上

在 Android 上,使用 Firebase SDK 將基於 Web 的通用 OAuth 登入整合到您的應用程式中,以執行端對端登入流程,從而透過 Firebase 對您的使用者進行身份驗證。

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

  1. 建構一個FederatedOAuthProviderData實例,並配置適合 Apple 的提供者 ID。

    Firebase.Auth.FederatedOAuthProviderData providerData =
      new Firebase.Auth.FederatedOAuthProviderData();
    
    providerData.ProviderId = "apple.com";
    
  2. 選用:指定您想要從身分驗證提供者要求的預設範圍之外的其他 OAuth 2.0 範圍。

    providerData.Scopes = new List<string>();
    providerData.Scopes.Add("email");
    providerData.Scopes.Add("name");
    
  3. 可選:如果您想以英語以外的語言顯示 Apple 的登入螢幕,請設定locale參數。請參閱「使用 Apple 登入」文件以了解支援的區域設定。

    providerData.CustomParameters = new Dictionary<string,string>;
    
    // Localize to French.
    providerData.CustomParameters.Add("language", "fr");
    
  4. 配置提供者資料後,使用它來建立 FederatedOAuthProvider。

    // Construct a FederatedOAuthProvider for use in Auth methods.
    Firebase.Auth.FederatedOAuthProvider provider =
      new Firebase.Auth.FederatedOAuthProvider();
    provider.SetProviderData(providerData);
    
  5. 使用身份驗證提供者物件透過 Firebase 進行身份驗證。請注意,與其他 FirebaseAuth 操作不同,這將透過彈出一個 Web 視圖(使用者可以在其中輸入其憑證)來控制您的 UI。

    若要啟動登入流程,請呼叫signInWithProvider

    auth.SignInWithProviderAsync(provider).ContinueOnMainThread(task => {
        if (task.IsCanceled) {
            Debug.LogError("SignInWithProviderAsync was canceled.");
            return;
        }
        if (task.IsFaulted) {
            Debug.LogError("SignInWithProviderAsync encountered an error: " +
              task.Exception);
            return;
        }
    
        Firebase.Auth.AuthResult authResult = task.Result;
        Firebase.Auth.FirebaseUser user = authResult.User;
        Debug.LogFormat("User signed in successfully: {0} ({1})",
            user.DisplayName, user.UserId);
    });
    
  6. 相同的模式可以與ReauthenticateWithProvider一起使用,它可用於檢索需要最近登入的敏感操作的新憑證。

    user.ReauthenticateWithProviderAsync(provider).ContinueOnMainThread(task => {
        if (task.IsCanceled) {
            Debug.LogError("ReauthenticateWithProviderAsync was canceled.");
            return;
        }
        if (task.IsFaulted) {
            Debug.LogError(
            "ReauthenticateWithProviderAsync encountered an error: " +
                task.Exception);
            return;
        }
    
        Firebase.Auth.AuthResult authResult = task.Result;
        Firebase.Auth.FirebaseUser user = authResult.User;
        Debug.LogFormat("User reauthenticated successfully: {0} ({1})",
            user.DisplayName, user.UserId);
    });
    
  7. 而且,您可以使用LinkWithCredentialAsync()將不同的身分提供者連結到現有帳戶。

    請注意,Apple 要求您在將用戶的 Apple 帳戶連結到其他資料之前獲得用戶的明確同意。

    例如,要將 Facebook 帳戶連結到目前 Firebase 帳戶,請使用使用者登入 Facebook 時獲得的存取權杖:

    // Initialize a Facebook credential with a Facebook access token.
    
    Firebase.Auth.Credential credential =
        Firebase.Auth.FacebookAuthProvider.GetCredential(facebook_token);
    
    // Assuming the current user is an Apple user linking a Facebook provider.
    user.LinkWithCredentialAsync(credential)
        .ContinueWithOnMainThread( task => {
          if (task.IsCanceled) {
              Debug.LogError("LinkWithCredentialAsync was canceled.");
              return;
          }
          if (task.IsFaulted) {
            Debug.LogError("LinkWithCredentialAsync encountered an error: "
                           + task.Exception);
              return;
          }
    
          Firebase.Auth.AuthResult result = task.Result;
          Firebase.Auth.FirebaseUser user = result.User;
          Debug.LogFormat("User linked successfully: {0} ({1})",
              user.DisplayName, user.UserId);
        });
    

使用 Apple Notes 登入

與 Firebase Auth 支援的其他提供者不同,Apple 不提供照片 URL。

此外,當使用者選擇不與應用程式分享其電子郵件時,Apple 會為該使用者提供一個獨特的電子郵件地址(格式為xyz@privaterelay.appleid.com ),並與您的應用程式共用。如果您設定了私人電子郵件轉發服務,Apple 會將發送到匿名地址的電子郵件轉發到使用者的真實電子郵件地址。

Apple 僅在使用者首次登入時與應用程式共用使用者訊息,例如顯示名稱。通常,Firebase 會在使用者首次登入 Apple 時儲存顯示名稱,您可以透過auth.CurrentUser.DisplayName取得該顯示名稱。但是,如果您之前使用 Apple 將使用者登入應用程式而不使用 Firebase,則 Apple 不會向 Firebase 提供使用者的顯示名稱。

下一步

使用者首次登入後,系統會建立新的使用者帳戶,並將其連結到使用者登入時所使用的憑證(即使用者名稱和密碼、電話號碼或驗證提供者資訊)。此新帳戶將作為 Firebase 專案的一部分存儲,並且可用於識別專案中每個應用程式中的用戶,無論用戶如何登入。

在您的應用程式中,您可以從 Firebase.Auth.FirebaseUser 物件取得使用者的基本個人資料資訊。請參閱管理用戶

在 Firebase 即時資料庫和雲端儲存安全性規則中,您可以從 auth 變數取得登入使用者的唯一使用者 ID,並使用它來控制使用者可以存取哪些資料。