您可以使用 Firebase SDK 將基於 Web 的通用 OAuth 登錄集成到您的應用程序中,以執行端到端登錄流程,從而讓您的用戶使用 Yahoo 等 OAuth 提供商通過 Firebase 進行身份驗證。由於此流程需要使用基於手機的 Firebase SDK,因此僅在 Android 和 Apple 平台上受支持。
在你開始之前
- 將 Firebase 添加到您的 C++ 項目。
- 在Firebase 控制台中,打開Auth部分。
- 在登錄方法選項卡上,啟用Yahoo提供商。
- 將該提供商的開發人員控制台中的客戶端 ID和客戶端密碼添加到提供商配置中:
要註冊 Yahoo OAuth 客戶端,請按照 Yahoo 開發人員文檔在Yahoo 註冊 Web 應用程序進行操作。
請務必選擇兩個 OpenID Connect API 權限:
profile
和email
。- 在向這些提供商註冊應用時,請務必將項目的
*.firebaseapp.com
域註冊為應用的重定向域。
- 單擊保存。
訪問firebase::auth::Auth
類
Auth
類是所有 API 調用的網關。- 添加 Auth 和 App 頭文件:
#include "firebase/app.h" #include "firebase/auth.h"
- 在您的初始化代碼中,創建一個
firebase::App
類。#if defined(__ANDROID__) firebase::App* app = firebase::App::Create(firebase::AppOptions(), my_jni_env, my_activity); #else firebase::App* app = firebase::App::Create(firebase::AppOptions()); #endif // defined(__ANDROID__)
- 為您的
firebase::App
獲取firebase::auth::Auth
類。App
和Auth
之間存在一對一的映射。firebase::auth::Auth* auth = firebase::auth::Auth::GetAuth(app);
使用 Firebase SDK 處理登錄流程
要使用 Firebase SDK 處理登錄流程,請執行以下步驟:
構造一個
FederatedOAuthProviderData
的實例,該實例配置了適用於 Yahoo 的提供商 ID。firebase::auth::FederatedOAuthProviderData provider_data(firebase::auth::YahooAuthProvider::kProviderId);
可選:指定要與 OAuth 請求一起發送的其他自定義 OAuth 參數。
// Prompt user to re-authenticate to Yahoo. provider_data.custom_parameters["prompt"] = "login"; // Localize to French. provider_data.custom_parameters["language"] = "fr";
有關 Yahoo 支持的參數,請參閱Yahoo OAuth 文檔。請注意,您不能使用
custom_parameters()
傳遞 Firebase 所需的參數。這些參數是client_id 、 redirect_uri 、 response_type 、 scope和state 。可選:指定您希望從身份驗證提供程序請求的
profile
和email
之外的其他 OAuth 2.0 範圍。如果您的應用程序需要從 Yahoo API 訪問私人用戶數據,您需要在 Yahoo 開發人員控制台的API 權限下請求對 Yahoo API 的權限。請求的 OAuth 範圍必須與應用程序 API 權限中的預配置範圍完全匹配。例如,如果向用戶聯繫人請求讀/寫訪問權限並在應用程序的 API 權限中進行預配置,則必須傳遞sdct-w
而不是只讀 OAuth 範圍sdct-r
。否則,流程將失敗並向最終用戶顯示錯誤。// Request access to Yahoo Mail API. provider_data.scopes.push_back("mail-r"); // This must be preconfigured in the app's API permissions. provider_data.scopes.push_back("sdct-w");
要了解更多信息,請參閱Yahoo scopes 文檔。
配置提供者數據後,使用它來創建 FederatedOAuthProvider。
// Construct a FederatedOAuthProvider for use in Auth methods. firebase::auth::FederatedOAuthProvider provider(provider_data);
使用 Auth provider 對象通過 Firebase 進行身份驗證。請注意,與其他 FirebaseAuth 操作不同,這將通過彈出一個 Web 視圖來控制您的 UI,用戶可以在其中輸入他們的憑據。
要啟動登錄流程,請調用
SignInWithProvider
:firebase::Future<firebase::auth::AuthResult> result = auth->SignInWithProvider(provider_data);
然後,您的應用程序可能會等待或在 Future 上註冊回調。
雖然上述示例側重於登錄流程,但您也可以使用
LinkWithProvider
將 Yahoo 提供商鏈接到現有用戶。例如,您可以將多個提供商鏈接到同一個用戶,允許他們使用其中任何一個登錄。firebase::Future<firebase::auth::AuthResult> result = user.LinkWithProvider(provider_data);
相同的模式可用於
ReauthenticateWithProvider
,可用於為需要最近登錄的敏感操作檢索新憑據。firebase::Future<firebase::auth::AuthResult> result = user.ReauthenticateWithProvider(provider_data);
然後,您的應用程序可能會等待或在 Future 上註冊回調。
下一步
用戶首次登錄後,將創建一個新的用戶帳戶並將其鏈接到用戶登錄所用的憑據,即用戶名和密碼、電話號碼或身份驗證提供商信息。這個新帳戶存儲為您的 Firebase 項目的一部分,可用於在項目中的每個應用程序中識別用戶,無論用戶如何登錄。
在您的應用中,您可以從
firebase::auth::User
對象獲取用戶的基本個人資料信息:firebase::auth::User user = auth->current_user(); if (user.is_valid()) { std::string name = user.display_name(); std::string email = user.email(); std::string photo_url = user.photo_url(); // The user's ID, unique to the Firebase project. // Do NOT use this value to authenticate with your backend server, // if you have one. Use firebase::auth::User::Token() instead. std::string uid = user.uid(); }
在您的 Firebase Realtime Database 和 Cloud Storage Security Rules中,您可以從
auth
變量中獲取登錄用戶的唯一用戶 ID,並使用它來控制用戶可以訪問的數據。
您可以允許用戶使用多個身份驗證提供程序登錄您的應用程序,方法是將身份驗證提供程序憑據鏈接到現有用戶帳戶。
要註銷用戶,請調用SignOut()
:
auth->SignOut();