Yahoo と Unity を使用して認証する

Firebase SDK を使用してウェブベースの汎用 OAuth ログインをアプリに統合し、エンドツーエンドのログインフローを実行することで、ユーザーが Firebase での認証に Yahoo などの OAuth プロバイダを使用できるようになります。このフローでは、スマートフォンベースの Firebase SDK を使用する必要があるため、Android プラットフォームと Apple プラットフォームでのみサポートされます。

始める前に

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;

Firebase SDK を使用したログインフローの処理

Firebase SDK でログインフローを処理する手順は次のとおりです。

Yahoo に適したプロバイダ ID で構成された FederatedOAuthProviderData のインスタンスを作成します。

Firebase.Auth.FederatedOAuthProviderData providerData =
  new Firebase.Auth.FederatedOAuthProviderData();
providerData.ProviderId = Firebase.Auth.YahooAuthProvider.ProviderId;

省略可: OAuth リクエストと一緒に送信したい追加のカスタム OAuth パラメータを指定します。
```
providerData.CustomParameters = new Dictionary<string,string>;

// Prompt user to re-authenticate to Yahoo.
providerData.CustomParameters.Add("prompt", "login");

// Localize to French.
providerData.CustomParameters.Add("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 Permissions] で、Yahoo API に権限をリクエストする必要があります。リクエストされた OAuth スコープは、アプリの API 権限で事前構成されたものと完全一致する必要があります。たとえば、読み取り / 書き込みアクセスがユーザーの連絡先にリクエストされ、それがアプリの API 権限で事前構成されている場合は、読み取り専用の OAuth スコープ sdct-r の代わりに sdct-w を渡す必要があります。渡さないと、フローは失敗し、エンドユーザーにエラーが表示されます。
```
providerData.Scopes = new List<string>();

// Request access to Yahoo Mail API.
providerData.Scopes.Add("mail-r");
// This must be preconfigured in the app's API permissions.
providerData.Scopes.Add("sdct-w");
```
詳しくは、Yahoo のスコープに関するドキュメントをご覧ください。

プロバイダのデータを設定したら、それを使用して FederatedOAuthProvider を作成します。

// Construct a FederatedOAuthProvider for use in Auth methods.
Firebase.Auth.FederatedOAuthProvider provider =
    new Firebase.Auth.FederatedOAuthProvider();
provider.SetProviderData(providerData);

Auth プロバイダオブジェクトを使用して Firebase での認証を行います。こうすると、他の FirebaseAuth オペレーションとは異なり、ユーザーが認証情報を入力できるウェブビューをポップアップ表示して UI を制御することになります。

ログインフローを開始するには、SignInAndRetrieveDataWithCredentialAsync を呼び出します。

<<../_includes/_sign_in_with_provider_unity.md>>>

上記の例ではログインフローを中心に説明していますが、LinkWithProviderAsync を使用して Yahoo プロバイダを既存のユーザーにリンクすることもできます。たとえば、複数のプロバイダを同じユーザーにリンクして、どれでもログインを可能にできます。

user.LinkWithProviderAsync(provider).ContinueOnMainThread(task => {
    if (task.IsCanceled) {
        Debug.LogError("LinkWithProviderAsync was canceled.");
        return;
    }
    if (task.IsFaulted) {
        Debug.LogError("LinkWithProviderAsync encountered an error: "
          + task.Exception);
        return;
    }

    Firebase.Auth.AuthResult authResult = task.Result;
    Firebase.Auth.FirebaseUser user = authResult.User;
    Debug.LogFormat("User linked successfully: {0} ({1})",
        user.DisplayName, user.UserId);
});

同じパターンを ReauthenticateWithProviderAsync でも使用できます。これは、ログインしてから短時間のうちに行うべき機密性の高い操作のために、最新の認証情報を取得するのに使われます。

user.ReauthenticateWithProviderAsync(provider).ContinueOnMainThread(task => {
    if (task.IsCanceled) {
        Debug.LogError("ReauthenticateWithProviderAsync was canceled.");
        return;
    }
    if (task.IsFaulted) {
        Debug.LogError(
        "ReauthenticateWithProviderAsync encountered an error: " +
            task.Exception);
        return;
    }

    Firebase.Auth.AuthResult authResult = task.Result;
    Firebase.Auth.FirebaseUser user = authResult.User;
    Debug.LogFormat("User reauthenticated successfully: {0} ({1})",
        user.DisplayName, user.UserId);
});

Firebase でサポートされている他の OAuth プロバイダ（Google、Facebook、Twitter など）では OAuth アクセストークンに基づいた認証情報を使用して直接ログインできますが、Yahoo などのプロバイダでは Firebase Auth が同様の機能をサポートしていません。これは Yahoo OAuth アクセストークンの対象デバイスを検証するのに Firebase Auth サーバーを使用できないためです。これは重要なセキュリティ要件です。こうしなければ、アプリケーションやウェブサイトをリプレイ攻撃にさらすことになり、攻撃者があるプロジェクト用に取得した Yahoo OAuth アクセストークンを使用して別のプロジェクト（被害者）にログインする恐れがあります。代わりに Firebase Auth では、Firebase コンソールで構成した OAuth のクライアント ID とクライアントシークレットを使用して、OAuth フロー全体と認証コード交換を処理する機能を提供しています。認証コードは特定のクライアント ID / シークレットの組み合わせでのみ使用できるため、あるプロジェクトで取得した認証コードを別のプロジェクトで使用することはできません。

このようなプロバイダを、サポートされていない環境で使用する必要がある場合は、サードパーティの OAuth ライブラリと Firebase カスタム認証を使用する必要があります。前者はプロバイダとの認証に、後者はプロバイダの認証情報をカスタムトークンと交換するために必要です。

次のステップ

ユーザーが初めてログインすると、新しいユーザーアカウントが作成され、ユーザーがログイン時に使用した認証情報（ユーザー名とパスワード、電話番号、または認証プロバイダ情報）にアカウントがリンクされます。この新しいアカウントは 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();