AndroidのアプリチェックでFirebase以外のリソースを保護する

App Checkを使用すると、セルフホストバックエンドなどのアプリのFirebase以外のリソースを保護できます。これを行うには、次の両方を行う必要があります。

  • このページで説明されているように、アプリクライアントを変更して、各リクエストとともにアプリチェックトークンをバックエンドに送信します。
  • カスタムバックエンドからのアプリチェックトークンの確認で説明されているように、リクエストごとに有効なアプリチェックトークンを要求するようにバックエンドを変更します。

あなたが始める前に

デフォルトのPlayIntegrityプロバイダーまたはカスタムプロバイダーのいずれかを使用して、アプリにアプリチェックを追加します。

バックエンドリクエストでアプリチェックトークンを送信する

バックエンドリクエストに有効な有効期限の切れていないアプリチェックトークンが含まれていることを確認するには、 getAppCheckToken()の呼び出しで各リクエストをラップします。 App Checkライブラリは必要に応じてトークンを更新し、メソッドの成功リスナーでトークンにアクセスできます。

有効なトークンを取得したら、リクエストと一緒にバックエンドに送信します。これを実現する方法の詳細はあなた次第ですが、アプリチェックトークンをURLの一部として、クエリパラメータを含めて送信しないでください。これにより、偶発的なリークや傍受に対して脆弱になります。推奨されるアプローチは、カスタムHTTPヘッダーでトークンを送信することです。

たとえば、レトロフィットを使用する場合：

Java

public class ApiWithAppCheckExample {
    private interface YourExampleBackendService {
        @GET("yourExampleEndpoint")
        Call<List<String>> exampleData(
                @Header("X-Firebase-AppCheck") String appCheckToken);
    }

    YourExampleBackendService yourExampleBackendService = new Retrofit.Builder()
            .baseUrl("https://yourbackend.example.com/")
            .build()
            .create(YourExampleBackendService.class);

    public void callApiExample() {
        FirebaseAppCheck.getInstance()
                .getAppCheckToken(false)
                .addOnSuccessListener(new OnSuccessListener<AppCheckToken>() {
                    @Override
                    public void onSuccess(@NonNull AppCheckToken tokenResponse) {
                        String appCheckToken = tokenResponse.getToken();
                        Call<List<String>> apiCall =
                                yourExampleBackendService.exampleData(appCheckToken);
                        // ...
                    }
                });
    }
}

Kotlin+KTX

class ApiWithAppCheckExample {
    interface YourExampleBackendService {
        @GET("yourExampleEndpoint")
        fun exampleData(
            @Header("X-Firebase-AppCheck") appCheckToken: String
        ): Call<List<String>>
    }

    var yourExampleBackendService: YourExampleBackendService = Retrofit.Builder()
        .baseUrl("https://yourbackend.example.com/")
        .build()
        .create(YourExampleBackendService::class.java)

    fun callApiExample() {
        FirebaseAppCheck.getInstance()
            .getAppCheckToken(false)
            .addOnSuccessListener { tokenResponse ->
                val appCheckToken = tokenResponse.token
                val apiCall = yourExampleBackendService.exampleData(appCheckToken)
                // ...
            }
    }
}