Android पर App Check की मदद से, कस्टम बैकएंड संसाधनों को सुरक्षित रखना

App Check का इस्तेमाल करके, अपने ऐप्लिकेशन के लिए Google से बाहर के कस्टम बैकएंड संसाधनों को सुरक्षित रखा जा सकता है. जैसे, खुद होस्ट किया गया बैकएंड. ऐसा करने के लिए, आपको ये दोनों काम करने होंगे:

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

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

अपने ऐप्लिकेशन में App Check जोड़ें. इसके लिए, डिफ़ॉल्ट Play Integrity प्रोवाइडर या कस्टम प्रोवाइडर का इस्तेमाल करें.

बैकएंड अनुरोधों के साथ App Check टोकन भेजना

यह पक्का करने के लिए कि आपके बैकएंड अनुरोधों में मान्य और चालू App Check टोकन शामिल हो, हर अनुरोध को getAppCheckToken() के कॉल में रैप करें. ज़रूरत पड़ने पर, App Check लाइब्रेरी टोकन को रीफ़्रेश करेगी. साथ ही, इस तरीके के सक्सेस लिसनर में टोकन को ऐक्सेस किया जा सकता है.

मान्य टोकन मिलने के बाद, उसे अनुरोध के साथ अपने बैकएंड पर भेजें. यह आप पर निर्भर करता है कि आप इसे कैसे पूरा करते हैं. हालांकि, App Check टोकन को यूआरएल के हिस्से के तौर पर न भेजें. इसमें क्वेरी पैरामीटर भी शामिल हैं. ऐसा करने से, टोकन के गलती से लीक होने और इंटरसेप्ट होने का खतरा बढ़ जाता है. हमारा सुझाव है कि टोकन को कस्टम एचटीटीपी हेडर में भेजें.

उदाहरण के लिए, अगर Retrofit का इस्तेमाल किया जाता है, तो:

Kotlin

class ApiWithAppCheckExample {
    interface YourExampleBackendService {
        @GET("yourExampleEndpoint")
        fun exampleData(
            @Header("X-Firebase-AppCheck") appCheckToken: String,
        ): Call<List<String>>
    }

    var yourExampleBackendService: YourExampleBackendService = Retrofit.Builder()
        .baseUrl("https://yourbackend.example.com/")
        .build()
        .create(YourExampleBackendService::class.java)

    fun callApiExample() {
        Firebase.appCheck.getAppCheckToken(false).addOnSuccessListener { appCheckToken ->
            val token = appCheckToken.token
            val apiCall = yourExampleBackendService.exampleData(token)
            // ...
        }
    }
}

Java

public class ApiWithAppCheckExample {
    private interface YourExampleBackendService {
        @GET("yourExampleEndpoint")
        Call<List<String>> exampleData(
                @Header("X-Firebase-AppCheck") String appCheckToken);
    }

    YourExampleBackendService yourExampleBackendService = new Retrofit.Builder()
            .baseUrl("https://yourbackend.example.com/")
            .build()
            .create(YourExampleBackendService.class);

    public void callApiExample() {
        FirebaseAppCheck.getInstance()
                .getAppCheckToken(false)
                .addOnSuccessListener(new OnSuccessListener<AppCheckToken>() {
                    @Override
                    public void onSuccess(@NonNull AppCheckToken appCheckToken) {
                        String token = appCheckToken.getToken();
                        Call<List<String>> apiCall =
                                yourExampleBackendService.exampleData(token);
                        // ...
                    }
                });
    }
}

रीप्ले प्रोटेक्शन (बीटा वर्शन)

जिस एंडपॉइंट के लिए आपने रीप्ले प्रोटेक्शन चालू किया है उस पर अनुरोध करते समय, अनुरोध को getAppCheckToken() के बजाय getLimitedUseAppCheckToken() के कॉल में रैप करें:

Kotlin

Firebase.appCheck.limitedUseAppCheckToken.addOnSuccessListener {
    // ...
}

Java

FirebaseAppCheck.getInstance()
        .getLimitedUseAppCheckToken().addOnSuccessListener(
                new OnSuccessListener<AppCheckToken>() {
                    @Override
                    public void onSuccess(AppCheckToken appCheckToken) {
                        String token = appCheckToken.getToken();
                        // ...
                    }
                }
        );