Blok Mağazası

Birçok kullanıcı, yeni bir Android cihazı kurarken kendi kimlik bilgilerini yönetmeye devam etmektedir. Bu manuel işlem zor olabilir ve genellikle kötü bir kullanıcı deneyimine yol açabilir. Google Play hizmetleri tarafından desteklenen bir kitaplık olan Block Store API, uygulamaların kullanıcı kimlik bilgilerini, kullanıcı şifrelerinin kaydedilmesiyle ilişkili karmaşıklık veya güvenlik riski olmadan kaydetmelerini sağlayacak bir yol sağlayarak bu sorunu çözmeye çalışır.

Block Store API, uygulamanızın yeni cihazlarda kullanıcıların kimliklerini yeniden doğrulamak için daha sonra alabileceği verileri depolamasına olanak tanır. Bu, kullanıcıların uygulamanızı yeni cihazda ilk kez açarken oturum açma ekranı görmesi gerekmeyeceğinden kullanıcılara daha sorunsuz bir deneyim sunulmasına yardımcı olur.

Block Store'u kullanmanın avantajları şunlardır:

• Geliştiriciler için şifrelenmiş kimlik bilgisi depolama çözümü. Kimlik bilgileri, mümkün olduğunda uçtan uca şifrelenir.
• Kullanıcı adları ve şifreler yerine jetonları kaydet.
• Oturum açma akışlarındaki sorunları ortadan kaldırın.
• Kullanıcıları karmaşık şifreleri yönetme zahmetinden kurtarın.
• Google, kullanıcının kimliğini doğrular.

Başlamadan önce

Uygulamanızı hazırlamak için aşağıdaki bölümlerde açıklanan adımları tamamlayın.

Uygulamanızı yapılandırma

Proje düzeyindeki build.gradle dosyanıza Google'ın Maven deposunu hem buildscript hem de allprojects bölümlerinize ekleyin:

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

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

Block Store API için Google Play Hizmetleri bağımlılığını modülünüzün Gradle derleme dosyasına ekleyin. Bu dosya genellikle app/build.gradle olur:

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

İşleyiş şekli

Blok Mağazası, geliştiricilerin 16 bayta kadar dizileri kaydetmelerine ve geri yüklemelerine olanak tanır. Bu, geçerli kullanıcı oturumuyla ilgili önemli bilgileri kaydetmenize olanak tanır ve bu bilgileri istediğiniz gibi kaydetme esnekliği sağlar. Bu veriler uçtan uca şifrelenebilir ve Block Store'u destekleyen altyapı, Yedekleme ve Geri Yükleme altyapısının üzerine inşa edilmiştir.

Bu kılavuzda, bir kullanıcının jetonunun Block Store'a kaydedilmesiyle ilgili kullanım alanı ele alınmaktadır. Aşağıdaki adımlar, Block Store'u kullanan bir uygulamanın nasıl çalışacağını özetlemektedir:

1. Uygulamanızın kimlik doğrulama akışı sırasında veya daha sonra herhangi bir zamanda, kullanıcının kimlik doğrulama jetonunu daha sonra almak üzere Block Store'da saklayabilirsiniz.
2. Jeton yerel olarak depolanır ve mümkün olduğunda buluta yedeklenebilir ve uçtan uca şifrelenebilir.
3. Kullanıcı yeni bir cihazda geri yükleme akışı başlattığında veriler aktarılır.
4. Kullanıcı, geri yükleme akışı sırasında uygulamanızı geri yüklerse uygulamanız yeni cihazdaki Block Store'dan kaydedilen jetonu alabilir.

Jetonu kaydetme

Bir kullanıcı uygulamanızda oturum açtığında, söz konusu kullanıcı için oluşturduğunuz kimlik doğrulama jetonunu Block Store'a kaydedebilirsiniz. Bu jetonu, giriş başına en fazla 4 KB olan benzersiz bir anahtar çifti değeri kullanarak saklayabilirsiniz. Jetonu depolamak için bir StoreBytesData.Builder örneğinde setBytes() ve setKey() yöntemini çağırarak kullanıcının kimlik bilgilerini kaynak cihazda depolayın. Jetonu Block Store ile kaydettikten sonra jeton şifrelenir ve cihazda yerel olarak depolanır.

Aşağıdaki örnekte, kimlik doğrulama jetonunun yerel cihaza nasıl kaydedileceği gösterilmektedir:

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

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

Varsayılan jetonu kullan

Anahtar olmadan StoreBytes kullanılarak kaydedilen veriler, varsayılan olarak BlockstoreClient.DEFAULT_BYTES_DATA_KEY anahtarını kullanır.

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

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

Jetonu alma

Daha sonra, bir kullanıcı yeni bir cihazda geri yükleme akışını gerçekleştirdiğinde, Google Play Hizmetleri önce kullanıcıyı doğrular ve ardından Blok Depo verilerinizi alır. Kullanıcı, geri yükleme akışı kapsamında uygulama verilerinizi geri yüklemeyi kabul etmiştir. Dolayısıyla ek izin gerekmez. Kullanıcı uygulamanızı açtığında retrieveBytes() numarasını arayarak Block Store'dan jetonunuzu isteyebilirsiniz. Alınan jeton daha sonra kullanıcının yeni cihazda oturumunun açık kalması için kullanılabilir.

Aşağıdaki örnekte, belirli anahtarlara göre birden fazla jetonun nasıl alınacağı gösterilmektedir.

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

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

Aşağıda, BlockStore'a kaydedilen tüm jetonların nasıl alınacağına dair bir örnek verilmiştir.

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

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

Aşağıda, varsayılan anahtarı nasıl alabileceğinizle ilgili bir örnek verilmiştir.

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

val client = Blockstore.getClient(this)

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

Jetonları silme

Aşağıdaki nedenlerden dolayı jetonların BlockStore'dan silinmesi gerekebilir:

• Kullanıcı, oturumu kapatmaya yönelik kullanıcı işlemleri akışı gerçekleştirir.
• Jeton iptal edilmiş veya geçersiz.

Jetonları almaya benzer şekilde, silinmesini gerektiren bir anahtar dizisi ayarlayarak hangi jetonların silinmesi gerektiğini belirtebilirsiniz.

Aşağıda, belirli anahtarları silmeyle ilgili örnek verilmiştir.

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)

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)

Tüm Jetonları Sil

Aşağıdaki örnek, şu anda BlockStore'da kayıtlı olan tüm jetonları siler:

// 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));

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

Uçtan uca şifreleme

Uçtan uca şifrelemenin kullanılabilmesi için cihazda Android 9 veya sonraki bir sürüm yüklü olmalıdır. Ayrıca kullanıcı, cihazında ekran kilidi (PIN, desen veya şifre) ayarlamış olmalıdır. isEndToEndEncryptionAvailable() numaralı telefonu arayarak cihazda şifrelemenin kullanılıp kullanılamayacağını doğrulayabilirsiniz.

Aşağıdaki örnekte, bulutta yedekleme sırasında şifreleme kullanılıp kullanılamayacağını nasıl doğrulayacağınız gösterilmektedir:

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

Buluta yedeklemeyi etkinleştir

Bulut yedeklemesini etkinleştirmek için StoreBytesData nesnenize setShouldBackupToCloud() yöntemini ekleyin. Block Store, setShouldBackupToCloud() doğru olarak ayarlandığında depolanan baytları düzenli olarak buluta yedekler.

Aşağıdaki örnekte, yalnızca bulut yedeklemesi uçtan uca şifrelendiğinde bulut yedeklemenin nasıl etkinleştirileceği gösterilmektedir:

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

Nasıl test edilir?

Geri yükleme akışlarını test etmek için geliştirme sırasında aşağıdaki yöntemleri kullanın.

Aynı cihazı kaldırma/yeniden yükleme

Kullanıcı, Yedekleme hizmetlerini etkinleştirirse (Ayarlar > Google > Yedekleme seçeneğinden kontrol edilebilir) Engelleme Mağazası verileri, uygulamayı kaldırma/yeniden yükleme işlemi boyunca korunur.

Test etmek için şu adımları uygulayabilirsiniz:

1. BlockStore API'yi test uygulamanıza entegre edin.
2. Verilerinizi depolamak için BlockStore API'yi çağırmak üzere test uygulamasını kullanın.
3. Test uygulamanızı kaldırıp aynı cihazda yeniden yükleyin.
4. Verilerinizi almak amacıyla BlockStore API'yi çağırmak için test uygulamasını kullanın.
5. Alınan baytların, kaldırma işleminden önce depolananlarla aynı olduğunu doğrulayın.

Cihazdan cihaza

Çoğu durumda, bu işlem hedef cihazın fabrika ayarlarına sıfırlanmasını gerektirir. Daha sonra Android kablosuz geri yükleme akışı veya Google kablosu geri yükleme (desteklenen cihazlar için) bölümüne girebilirsiniz.

Buluta geri yükleme

1. Blockstore API'yi test uygulamanıza entegre edin. Test uygulamasının Play Store'a gönderilmesi gerekir.
2. Kaynak cihazda, verilerinizi depolamak için Blockstore API'yi çağırmak üzere test uygulamasını kullanın. Bunu yaparken shouldBackUpToCloud'u "true" değerine ayarlayın.
3. O ve üstü cihazlarda, Block Store bulut yedeklemesini manuel olarak tetikleyebilirsiniz: Ayarlar > Google > Yedekleme'ye gidip "Şimdi Yedekle" düğmesini tıklayın.
   1. Block Store bulut yedeklemesinin başarılı olduğunu doğrulamak için şunları yapabilirsiniz:
      1. Yedekleme tamamlandıktan sonra "CloudSyncBpTkSvc" etiketine sahip günlük satırlarını arayın.
      2. Şuna benzer satırlar görmeniz gerekir: “......, CloudSyncBpTkSvc: senkronize sonuç: SUCCESS, ..., uploaded size: XXX bytes ...”
   2. Block Store bulut yedeklemesinden sonra, 5 dakikalık bir "bekleme" dönemi başlar. Bu 5 dakika içinde "Şimdi Yedekle" düğmesi tıklandığında, başka bir Block Store bulut yedeklemesi tetiklenmez.
4. Hedef cihazı fabrika ayarlarına sıfırlayın ve bulut geri yükleme akışını uygulayın. Geri yükleme akışı sırasında test uygulamanızı geri yüklemek için bu seçeneği belirleyin. Buluta geri yükleme akışları hakkında daha fazla bilgi edinmek için Desteklenen bulut geri yükleme akışları bölümüne bakın.
5. Verilerinizi almak amacıyla, hedef cihazda Blockstore API'yi çağırmak için test uygulamasını kullanın.
6. Alınan baytların, kaynak cihazda depolananlarla aynı olduğunu doğrulayın.

Cihaz Gereksinimleri

Uçtan Uca Şifreleme

• Uçtan uca şifreleme, Android 9 (API 29) ve sonraki sürümleri çalıştıran cihazlarda desteklenir.
• Uçtan uca şifrelemenin etkinleştirilmesi ve kullanıcı verilerinin doğru şekilde şifrelenmesi için cihazda PIN, desen veya şifreyle ayarlanmış bir ekran kilidi bulunmalıdır.

Cihazdan Cihaza Geri Yükleme Akışı

Cihazdan cihaza geri yükleme işlemi için bir kaynak ve hedef cihaz sahibi olmanız gerekir. Bunlar veri aktaran iki cihaz olacaktır.

Kaynak cihazlar, yedekleme için Android 6 (API 23) ve sonraki bir sürümünü çalıştırmalıdır.

Geri yükleme yapabilmek için Android 9 (API 29) ve sonraki sürümleri çalıştıran cihazları hedefleyin.

Cihazdan cihaza geri yükleme akışı hakkında daha fazla bilgiyi burada bulabilirsiniz.

Bulut Yedekleme ve Geri Yükleme Akışı

Bulut yedekleme ve geri yükleme için bir kaynak cihaz ve hedef cihaz gerekir.

Kaynak cihazlar, yedekleme için Android 6 (API 23) ve sonraki bir sürümünü çalıştırmalıdır.

Hedef cihazlar, tedarikçi firmalarına göre desteklenir. Pixel cihazlar bu özelliği Android 9 (API 29) sürümünden kullanabilir, diğer tüm cihazlar Android 12 (API 31) veya sonraki bir sürümü çalıştırmalıdır.