封鎖儲存庫

許多使用者在設定新的 Android 裝置時,仍負責管理自己的憑證。這項手動程序可能變得困難,且通常會導致使用者體驗不佳。Block Store API 是由 Google Play 服務技術提供的程式庫,設法為應用程式提供儲存使用者憑證的方法,而不會儲存使用者密碼的複雜性或安全性風險。

Block Store API 可讓應用程式儲存使用者憑證,以供日後在新的裝置上重新驗證使用者。這有助於為使用者提供更流暢的體驗,因為使用者首次在新裝置上啟動應用程式時,不會看到登入畫面。

使用 Block Store 的好處包括:

  • 開發人員專用的加密憑證儲存解決方案。憑證會盡可能進行端對端加密。
  • 儲存權杖,而非使用者名稱和密碼。
  • 消除登入流程的阻礙。
  • 省去管理複雜密碼的麻煩。
  • Google 會驗證使用者身分。

事前準備

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

設定應用程式

在專案層級的 build.gradle 檔案中,在 buildscriptallprojects 區段中加入 Google #Maven 存放區

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

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

將 Block Store API 的 Google Play 服務依附元件新增至模組's Gradle 建構檔案,通常為 app/build.gradle

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

運作方式

「區塊存放區」是一種以權杖為基礎的登入機制,會經過端對端加密處理,並依據備份和還原基礎架構為基礎進行建構。下列步驟概述了使用 Block Store 的應用程式的運作方式:

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

儲存憑證

使用者登入應用程式時,您可以將您為使用者產生的驗證權杖儲存至 Block Store。方法是在 StoreBytesData.Builder 執行個體上呼叫 setBytes(),以將使用者的憑證儲存至來源裝置。使用 Block Store 儲存權杖後,權杖就會加密並儲存在裝置本機。

以下範例說明如何將驗證權杖儲存至本機裝置:

val client = Blockstore.getClient(this)
val data = StoreBytesData.Builder()
        .setBytes(/* BYTE_ARRAY */)
        .build()
client.storeBytes(data)
        .addOnSuccessListener{ result ->
            Log.d(TAG, "Stored: ${result} bytes")
        }
        .addOnFailureListener { e ->
            Log.e(TAG, “Failed to store bytes”, e)
        }

擷取權杖

之後,當使用者在新裝置上完成還原流程時,Google Play 服務會先驗證使用者,然後擷取您的封鎖儲存庫資料。使用者已同意在還原流程中還原應用程式資料,因此不需要額外同意聲明。使用者開啟應用程式時,您可以呼叫 retrieveBytes(),透過 Block Store 要求權杖。接著,系統就能擷取已擷取的權杖,讓使用者在新裝置上保持登入狀態。

以下範例顯示如何擷取先前以 Block Store 儲存的加密權杖:

val client = Blockstore.getClient(this)
client.retrieveBytes()
            .addOnSuccessListener { result ->
                Log.d(TAG, "Retrieved: ${String(result)}")
            }
            .addOnFailureListener { e ->
                Log.e(TAG, "Failed to retrieve bytes", e)
            }
}

端對端加密

裝置必須搭載 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.")
          }
        }

測試方式

在開發期間,請使用以下方法來測試還原流程。

同一部裝置解除安裝/重新安裝

如果使用者啟用備份服務 (可依序前往「Settings」(設定) >「Google > Backup」(設定)),「App Store」資料會保留在應用程式的解除安裝/重新安裝中。

您可以按照以下步驟進行測試:

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

裝置對裝置

在大多數情況下,您需要將目標裝置恢復原廠設定。接著,您可以進入 Android 無線還原流程Google 傳輸線還原功能 (適用於支援的裝置)。

雲端還原

  1. 將 Blockstore API 整合至測試應用程式。測試應用程式必須提交至 Play 商店。
  2. 在來源裝置上,使用測試應用程式叫用 Blockstore API 來儲存資料,應將 BackBackToCloud 設為 true。
  3. 對於 O 及以上的裝置,您可以手動觸發 Block Store 雲端備份:前往「Settings > Google > Backup」(設定 &Google;備份),然後按一下「Backup」(立即備份) 按鈕。
    1. 如要確認 Block Store 雲端備份是否成功,您可以採取下列做法:
      1. 備份完成後,請搜尋標有「CloudSyncBpTkSvc」標記的記錄行。
      2. 您應該會看到類似以下的行:「......、CloudSyncBpTkSvc:同步結果:SUCCESS、...、上傳的大小:XXX 個位元組 ...」
    2. 「Block Store」雲端備份服務設有 5 分鐘的「等待期」備份。5 分鐘內,按一下「立即備份」按鈕不會觸發其他 Block Store 雲端備份作業。
  4. 將目標裝置恢復原廠設定,並採用雲端還原流程。選取以在還原流程中還原測試應用程式。如要進一步瞭解雲端還原流程,請參閱支援的雲端還原流程
  5. 在目標裝置上,使用測試應用程式叫用 Blockstore API 來擷取資料。
  6. 確認擷取的位元組與來源裝置中儲存的位元組相同。

裝置需求

端對端加密

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

裝置對裝置還原流程

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

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

指定搭載 Android 9 (API 29) 以上版本的裝置,以便進行還原。

如要進一步瞭解裝置對裝置還原流程的資訊,請參閱這篇文章

雲端備份與還原流程

您必須設定來源裝置和目標裝置,才能使用雲端備份與還原功能。

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

根據供應商支援的目標裝置,Pixel 裝置可以從 Android 9 (API 29) 使用這項功能,而所有其他裝置都必須搭載 Android 12 (API 31) 以上版本。