封鎖儲存庫

許多使用者仍會在設定新的 Android 裝置時管理自己的憑證。這類人工作業可能會變得越來越困難，而且通常會導致使用者體驗不佳。Block Store API 是由 Google Play 服務提供的程式庫，如要解決這個問題，應用程式可透過儲存使用者憑證的方式，因此無須儲存使用者密碼的相關複雜性或安全性風險。

Block Store API 可讓應用程式儲存資料，方便日後擷取在新裝置上重新驗證使用者。這有助於讓使用者享有更好的流暢體驗，因為在新裝置中首次啟動應用程式時，不需要查看登入畫面。

使用 Block Store 的好處如下：

• 開發人員專用的加密憑證儲存空間解決方案。系統會在可行情況下將憑證加密。
• 儲存權杖，而非使用者名稱和密碼。
• 讓登入流程更加流暢。
• 省去管理複雜密碼的麻煩。
• Google 驗證使用者的身分。

注意： 使用 Block Store 並不會限制使用者可以使用的憑證類型。使用者只要使用自己的使用者名稱和密碼、自己的 Google 帳戶或任何其他聯合識別資訊提供者登入，還是可以使用 Block Store。

事前準備

如要讓應用程式做好準備，請完成下列各節的步驟。

設定應用程式

在專案層級 build.gradle 檔案中，請同時在 buildscript 和 allprojects 區段中納入 Google 的 Maven 存放區：

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

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

將 Block Store API 的 Google Play 服務依附元件新增至模組的 Gradle 版本檔案，通常為 app/build.gradle：

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

運作方式

Block Store 可讓開發人員儲存及還原多達 16 個位元組的陣列。這可讓您儲存目前使用者工作階段的重要資訊，亦可視需要儲存這些資訊。這項資料可以進行端對端加密處理，而且支援 Block Store 的基礎架構是以「備份與還原」基礎架構為基礎。

本指南將說明將使用者權杖儲存到 Block Store 的用途。下列步驟概略說明使用區塊儲存庫的應用程式如何運作：

1. 在應用程式的驗證流程期間或之後，您可以將使用者的驗證權杖儲存到 Block Store 以供日後擷取。
2. 系統會將權杖儲存在本機，也可以盡可能備份至雲端，並盡可能經過端對端加密處理。
3. 當使用者在新裝置上啟動還原流程時，系統會轉移資料。
4. 如果使用者在還原流程中還原您的應用程式，應用程式便可在新裝置上從 Block Store 擷取已儲存的權杖。

儲存權杖

當使用者登入應用程式時，您可以將您為該使用者產生的驗證權杖儲存到 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() 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 服務會先驗證使用者，然後擷取 Block Store 資料，使用者已同意在還原流程中還原您的應用程式資料，因此不需要額外同意。使用者開啟應用程式時，您可以呼叫 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")
        }

注意： 建議您在啟用雲端備份之前，先確認是否能進行端對端加密。

啟用雲端備份

若要啟用雲端備份，請將 setShouldBackupToCloud() 方法新增至 StoreBytesData 物件。當 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.")
          }
        }

注意： 如果將 storeBytes 呼叫時，使用 shouldBackupToCloud 未設定或設為 false，系統就會在下次同步處理時，從雲端刪除先前備份至雲端的位元組。

如何測試

如要在開發期間測試還原流程，請使用以下方法。

相同裝置解除安裝/重新安裝

如果使用者啟用備份服務 (想依序前往「設定」>「Google」>「備份」)，則在解除安裝/重新安裝應用程式期間，「封鎖商店」資料會保留。

您可以按照下列步驟測試：

1. 將 BlockStore API 整合至測試應用程式。
2. 使用測試應用程式叫用 BlockStore API 來儲存資料。
3. 解除安裝測試應用程式，然後在相同裝置上重新安裝應用程式。
4. 使用測試應用程式叫用 BlockStore API 來擷取資料。
5. 確認擷取的位元組數與解除安裝前儲存的位元組數相同。

注意： 由於測試跨裝置還原時需要完成更多步驟，因此建議您先透過解除安裝/重新安裝案例來驗證應用程式與 BlockStore API 的整合作業。

裝置對裝置

在大多數情況下，這項操作需要將目標裝置恢復原廠設定。接著，您可以輸入 Android 無線還原流程或 Google 傳輸線還原功能 (如果使用支援的裝置)。

注意： 如果目標裝置是 Samsung Galaxy，您可以啟動 Smart Switch 以進入還原流程。

雲端還原

1. 將 Blockstore API 整合到測試應用程式。測試應用程式必須提交至 Play 商店。
2. 在來源裝置上，使用測試應用程式叫用 Blockstore API 來儲存資料，其中應設為 true。
3. 針對 O 以上版本裝置，您可以手動觸發 Block Store 雲端備份：依序前往「Settings」>「Google」>「Backup」，然後按一下「Backup Now」按鈕。
   1. 如要確認 Block Store 雲端備份是否成功，您可以執行下列操作：
      1. 備份完成後，請搜尋含有「CloudSyncBpTkSvc」標記的記錄行。
      2. 您應該會看到類似以下的訊息：「......, CloudSyncBpTkSvc: sync result result: SUCCESS, ..., upload size: XXX bytes ...」
   2. 「Block Store」雲端備份作業結束後，還原作業會等待 5 分鐘，也就是「等待期」。在這 5 分鐘內，按一下「立即備份」按鈕不會觸發另一個 Block Store 雲端備份。
4. 將目標裝置恢復原廠設定，執行雲端還原流程。選取要在還原流程中還原測試應用程式。如要進一步瞭解雲端還原流程，請參閱支援的雲端還原流程。
5. 在目標裝置上，使用測試應用程式叫用 Blockstore API 來擷取資料。
6. 確認擷取的位元組數與來源裝置中儲存的位元組相同。

裝置需求

端對端加密

• 搭載 Android 9 (API 29) 以上版本的裝置支援端對端加密功能。
• 裝置設定螢幕鎖定時，必須設定 PIN 碼、解鎖圖案或密碼，才能啟用端對端加密功能，讓系統正確加密使用者資料。

注意： 如果不符合上述任一條件，則會傳回 false。

裝置到裝置還原流程

如要還原裝置，你必須使用來源裝置和目標裝置。兩部裝置正在轉移資料。

來源裝置必須搭載 Android 6 (API 23) 以上版本才能備份。

指定搭載 Android 9 (API 29) 以上版本的裝置。

如要進一步瞭解裝置還原裝置的流程，請參閱這篇文章。

雲端備份與還原流程

雲端備份與還原作業需要來源裝置和目標裝置。

來源裝置必須搭載 Android 6 (API 23) 以上版本才能備份。

目標裝置取決於供應商。Pixel 裝置可透過 Android 9 (API 29) 使用這項功能，所有其他裝置則必須搭載 Android 12 (API 31) 以上版本。