ブロック ストア

注: ユーザー エクスペリエンスを更新したり、その他の機能を改善したりするには、 認証情報マネージャーでパスキー を使用することを検討してください。

多くのユーザーは、新しい Android デバイスを設定するときにも自身の認証情報を管理します。この手動プロセスは難しくなり、多くの場合、ユーザー エクスペリエンスの低下につながります。Google Play 開発者サービスのライブラリである Block Store API は、ユーザーのパスワード保存に伴う複雑さやセキュリティ上のリスクなしに、ユーザーの認証情報を保存できる方法を提供することで、この問題を解決しようとしています。

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

Block Store を使用すると、次のようなメリットがあります。

• デベロッパー向けの暗号化された認証情報ストレージ ソリューション。可能であれば、認証情報はエンドツーエンドで暗号化されます。
• ユーザー名とパスワードの代わりにトークンを保存します。
• ログインフローの煩わしさをなくします。
• ユーザーが複雑なパスワードを管理する負担から解放されます。
• Google がユーザーの本人確認を行います。

注: ブロックストアを使用しても、ユーザーは使用できる認証情報の種類が制限されるわけではありません。ユーザーはユーザー名とパスワード、Google アカウント、その他のフェデレーション ID プロバイダを使用してログインでき、Block Store は引き続き機能します。

始める前に

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

アプリを設定する

プロジェクト レベルの 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'
}

仕組み

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

このガイドでは、ユーザーのトークンをブロックストアに保存するユースケースについて説明します。 ブロックストアを利用するアプリの動作の概要は次のとおりです。

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

トークンの保存

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

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

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() API を使用してデータを保存したことがある場合は、キーを使用してトークンを保存することをおすすめします。以前に StoreBytes を使用して保存されたデータは、BlockstoreClient.DEFAULT_BYTES_DATA_KEY キーで保存されるようになりました。

デフォルトのトークンを使用

キーなしで 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)
    }

デバイスにデータはどのように保存され、誰がデータにアクセスできますか？

デバイス上では、BlockStore のデータは、Google Play 開発者サービスのローカルの非公開データ ディレクトリに保存されます。他のアプリがデータファイルに直接アクセスすることはできません。retrieveBytes() API を介してのみ BlockStore データにアクセスでき、アプリはそのアプリ自体に保存されているデータのみを取得できます。Google Play 開発者サービスは、パッケージ名と署名の両方をチェックします。

トークンの取得

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

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

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)
  }

retrieveBytes() の非推奨化。

retrieveBytes() が非推奨になりました。バイトを取得するには、RetrieveBytesRequest インスタンスでキー BlockstoreClient.DEFAULT_BYTES_DATA_KEY を使用して、保存済みデータを取得します。

以下は、デフォルトのキーを取得する方法の例です。

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)

トークンの削除

次の理由により、BlockStore からトークンを削除する必要がある場合があります。

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

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

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

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.")
          }
        }

注: shouldBackupToCloud を未設定または false に設定して storeBytes を呼び出した場合、以前にクラウドにバックアップされたこのデバイスのバイトは、次回の定期的な同期時にクラウドから削除されます。

テスト方法

開発中に復元フローをテストするには、次の方法を使用します。

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

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

テストする手順は次のとおりです。

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

注: クロスデバイスの復元をテストする場合は追加の手順が必要となるため、アンインストールと再インストールのケースを使用して、最初にアプリと BlockStore API の統合を検証することをおすすめします。

デバイス間

ほとんどの場合、対象デバイスの出荷時設定へのリセットが必要になります。その後、Android ワイヤレス復元フローまたは Google ケーブル復元（対応デバイスの場合）を開始できます。

注: 対象デバイスが Samsung Galaxy の場合は、セットアップの外部でスマート スイッチを起動することで、復元フローを開始できます。

クラウドの復元

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

デバイスの要件

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

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

注: これらの条件のいずれかが満たされない場合、isEndtoEndEncryptionAvailable() は false を返します。

デバイスからデバイスへの復元フロー

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

ソースデバイスに Android 6（API 23）以降が搭載されている必要があります。

Android 9（API 29）以降を搭載しているデバイスが復元できるように対象にします。

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

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

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

ソースデバイスに Android 6（API 23）以降が搭載されている必要があります。

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