بدء استخدام ميزة "التحقّق من التطبيقات" مع مقدّم خدمة مخصّص على Android

تعرض هذه الصفحة كيفية تفعيل ميزة App Check في تطبيق Android باستخدام موفّر مخصّص لميزة App Check. عند تفعيل App Check، يمكنك المساعدة في ضمان إمكانية وصول تطبيقك فقط إلى موارد Firebase الخاصة بمشروعك.

إذا أردت استخدام App Check مع موفّر Play Integrity التلقائي، يمكنك الاطّلاع على مقالة تفعيل App Check باستخدام Play Integrity على Android.

قبل البدء

1. أضِف مكتبة App Check إلى تطبيقك

في ملف Gradle للوحدة (على مستوى التطبيق) (عادةً <project>/<app-module>/build.gradle.kts أو <project>/<app-module>/build.gradle)، أضِف التبعية لمكتبة App Check لنظام التشغيل Android. ننصحك باستخدام الـ Firebase Android BoM للتحكّم في تحديد إصدار المكتبة. 

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

باستخدام Firebase Android BoM، سيستخدم تطبيقك دائمًا إصدارات متوافقة من مكتبات Firebase Android.

(بديل)  إضافة تبعيات مكتبة Firebase بدون استخدام BoM

إذا اخترت عدم استخدام Firebase BoM، عليك تحديد إصدار كل مكتبة من مكتبات Firebase في سطر التبعية الخاص بها.

يُرجى العِلم أنّه إذا كنت تستخدم عدة مكتبات من مكتبات Firebase في تطبيقك، ننصحك بشدة باستخدام BoM لإدارة إصدارات المكتبات، ما يضمن توافق جميع الإصدارات. 

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

2. تنفيذ واجهات App Check

أولاً، عليك إنشاء فئتَين تنفّذان واجهتَي AppCheckProvider و AppCheckProviderFactory.

يجب أن تتضمّن فئة AppCheckProvider طريقة getToken() التي تجمع أي معلومات يطلبها موفّر ميزة App Check المخصّص كدليل على المصداقية، وترسلها إلى خدمة الحصول على الرموز المميزة مقابل رمز مميّز لميزة App Check. تتولّى حزمة تطوير البرامج (SDK) لميزة App Check تخزين الرموز المميزة مؤقتًا، لذا احصل دائمًا على رمز مميّز جديد في عملية تنفيذ getToken().

Kotlin 

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

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

نفِّذ أيضًا فئة AppCheckProviderFactory التي تنشئ مثيلات لتنفيذ AppCheckProvider لديك:

Kotlin 

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

Java 

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

3. تهيئة App Check

أضِف رمز التهيئة التالي إلى تطبيقك بحيث يتم تشغيله قبل استخدام أيّ من حِزم Firebase SDK الأخرى:

Kotlin 

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

Java 

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

الخطوات التالية

بعد تثبيت مكتبة App Check في تطبيقك، ابدأ بتوزيع التطبيق المعدَّل على المستخدمين.

سيبدأ تطبيق العميل المعدَّل بإرسال App Check رموز مميّزة مع كل طلب يرسله إلى Firebase، ولكن لن تتطلّب منتجات Firebase أن تكون الرموز المميزة صالحة إلى أن تفعِّل ميزة "التحقّق من التطبيق" في قسم App Check في وحدة تحكُّم Firebase.

مراقبة المقاييس وتفعيل ميزة "التحقّق من التطبيق"

قبل تفعيل ميزة "التحقّق من التطبيق"، عليك التأكّد من أنّ تفعيلها لن يؤدي إلى إيقاف المستخدمين الحاليين الشرعيين. من ناحية أخرى، إذا كنت تلاحظ استخدامًا مشبوهًا لموارد تطبيقك، قد تحتاج إلى تفعيل ميزة "التحقّق من التطبيق" في وقت أقرب.

للمساعدة في اتّخاذ هذا القرار، يمكنك الاطّلاع على App Check مقاييس للـ خدمات التي تستخدمها:

تفعيل ميزة "التحقّق من التطبيق" App Check

عند فهم تأثير App Check على المستخدمين والاستعداد للمتابعة، يمكنك تفعيل ميزة App Check:

استخدام App Check في بيئات تصحيح الأخطاء

إذا أردت تشغيل تطبيقك في بيئة لا تصنّفها ميزة App Check عادةً على أنّها صالحة، مثل المحاكي أثناء التطوير أو من بيئة التكامل المستمر (CI)، يمكنك إنشاء إصدار مخصص لتصحيح الأخطاء من تطبيقك يستخدم موفّر تصحيح الأخطاء لميزة App Check بدلاً من موفّر إثبات حقيقي، وذلك بعد تسجيل تطبيقك في ميزة App Check.

يمكنك الاطّلاع على مقالة استخدام App Check مع موفّر تصحيح الأخطاء على Android.