使用 Microsoft 和 C++ 進行身份驗證

您可以讓您的用戶使用 Microsoft Azure Active Directory 等 OAuth 提供商通過 Firebase 進行身份驗證,方法是使用 Firebase SDK 將基於 Web 的通用 OAuth 登錄集成到您的應用程序中,以執行端到端的登錄流程。由於此流程需要使用基於手機的 Firebase SDK,因此僅在 Android 和 Apple 平台上受支持。

在你開始之前

  1. 將 Firebase 添加到您的 C++ 項目
  2. Firebase 控制台中,打開Auth部分。
  3. 登錄方法選項卡上,啟用Microsoft提供商。
  4. 將該提供商的開發人員控制台中的客戶端 ID客戶端密碼添加到提供商配置中:
    1. 要註冊 Microsoft OAuth 客戶端,請按照快速入門中的說明進行操作:使用 Azure Active Directory v2.0 終結點註冊應用程序。請注意,此端點支持使用 Microsoft 個人帳戶和 Azure Active Directory 帳戶登錄。了解有關 Azure Active Directory v2.0 的更多信息
    2. 在向這些提供商註冊應用時,請務必將項目的*.firebaseapp.com域註冊為應用的重定向域。
  5. 單擊保存

訪問firebase::auth::Auth

Auth類是所有 API 調用的網關。
  1. 添加 Auth 和 App 頭文件:
    #include "firebase/app.h"
    #include "firebase/auth.h"
    
  2. 在您的初始化代碼中,創建一個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__)
    
  3. 為您的firebase::App獲取firebase::auth::Auth類。 AppAuth之間存在一對一的映射。
    firebase::auth::Auth* auth = firebase::auth::Auth::GetAuth(app);
    

使用 Firebase SDK 處理登錄流程

要使用 Firebase SDK 處理登錄流程,請執行以下步驟:

  1. 構造一個FederatedOAuthProviderData的實例,該實例配置了適用於 Microsoft 的提供商 ID。

    firebase::auth::FederatedOAuthProviderData
        provider_data(firebase::auth::MicrosoftAuthProvider::kProviderId);
    
  2. 可選:指定要與 OAuth 請求一起發送的其他自定義 OAuth 參數。

    // Prompt user to re-authenticate to Microsoft.
    provider_data.custom_parameters["prompt"] = "login";
    
    // Target specific email with login hint.
    provider_data.custom_parameters["login_hint"] =
        "user@firstadd.onmicrosoft.com";
    

    有關 Microsoft 支持的參數,請參閱Microsoft OAuth 文檔。請注意,您不能使用setCustomParameters()傳遞 Firebase 所需的參數。這些參數是client_idresponse_typeredirect_uristatescoperesponse_mode

    要僅允許來自特定 Azure AD 租戶的用戶登錄應用程序,可以使用 Azure AD 租戶的友好域名或租戶的 GUID 標識符。這可以通過在自定義參數對像中指定“租戶”字段來完成。

    // Optional "tenant" parameter in case you are using an Azure AD tenant.
    // eg. '8eaef023-2b34-4da1-9baa-8bc8c9d6a490' or 'contoso.onmicrosoft.com'
    // or "common" for tenant-independent tokens.
    // The default value is "common".
    provider_data.custom_parameters["tenant"] ="TENANT_ID";
    
  3. 可選:指定要從身份驗證提供程序請求的基本配置文件之外的其他 OAuth 2.0 範圍。

    provider_data.scopes.push_back("mail.read");
    provider_data.scopes.push_back("calendars.read");
    

    要了解更多信息,請參閱Microsoft 權限和同意文檔

  4. 配置提供者數據後,使用它來創建FederatedOAuthProvider

    // Construct a FederatedOAuthProvider for use in Auth methods.
    firebase::auth::FederatedOAuthProvider provider(provider_data);
    
  5. 使用 Auth provider 對象通過 Firebase 進行身份驗證。請注意,與其他 FirebaseAuth 操作不同,這將通過彈出一個 Web 視圖來控制您的 UI,用戶可以在其中輸入他們的憑據。

    要啟動登錄流程,請調用SignInWithProvider

    firebase::Future<firebase::auth::AuthResult> result =
      auth->SignInWithProvider(provider_data);
    

    然後,您的應用程序可能會等待或在 Future 上註冊回調

    使用 OAuth 訪問令牌,您可以調用Microsoft Graph API

    與 Firebase Auth 支持的其他提供商不同,Microsoft 不提供照片 URL,而是必須通過Microsoft Graph API請求個人資料照片的二進制數據。

  6. 雖然上述示例側重於登錄流程,但您還可以使用LinkWithProvider將 Microsoft Azure Active Directory 提供程序鏈接到現有用戶。例如,您可以將多個提供商鏈接到同一個用戶,允許他們使用其中任何一個登錄。

    firebase::Future<firebase::auth::AuthResult> result = user.LinkWithProvider(provider_data);
    
  7. 相同的模式可用於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();