Pierwsze kroki ze Sprawdzaniem aplikacji za pomocą Play Integrity na Androidzie

Na tej stronie dowiesz się, jak włączyć App Check w aplikacji na Androida za pomocą wbudowanego dostawcy Play Integrity. Gdy włączysz App Check, będziesz mieć pewność, że tylko Twoja aplikacja może uzyskiwać dostęp do zasobów backendu projektu. Zobacz omówienie tej funkcji.

Dostawca interfejsu Play Integrity API obsługuje aplikacje na Androida opublikowane w Google Play, poza Google Play lub w obu tych miejscach. Jeśli Twój przypadek użycia wymaga funkcji Play Integrity, które nie są zaimplementowane przez App Check, lub jeśli chcesz używać App Check z własnym dostawcą niestandardowym, zapoznaj się z artykułem Implementowanie niestandardowego dostawcy App Check.

1. Konfigurowanie projektu Firebase

  1. Dodaj Firebase do projektu na Androida, jeśli nie korzystasz w nim jeszcze z tej usługi.

  2. Włącz interfejs Play Integrity API:

    1. W Konsoli Google Play wybierz aplikację lub dodaj ją, jeśli jeszcze tego nie zrobiono.

    2. W sekcji Wersja kliknij Integralność aplikacji.

    3. Przejdź do sekcji Play Integrity API na stronie, kliknij Połącz projekt w Google Cloud, a potem wybierz projekt Firebase z listy projektów Google Cloud. Wybrany tutaj projekt musi być tym samym projektem Firebase, w którym rejestrujesz aplikację (patrz następny krok).

  3. Zarejestruj aplikacje, aby korzystać z App Check, u dostawcy Play Integrity w sekcji App Check w konsoli Firebase. Musisz podać odcisk cyfrowy SHA-256 certyfikatu podpisywania aplikacji.

    Zwykle musisz zarejestrować wszystkie aplikacje w projekcie, ponieważ po włączeniu egzekwowania zasad w przypadku usługi Firebase tylko zarejestrowane aplikacje będą mogły uzyskiwać dostęp do zasobów backendu tej usługi.

  4. Opcjonalnie: w ustawieniach rejestracji aplikacji ustaw niestandardowy czas życia danych (TTL) dla tokenów App Check wydawanych przez dostawcę. Możesz ustawić czas życia na dowolną wartość z zakresu od 30 minut do 7 dni. Zmieniając tę wartość, pamiętaj o tych kompromisach:

    • Bezpieczeństwo: krótsze czasy TTL zapewniają większe bezpieczeństwo, ponieważ skracają okres, w którym wyciekły lub przechwycony token może zostać wykorzystany przez atakującego.
    • Wydajność: krótsze czasy TTL oznaczają, że aplikacja będzie częściej przeprowadzać atestowanie. Proces potwierdzania aplikacji za każdym razem, gdy jest wykonywany, zwiększa opóźnienie w przypadku żądań sieciowych, dlatego krótki czas TTL może mieć wpływ na wydajność aplikacji.
    • Limit i koszt: krótsze czasy TTL i częste ponowne potwierdzanie wyczerpują limit szybciej, a w przypadku usług płatnych mogą generować wyższe koszty. Zobacz Limity przydziału i limity systemu.

    Domyślna wartość TTL wynosząca 1 godzinę jest odpowiednia w przypadku większości aplikacji. Pamiętaj, że App Check biblioteka odświeża tokeny mniej więcej w połowie czasu trwania TTL.

Skonfiguruj ustawienia zaawansowane (opcjonalnie)

App Check oferuje szereg ustawień obsługujących zaawansowane przypadki użycia, w tym rozpowszechnianie aplikacji poza Google Play. Te ustawienia możesz skonfigurować w sekcji App Check w konsoli Firebase dla każdej aplikacji na Androida. Zalecamy skonfigurowanie tych ustawień zgodnie z tabelą poniżej podczas pierwszej rejestracji aplikacji.

kanał dystrybucji aplikacji, PLAY_RECOGNIZED LICENSED Minimalny akceptowalny poziom integralności urządzenia
Wyłącznie w Google Play Wymagane Wymagane Nie sprawdzaj wyraźnie poziomu integralności urządzenia
wyłącznie poza Google Play, Niewymagane Niewymagane Integralność urządzenia
W Google Play i poza nim Wymagane Niewymagane Nie sprawdzaj wyraźnie poziomu integralności urządzenia

Szczegóły

Każde ustawienie zaawansowane odpowiada etykiecie wyniku usługi Play Integrity. Więcej informacji znajdziesz w dokumentacji usługi Play Integrity.

  • Domyślnie App Check wymaga etykiety rozpoznawania aplikacji PLAY_RECOGNIZED. Aplikacje, które nie są opublikowane w Google Play, nie kwalifikują się do otrzymania tego oznaczenia.
  • Domyślnie App Check nie wymaga etykiety licencji aplikacji LICENSED. Tę etykietę mogą otrzymać tylko użytkownicy, którzy zainstalowali lub zaktualizowali Twoją aplikację bezpośrednio z Google Play.

  • Domyślnie App Check nie sprawdza bezpośrednio wyniku testu integralności urządzenia. App Check obsługuje wyraźne sprawdzanie tych 3 poziomów integralności urządzenia, wymienionych w kolejności rosnącej integralności.

    • Podstawowa integralność Powoduje, że App Check wymaga etykiety rozpoznawania urządzeniaMEETS_BASIC_INTEGRITY. Aby Twoja aplikacja mogła otrzymać ten opcjonalny tag, musisz najpierw wyrazić zgodę w Konsoli Google Play.

    • Integralność urządzenia. Powoduje, że App Check wymaga etykiety rozpoznawania urządzeniaMEETS_DEVICE_INTEGRITY. Wszystkie aplikacje automatycznie kwalifikują się do otrzymania tej etykiety.

    • Silna integralność. Powoduje, że App Check wymaga etykiety rozpoznawania urządzeniaMEETS_STRONG_INTEGRITY. Aby Twoja aplikacja mogła otrzymać ten opcjonalny tag, musisz najpierw wyrazić zgodę w Konsoli Google Play.

2. Dodawanie biblioteki App Check do aplikacji

W pliku Gradle na poziomie modułu (aplikacji) (zwykle <project>/<app-module>/build.gradle.kts lub<project>/<app-module>/build.gradle) dodaj zależność z biblioteką App Check na Androida. Zalecamy używanie symbolu Firebase Android BoM do kontrolowania wersji biblioteki. 

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

Gdy korzystamy z Firebase Android BoM, aplikacja zawsze używa zgodnych wersji bibliotek Firebase na Androida.

(Alternatywnie)  Dodaj zależności biblioteki Firebase bez użycia BoM

Jeśli nie chcesz używać Firebase BoM, musisz określić wersję każdej biblioteki Firebase w wierszu zależności.

Pamiętaj, że jeśli w aplikacji używasz kilku bibliotek Firebase, zdecydowanie zalecamy używanie BoM do zarządzania wersjami bibliotek, co zapewnia zgodność wszystkich wersji. 

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

3. Zainicjuj App Check

Dodaj do aplikacji poniższy kod inicjalizacji, aby był uruchamiany przed użyciem innych pakietów SDK Firebase:

Kotlin 

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

Java 

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

Dalsze kroki

Po zainstalowaniu biblioteki App Check w aplikacji zacznij rozpowszechniać zaktualizowaną aplikację wśród użytkowników.

Zaktualizowana aplikacja kliencka zacznie wysyłać tokeny App Check wraz z każdym żądaniem wysyłanym do Firebase, ale usługi Firebase nie będą wymagać, aby tokeny były ważne, dopóki nie włączysz egzekwowania w sekcji App Check konsoli Firebase.

Monitorowanie danych i włączanie egzekwowania

Zanim jednak włączysz egzekwowanie, upewnij się, że nie zakłóci to działania obecnych, legalnych użytkowników. Jeśli jednak zauważysz podejrzane wykorzystanie zasobów aplikacji, możesz włączyć egzekwowanie wcześniej.

Aby podjąć decyzję, możesz sprawdzić dane App Check dotyczące usług, z których korzystasz:

Włączanie wymuszania App Check

Gdy zrozumiesz, jak App Check wpłynie na Twoich użytkowników, i będziesz gotowy(-a) do kontynuowania, możesz włączyć egzekwowanie App Check:

Używanie App Check w środowiskach debugowania

Jeśli po zarejestrowaniu aplikacji w App Check chcesz uruchomić ją w środowisku, które App Check zwykle nie klasyfikuje jako prawidłowe, np. w emulatorze podczas programowania lub w środowisku ciągłej integracji (CI), możesz utworzyć wersję debugowania aplikacji, która zamiast prawdziwego dostawcy atestów używa dostawcy debugowania App Check.

Zobacz Korzystanie z App Check z dostawcą debugowania na Androidzie.