Proteggere le risorse non Firebase con App Check su Android

Puoi proteggere le risorse non Firebase della tua app, ad esempio i backend self-hosted, con App Check. A questo scopo, dovrai eseguire entrambe le seguenti operazioni:

  • Modifica il client dell'app in modo da inviare un token App Check insieme a ogni richiesta al tuo backend, come descritto in questa pagina.
  • Modifica il backend in modo da richiedere un token App Check valido con ogni richiesta, come descritto in Verificare i token App Check da un backend personalizzato.

Prima di iniziare

Aggiungi App Check alla tua app utilizzando il provider Play Integrity predefinito o un provider personalizzato.

Inviare token App Check con le richieste di backend

Per assicurarti che le richieste di backend includano un token App Check valido e non scaduto, incapsula ogni richiesta in una chiamata a getAppCheckToken(). La libreria App Check aggiornerà il token, se necessario, e potrai accedervi nell'ascoltatore di eventi di successo del metodo.

Una volta ottenuto un token valido, invialo insieme alla richiesta al tuo backend. Le specifiche su come eseguire questa operazione dipendono da te, ma non inviare i token App Check all'interno degli URL, inclusi nei parametri di query, in quanto ciò li rende vulnerabili a fughe e intercettazioni accidentali. L'approccio consigliato è inviare il token in un'intestazione HTTP personalizzata.

Ad esempio, se utilizzi Retrofit:

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() {
        Firebase.appCheck.getAppCheckToken(false).addOnSuccessListener { appCheckToken ->
            val token = appCheckToken.token
            val apiCall = yourExampleBackendService.exampleData(token)
            // ...
        }
    }
}
ApiWithAppCheckExample.kt

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 appCheckToken) {
                        String token = appCheckToken.getToken();
                        Call<List<String>> apiCall =
                                yourExampleBackendService.exampleData(token);
                        // ...
                    }
                });
    }
}
ApiWithAppCheckExample.java

Protezione da replay (beta)

Quando effettui una richiesta a un endpoint per il quale hai attivato la protezione da replay, assegna alla richiesta una chiamata a getLimitedUseAppCheckToken() anziché a getAppCheckToken():

Kotlin+KTX 

Firebase.appCheck.limitedUseAppCheckToken.addOnSuccessListener {
    // ...
}
ApiWithAppCheckExample.kt

Java 

FirebaseAppCheck.getInstance()
        .getLimitedUseAppCheckToken().addOnSuccessListener(
                new OnSuccessListener<AppCheckToken>() {
                    @Override
                    public void onSuccess(AppCheckToken appCheckToken) {
                        String token = appCheckToken.getToken();
                        // ...
                    }
                }
        );
ApiWithAppCheckExample.java