Firebase is back at Google I/O on May 10! Register now

Inizia a utilizzare App Check con un provider personalizzato su Android

Mantieni tutto organizzato con le raccolte Salva e classifica i contenuti in base alle tue preferenze.

Questa pagina mostra come abilitare App Check in un'app Android, utilizzando il tuo provider App Check personalizzato . Quando abiliti App Check, contribuisci a garantire che solo la tua app possa accedere alle risorse Firebase del tuo progetto.

Se desideri utilizzare App Check con il provider Play Integrity predefinito, consulta Abilitare App Check con Play Integrity su Android .

Prima di iniziare

1. Aggiungi la libreria App Check alla tua app

Nel file Gradle del tuo modulo (a livello di app) (di solito app/build.gradle ), dichiara la dipendenza per la libreria Android App Check:

Kotlin+KTX

dependencies {
    implementation 'com.google.firebase:firebase-appcheck:16.1.2'
}

Java

dependencies {
    implementation 'com.google.firebase:firebase-appcheck:16.1.2'
}

2. Implementare le interfacce di App Check

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

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

Kotlin+KTX

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

    override fun getExpireTimeMillis(): Long {
        return expiration
    }
}

class YourCustomAppCheckProvider : AppCheckProvider {
    val token: Task<AppCheckToken>
        get() {
            // Logic to exchange proof of authenticity for an App Check token.
            // ...

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

            // Create AppCheckToken object.
            val appCheckToken: AppCheckToken =
                    YourCustomAppCheckToken(tokenFromServer, expMillis)

            return appCheckToken!
        }
}

Java

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 {
    @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 * 1000 - 60000;

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

        return appCheckToken;
    }
}

Inoltre, implementa una classe AppCheckProviderFactory che crea istanze della tua implementazione AppCheckProvider :

Kotlin+KTX

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

Java

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

3. Inizializzare App Check

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

Kotlin+KTX

FirebaseApp.initializeApp(/*context=*/ this)
val firebaseAppCheck = FirebaseAppCheck.getInstance()
firebaseAppCheck.installAppCheckProviderFactory(
    YourCustomAppCheckProviderFactory.getInstance())

Java

FirebaseApp.initializeApp(/*context=*/ this);
FirebaseAppCheck firebaseAppCheck = FirebaseAppCheck.getInstance();
firebaseAppCheck.installAppCheckProviderFactory(
    YourCustomAppCheckProviderFactory.getInstance());

Prossimi passi

Dopo aver installato la libreria App Check nella tua app, inizia a distribuire l'app aggiornata ai tuoi utenti.

L'app client aggiornata inizierà a inviare token App Check insieme a ogni richiesta che effettua a Firebase, ma i prodotti Firebase non richiederanno che i token siano validi fino a quando non abiliti l'applicazione nella sezione App Check della console Firebase.

Monitora le metriche e abilita l'applicazione

Prima di abilitare l'applicazione, tuttavia, è necessario assicurarsi che ciò non interrompa gli utenti legittimi esistenti. D'altra parte, se riscontri un utilizzo sospetto delle risorse della tua app, potresti voler abilitare l'applicazione prima.

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

Abilita l'applicazione di App Check

Quando capisci in che modo App Check influenzerà i tuoi utenti e sei pronto a procedere, puoi abilitare l'applicazione di App Check:

Usa App Check negli ambienti di debug

Se, dopo aver registrato la tua app per App Check, vuoi eseguire la tua app 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 crea una build di debug della tua app che utilizza il provider di debug App Check invece di un vero provider di attestazione.

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