Utilizzare App Check con il provider di debug su Android

Se, dopo aver registrato la tua app per App Check, vuoi eseguirla in un ambiente che normalmente App Check non classificherebbe come valido, ad esempio un emulatore durante lo sviluppo o da un ambiente di integrazione continua (CI), puoi creare una build di debug della tua app che utilizza il provider di debug App Check anziché un vero provider di attestazione.

Utilizzare il provider di debug in un emulatore

Per utilizzare il provider di debug durante l'esecuzione dell'app in un emulatore in modo interattivo (ad esempio durante lo sviluppo):

  1. Nel file Gradle (a livello di app) del modulo (di solito <project>/<app-module>/build.gradle.kts o <project>/<app-module>/build.gradle), aggiungi la dipendenza per la libreria App Check per Android. Ti consigliamo di utilizzare Firebase Android BoM per controllare il controllo delle versioni della libreria. 

    dependencies {
    // Import the BoM for the Firebase platform
    implementation(platform("com.google.firebase:firebase-bom:34.0.0"))

    // Add the dependencies for the App Check libraries
    // When using the BoM, you don't specify versions in Firebase library dependencies
    implementation("com.google.firebase:firebase-appcheck-debug")
}

    Utilizzando la Firebase Android BoM, la tua app utilizzerà sempre versioni compatibili delle librerie Firebase Android.

    (Alternativa)  Aggiungi le dipendenze della libreria Firebase senza utilizzare BoM

    Se scegli di non utilizzare la Firebase BoM, devi specificare ogni versione della libreria Firebase nella riga della dipendenza.

    Tieni presente che se utilizzi più librerie Firebase nella tua app, ti consigliamo vivamente di utilizzare la BoM per gestire le versioni delle librerie, in modo da garantire la compatibilità di tutte le versioni. 

    dependencies {
    // Add the dependencies for the App Check libraries
    // When NOT using the BoM, you must specify versions in Firebase library dependencies
    implementation("com.google.firebase:firebase-appcheck-debug:19.0.0")
}

  2. Nella build di debug, configura App Check in modo che utilizzi la factory del provider di debug:

    Kotlin 

    Firebase.initialize(context = this)
Firebase.appCheck.installAppCheckProviderFactory(
    DebugAppCheckProviderFactory.getInstance(),
)
    MainActivity.kt

    Java 

    FirebaseApp.initializeApp(/*context=*/ this);
FirebaseAppCheck firebaseAppCheck = FirebaseAppCheck.getInstance();
firebaseAppCheck.installAppCheckProviderFactory(
        DebugAppCheckProviderFactory.getInstance());
    MainActivity.java

  3. Avvia l'app e attiva una chiamata a un servizio di backend Firebase. Un token di debug locale verrà registrato quando l'SDK tenta di inviare una richiesta al backend. Ad esempio:

    D DebugAppCheckProvider: Enter this debug secret into the allow list in
the Firebase Console for your project: 123a4567-b89c-12d3-e456-789012345678

  4. Nella sezione App Check della console Firebase, scegli Gestisci token di debug dal menu overflow della tua app. Poi, registra il token di debug con cui hai eseguito l'accesso nel passaggio precedente.

    Screenshot della voce di menu Gestisci token di debug

Dopo aver registrato il token, i servizi di backend Firebase lo accetteranno come valido.

Poiché questo token consente l'accesso alle risorse Firebase senza un dispositivo valido, è fondamentale mantenerlo privato. Non eseguirne il commit in un repository pubblico e, se un token registrato viene compromesso, revocalo immediatamente nella console Firebase.

Utilizzare il provider di debug per i test unitari in un ambiente CI

Per utilizzare il provider di debug per il test delle unità in un ambiente di integrazione continua (CI), segui questi passaggi:

  1. Nella sezione App Check della console Firebase, scegli Gestisci token di debug dal menu overflow della tua app. Poi, crea un nuovo token di debug. Ti servirà nel passaggio successivo.

    Poiché questo token consente l'accesso alle risorse Firebase senza un dispositivo valido, è fondamentale che rimanga privato. Non eseguirne il commit in un repository pubblico e, se un token registrato viene compromesso, revocalo immediatamente nella console Firebase.

    Screenshot della voce di menu Gestisci token di debug

  2. Aggiungi il token di debug che hai appena creato all'archivio chiavi sicuro del tuo sistema di integrazione continua (ad esempio, i segreti criptati di GitHub Actions o le variabili criptate di Travis CI).

  3. Se necessario, configura il sistema CI in modo che il token di debug sia disponibile nell'ambiente CI come variabile di ambiente. Assegna alla variabile un nome come APP_CHECK_DEBUG_TOKEN_FROM_CI.

  4. Nel file Gradle (a livello di app) del modulo (di solito <project>/<app-module>/build.gradle.kts o <project>/<app-module>/build.gradle), aggiungi la dipendenza per la libreria App Check per Android. Ti consigliamo di utilizzare Firebase Android BoM per controllare il controllo delle versioni della libreria.

    Kotlin 

    dependencies {
    // Import the BoM for the Firebase platform
    implementation(platform("com.google.firebase:firebase-bom:34.0.0"))

    // Add the dependency for the App Check library
    // When using the BoM, you don't specify versions in Firebase library dependencies
    implementation("com.google.firebase:firebase-appcheck-debug")
}

    Utilizzando la Firebase Android BoM, la tua app utilizzerà sempre versioni compatibili delle librerie Firebase Android.

    (Alternativa)  Aggiungi le dipendenze della libreria Firebase senza utilizzare BoM

    Se scegli di non utilizzare la Firebase BoM, devi specificare ogni versione della libreria Firebase nella riga della dipendenza.

    Tieni presente che se utilizzi più librerie Firebase nella tua app, ti consigliamo vivamente di utilizzare la BoM per gestire le versioni delle librerie, in modo da garantire la compatibilità di tutte le versioni. 

    dependencies {
    // Add the dependency for the App Check library
    // When NOT using the BoM, you must specify versions in Firebase library dependencies
    implementation("com.google.firebase:firebase-appcheck-debug:19.0.0")
}

    Java 

    dependencies {
    // Import the BoM for the Firebase platform
    implementation(platform("com.google.firebase:firebase-bom:34.0.0"))

    // Add the dependency for the App Check library
    // When using the BoM, you don't specify versions in Firebase library dependencies
    implementation("com.google.firebase:firebase-appcheck-debug")
}

    Utilizzando la Firebase Android BoM, la tua app utilizzerà sempre versioni compatibili delle librerie Firebase Android.

    (Alternativa)  Aggiungi le dipendenze della libreria Firebase senza utilizzare BoM

    Se scegli di non utilizzare la Firebase BoM, devi specificare ogni versione della libreria Firebase nella riga della dipendenza.

    Tieni presente che se utilizzi più librerie Firebase nella tua app, ti consigliamo vivamente di utilizzare la BoM per gestire le versioni delle librerie, in modo da garantire la compatibilità di tutte le versioni. 

    dependencies {
    // Add the dependency for the App Check library
    // When NOT using the BoM, you must specify versions in Firebase library dependencies
    implementation("com.google.firebase:firebase-appcheck-debug:19.0.0")
}

  5. Aggiungi quanto segue alla configurazione della variante di build CI:

    testInstrumentationRunnerArguments["firebaseAppCheckDebugSecret"] =
    System.getenv("APP_CHECK_DEBUG_TOKEN_FROM_CI") ?: ""

  6. Nelle classi di test, utilizza DebugAppCheckTestHelper per racchiudere qualsiasi codice che richiede un token App Check:

    Kotlin 

    @RunWith(AndroidJunit4::class)
class MyTests {
    private val debugAppCheckTestHelper =
        DebugAppCheckTestHelper.fromInstrumentationArgs()

    @Test
    fun testWithDefaultApp() {
        debugAppCheckTestHelper.withDebugProvider {
            // Test code that requires a debug AppCheckToken.
        }
    }

    @Test
    fun testWithNonDefaultApp() {
        debugAppCheckTestHelper.withDebugProvider(
            FirebaseApp.getInstance("nonDefaultApp")
        ) {
            // Test code that requires a debug AppCheckToken.
        }
    }
}

    Java 

    @RunWith(AndroidJunit4.class)
public class YourTests {
    private final DebugAppCheckTestHelper debugAppCheckTestHelper =
            DebugAppCheckTestHelper.fromInstrumentationArgs();

    @Test
    public void testWithDefaultApp() {
        debugAppCheckTestHelper.withDebugProvider(() -> {
            // Test code that requires a debug AppCheckToken.
        });
    }

    @Test
    public void testWithNonDefaultApp() {
        debugAppCheckTestHelper.withDebugProvider(
                FirebaseApp.getInstance("nonDefaultApp"),
                () -> {
                    // Test code that requires a debug AppCheckToken.
                });
    }
}

Quando l'app viene eseguita in un ambiente CI, i servizi di backend Firebase accettano il token che invia come valido.