Iniziare a utilizzare App Check con un provider personalizzato su Android

Questa pagina mostra come attivare App Check in un'app per Android utilizzando il tuo fornitore App Check personalizzato. Se attivi App Check, contribuisci ad assicurarti che solo la tua app possa accedere alle risorse Firebase del tuo progetto.

Se vuoi utilizzare App Check con il provider Play Integrity predefinito, consulta Attivare App Check con Play Integrity su Android.

Prima di iniziare

• Aggiungi Firebase al tuo progetto Android, se non lo hai ancora fatto.

• Implementa la logica lato server del tuo provider App Check personalizzato.

1. Aggiungere la raccolta App Check all'app

dependencies {
    // Import the BoM for the Firebase platform
    implementation(platform("com.google.firebase:firebase-bom:33.6.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")
}

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

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:18.0.0")
}

2. Implementa le interfacce App Check

Innanzitutto, devi creare classi che implementino le interfacce AppCheckProvider e AppCheckProviderFactory.

La classe AppCheckProvider deve avere un metodo getToken() che raccoglie tutte le informazioni richieste dal fornitore App Check personalizzato come prova di autenticità e le invia al servizio di acquisizione di token in cambio di un token App Check. L'SDK App Check gestisce la memorizzazione nella cache dei token, quindi ricevi sempre un nuovo token nell'implementazione di getToken().

class YourCustomAppCheckToken(
    private val token: String,
    private val expiration: Long,
) : AppCheckToken() {
    override fun getToken(): String = token
    override fun getExpireTimeMillis(): Long = expiration
}

class YourCustomAppCheckProvider(firebaseApp: FirebaseApp) : AppCheckProvider {
    override fun getToken(): Task<AppCheckToken> {
        // Logic to exchange proof of authenticity for an App Check token and
        //   expiration time.
        // ...

        // Refresh the token early to handle clock skew.
        val expMillis = expirationFromServer * 1000L - 60000L

        // Create AppCheckToken object.
        val appCheckToken: AppCheckToken = YourCustomAppCheckToken(tokenFromServer, expMillis)
        return Tasks.forResult(appCheckToken)
    }
}
CustomProvider.kt

public class YourCustomAppCheckToken extends AppCheckToken {
    private String token;
    private long expiration;

    YourCustomAppCheckToken(String token, long expiration) {
        this.token = token;
        this.expiration = expiration;
    }

    @NonNull
    @Override
    public String getToken() {
        return token;
    }

    @Override
    public long getExpireTimeMillis() {
        return expiration;
    }
}

public class YourCustomAppCheckProvider implements AppCheckProvider {
    public YourCustomAppCheckProvider(FirebaseApp firebaseApp) {
        // ...
    }

    @NonNull
    @Override
    public Task<AppCheckToken> getToken() {
        // Logic to exchange proof of authenticity for an App Check token and
        //   expiration time.
        // ...

        // Refresh the token early to handle clock skew.
        long expMillis = expirationFromServer * 1000L - 60000L;

        // Create AppCheckToken object.
        AppCheckToken appCheckToken =
                new YourCustomAppCheckToken(tokenFromServer, expMillis);

        return Tasks.forResult(appCheckToken);
    }
}
CustomProvider.java

Implementa anche una classe AppCheckProviderFactory che crei istanze della tua implementazione AppCheckProvider:

class YourCustomAppCheckProviderFactory : AppCheckProviderFactory {
    override fun create(firebaseApp: FirebaseApp): AppCheckProvider {
        // Create and return an AppCheckProvider object.
        return YourCustomAppCheckProvider(firebaseApp)
    }
}
CustomProvider.kt

public class YourCustomAppCheckProviderFactory implements AppCheckProviderFactory {
    @NonNull
    @Override
    public AppCheckProvider create(@NonNull FirebaseApp firebaseApp) {
        // Create and return an AppCheckProvider object.
        return new YourCustomAppCheckProvider(firebaseApp);
    }
}
CustomProvider.java

3. Inizializza App Check

Aggiungi il seguente codice di inizializzazione alla tua app in modo che venga eseguito prima di utilizzare qualsiasi altro SDK Firebase:

Firebase.initialize(context)
Firebase.appCheck.installAppCheckProviderFactory(
    YourCustomAppCheckProviderFactory(),
)
CustomProvider.kt

FirebaseApp.initializeApp(/*context=*/ context);
FirebaseAppCheck firebaseAppCheck = FirebaseAppCheck.getInstance();
firebaseAppCheck.installAppCheckProviderFactory(
        new YourCustomAppCheckProviderFactory());
CustomProvider.java

Passaggi successivi

Una volta installata la libreria App Check nella tua app, inizia a distribuire l'app aggiornata agli utenti.

L'app client aggiornata inizierà a inviare token App Check con ogni richiesta inviata a Firebase, ma i prodotti Firebase non richiederanno che i token siano validi finché non attivi l'applicazione forzata nella sezione App Check della Console Firebase.

Monitorare le metriche e abilitare l'applicazione delle norme

Tuttavia, prima di attivare l'applicazione, devi assicurarti che questa operazione non causi interruzioni per gli utenti legittimi esistenti. D'altra parte, se noti un uso sospetto delle risorse della tua app, ti consigliamo di attivare l'applicazione delle norme in precedenza.

Per aiutarti a prendere questa decisione, puoi esaminare le metriche App Check per i servizi che utilizzi:

• Monitora le metriche delle richieste App Check per Realtime Database, Cloud Firestore, Cloud Storage, Authentication (beta) e Vertex AI in Firebase.
• Monitora le metriche delle richieste App Check per Cloud Functions.

Attivare l'applicazione di App Check

Una volta compreso l'impatto di App Check sui tuoi utenti e quando è tutto pronto per procedere, puoi attivare l'applicazione di App Check:

• Abilita l'applicazione di App Check per Realtime Database, Cloud Firestore, Cloud Storage, Authentication (beta) e Vertex AI in Firebase.
• Attiva l'applicazione forzata di App Check per Cloud Functions.

Utilizzare App Check in ambienti di debug

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

Vedi Utilizzare App Check con il provider di debug su Android.