C++ でパスワード ベースのアカウントを使用して Firebase 認証を行う

Firebase Authentication を使用することで、ユーザーが Firebase での認証にメールアドレスとパスワードを使用できるようにし、アプリのパスワード ベースのアカウントを管理できます。

始める前に

  1. Firebase を C++ プロジェクトに追加します。
  2. アプリを Firebase プロジェクトに接続していない場合は、Firebase コンソールで接続します。
  3. メールアドレスとパスワードによるログインを有効にします。
    1. Firebase コンソールで [Auth] セクションを開きます。
    2. [ログイン方法] タブで [メール / パスワード] を有効にして、[保存] をクリックします。

firebase::auth::Auth クラスへのアクセス

すべての API 呼び出しは Auth クラスを使用して行われます。
  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 クラスを取得します。App と Auth は、1 対 1 で対応しています。
    firebase::auth::Auth* auth = firebase::auth::Auth::GetAuth(app);

パスワード ベースのアカウントを作成する

パスワードを使用して新しいユーザー アカウントを作成するには、アプリのログインコードで次の手順に沿って操作します。

  1. 新しいユーザーがアプリの登録フォームを使用して登録したら、アプリで必要な新しいアカウントの検証手順（新しいアカウントのパスワードが正しく入力されていることや、パスワードの複雑さの要件を満たしているかの確認など）を行います。
  2. 新しいユーザーのメールアドレスとパスワードを Auth::CreateUserWithEmailAndPassword に渡して、新しいアカウントを作成します。 
    firebase::Future<firebase::auth::AuthResult> result =
    auth->CreateUserWithEmailAndPassword(email, password);
  3. 定期的に（たとえば、毎秒 30 回または 60 回）実行される更新ループがプログラムに含まれている場合、Auth::CreateUserWithEmailAndPasswordLastResult を使用して、更新されるたびに 1 回結果を確認できます。 
    firebase::Future<firebase::auth::AuthResult> result =
    auth->CreateUserWithEmailAndPasswordLastResult();
if (result.status() == firebase::kFutureStatusComplete) {
  if (result.error() == firebase::auth::kAuthErrorNone) {
    const firebase::auth::AuthResult auth_result = *result.result();
    printf("Create user succeeded for email %s\n",
           auth_result.user.email().c_str());
  } else {
    printf("Created user failed with error '%s'\n", result.error_message());
  }
}
    または、プログラムがイベント ドリブンの場合は、Future にコールバックを登録することをおすすめします。

メールアドレスとパスワードを使用してユーザーのログインを行う

パスワードを使用したユーザーのログイン手順は、新しいアカウントの作成手順と似ています。アプリのログイン機能で、次の手順に沿って操作します。

  1. ユーザーがアプリにログインしたら、そのユーザーのメールアドレスとパスワードを firebase::auth::Auth::SignInWithEmailAndPassword に渡します。 
    firebase::Future<firebase::auth::AuthResult> result =
    auth->SignInWithEmailAndPassword(email, password);
  2. 定期的に（たとえば、毎秒 30 回または 60 回）実行される更新ループがプログラムに含まれている場合、Auth::SignInWithEmailAndPasswordLastResult を使用して、更新されるたびに 1 回結果を確認できます。 
    firebase::Future<firebase::auth::AuthResult> result =
    auth->SignInWithEmailAndPasswordLastResult();
if (result.status() == firebase::kFutureStatusComplete) {
  if (result.error() == firebase::auth::kAuthErrorNone) {
    const firebase::auth::AuthResult auth_result = *result.result();
    printf("Sign in succeeded for email %s\n",
           auth_result.user.email().c_str());
  } else {
    printf("Sign in failed with error '%s'\n", result.error_message());
  }
}
    または、プログラムがイベント ドリブンの場合は、Future にコールバックを登録することをおすすめします。

Future にコールバックを登録する

プログラムの中には、毎秒 30 回または 60 回呼び出される Update 関数が含まれるものがあります。たとえば、多くのゲームでこのモデルが使用されています。このようなプログラムでは、LastResult 関数を呼び出して、非同期呼び出しをポーリングできます。ただし、プログラムがイベント ドリブンの場合は、コールバック関数を登録することをおすすめします。コールバック関数は、Future の完了時に呼び出されます。 
void OnCreateCallback(const firebase::Future<firebase::auth::User*>& result,
                      void* user_data) {
  // The callback is called when the Future enters the `complete` state.
  assert(result.status() == firebase::kFutureStatusComplete);

  // Use `user_data` to pass-in program context, if you like.
  MyProgramContext* program_context = static_cast<MyProgramContext*>(user_data);

  // Important to handle both success and failure situations.
  if (result.error() == firebase::auth::kAuthErrorNone) {
    firebase::auth::User* user = *result.result();
    printf("Create user succeeded for email %s\n", user->email().c_str());

    // Perform other actions on User, if you like.
    firebase::auth::User::UserProfile profile;
    profile.display_name = program_context->display_name;
    user->UpdateUserProfile(profile);

  } else {
    printf("Created user failed with error '%s'\n", result.error_message());
  }
}

void CreateUser(firebase::auth::Auth* auth) {
  // Callbacks work the same for any firebase::Future.
  firebase::Future<firebase::auth::AuthResult> result =
      auth->CreateUserWithEmailAndPasswordLastResult();

  // `&my_program_context` is passed verbatim to OnCreateCallback().
  result.OnCompletion(OnCreateCallback, &my_program_context);
}
コールバック関数にラムダを使用することもできます。
void CreateUserUsingLambda(firebase::auth::Auth* auth) {
  // Callbacks work the same for any firebase::Future.
  firebase::Future<firebase::auth::AuthResult> result =
      auth->CreateUserWithEmailAndPasswordLastResult();

  // The lambda has the same signature as the callback function.
  result.OnCompletion(
      [](const firebase::Future<firebase::auth::User*>& result,
         void* user_data) {
        // `user_data` is the same as &my_program_context, below.
        // Note that we can't capture this value in the [] because std::function
        // is not supported by our minimum compiler spec (which is pre C++11).
        MyProgramContext* program_context =
            static_cast<MyProgramContext*>(user_data);

        // Process create user result...
        (void)program_context;
      },
      &my_program_context);
}

推奨: パスワード ポリシーを設定する

パスワードの複雑さの要件を適用することで、アカウントのセキュリティを強化できます。

プロジェクトのパスワード ポリシーを構成するには、Firebase コンソールの [認証設定] ページで [パスワード ポリシー] タブを開きます。

認証の設定

Firebase Authentication パスワード ポリシーは、次のパスワード要件をサポートしています。

  • 小文字は必須です

  • 大文字は必須です

  • 数字は必須です

  • 英数字以外の文字は必須です

    次の文字は英数字以外の文字の要件を満たします。 ^ $ * . [ ] { } ( ) ? " ! @ # % & / \ , > < ' : ; | _ ~

  • パスワードの最小文字数（6～30 文字。デフォルトは 6）

  • パスワードの最大文字数（最大 4,096 文字）

パスワード ポリシーの適用は、次の 2 つのモードで有効にできます。

  • 必須: ユーザーがポリシーに準拠したパスワードに更新するまで、ログインの試行は失敗します。

  • 通知: ユーザーは準拠していないパスワードを使用してログインできます。このモードを使用する場合は、ユーザーのパスワードがクライアント側でポリシーに準拠しているかどうかを確認し、準拠していない場合はパスワードを更新するようユーザーになんらかの方法で促す必要があります。

新規ユーザーは、常にポリシーに準拠したパスワードを選択する必要があります。

アクティブ ユーザーがいる場合は、パスワードがポリシーに準拠していないユーザーへのアクセスをブロックする場合を除き、ログイン時の強制アップグレードを有効にしないことをおすすめします。代わりに、通知モードを使用します。これにより、ユーザーに現在のパスワードでログインさせて、現在のパスワードに欠けている要件を通知することができます。

推奨: メール列挙保護を有効にする

メールアドレスをパラメータとして受け取る Firebase Authentication メソッドの中には、メールアドレスが登録されている必要がある処理（たとえばメールアドレスとパスワードを使用してログインするなど）においてメールアドレスが未登録である場合、またはメールアドレスが未使用であることが必要な処理（たとえばユーザーのメールアドレスを変更するなど）においてメールアドレスが登録済みである場合に、特定のエラーをスローするものがあります。これは、ユーザーに具体的な解決策を提示するのに役立つ一方で、ユーザーが登録したメールアドレスを検出するために悪意のあるアクターによって悪用される可能性もあります。

このリスクを軽減するため、Google Cloud の gcloud ツールを使用して、プロジェクトでメール列挙保護を有効にすることをおすすめします。この機能を有効にすると Firebase Authentication のエラーレポートの動作が変わるため、アプリが具体的なエラーに依存しないように注意してください。

次のステップ

ユーザーが初めてログインすると、新しいユーザー アカウントが作成され、ユーザーがログイン時に使用した認証情報（ユーザー名とパスワード、電話番号、または認証プロバイダ情報）にアカウントがリンクされます。この新しいアカウントは 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 のセキュリティ ルールでは、ログイン済みユーザーの一意のユーザー ID を auth 変数から取得し、それを使用して、ユーザーがアクセスできるデータを制御できます。

既存のユーザー アカウントに認証プロバイダの認証情報をリンクすることで、ユーザーは複数の認証プロバイダを使用してアプリにログインできるようになります。

ユーザーのログアウトを行うには、SignOut() を呼び出します。

auth->SignOut();