通過使用 Firebase SDK 執行端到端 OAuth 2.0 登錄流程,您可以讓您的用戶使用他們的 Apple ID 通過 Firebase 進行身份驗證。
在你開始之前
要使用 Apple 登錄用戶,首先在 Apple 的開發者網站上配置使用 Apple 登錄,然後啟用 Apple 作為您的 Firebase 項目的登錄提供商。
加入蘋果開發者計劃
Sign In with Apple 只能由Apple Developer Program的成員配置。
配置使用 Apple 登錄
必須在您的 Firebase 項目中啟用並正確配置 Apple Sign In。 Apple Developer 配置因 Android 和 Apple 平台而異。在繼續之前,請按照iOS+和/或Android指南的“使用 Apple 配置登錄”部分進行操作。啟用 Apple 作為登錄提供商
- 在Firebase 控制台中,打開Auth部分。在登錄方法選項卡上,啟用Apple提供商。
- 配置 Apple 登錄提供商設置:
- 如果您僅在 Apple 平台上部署您的應用程序,您可以將服務 ID、Apple 團隊 ID、私鑰和密鑰 ID 字段留空。
- 對於 Android 設備的支持:
- 將 Firebase 添加到您的 Android 項目。當您在 Firebase 控制台中設置您的應用時,請務必註冊您應用的 SHA-1 簽名。
- 在Firebase 控制台中,打開Auth部分。在登錄方法選項卡上,啟用Apple提供商。指定您在上一節中創建的服務 ID。此外,在 OAuth 代碼流配置部分,指定您的 Apple Team ID 以及您在上一節中創建的私鑰和密鑰 ID。
符合 Apple 匿名數據要求
Sign In with Apple 為用戶提供了在登錄時匿名化他們的數據的選項,包括他們的電子郵件地址。選擇此選項的用戶擁有域為privaterelay.appleid.com
的電子郵件地址。當您在您的應用程序中使用 Sign In with 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 處理登錄流程
Sign-in With Apple 的流程因 Apple 和 Android 平台而異。
在蘋果平台上
安裝第三方插件來處理 Apple 登錄 nonce 和令牌生成,例如Unity 的 Sign In With Apple Asset Storage Package 。您可能需要更改代碼以檢測原始字符串狀態下生成的隨機隨機數字符串,以便在 Firebase 操作中使用(即,在創建隨機數的 SHA256 摘要形式之前存儲它的副本)。
使用生成的令牌字符串和原始隨機數構建 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); });
相同的模式可用於
ReauthenticateAsync
,它可用於為需要最近登錄的敏感操作檢索新憑據。有關詳細信息,請參閱管理用戶。在 Apple 平台上鍊接 Apple Sign In 時,您可能會遇到一個錯誤,指出現有的 Firebase 帳戶已經鏈接到 Apple 帳戶。發生這種情況時,將拋出
Firebase.Auth.FirebaseAccountLinkException
而不是標準的Firebase.FirebaseException
。在這種情況下,AuthResult.AdditionalInfo
包含一個UserInfo.UpdatedCredential
屬性,如果有效,該屬性可用於通過FirebaseAuth.SignInAndRetrieveDataWithCredentialAsync
登錄 Apple 鏈接的用戶。更新後的憑據避免了為登錄操作生成帶有隨機數的新 Apple 登錄令牌的需要。auth.CurrentUser.LinkWithCredentialAsync( Firebase.Auth.OAuthProvider.GetCredential("apple.com", idToken, rawNonce, null)) .ContinueWithOnMainThread( task => { if (task.IsCompleted) { // 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 && task.Result.AdditionalUserInfo.UpdatedCredential.IsValid()) { // Attempt to sign in with the updated credential. auth.SignInAndRetrieveDataWithCredentialAsync(task.Result.AdditionalUserInfo.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 處理登錄流程,請執行以下步驟:
構造一個
FederatedOAuthProviderData
的實例,該實例配置了適用於 Apple 的提供商 ID。Firebase.Auth.FederatedOAuthProviderData providerData = new Firebase.Auth.FederatedOAuthProviderData(); providerData.ProviderId = "apple.com";
可選:指定超出您希望從身份驗證提供程序請求的默認範圍的其他 OAuth 2.0 範圍。
providerData.Scopes = new List<string>(); providerData.Scopes.Add("email"); providerData.Scopes.Add("name");
可選:如果要以英語以外的語言顯示 Apple 的登錄屏幕,請設置
locale
參數。有關支持的語言環境,請參閱使用 Apple 文檔登錄。providerData.CustomParameters = new Dictionary<string,string>; // Localize to French. providerData.CustomParameters.Add("language", "fr");
配置提供者數據後,使用它來創建 FederatedOAuthProvider。
// Construct a FederatedOAuthProvider for use in Auth methods. Firebase.Auth.FederatedOAuthProvider provider = new Firebase.Auth.FederatedOAuthProvider(); provider.SetProviderData(providerData);
使用 Auth provider 對象通過 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); });
相同的模式可用於
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); });
而且,您可以使用
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 筆記登錄
與 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,並使用它來控制用戶可以訪問的數據。