توضح لك هذه الصفحة كيفية تفعيل App Check في تطبيق Android، باستخدام موفِّر App Check مخصّص عند تفعيل App Check، أنت تساعد على ضمان وصول تطبيقك فقط إلى موارد Firebase لمشروعك.
إذا أردت استخدام "App Check" مع موفِّر Play Integrity التلقائي، يُرجى الاطّلاع على تفعيل "App Check" باستخدام Play Integrity على جهاز Android
قبل البدء
أضِف منصة Firebase إلى مشروع 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:33.2.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، سيستخدم تطبيقك دائمًا إصدارات متوافقة من مكتبات Android في Firebase.
(الطريقة البديلة) إضافة اعتماديات مكتبة 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:18.0.0") }
2- تنفيذ واجهات App Check
عليك أولاً إنشاء صفوف تنفّذ AppCheckProvider
AppCheckProviderFactory
واجهة.
يجب أن يستخدم صف AppCheckProvider
طريقة getToken()
التي تجمع
المعلومات التي يحتاجها موفِّر خدمة App Check المخصص كإثبات
ويرسلها إلى خدمة الحصول على الرموز المميزة مقابل
الرمز المميّز لـ "App Check" تعالج حزمة تطوير البرامج (SDK) "App Check" التخزين المؤقت للرموز المميّزة، لذا ننصحك دائمًا
رمز مميز جديد في عملية تنفيذ getToken()
.
Kotlin+KTX
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+KTX
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
أضِف رمز الإعداد التالي إلى تطبيقك ليتم تشغيله قبل استخدامه أي حِزم تطوير برامج (SDK) أخرى لمنصّة Firebase:
Kotlin+KTX
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 لحساب Realtime Database وCloud Firestore وCloud Storage وAuthentication (إصدار تجريبي).
- مراقبة مقاييس طلب App Check في Cloud Functions.
تفعيل فرض App Check
عندما تفهم تأثير App Check في المستخدمين وتكون مستعدًا لذلك المتابعة، يمكنك تفعيل تنفيذ سياسة App Check:
- تفعيل فرض App Check في Realtime Database وCloud Firestore وCloud Storage وAuthentication (إصدار تجريبي).
- تفعيل فرض App Check في Cloud Functions.
استخدام App Check في بيئات تصحيح الأخطاء
بعد تسجيل تطبيقك لـ App Check، إذا أردت تشغيل في بيئة لا يصنفها App Check عادةً على أنها صالحة، مثل المحاكي أثناء التطوير، أو من عمليات التكامل المستمر (CI) يمكنك إنشاء إصدار لتصحيح أخطاء تطبيقك يستخدم موفِّر خدمة تصحيح الأخطاء App Check بدلاً من موفر مصادقة حقيقي.
راجِع استخدام App Check مع موفِّر تصحيح الأخطاء على نظام التشغيل Android.