Android पर, सेवा देने वाली अपनी पसंद की कंपनी की मदद से, ऐप्लिकेशन की जांच करने की सुविधा का इस्तेमाल शुरू करें

इस पेज पर, Android ऐप्लिकेशन में App Check की सुविधा चालू करने का तरीका बताया गया है. इसके लिए, आपके कस्टम App Check प्रोवाइडर का इस्तेमाल किया जाता है. App Check की सुविधा चालू करने पर, यह पक्का करने में मदद मिलती है कि आपके प्रोजेक्ट के Firebase संसाधनों को सिर्फ़ आपका ऐप्लिकेशन ऐक्सेस कर सके.

अगर आपको App Check को Play Integrity के डिफ़ॉल्ट प्रोवाइडर के साथ इस्तेमाल करना है, तो Android पर Play Integrity के साथ App Check की सुविधा चालू करना लेख पढ़ें.

शुरू करने से पहले

1. अपने ऐप्लिकेशन में App Check लाइब्रेरी जोड़ना

अपने मॉड्यूल (ऐप्लिकेशन-लेवल) की Gradle फ़ाइल (आम तौर पर <project>/<app-module>/build.gradle.kts या <project>/<app-module>/build.gradle) में, Android के लिए App Check लाइब्रेरी की डिपेंडेंसी जोड़ें. हमारा सुझाव है कि लाइब्रेरी के वर्शन को कंट्रोल करने के लिए, Firebase Android BoM का इस्तेमाल करें.

dependencies {
    // Import the BoM for the Firebase platform
    implementation(platform("com.google.firebase:firebase-bom:34.11.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 लाइब्रेरी के साथ काम करने वाले वर्शन का इस्तेमाल करेगा.

(दूसरा तरीका)  BoM का इस्तेमाल किए बिना, 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 टोकन के बदले में, टोकन पाने की आपकी सेवा को भेजता है. App Check SDK टूल, टोकन को कैश मेमोरी में सेव करने की प्रोसेस को मैनेज करता है. इसलिए, अपने लागू करने में हमेशा नया टोकन पाएं 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 की लाइब्रेरी इंस्टॉल हो जाने के बाद, अपडेट किए गए ऐप्लिकेशन को अपने उपयोगकर्ताओं के लिए डिस्ट्रिब्यूट करना शुरू करें.

अपडेट किया गया क्लाइंट ऐप्लिकेशन, Firebase को किए जाने वाले हर अनुरोध के साथ, App Check टोकन भेजना शुरू कर देगा. हालांकि, Firebase प्रॉडक्ट के लिए, टोकन तब तक मान्य नहीं होंगे, जब तक Firebase कंसोल के App Check सेक्शन में, लागू करने की सुविधा चालू नहीं की जाती.

मेट्रिक मॉनिटर करना और लागू करने की सुविधा चालू करना

हालांकि, लागू करने की सुविधा चालू करने से पहले, यह पक्का करें कि ऐसा करने से, आपके मौजूदा असली उपयोगकर्ताओं पर कोई असर न पड़े. दूसरी ओर, अगर आपको अपने ऐप्लिकेशन के संसाधनों का संदिग्ध इस्तेमाल दिख रहा है, तो लागू करने की सुविधा को जल्द ही चालू किया जा सकता है.

यह फ़ैसला लेने के लिए, उन App Check मेट्रिक के लिए सेवाएं देखी जा सकती हैं जिनका इस्तेमाल किया जाता है:

लागू करने की सुविधा चालू करनाApp Check

जब आपको यह पता चल जाए कि App Check का आपके उपयोगकर्ताओं पर क्या असर पड़ेगा और आगे बढ़ने के लिए तैयार हैं, तो App Check को लागू करने की सुविधा चालू की जा सकती है:

डीबग करने वाले एनवायरमेंट में App Check का इस्तेमाल करना

अगर आपने App Check के लिए अपने ऐप्लिकेशन को रजिस्टर कर लिया है और आपको अपने ऐप्लिकेशन को ऐसे एनवायरमेंट में चलाना है जिसे App Check आम तौर पर मान्य नहीं मानता, तो अपने ऐप्लिकेशन का डीबग बिल्ड बनाया जा सकता है. जैसे, डेवलपमेंट के दौरान एम्युलेटर या कंटीन्यूअस इंटिग्रेशन (सीआई) एनवायरमेंट. यह बिल्ड, असली अटेस्टेशन प्रोवाइडर के बजाय, App Check के डीबग प्रोवाइडर का इस्तेमाल करता है.

Android पर डीबग प्रोवाइडर के साथ App Check का इस्तेमाल करना लेख पढ़ें.