블록 스토어

많은 사용자가 새 Android 기기를 설정할 때 여전히 자신의 사용자 인증 정보를 관리합니다. 이러한 수동 프로세스는 까다로울 수 있으며 결국 사용자 환경이 저하됩니다. Google Play 서비스에서 제공하는 라이브러리인 Block Store API는 앱이 사용자 비밀번호 저장과 관련된 복잡성이나 보안 위험 없이 사용자 인증 정보를 저장할 수 있는 방법을 제공하여 이 문제를 해결하고자 합니다.

Block Store API를 사용하면 앱에서 나중에 검색할 수 있는 데이터를 저장하여 새 기기에서 사용자를 재인증할 수 있습니다. 이렇게 하면 사용자가 새 기기에서 처음으로 앱을 실행할 때 로그인 화면을 볼 필요가 없으므로 사용자에게 더 원활한 환경을 제공할 수 있습니다.

블록 스토어를 사용할 때의 이점은 다음과 같습니다.

• 개발자를 위한 암호화된 사용자 인증 정보 저장소 솔루션입니다. 사용자 인증 정보는 가능하면 엔드 투 엔드 암호화됩니다.
• 사용자 이름과 비밀번호 대신 토큰을 저장합니다.
• 로그인 흐름에서 장애 요소 제거
• 복잡한 비밀번호를 관리하는 부담에서 사용자를 해방해 보세요.
• Google에서 사용자의 신원을 확인합니다.

참고: Block Store를 사용해도 사용자는 사용할 수 있는 사용자 인증 정보 유형으로 제한되지 않습니다. 사용자는 사용자 이름과 비밀번호, Google 계정 또는 기타 제휴 ID 공급업체로 로그인할 수 있으며 블록 스토어는 계속 작동합니다.

시작하기 전에

앱을 준비하려면 다음 섹션의 단계를 완료합니다.

앱 구성

프로젝트 수준 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'
}

작동 방식

블록 저장소를 사용하면 개발자가 최대 16바이트 배열을 저장하고 복원할 수 있습니다. 이렇게 하면 현재 사용자 세션과 관련된 중요한 정보를 저장할 수 있으며 원하는 대로 정보를 저장할 수 있습니다. 이 데이터는 엔드 투 엔드 암호화가 가능하며 Block Store를 지원하는 인프라는 백업 및 복원 인프라를 기반으로 구축됩니다.

이 가이드에서는 사용자의 토큰을 블록 스토어에 저장하는 사용 사례를 다룹니다. 다음 단계에서는 Block Store를 활용하는 앱의 작동 방식을 간략히 설명합니다.

1. 앱의 인증 흐름 중에 또는 그 후에 언제든지 검색할 수 있도록 사용자의 인증 토큰을 Block Store에 저장할 수 있습니다.
2. 토큰은 로컬에 저장되며 클라우드에 백업할 수 있으며 가능하면 엔드 투 엔드 암호화가 가능합니다.
3. 사용자가 새 기기에서 복원 흐름을 시작하면 데이터가 전송됩니다.
4. 복원 흐름 중에 사용자가 앱을 복원하면 앱은 새 기기의 Block Store에서 저장된 토큰을 검색할 수 있습니다.

토큰 저장

사용자가 앱에 로그인하면 개발자는 이 사용자를 위해 생성한 인증 토큰을 차단 스토어에 저장할 수 있습니다. 항목당 최대 4KB인 고유한 키 쌍 값을 사용하여 이 토큰을 저장할 수 있습니다. 토큰을 저장하려면 StoreBytesData.Builder 인스턴스에서 setBytes() 및 'setKey(/android/reference/com/google/android/gms/auth/blockstore/StoreBytesData.Builder.html#setKey(java.lang.String)'를 호출하여 사용자 인증 정보를 소스 기기에 저장합니다. 토큰을 블록 저장소로 저장하면 토큰이 암호화되어 기기에 로컬로 저장됩니다.

다음 샘플은 인증 토큰을 로컬 기기에 저장하는 방법을 보여줍니다.

자바

  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를 사용합니다.

자바

  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에서 토큰을 요청할 수 있습니다. 그러면 검색된 토큰을 사용하여 사용자가 새 기기에서 로그인 상태를 유지하도록 할 수 있습니다.

다음 샘플은 특정 키를 기준으로 여러 토큰을 검색하는 방법을 보여줍니다.

자바

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에 저장된 모든 토큰을 검색하는 방법을 보여주는 예입니다.

자바

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()를 이제 지원 중단했습니다. 바이트 인스턴스에 블록 키를 사용하려면 BlockstoreClient.DEFAULT_BYTES_DATA_KEY 키를 RetrieveBytesRequest 인스턴스에서 사용하여 저장된 데이터를 가져올 수 있습니다.

다음은 기본 키를 가져오는 방법의 예시입니다.

자바

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에서 토큰을 삭제해야 할 수 있습니다.

• 사용자가 로그아웃 사용자 플로우를 진행합니다.
• 토큰이 취소되었거나 잘못되었습니다.

토큰을 가져오는 것과 마찬가지로 삭제해야 하는 키의 배열을 설정하여 삭제해야 하는 토큰을 지정할 수 있습니다.

다음은 특정 키를 삭제하는 예입니다.

자바

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)

모든 토큰 삭제

아래 예에서는 현재 블록 스토어에 저장된 모든 토큰을 삭제합니다.

자바

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

참고: storeBytes가 shouldBackupToCloud 설정 취소되거나 false로 설정된 경우 이전에 클라우드에 백업된 이 기기의 바이트가 다음 정기 동기화 시 클라우드에서 삭제됩니다.

테스트 방법

개발 중에 다음 메서드를 사용하여 복원 흐름을 테스트합니다.

동일 기기 제거/재설치

사용자가 백업 서비스를 사용 설정하면(설정 > Google > 백업에서 확인 가능) 블록 스토어 데이터가 앱 제거/재설치 간에 유지됩니다.

다음 단계에 따라 테스트할 수 있습니다.

1. 테스트 앱에 BlockStore API를 통합합니다.
2. 테스트 앱을 사용하여 블록 스토어 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 클라우드 백업을 수동으로 트리거할 수 있습니다. Settings > Google > Backup으로 이동하여 'Backup Now' 버튼을 클릭하세요.
   1. 블록 스토어 클라우드 백업이 성공했는지 확인하려면 다음을 수행합니다.
      1. 백업이 완료되면 'CloudSyncBpTkSvc' 태그가 있는 로그 줄을 검색합니다.
      2. 다음과 같은 행이 표시됩니다. '......, CloudSyncBpTkSvc: 동기화 결과: SUCCESS, ..., 업로드된 크기: XXX바이트 ...'
   2. Block Store 클라우드 백업 후에는 5분의 '대기' 시간이 발생합니다. 5분 이내에 '지금 백업' 버튼을 클릭해도 다른 블록 스토어 클라우드 백업이 트리거되지 않습니다.
4. 대상 기기를 초기화하고 클라우드 복원 단계를 진행합니다. 복원 흐름 중에 테스트 앱을 복원하려면 선택하세요. 클라우드 복원 흐름에 대한 자세한 내용은 지원되는 클라우드 복원 흐름을 참조하세요.
5. 대상 기기에서 테스트 앱을 사용하여 Blockstore API를 호출하여 데이터를 가져옵니다.
6. 검색된 바이트가 소스 기기에 저장된 바이트와 동일한지 확인합니다.

기기 요구사항

엔드 투 엔드 암호화

• 엔드 투 엔드 암호화는 Android 9 (API 29) 이상을 실행하는 기기에서 지원됩니다.
• 엔드 투 엔드 암호화를 사용 설정하고 사용자 데이터를 올바르게 암호화하려면 기기에 PIN, 패턴 또는 비밀번호로 설정된 화면 잠금이 있어야 합니다.

참고: isEndtoEndEncryptionAvailable()은 이러한 조건 중 하나라도 충족되지 않으면 false를 반환합니다.

기기 간 복원 흐름

기기 간 복원을 사용하려면 소스 기기 및 대상 기기가 필요합니다. 이 두 기기가 데이터를 전송하는 기기입니다.

소스 기기는 Android 6 (API 23) 이상을 실행해야 백업할 수 있습니다.

Android 9 (API 29) 이상을 실행하는 기기를 타겟팅하여 복원할 수 있습니다.

기기에서 기기로의 복구 절차에 대한 자세한 내용은 여기에서 확인할 수 있습니다.

Cloud 백업 및 복원 흐름

클라우드 백업 및 복원에는 소스 기기와 대상 기기가 필요합니다.

소스 기기는 Android 6 (API 23) 이상을 실행해야 백업할 수 있습니다.

대상 기기는 공급업체에 따라 지원됩니다. Pixel 기기는 이 기능을 Android 9 (API 29)에서 사용할 수 있으며 다른 모든 기기는 Android 12 (API 31) 이상을 실행해야 합니다.