使用 Microsoft 和 C++ 進行驗證

您可以使用 Firebase SDK 將網頁式一般 OAuth 登入整合至您的應用程式,讓使用者透過 OAuth 供應商 (例如 Microsoft Azure Active Directory) 驗證 Firebase,以執行端對端登入流程。由於這個流程需要使用手機式 Firebase SDK,因此只有 Android 和 Apple 平台支援這個 SDK。

事前準備

  1. 將 Firebase 新增至您的 C++ 專案
  2. Firebase 控制台開啟「驗證」專區。
  3. 在「Sign in method」分頁中,啟用「Microsoft」供應商。
  4. 從供應商的 Play 管理中心,新增「用戶端 ID」和「用戶端密鑰」到供應商設定:
    1. 如要註冊 Microsoft OAuth 用戶端,請按照 快速入門導覽課程:使用 Azure Active Directory v2.0 端點註冊應用程式。請注意,這個端點支援使用 Microsoft 個人帳戶和 Azure Active Directory 帳戶登入。 進一步瞭解 Azure Active Directory 2.0 版。
    2. 向這些供應商註冊應用程式時,請務必為專案的 *.firebaseapp.com 網域註冊應用程式的重新導向網域。
  5. 點選「Save」

存取 firebase::auth::Auth 類別

Auth 類別是所有 API 呼叫的閘道,
  1. 新增 Auth 和應用程式標頭檔案:
    #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::Appfirebase::auth::Auth 類別。AppAuth 之間有一對一的對應關係。
    firebase::auth::Auth* auth = firebase::auth::Auth::GetAuth(app);
    

使用 Firebase SDK 處理登入流程

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

  1. 使用適合 Microsoft 的提供者 ID 設定的 FederatedOAuthProviderData 執行個體。

    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 ID。方法是在自訂參數物件中指定「用戶群」欄位。

    // 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. 使用驗證提供者物件進行 Firebase 驗證。請注意,與其他 FirebaseAuth 作業不同,這會彈出網路檢視畫面,讓使用者輸入憑證來控制 UI。

    如要啟動登入流程,請呼叫 SignInWithProvider

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

    接著,應用程式可以等待或 在 Future 上註冊回呼

    使用 OAuth 存取權杖,您可以呼叫 Microsoft Graph API

    不同於 Firebase 驗證支援的其他供應商,Microsoft 不提供相片網址,而是必須透過 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 即時資料庫和 Cloud Storage 安全性規則中,您可以透過 auth 變數取得登入使用者的專屬 ID,並使用該 ID 控管使用者可存取哪些資料。

您可以將驗證供應商憑證連結至現有的使用者帳戶,讓使用者透過多個驗證服務提供者登入您的應用程式。

如要登出使用者,請呼叫 SignOut()

auth->SignOut();