Comience a usar App Check con un proveedor personalizado en Android

Esta página le muestra cómo habilitar App Check en una aplicación de Android, utilizando su proveedor de App Check personalizado . Cuando habilita App Check, ayuda a garantizar que solo su aplicación pueda acceder a los recursos de Firebase de su proyecto.

Si desea utilizar App Check con el proveedor predeterminado de Play Integrity, consulte Habilitar App Check con Play Integrity en Android .

Antes de que empieces

• Agregue Firebase a su proyecto de Android si aún no lo ha hecho.

• Implemente la lógica del lado del servidor de su proveedor App Check personalizado .

1. Agregue la biblioteca App Check a su aplicación

En el archivo Gradle de tu módulo (nivel de aplicación) (generalmente app/build.gradle ), declara la dependencia para la biblioteca de Android App Check:

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

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

2. Implementar las interfaces de App Check

Primero, debe crear clases que implementen las interfaces AppCheckProvider y AppCheckProviderFactory .

Su clase AppCheckProvider debe tener un getToken() , que recopila cualquier información que su proveedor de App Check personalizado requiera como prueba de autenticidad y la envía a su servicio de adquisición de tokens a cambio de un token de App Check. El SDK de App Check maneja el almacenamiento en caché de tokens, así que obtenga siempre un nuevo token en su implementación de getToken() .

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!
        }
}

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;
    }
}

Además, implemente una clase AppCheckProviderFactory que cree instancias de su implementación de AppCheckProvider :

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

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

3. Inicializar verificación de aplicaciones

Agregue el siguiente código de inicialización a su aplicación para que se ejecute antes de usar cualquier otro SDK de Firebase:

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

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

Próximos pasos

Una vez que la biblioteca App Check esté instalada en su aplicación, comience a distribuir la aplicación actualizada a sus usuarios.

La aplicación cliente actualizada comenzará a enviar tokens de verificación de aplicaciones junto con cada solicitud que haga a Firebase, pero los productos de Firebase no requerirán que los tokens sean válidos hasta que habilite la aplicación en la sección Verificación de aplicaciones de la consola de Firebase.

Supervise las métricas y habilite la aplicación

Sin embargo, antes de habilitar la aplicación, debe asegurarse de que hacerlo no interrumpa a sus usuarios legítimos existentes. Por otro lado, si observa un uso sospechoso de los recursos de su aplicación, es posible que desee habilitar la aplicación antes.

Para ayudarlo a tomar esta decisión, puede consultar las métricas de App Check para los servicios que utiliza:

• Supervise las métricas de solicitud de verificación de aplicaciones para Realtime Database, Cloud Firestore y Cloud Storage.
• Supervise las métricas de solicitud de App Check para Cloud Functions .

Habilitar la aplicación de verificación de aplicaciones

Cuando comprenda cómo App Check afectará a sus usuarios y esté listo para continuar, puede habilitar la aplicación de App Check:

• Habilite el cumplimiento de App Check para Realtime Database, Cloud Firestore y Cloud Storage.
• Habilite el cumplimiento de App Check para Cloud Functions .

Usar App Check en entornos de depuración

Si, después de haber registrado su aplicación para App Check, desea ejecutar su aplicación en un entorno que App Check normalmente no clasificaría como válido, como un emulador durante el desarrollo o desde un entorno de integración continua (CI), puede cree una compilación de depuración de su aplicación que use el proveedor de depuración de App Check en lugar de un proveedor de atestación real.

Consulte Usar App Check con el proveedor de depuración en Android .