Как использовать Проверку приложений для защиты Navigation SDK для Android
Проверка приложений Firebase защищает вызовы платформы Google Карт из вашего приложения, блокируя трафик, поступающий из других источников. Для этого запрашивается оценка подлинности приложения или устройства у поставщика аттестации, например Play Integrity. Интегрировав приложение с App Check, вы защитите его от вредоносных и несанкционированных запросов, а значит и от несанкционированных списаний средств. Кроме того, App Check значительно улучшает отчеты о сбоях в реальном времени в экосистеме приложений для автопарка, что приносит пользу всем водителям, использующим ваше приложение. Подробнее об отчетах о сбоях…
Зачем использовать проверку приложений?
Проверка приложений защищает две области Navigation SDK для Android: основные функции навигации и отчеты о сбоях.
Навигация
Проверка приложений помогает блокировать основные запросы Navigation SDK для Android из вредоносных или неавторизованных источников. Это защищает ваш проект от мошеннического списания средств и исчерпания квот.
Сообщения о сбоях
Мы настоятельно рекомендуем использовать Проверку приложений, если в вашем приложении есть функции сообщения о сбоях в реальном времени и голосования. Включив проверку приложений, вы обеспечите водителей самыми точными маршрутами, учитывающими все отзывы в реальном времени.
Почему Проверка приложений важна для отчетов
- Высокий уровень доверия для перекрытых участков. События, влияющие на маршрут, например перекрытые участки дорог, могут значительно изменить прокладку маршрута для всех водителей. Чтобы защитить карту от потенциального вандализма, спама и неточных сообщений, инфраструктура модерации Google для перекрытых участков полагается на надежные сигналы целостности устройства и целостности приложения.
- Как Проверка приложений подтверждает сообщения. Сообщения и голоса пользователей, отправленные из Navigation SDK для Android, включают токен Проверки приложений. Он используется серверной частью Google для подтверждения легитимности отзыва, что повышает уровень доверия к нему и позволяет оценить его влияние на онлайн-карту.
- Последствия отказа от Проверки приложений. Жалобы, отправленные без действительного токена Проверки приложений, оцениваются по модели с более низким уровнем доверия и могут обрабатываться только как скрытые сигналы. Это значит, что пользователи по-прежнему могут отправлять сообщения и голосовать, но их сообщения с меньшей вероятностью будут видны на карте или повлияют на маршруты других водителей и потребуют дополнительной проверки.
Подходит ли мне Проверка приложений?
Проверка приложений рекомендуется в большинстве случаев, однако она не требуется или не поддерживается в следующих сценариях:
- Частные или экспериментальные приложения. Если ваше приложение недоступно широкой публике, проверка приложений не требуется.
- Взломанные устройства. Рекомендуемые поставщики аттестации не позволяют Navigation SDK для Android работать на ненадежных устройствах, например телефонах с root-доступом или взломанных телефонах. Чтобы обеспечить поддержку таких устройств, разверните стороннего поставщика аттестации.
- Устройства Android без GMS. Для работы Play Integrity API на устройствах Android должны быть установлены сервисы Google для мобильных устройств (GMS). Если вы планируете поддерживать устройства Android без GMS, разверните собственного поставщика аттестации.
Обзор этапов реализации
Чтобы интегрировать приложение с Проверкой приложений, выполните следующие действия:
- Добавьте Firebase в приложение.
- Добавьте библиотеку App Check и инициализируйте App Check.
- Добавьте поставщика токенов. На этом этапе вызывается выбранный вами поставщик аттестации, который проверяет целостность устройства или приложения.
- Инициализируйте Navigation API и App Check API.
- Включите отладку. Это полезно при разработке или в средах непрерывной интеграции.
- Прежде чем включить принудительное применение, отслеживайте запросы приложения. Это позволит вам внедрить Проверку приложений, не мешая пользователям.
Что нужно учитывать при планировании интеграции App Check
- Квоты поставщика аттестации. У рекомендуемого нами поставщика аттестации, Play Integrity, есть дневной лимит вызовов для стандартного уровня использования API. Дополнительную информацию о лимитах на вызовы можно найти на странице Настройка в документации для разработчиков Google Play Integrity.
- Задержка при запуске. В большинстве случаев пользователи не сталкиваются с задержками при обычном использовании, поскольку токены App Check кешируются на устройстве. Система автоматически обновляет токены Проверки приложений в фоновом режиме до истечения срока их действия, чтобы обеспечить бесперебойную работу. Однако если действительный токен Проверки приложений отсутствует, пользователи могут столкнуться с задержкой при запуске приложения. Например, задержка возникает при холодном запуске, когда срок действия токена в кеше истек или токен отсутствует.
- Время жизни токена (TTL). Определяет, в течение какого времени токен Проверки приложений будет действителен, прежде чем его нужно будет обновить. Вы можете задать в консоли Firebase продолжительность от 30 минут до 7 дней. В качестве базового значения рекомендуется использовать 1 час, но SDK автоматически пытается выполнить фоновое обновление примерно через половину времени жизни. Пошаговые инструкции по работе с консолью можно найти в документации по Проверке приложений Firebase.
Интегрируйте приложение с App Check
Требования
- Приложение с Navigation SDK для Android версии 7.9 или более поздней.
- Цифровой отпечаток сертификата SHA-256 для приложения.
- Название пакета приложения.
- Вы должны быть владельцем приложения в консоли Google Cloud.
- Идентификатор проекта приложения из консоли Google Cloud.
Шаг 1. Добавьте Firebase в приложение
Добавьте Firebase в приложение, следуя инструкциям в документации для разработчиков Firebase. Добавьте файл google-services.json в каталог уровня приложения в проекте.
Шаг 2. Добавьте библиотеку App Check и инициализируйте App Check
Добавьте зависимость App Check в файл build.gradle своего приложения:
Groovy (build.gradle)
dependencies { // Import the Firebase BoM implementation platform('com.google.firebase:firebase-bom:34.17.0') // Add the dependency for the App Check library with Play Integrity implementation 'com.google.firebase:firebase-appcheck-playintegrity' }
Инициализируйте Проверку приложений в классе Application или основном действии:
Java
import com.google.firebase.FirebaseApp; import com.google.firebase.appcheck.FirebaseAppCheck; import com.google.firebase.appcheck.playintegrity.PlayIntegrityAppCheckProviderFactory; // Initialize Firebase App FirebaseApp.initializeApp(/* context= */ this); // Initialize App Check FirebaseAppCheck firebaseAppCheck = FirebaseAppCheck.getInstance(); firebaseAppCheck.installAppCheckProviderFactory( PlayIntegrityAppCheckProviderFactory.getInstance());
Kotlin
import com.google.firebase.Firebase import com.google.firebase.appcheck.appCheck import com.google.firebase.appcheck.playintegrity.PlayIntegrityAppCheckProviderFactory import com.google.firebase.initialize // Initialize Firebase App Firebase.initialize(context = this) // Initialize App Check Firebase.appCheck.installAppCheckProviderFactory( PlayIntegrityAppCheckProviderFactory.getInstance(), )
Шаг 3. Добавьте поставщика токенов
Создайте реализацию интерфейса MapsAppCheckTokenProvider. Этот поставщик асинхронно получает токены Проверки приложений Firebase из Firebase App Check и передает их в сетевой стек Navigation SDK для Android с помощью MapsAppCheckTokenCallback:
Java
import com.google.android.gms.maps.MapsAppCheckTokenCallback; import com.google.android.gms.maps.MapsAppCheckTokenProvider; import com.google.firebase.appcheck.FirebaseAppCheck; public class NavigationTokenProvider implements MapsAppCheckTokenProvider { @Override public void fetchToken(MapsAppCheckTokenCallback callback) { FirebaseAppCheck.getInstance() .getAppCheckToken(false) // forcingRefresh = false .addOnSuccessListener( tokenResult -> { String token = tokenResult.getToken(); callback.onSuccess(token); }) .addOnFailureListener( e -> { callback.onFailure(); }); } }
Kotlin
import com.google.android.gms.maps.MapsAppCheckTokenCallback import com.google.android.gms.maps.MapsAppCheckTokenProvider import com.google.firebase.appcheck.FirebaseAppCheck class NavigationTokenProvider : MapsAppCheckTokenProvider { override fun fetchToken(callback: MapsAppCheckTokenCallback) { FirebaseAppCheck.getInstance() .getAppCheckToken(false) .addOnSuccessListener { tokenResult -> callback.onSuccess(tokenResult.token) } .addOnFailureListener { callback.onFailure() } } }
Шаг 4. Инициализируйте Navigation API и App Check API
Инициализируйте Navigation SDK для Android и зарегистрируйте экземпляр поставщика унифицированных токенов с помощью MapsApiSettings.setAppCheckTokenProvider():
Java
import com.google.android.gms.maps.MapsApiSettings; // Register your App Check token provider before initializing Navigation SDK for Android MapsApiSettings.setAppCheckTokenProvider(context, new NavigationTokenProvider());
Kotlin
import com.google.android.gms.maps.MapsApiSettings // Register your App Check token provider before initializing Navigation SDK for Android MapsApiSettings.setAppCheckTokenProvider(context, NavigationTokenProvider())
Шаг 5. Включите отладку (необязательно)
После того как для Navigation SDK для Android будет включена проверка приложений, функции вашего приложения, зависящие от Navigation SDK для Android, не будут работать в симуляторе или в среде непрерывной интеграции (CI), поскольку эти среды не считаются допустимыми устройствами. Чтобы запустить приложение в этих средах во время разработки и тестирования, вам необходимо создать отладочную сборку приложения, которая использует отладочный поставщик App Check вместо поставщика аттестации рабочей версии.
- Добавьте зависимость отладочного поставщика в файл
build.gradleприложения:Groovy (build.gradle)
dependencies { implementation 'com.google.firebase:firebase-appcheck-debug' }
- Настройте Проверку приложений так, чтобы в отладочных сборках использовалась фабрика отладочных поставщиков.
Java
import com.google.firebase.appcheck.debug.DebugAppCheckProviderFactory; import com.google.firebase.appcheck.playintegrity.PlayIntegrityAppCheckProviderFactory; if (BuildConfig.DEBUG) { firebaseAppCheck.installAppCheckProviderFactory( DebugAppCheckProviderFactory.getInstance() ); } else { firebaseAppCheck.installAppCheckProviderFactory( PlayIntegrityAppCheckProviderFactory.getInstance() ); }
Kotlin
import com.google.firebase.Firebase import com.google.firebase.appcheck.appCheck import com.google.firebase.appcheck.debug.DebugAppCheckProviderFactory import com.google.firebase.appcheck.playintegrity.PlayIntegrityAppCheckProviderFactory if (BuildConfig.DEBUG) { Firebase.appCheck.installAppCheckProviderFactory( DebugAppCheckProviderFactory.getInstance(), ) } else { Firebase.appCheck.installAppCheckProviderFactory( PlayIntegrityAppCheckProviderFactory.getInstance(), ) }
- Запустите приложение на эмуляторе или устройстве для отладки. Проверка приложений выведет локальный токен отладки в выходные данные logcat.
- Скопируйте и зарегистрируйте этот токен отладки в консоли Firebase. Подробную информацию можно найти в документации по отладочному поставщику Проверки приложений Firebase.
Шаг 6. Отслеживайте запросы приложения и принимайте меры
Прежде чем включить принудительное применение, отслеживайте запросы приложения, чтобы убедиться, что вы не заблокируете добросовестных пользователей.
- Чтобы посмотреть процент подтвержденного и неподтвержденного трафика, перейдите на экран показателей Проверки приложений в консоли Firebase.
- Когда вы убедитесь, что большая часть трафика проверена и пользователи обновили приложение до версии с Проверкой приложений, включите принудительное применение.
- После этого App Check будет отклонять весь трафик без действительного токена.