ブロックストア

多くのユーザーは、新しい Android デバイスをセットアップする際に、自身の認証情報を管理します。この手動プロセスは困難であり、多くの場合、ユーザー エクスペリエンスが低下します。Google Play 開発者サービスを備えたライブラリ Block Store API は、この解決策として、ユーザー パスワードの保存に伴う複雑さやセキュリティ リスクを伴わずに、アプリがユーザーの認証情報を保存する方法を提供することを目指しています。

Block Store API を使用すると、アプリでデータを保存し、そのデータを使用して後で新しいデバイスでユーザーを再認証できます。こうすることで、ユーザーは新しいデバイスで初めてアプリを起動する際に、ログイン画面を表示する必要がなくなるので、シームレスなエクスペリエンスを実現できます。

Block Store を使用するメリットは次のとおりです。

  • 開発者のための、暗号化された認証情報ストレージ ソリューション。認証情報は可能な限りエンドツーエンドの暗号化されます。
  • ユーザー名とパスワードの代わりにトークンを保存します。
  • ログインフローが簡単になります。
  • 複雑なパスワードを管理する手間を省くことができます。
  • Google がユーザーの本人確認を行います。

始める前に

アプリを準備するには、以下のセクションに示す手順を完了します。

アプリを構成する

プロジェクト レベルの build.gradle ファイルで、buildscript セクションと allprojects セクションの両方に Google の Maven リポジトリを含めます。

buildscript {
  repositories {
    google()
    mavenCentral()
  }
}

allprojects {
  repositories {
    google()
    mavenCentral()
  }
}

モジュールの Gradle ビルドファイル（通常は app/build.gradle）に、Block Store API の Google Play 開発者サービスの依存関係を追加します。

dependencies {
  implementation 'com.google.android.gms:play-services-auth-blockstore:16.2.0'
}

仕組み

ブロックストアにより、デベロッパーは最大 16 バイトの配列を保存および復元できます。 これにより、現在のユーザー セッションに関する重要な情報を保存でき、その情報を柔軟に保存することができます。このデータはエンドツーエンドの暗号化が可能で、Block Store をサポートするインフラストラクチャはバックアップと復元のインフラストラクチャ上に構築されています。

このガイドでは、ユーザーのトークンをブロック ストアに保存するユースケースについて説明します。Block Store を利用するアプリがどのように動作するかを以下の手順で概説します。

  1. アプリの認証フロー中、またはその後のいつでも、ユーザーの認証トークンを後で取得するために Block Store に保存できます。
  2. トークンはローカルに保存されます。また、可能であればクラウドにバックアップし、エンドツーエンドで暗号化することもできます。
  3. ユーザーが新しいデバイスで復元フローを開始すると、データが転送されます。
  4. ユーザーが復元フローでアプリを復元すると、アプリは新しいデバイスの Block Store から保存済みトークンを取得できます。

トークンの保存

ユーザーがアプリにログインしたら、そのユーザー用に生成した認証トークンをブロックストアに保存することができます。このトークンは、エントリあたり最大 4 KB の一意のキーペア値を使用して保存できます。トークンを保存するには、StoreBytesData.Builder のインスタンスで setBytes() と 'setKey(/android/reference/com/google/android/gms/auth/blockstore/StoreBytesData.Builder.html#setKey(java.lang.String)' を呼び出し、ユーザーの認証情報をソースデバイスに保存します。Block Store を使用してトークンを保存すると、トークンは暗号化され、デバイスにローカルに保存されます。

次のサンプルは、認証トークンをローカル デバイスに保存する方法を示しています。

Java

  BlockstoreClient client = Blockstore.getClient(this);
  byte[] bytes1 = new byte[] { 1, 2, 3, 4 };  // Store one data block.
  String key1 = "com.example.app.key1";
  StoreBytesData storeRequest1 = StoreBytesData.Builder()
          .setBytes(bytes1)
          // Call this method to set the key value pair the data should be associated with.
          .setKeys(Arrays.asList(key1))
          .build();
  client.storeBytes(storeRequest1)
    .addOnSuccessListener(result -> Log.d(TAG, "stored " + result + " bytes"))
    .addOnFailureListener(e -> Log.e(TAG, "Failed to store bytes", e));

Kotlin

  val client = Blockstore.getClient(this)

  val bytes1 = byteArrayOf(1, 2, 3, 4) // Store one data block.
  val key1 = "com.example.app.key1"
  val storeRequest1 = StoreBytesData.Builder()
    .setBytes(bytes1) // Call this method to set the key value with which the data should be associated with.
    .setKeys(Arrays.asList(key1))
    .build()
  client.storeBytes(storeRequest1)
    .addOnSuccessListener { result: Int ->
      Log.d(TAG,
            "Stored $result bytes")
    }
    .addOnFailureListener { e ->
      Log.e(TAG, "Failed to store bytes", e)
    }

デフォルト トークンを使用する

StoreBytes を使用して鍵なしで保存されたデータは、デフォルトの鍵 BlockstoreClient.DEFAULT_BYTES_DATA_KEY が使用されます。

Java

  BlockstoreClient client = Blockstore.getClient(this);
  // The default key BlockstoreClient.DEFAULT_BYTES_DATA_KEY.
  byte[] bytes = new byte[] { 9, 10 };
  StoreBytesData storeRequest = StoreBytesData.Builder()
          .setBytes(bytes)
          .build();
  client.storeBytes(storeRequest)
    .addOnSuccessListener(result -> Log.d(TAG, "stored " + result + " bytes"))
    .addOnFailureListener(e -> Log.e(TAG, "Failed to store bytes", e));

Kotlin

  val client = Blockstore.getClient(this);
  // the default key BlockstoreClient.DEFAULT_BYTES_DATA_KEY.
  val bytes = byteArrayOf(1, 2, 3, 4)
  val storeRequest = StoreBytesData.Builder()
    .setBytes(bytes)
    .build();
  client.storeBytes(storeRequest)
    .addOnSuccessListener { result: Int ->
      Log.d(TAG,
            "stored $result bytes")
    }
    .addOnFailureListener { e ->
      Log.e(TAG, "Failed to store bytes", e)
    }

トークンの取得

その後、ユーザーが新しいデバイスで復元フローを実行すると、Google Play 開発者サービスはまずユーザーを検証してから、ブロックストア データを取得します。ユーザーは、復元フローの一環としてアプリデータの復元にすでに同意しているため、追加の同意は必要ありません。ユーザーがアプリを開くと、retrieveBytes() を呼び出してブロック ストアにトークンをリクエストできます。取得したトークンを使用して、新しいデバイスでユーザーがログインした状態を維持できます。

次のサンプルは、特定のキーに基づいて複数のトークンを取得する方法を示しています。

Java

BlockstoreClient client = Blockstore.getClient(this);

// Retrieve data associated with certain keys.
String key1 = "com.example.app.key1";
String key2 = "com.example.app.key2";
String key3 = BlockstoreClient.DEFAULT_BYTES_DATA_KEY; // Used to retrieve data stored without a key

List requestedKeys = Arrays.asList(key1, key2, key3); // Add keys to array
RetrieveBytesRequest retrieveRequest = new RetrieveBytesRequest.Builder()
    .setKeys(requestedKeys)
    .build();

client.retrieveBytes(retrieveRequest)
    .addOnSuccessListener(
        result -> {
          Map blockstoreDataMap = result.getBlockstoreDataMap();
          for (Map.Entry entry : blockstoreDataMap.entrySet()) {
            Log.d(TAG, String.format(
                "Retrieved bytes %s associated with key %s.",
                new String(entry.getValue().getBytes()), entry.getKey()));
          }
        })
    .addOnFailureListener(e -> Log.e(TAG, "Failed to store bytes", e));

Kotlin

val client = Blockstore.getClient(this)

// Retrieve data associated with certain keys.
val key1 = "com.example.app.key1"
val key2 = "com.example.app.key2"
val key3 = BlockstoreClient.DEFAULT_BYTES_DATA_KEY // Used to retrieve data stored without a key

val requestedKeys = Arrays.asList(key1, key2, key3) // Add keys to array

val retrieveRequest = RetrieveBytesRequest.Builder()
  .setKeys(requestedKeys)
  .build()

client.retrieveBytes(retrieveRequest)
  .addOnSuccessListener { result: RetrieveBytesResponse ->
    val blockstoreDataMap =
      result.blockstoreDataMap
    for ((key, value) in blockstoreDataMap) {
      Log.d(ContentValues.TAG, String.format(
        "Retrieved bytes %s associated with key %s.",
        String(value.bytes), key))
    }
  }
  .addOnFailureListener { e: Exception? ->
    Log.e(ContentValues.TAG,
          "Failed to store bytes",
          e)
  }

すべてのトークンを取得しています。

以下は、BlockStore に保存されているすべてのトークンを取得する方法の例です。

Java

BlockstoreClient client = Blockstore.getClient(this)

// Retrieve all data.
RetrieveBytesRequest retrieveRequest = new RetrieveBytesRequest.Builder()
    .setRetrieveAll(true)
    .build();

client.retrieveBytes(retrieveRequest)
    .addOnSuccessListener(
        result -> {
          Map blockstoreDataMap = result.getBlockstoreDataMap();
          for (Map.Entry entry : blockstoreDataMap.entrySet()) {
            Log.d(TAG, String.format(
                "Retrieved bytes %s associated with key %s.",
                new String(entry.getValue().getBytes()), entry.getKey()));
          }
        })
    .addOnFailureListener(e -> Log.e(TAG, "Failed to store bytes", e));

Kotlin

val client = Blockstore.getClient(this)

val retrieveRequest = RetrieveBytesRequest.Builder()
  .setRetrieveAll(true)
  .build()

client.retrieveBytes(retrieveRequest)
  .addOnSuccessListener { result: RetrieveBytesResponse ->
    val blockstoreDataMap =
      result.blockstoreDataMap
    for ((key, value) in blockstoreDataMap) {
      Log.d(ContentValues.TAG, String.format(
        "Retrieved bytes %s associated with key %s.",
        String(value.bytes), key))
    }
  }
  .addOnFailureListener { e: Exception? ->
    Log.e(ContentValues.TAG,
          "Failed to store bytes",
          e)
  }

デフォルトの鍵を取得する例を次に示します。

Java

BlockStoreClient client = Blockstore.getClient(this);
RetrieveBytesRequest retrieveRequest = new RetrieveBytesRequest.Builder()
    .setKeys(Arrays.asList(BlockstoreClient.DEFAULT_BYTES_DATA_KEY))
    .build();
client.retrieveBytes(retrieveRequest);

Kotlin

val client = Blockstore.getClient(this)

val retrieveRequest = RetrieveBytesRequest.Builder()
  .setKeys(Arrays.asList(BlockstoreClient.DEFAULT_BYTES_DATA_KEY))
  .build()
client.retrieveBytes(retrieveRequest)

トークンの削除

ブロックストアからのトークンの削除が必要になる理由は次のとおりです。

  • ユーザーがログアウト フローを実行します。
  • トークンが取り消されているか、無効です。

トークンの取得と同様に、削除が必要なキーの配列を設定することで、削除の必要があるトークンを指定できます。

特定のキーを削除する例を以下に示します。

Java

BlockstoreClient client = Blockstore.getClient(this);

// Delete data associated with certain keys.
String key1 = "com.example.app.key1";
String key2 = "com.example.app.key2";
String key3 = BlockstoreClient.DEFAULT_BYTES_DATA_KEY; // Used to delete data stored without key

List requestedKeys = Arrays.asList(key1, key2, key3) // Add keys to array
DeleteBytesRequest deleteRequest = new DeleteBytesRequest.Builder()
      .setKeys(requestedKeys)
      .build();
client.deleteBytes(deleteRequest)

Kotlin

val client = Blockstore.getClient(this)

// Retrieve data associated with certain keys.
val key1 = "com.example.app.key1"
val key2 = "com.example.app.key2"
val key3 = BlockstoreClient.DEFAULT_BYTES_DATA_KEY // Used to retrieve data stored without a key

val requestedKeys = Arrays.asList(key1, key2, key3) // Add keys to array

val retrieveRequest = DeleteBytesRequest.Builder()
      .setKeys(requestedKeys)
      .build()

client.deleteBytes(retrieveRequest)

すべてのトークンを削除

次の例では、BlockStore に現在保存されているすべてのトークンを削除します。

Java

// Delete all data.
DeleteBytesRequest deleteAllRequest = new DeleteBytesRequest.Builder()
      .setDeleteAll(true)
      .build();
client.deleteBytes(deleteAllRequest)
.addOnSuccessListener(result -> Log.d(TAG, "Any data found and deleted? " + result));

Kotlin

  val deleteAllRequest = DeleteBytesRequest.Builder()
  .setDeleteAll(true)
  .build()
client.deleteBytes(deleteAllRequest)
  .addOnSuccessListener { result: Boolean ->
    Log.d(TAG,
          "Any data found and deleted? $result")
  }

エンドツーエンドの暗号化

エンドツーエンドの暗号化を使用するには、デバイスで Android 9 以降が実行されていること、ユーザーがデバイスで画面ロック（PIN、パターン、パスワード）のいずれかを設定している必要があります。isEndToEndEncryptionAvailable() を呼び出すことで、デバイスで暗号化を使用できるかどうかを確認できます。

次のサンプルは、クラウド バックアップ中に暗号化を使用できるかどうかを確認する方法を示しています。

client.isEndToEndEncryptionAvailable()
        .addOnSuccessListener { result ->
          Log.d(TAG, "Will Block Store cloud backup be end-to-end encrypted? $result")
        }

クラウド バックアップを有効にする

クラウド バックアップを有効にするには、StoreBytesData オブジェクトに setShouldBackupToCloud() メソッドを追加します。setShouldBackupToCloud() が true に設定されている場合、Block Store は保存されたバイトを定期的にクラウドにバックアップします。

次のサンプルは、クラウド バックアップがエンドツーエンドで暗号化されている場合にのみ、クラウド バックアップを有効にする方法を示しています。

val client = Blockstore.getClient(this)
val storeBytesDataBuilder = StoreBytesData.Builder()
        .setBytes(/* BYTE_ARRAY */)

client.isEndToEndEncryptionAvailable()
        .addOnSuccessListener { isE2EEAvailable ->
          if (isE2EEAvailable) {
            storeBytesDataBuilder.setShouldBackupToCloud(true)
            Log.d(TAG, "E2EE is available, enable backing up bytes to the cloud.")

            client.storeBytes(storeBytesDataBuilder.build())
                .addOnSuccessListener { result ->
                  Log.d(TAG, "stored: ${result.getBytesStored()}")
                }.addOnFailureListener { e ->
                  Log.e(TAG, “Failed to store bytes”, e)
                }
          } else {
            Log.d(TAG, "E2EE is not available, only store bytes for D2D restore.")
          }
        }

テスト方法

開発中に復元フローをテストするために、次のメソッドを使用します。

同じデバイスのアンインストールと再インストール

ユーザーがバックアップ サービスを有効にすると（[設定] > [Google] > [バックアップ] で確認できます）、ブロックストア データはアプリをアンインストールしても再インストールしても保持されます。

手順は以下のとおりです。

  1. BlockStore API をテストアプリに統合します。
  2. テストアプリを使用して BlockStore API を呼び出し、データを保存します。
  3. テストアプリをアンインストールしてから、同じデバイスにアプリを再インストールします。
  4. テストアプリを使用して BlockStore API を呼び出し、データを取得します。
  5. 取得したバイト数がアンインストール前に保存されていたバイト数と同じであることを確認します。

デバイス間

ほとんどの場合、対象デバイスを出荷時の設定にリセットする必要があります。その後、Android ワイヤレス復元フローまたは Google ケーブル復元（サポートされているデバイスの場合）を入力できます。

クラウドの復元

  1. Blockstore API をテストアプリに統合します。テストアプリを Play ストアに送信する必要があります。
  2. ソースデバイスで、テストアプリを使用して Blockstore API を呼び出し、 shouldBackUpToCloud を true に設定してデータを保存します。
  3. O 以降のデバイスの場合、Block Store のクラウド バックアップを手動でトリガーできます。[設定] > [Google] > [バックアップ] に移動し、[今すぐバックアップ] ボタンをクリックします。
    1. Block Store のクラウド バックアップが成功したことを確認するには、次の操作を行います。
      1. バックアップが完了したら、「CloudSyncBpTkSvc」タグが付いたログ行を検索します。
      2. 「......, CloudSyncBpTkSvc: sync result: SUCCESS, ..., uploaded size: XXX bytes ...」のような行が表示されます。
    2. Block Store のクラウド バックアップの後、5 分間の「クールダウン」期間があります。その 5 分以内に [今すぐバックアップ] ボタンをクリックしても、Block Store の別のクラウド バックアップがトリガーされることはありません。
  4. 対象デバイスを出荷時の設定にリセットし、クラウド復元フローを行います。復元フロー中にテストアプリを復元することを選択します。クラウド復元フローの詳細については、サポートされているクラウド復元フローをご覧ください。
  5. 対象のデバイスで、テストアプリを使用して Blockstore API を呼び出し、データを取得します。
  6. 取得されたバイト数が、ソースデバイスに保存されているバイトと同じであることを確認します。

デバイスの要件

エンドツーエンドの暗号化

  • エンドツーエンドの暗号化は、Android 9（API 29）以降を搭載したデバイスでサポートされています。
  • エンドツーエンドの暗号化を有効にして、ユーザーのデータを正しく暗号化するには、デバイスで PIN、パターン、またはパスワードによる画面ロックを設定する必要があります。

デバイス間の復元フロー

デバイス間で復元を行うには、ソースデバイスとターゲット デバイスが必要です。これらは 2 つのデバイスでデータを転送します。

ソースデバイスがバックアップの対象となるには、Android 6（API 23）以降を実行している必要があります。

ターゲット: Android 9（API 29）以降を搭載しているデバイスを復元できます。

デバイス間の復元フローの詳細については、こちらを参照してください。

クラウドのバックアップと復元のフロー

クラウドのバックアップと復元には、ソースデバイスとターゲット デバイスが必要です。

ソースデバイスがバックアップの対象となるには、Android 6（API 23）以降を実行している必要があります。

対象デバイスは、ベンダーによってサポートされています。Google Pixel では Android 9（API 29）からこの機能を使用できます。その他のデバイスはすべて Android 12（API 31）以降を搭載した必要があります。