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

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

始める前に

Firebase Authentication を使用するには、次の作業が必要です。

Firebase を使用するように Unity プロジェクトを登録して構成する。
- Unity プロジェクトですでに Firebase を使用している場合、この登録と構成はすでに行われています。
- Unity プロジェクトがない場合は、サンプルアプリをダウンロードできます。
Unity プロジェクトに Firebase Unity SDK（具体的には FirebaseAuth.unitypackage）を追加する。

Firebase を Unity プロジェクトに追加するには、Firebase コンソールと開いている Unity プロジェクトの両方でタスクを行う必要があります（コンソールから Firebase 構成ファイルをダウンロードし、それを Unity プロジェクトに移動するなど）。

`Firebase.Auth.FirebaseAuth` クラスへのアクセス

すべての API 呼び出しは FirebaseAuth クラスを使用して行われます。このクラスには、FirebaseAuth.DefaultInstance を介してアクセスできます。

Firebase.Auth.FirebaseAuth auth = Firebase.Auth.FirebaseAuth.DefaultInstance;

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

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

新しいユーザーがアプリの登録フォームを使用して登録したら、アプリで必要な新しいアカウントの検証手順（新しいアカウントのパスワードが正しく入力されていることや、パスワードの複雑さの要件を満たしていることの確認など）を行います。

新しいユーザーのメールアドレスとパスワードを FirebaseAuth.CreateUserWithEmailAndPassword に渡して、新しいアカウントを作成します。

auth.CreateUserWithEmailAndPasswordAsync(email, password).ContinueWith(task => {
  if (task.IsCanceled) {
    Debug.LogError("CreateUserWithEmailAndPasswordAsync was canceled.");
    return;
  }
  if (task.IsFaulted) {
    Debug.LogError("CreateUserWithEmailAndPasswordAsync encountered an error: " + task.Exception);
    return;
  }

  // Firebase user has been created.
  Firebase.Auth.AuthResult result = task.Result;
  Debug.LogFormat("Firebase user created successfully: {0} ({1})",
      result.User.DisplayName, result.User.UserId);
});

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

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

ユーザーがアプリにログインしたら、そのユーザーのメールアドレスとパスワードを FirebaseAuth.SignInWithEmailAndPassword に渡します。

auth.SignInWithEmailAndPasswordAsync(email, password).ContinueWith(task => {
  if (task.IsCanceled) {
    Debug.LogError("SignInWithEmailAndPasswordAsync was canceled.");
    return;
  }
  if (task.IsFaulted) {
    Debug.LogError("SignInWithEmailAndPasswordAsync 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);
});

また他のワークフローと同様に、認証情報を作成してログインを行うこともできます。

Firebase.Auth.Credential credential =
    Firebase.Auth.EmailAuthProvider.GetCredential(email, password);
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);
});

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

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

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

認証の設定

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

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

次の文字は英数字以外の文字の要件を満たします: ^ $ * . [ ] { } ( ) ? " ! @ # % & / \ , > < ' : ; | _ ~
パスワードの最小文字数（6～30 文字。デフォルトは 6）
パスワードの最大文字数（最大 4,096 文字）

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

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

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

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

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

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

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

次のステップ

ユーザーが初めてログインすると、新しいユーザーアカウントが作成され、ユーザーがログインに使用した認証情報（ユーザー名とパスワード、電話番号、または認証プロバイダ情報）にアカウントがリンクされます。この新しいアカウントは Firebase プロジェクトの一部として保存され、ユーザーのログイン方法にかかわらず、プロジェクトのすべてのアプリでユーザーを識別するために使用できます。

アプリでは、Firebase.Auth.FirebaseUser オブジェクトからユーザーの基本的なプロフィール情報を取得できます。

Firebase.Auth.FirebaseUser user = auth.CurrentUser;
if (user != null) {
  string name = user.DisplayName;
  string email = user.Email;
  System.Uri photo_url = user.PhotoUrl;
  // 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 User.TokenAsync() instead.
  string uid = user.UserId;
}

Firebase Realtime Database と Cloud Storage のセキュリティルールでは、ログイン済みユーザーの一意のユーザー ID を auth 変数から取得し、それを使用して、ユーザーがアクセスできるデータを制御できます。

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

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

auth.SignOut();