Firebase ML Android 앱의 클라우드 사용자 인증 정보 보호

Android 앱에서 Firebase ML의 Cloud API 중 하나를 사용하는 경우 프로덕션 환경에서 앱을 실행하기 전에 승인되지 않은 API 액세스를 방지하기 위한 몇 가지 추가 조치를 취해야 합니다.

프로덕션 앱의 경우 인증된 클라이언트만 클라우드 서비스에 액세스할 수 있는지 확인합니다. 루팅되지 않은 기기에서만 아래에 설명된 방법으로 인증할 수 있습니다.

그런 다음 테스트와 개발 중에 편리하게 사용할 수 있는 디버그 전용 API 키를 만듭니다.

1. Firebase에 프로덕션 앱 등록

먼저 프로덕션 앱을 Firebase에 등록합니다.

  1. 앱의 SHA-1 서명이 있어야 합니다. 자세한 방법은 클라이언트 인증을 참조하세요.

  2. Firebase Console에서 프로젝트 설정으로 이동한 후 설정 탭을 선택합니다.

  3. 내 앱 카드까지 아래로 스크롤한 다음 Android 앱을 선택합니다.

  4. 앱의 SHA-1 서명을 앱 정보에 추가합니다.

2. API 키 범위 제한

다음으로 Cloud Vision API에 대한 액세스를 허용하지 않도록 기존 API 키를 구성합니다.

  1. Google Cloud 콘솔의 사용자 인증 정보 페이지를 엽니다. 메시지가 표시되면 프로젝트를 선택합니다.

  2. 목록에 있는 기존 API 키마다 편집 화면을 엽니다.

  3. API 제한사항 섹션에서 키 제한을 선택한 다음 API 키로 액세스할 모든 API를 목록에 추가합니다. Cloud Vision API는 포함하지 않아야 합니다.

    API 키의 API 제한사항을 구성하면 키로 액세스할 수 있는 API를 명시적으로 선언하게 됩니다. 기본적으로 API 제한사항 섹션에 키 제한 안함이 선택되어 있으면 프로젝트에 사용 설정된 모든 API 액세스에 API 키를 사용할 수 있습니다.

이제 기존 API 키는 클라우드 ML 서비스에 대한 액세스 권한을 부여하지 않지만 API 제한사항 목록에 추가된 API에서는 각 키가 계속 작동합니다.

향후 추가 API를 사용 설정할 경우 관련 API 키의 API 제한사항 목록에 추가해야 합니다.

3. 디버그 전용 API 키 생성 및 사용

마지막으로 개발용으로만 사용할 새 API 키를 만듭니다. Firebase ML은 에뮬레이터에서 실행할 때와 같이 앱 인증이 불가능한 환경에서 API 키를 사용하여 Google Cloud 서비스에 액세스할 수 있습니다.

  1. 개발에 사용할 새 API 키를 만듭니다.

    1. Google Cloud 콘솔의 사용자 인증 정보 페이지를 엽니다. 메시지가 표시되면 프로젝트를 선택합니다.

    2. 사용자 인증 정보 만들기 > API 키를 클릭하고 새 API 키를 기록합니다. 이 키는 인증되지 않은 앱에서의 API 액세스를 허용하므로 이 키를 기밀로 유지해야 합니다.

  2. 출시된 앱에서 새로운 디버그 API 키가 유출되지 않도록 하려면 디버그 빌드에만 사용되는 Android 매니페스트 파일에 디버그 API 키를 지정합니다.

    1. 디버그 매니페스트가 아직 없으면 파일 > 새로 만들기 > 기타 > Android 매니페스트 파일을 클릭하고 대상 소스 세트에서 debug를 선택하여 하나 만듭니다.

    2. 디버그 매니페스트에 다음 선언을 추가합니다.

      <application>
<meta-data
    android:name="com.firebase.ml.cloud.ApiKeyForDebug"
    android:value="your-debug-api-key" />
</application>

  3. 앱에서 Firebase ML이 인증서의 디지털 지문 일치를 통해 프로덕션 환경에 있는 클라이언트를 인증하고 디버그 빌드에서만 API 키(디버그 키)를 사용하도록 구성합니다.

    Kotlin+KTX 

    val optionsBuilder = FirebaseVisionCloudImageLabelerOptions.Builder()
if (!BuildConfig.DEBUG) {
    // Requires physical, non-rooted device:
    optionsBuilder.enforceCertFingerprintMatch()
}

// Set other options. For example:
optionsBuilder.setConfidenceThreshold(0.8f)
// ...

// And lastly:
val options = optionsBuilder.build()
FirebaseVision.getInstance().getCloudImageLabeler(options).processImage(myImage)
    MainActivity.kt

    Java 

    FirebaseVisionCloudImageLabelerOptions.Builder optionsBuilder =
        new FirebaseVisionCloudImageLabelerOptions.Builder();
if (!BuildConfig.DEBUG) {
    // Requires physical, non-rooted device:
    optionsBuilder.enforceCertFingerprintMatch();
}

// Set other options. For example:
optionsBuilder.setConfidenceThreshold(0.8f);
// ...

// And lastly:
FirebaseVisionCloudImageLabelerOptions options = optionsBuilder.build();
FirebaseVision.getInstance().getCloudImageLabeler(options).processImage(myImage);
    MainActivity.java

다음 단계

다른 Firebase 기능 사용 시 출시할 앱 준비에 대한 내용은 출시 체크리스트를 참조하세요.