Blokir Toko

Banyak pengguna yang masih mengelola kredensialnya sendiri saat menyiapkan perangkat Android baru. Proses manual ini dapat menjadi sulit dan sering mengakibatkan pengalaman pengguna yang buruk. Block Store API, library yang didukung oleh layanan Google Play, ingin mengatasi masalah ini dengan menyediakan cara bagi aplikasi untuk menyimpan kredensial pengguna tanpa kerumitan atau risiko keamanan yang terkait dengan penyimpanan sandi pengguna.

Block Store API memungkinkan aplikasi Anda menyimpan data yang nantinya dapat diambil untuk mengautentikasi ulang pengguna di perangkat baru. Hal ini membantu memberikan pengalaman yang lebih lancar bagi pengguna, karena mereka tidak perlu melihat layar login saat meluncurkan aplikasi untuk pertama kali di perangkat baru.

Manfaat menggunakan Block Store antara lain:

• Solusi penyimpanan kredensial terenkripsi untuk developer. Kredensial dienkripsi menyeluruh jika memungkinkan.
• Menyimpan token, bukan nama pengguna dan sandi.
• Menghilangkan hambatan dari alur login.
• Lindungi pengguna dari beban pengelolaan sandi yang kompleks.
• Google memverifikasi identitas pengguna.

Catatan: Penggunaan Block Store tidak membatasi pengguna pada jenis kredensial apa yang dapat digunakan. Pengguna dapat login dengan nama pengguna dan sandi, Akun Google mereka, atau penyedia identitas gabungan lainnya, dan Block Store tetap berfungsi.

Sebelum memulai

Untuk mempersiapkan aplikasi Anda, selesaikan langkah-langkah di bagian berikut ini.

Mengonfigurasi aplikasi Anda

Dalam file build.gradle level project, sertakan repositori Maven Google di bagian buildscript dan allprojects:

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

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

Tambahkan dependensi layanan Google Play untuk Block Store API ke file build Gradle modul Anda, yang biasanya adalah app/build.gradle:

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

Cara kerja

Block Store memungkinkan developer menyimpan dan memulihkan array hingga 16 byte. Tindakan ini memungkinkan Anda menyimpan informasi penting terkait sesi pengguna saat ini dan menawarkan fleksibilitas untuk menyimpan informasi ini sesuai keinginan Anda. Data ini dapat dienkripsi menyeluruh dan infrastruktur yang mendukung Block Store dibuat berdasarkan infrastruktur Pencadangan dan Pemulihan.

Panduan ini akan mencakup kasus penggunaan penyimpanan token pengguna ke Block Store. Langkah-langkah berikut menguraikan cara kerja aplikasi yang menggunakan Block Store:

1. Selama alur autentikasi aplikasi, atau kapan saja setelahnya, Anda dapat menyimpan token autentikasi pengguna ke Block Store untuk pengambilan nanti.
2. Token akan disimpan secara lokal dan juga dapat dicadangkan ke cloud, dienkripsi menyeluruh jika memungkinkan.
3. Data ditransfer saat pengguna memulai alur pemulihan pada perangkat baru.
4. Jika pengguna memulihkan aplikasi Anda selama alur pemulihan, aplikasi Anda kemudian dapat mengambil token tersimpan dari Block Store di perangkat baru.

Menyimpan token

Saat pengguna login ke aplikasi Anda, Anda dapat menyimpan token autentikasi yang Anda buat untuk pengguna tersebut ke Block Store. Anda dapat menyimpan token ini menggunakan nilai pasangan kunci unik yang memiliki maksimum 4 kb per entri. Untuk menyimpan token, panggil setBytes() dan 'setKey(/android/reference/com/google/android/gms/auth/blockstore/StoreBytesData.Builder.html#setKey(java.lang.String)' pada instance StoreBytesData.Builder untuk menyimpan kredensial pengguna ke perangkat sumber. Setelah Anda menyimpan token dengan Block Store, token akan dienkripsi dan disimpan secara lokal di perangkat.

Contoh berikut menunjukkan cara menyimpan token autentikasi ke perangkat lokal:

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

Byte yang disimpan sebelumnya tanpa kunci?

Jika sebelumnya Anda telah menggunakan StoreBytes() API untuk menyimpan data, sebaiknya Anda mulai menyimpan token dengan kunci. Data yang sebelumnya disimpan menggunakan StoreBytes kini disimpan dengan kunci BlockstoreClient.DEFAULT_BYTES_DATA_KEY.

Gunakan token default

Data yang disimpan menggunakan StoreBytes tanpa kunci menggunakan kunci default 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)
    }

Bagaimana cara data disimpan di perangkat dan siapa yang dapat mengakses data tersebut?

Di perangkat, data BlockStore disimpan di direktori data pribadi lokal Layanan Google Play. Tidak ada aplikasi lain yang dapat mengakses file data secara langsung. Aplikasi hanya dapat mengakses data BlockStore melalui retrieveBytes() API, dan aplikasi hanya dapat mengambil data yang disimpan dengan sendirinya. Layanan Google Play memeriksa nama paket dan tanda tangan.

Mengambil token

Kemudian, saat pengguna menjalani alur pemulihan di perangkat baru, layanan Google Play akan memverifikasi pengguna tersebut terlebih dahulu, lalu mengambil data Block Store Anda. Pengguna telah setuju untuk memulihkan data aplikasi Anda sebagai bagian dari alur pemulihan, sehingga tidak ada izin tambahan yang diperlukan. Ketika pengguna membuka aplikasi Anda, Anda dapat meminta token dari Block Store dengan memanggil retrieveBytes(). Kemudian, token yang diambil dapat digunakan agar pengguna tetap login di perangkat baru.

Contoh berikut menunjukkan cara mengambil beberapa token berdasarkan kunci tertentu.

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

Mengambil semua token.

Berikut adalah contoh cara mengambil semua token yang disimpan ke 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)
  }

Menghentikan penggunaan ByteBytes().

retrieveBytes() tidak digunakan lagi. Untuk mengambil byte, kunci BlockstoreClient.DEFAULT_BYTES_DATA_KEY dapat digunakan dalam instance RetrieveBytesRequest untuk mendapatkan data Anda yang tersimpan

Berikut adalah contoh cara mengambil kunci default.

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)

Menghapus token

Menghapus token dari BlockStore mungkin diperlukan karena alasan berikut:

• Pengguna melalui alur logout pengguna.
• Token telah dicabut atau tidak valid.

Mirip dengan pengambilan token, Anda dapat menentukan token mana yang perlu dihapus dengan menyetel array kunci yang perlu dihapus.

Berikut adalah contoh untuk menghapus kunci tertentu.

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)

Hapus Semua Token

Contoh di bawah menghapus semua token yang saat ini disimpan ke 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")
  }

Enkripsi menyeluruh

Agar enkripsi menyeluruh tersedia, perangkat harus menjalankan Android 9 atau yang lebih baru, dan pengguna harus menyetel kunci layar (PIN, pola, atau sandi) untuk perangkat mereka. Anda dapat memverifikasi apakah enkripsi akan tersedia di perangkat dengan memanggil isEndToEndEncryptionAvailable().

Contoh berikut menunjukkan cara memverifikasi apakah enkripsi akan tersedia selama pencadangan cloud:

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

Catatan: Sebaiknya verifikasi bahwa enkripsi menyeluruh tersedia sebelum mengaktifkan pencadangan cloud.

Aktifkan pencadangan cloud

Untuk mengaktifkan pencadangan cloud, tambahkan metode setShouldBackupToCloud() ke objek StoreBytesData Anda. Block Store akan mencadangkan secara berkala ke cloud untuk byte yang disimpan saat setShouldBackupToCloud() ditetapkan ke true (benar).

Contoh berikut menunjukkan cara mengaktifkan pencadangan cloud hanya jika pencadangan cloud dienkripsi menyeluruh:

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

Catatan: Jika storeBytes dipanggil dengan shouldBackupToCloud unset atau ditetapkan sebagai false, byte perangkat ini yang sebelumnya dicadangkan ke cloud akan dihapus dari cloud pada sinkronisasi berkala berikutnya.

Cara menguji

Gunakan metode berikut selama pengembangan untuk menguji alur pemulihan.

Uninstal/instal ulang perangkat yang sama

Jika pengguna mengaktifkan Layanan pencadangan (dapat diperiksa di Setelan > Google > Pencadangan), data Block Store akan disimpan di seluruh proses uninstal/instal ulang aplikasi.

Anda dapat mengikuti langkah-langkah berikut untuk mengujinya:

1. Integrasikan BlockStore API ke aplikasi pengujian Anda.
2. Gunakan aplikasi pengujian untuk memanggil BlockStore API untuk menyimpan data Anda.
3. Uninstal aplikasi pengujian, lalu instal ulang aplikasi Anda di perangkat yang sama.
4. Gunakan aplikasi pengujian untuk memanggil BlockStore API untuk mengambil data Anda.
5. Pastikan byte yang diambil sama dengan yang disimpan sebelum uninstal.

Catatan: Karena diperlukan lebih banyak langkah untuk menguji pemulihan lintas perangkat, sebaiknya verifikasi terlebih dahulu integrasi aplikasi Anda dengan BlockStore API menggunakan kasus uninstal/instal ulang.

Perangkat ke perangkat

Dalam sebagian besar kasus, perangkat target perlu direset ke setelan pabrik. Anda kemudian dapat memasukkan alur pemulihan nirkabel Android atau pemulihan kabel Google (untuk perangkat yang didukung).

Catatan: Jika perangkat target adalah Samsung Galaxy, Anda dapat memasuki alur pemulihan dengan meluncurkan Smart Switch di luar penyiapan.

Pemulihan cloud

1. Integrasikan Blockstore API ke aplikasi pengujian Anda. Aplikasi pengujian harus dikirimkan ke Play Store.
2. Di perangkat sumber, gunakan aplikasi pengujian untuk memanggil Blockstore API untuk menyimpan data Anda, dengan shouldBackUpToCloud yang ditetapkan ke true.
3. Untuk perangkat O dan yang lebih baru, Anda dapat memicu pencadangan cloud Block Store secara manual: buka Settings > Google > Backup, lalu klik tombol “Cadangkan Sekarang”.
   1. Untuk memverifikasi bahwa pencadangan cloud Block Store berhasil, Anda dapat:
      1. Setelah pencadangan selesai, telusuri baris log dengan tag "CloudSyncBpTkSvc".
      2. Anda akan melihat baris seperti ini: “......, CloudSyncBpTkSvc: sync result: SUCCESS, ..., uploaded size: XXX byte ...”
   2. Setelah pencadangan cloud Block Store, ada periode “sejuk” selama 5 menit. Dalam 5 menit tersebut, mengklik tombol “Cadangkan Sekarang” tidak akan memicu pencadangan cloud Block Store lain.
4. Reset perangkat target ke setelan pabrik dan lakukan alur pemulihan cloud. Pilih untuk memulihkan aplikasi pengujian selama alur pemulihan. Untuk informasi selengkapnya tentang alur pemulihan cloud, lihat Alur pemulihan cloud yang didukung.
5. Di perangkat target, gunakan aplikasi pengujian untuk memanggil Blockstore API untuk mengambil data Anda.
6. Pastikan byte yang diambil sama dengan yang disimpan di perangkat sumber.

Persyaratan Perangkat

Enkripsi Menyeluruh

• Enkripsi End to End didukung pada perangkat yang menjalankan Android 9 (API 29) dan yang lebih tinggi.
• Perangkat harus memiliki kunci layar yang disetel dengan PIN, pola, atau sandi agar enkripsi menyeluruh diaktifkan dan mengenkripsi data pengguna dengan benar.

Catatan: isEndtoEndEncryptionAvailable() akan menampilkan nilai false jika salah satu kondisi ini tidak terpenuhi.

Alur Pemulihan Perangkat ke Perangkat

Pemulihan perangkat ke perangkat akan mengharuskan Anda memiliki perangkat sumber dan perangkat target. Ini akan menjadi dua perangkat yang mentransfer data.

Perangkat Sumber harus menjalankan Android 6 (API 23) dan yang lebih baru untuk pencadangan.

Menargetkan perangkat yang menjalankan Android 9 (API 29) dan yang lebih baru agar dapat dipulihkan.

Informasi selengkapnya tentang alur pemulihan perangkat ke perangkat dapat ditemukan di sini.

Alur Pencadangan dan Pemulihan Cloud

Pencadangan dan pemulihan cloud akan memerlukan perangkat sumber dan perangkat target.

Perangkat Sumber harus menjalankan Android 6 (API 23) dan yang lebih baru untuk pencadangan.

Perangkat target didukung berdasarkan vendornya. Perangkat Pixel dapat menggunakan fitur ini dari Android 9 (API 29) dan semua perangkat lainnya harus menjalankan Android 12 (API 31) atau yang lebih baru.