Android-এ ডিবাগ প্রোভাইডারের সাথে App Check ব্যবহার করা

কোনও ব্যাকএন্ড পরিষেবার জন্য App Check এনফোর্স করার পরে, আপনার অ্যাপের যেসব ফিচার সেই ব্যাকএন্ড পরিষেবার উপর নির্ভর করে, সেগুলি এমুলেটর বা কন্টিনিউয়াস ইন্টিগ্রেশন (CI) এনভায়রনমেন্টে রান করবে না, কারণ এইসব এনভায়রনমেন্ট বৈধ ডিভাইস হিসেবে যোগ্যতা অর্জন করে না। ডেভেলপমেন্ট ও টেস্টিংয়ের সময় এইসব এনভায়রনমেন্টে আপনার অ্যাপ রান করতে, আপনাকে অ্যাপের একটি ডিবাগ বিল্ড তৈরি করতে হবে যা প্রোডাকশন অ্যাটেস্টেশন প্রোভাইডারের পরিবর্তে App Check ডিবাগ প্রোভাইডার ব্যবহার করে।

এমুলেটরে ডিবাগ প্রোভাইডার ব্যবহার করা

এমুলেটরে ইন্টার‍্যাক্টিভভাবে আপনার অ্যাপ চালানোর সময় (যেমন, লোকাল ডেভেলপমেন্টের সময়) ডিবাগ প্রোভাইডার কীভাবে ব্যবহার করবেন তা এখানে দেওয়া হল:

  1. আপনার মডিউল (অ্যাপ-লেভেল) 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:35.0.2"))
    
        // Add the dependencies for the App Check libraries
        // When using the BoM, you don't specify versions in Firebase library dependencies
        implementation("com.google.firebase:firebase-appcheck-debug")
    }

    Firebase Android BoM ব্যবহার করার মাধ্যমে, আপনার অ্যাপ সবসময় Firebase Android লাইব্রেরির মানানসই ভার্সন ব্যবহার করবে।

    (বিকল্প)  BoM ব্যবহার না করে Firebase লাইব্রেরি ডিপেন্ডেন্সি যোগ করুন

    আপনি যদি Firebase BoM ব্যবহার না করার সিদ্ধান্ত নেন, তাহলে আপনাকে অবশ্যই প্রতিটি Firebase লাইব্রেরি ভার্সন এর ডিপেন্ডেন্সি লাইনে উল্লেখ করতে হবে।

    মনে রাখবেন, আপনার অ্যাপে একাধিক Firebase লাইব্রেরি ব্যবহার করলে, লাইব্রেরি ভার্সন ম্যানেজ করার জন্য আমরা BoM ব্যবহার করার জন্য বিশেষভাবে সাজেস্ট করি, যা নিশ্চিত করে যে সব ভার্সন মানানসই।

    dependencies {
        // Add the dependencies for the App Check libraries
        // When NOT using the BoM, you must specify versions in Firebase library dependencies
        implementation("com.google.firebase:firebase-appcheck-debug:20.0.0")
    }

  2. আপনার ডিবাগ বিল্ডে, ডিবাগ প্রোভাইডার ফ্যাক্টরি ব্যবহার করতে App Check কনফিগার করুন:

    Kotlin

    Firebase.initialize(context = this)
    Firebase.appCheck.installAppCheckProviderFactory(
        DebugAppCheckProviderFactory.getInstance(),
    )

    Java

    FirebaseApp.initializeApp(/*context=*/ this);
    FirebaseAppCheck firebaseAppCheck = FirebaseAppCheck.getInstance();
    firebaseAppCheck.installAppCheckProviderFactory(
            DebugAppCheckProviderFactory.getInstance());
  3. আপনার ডিবাগ টোকেন পান:

    1. এমুলেটরে বা আপনার টেস্ট ডিভাইসে অ্যাপ রান করুন।

    2. আপনার লগে App Check ডিবাগ টোকেন খুঁজুন। যেমন:

      D DebugAppCheckProvider: Enter this debug secret into the allow list
      in the Firebase Console for your project: 123a4567-b89c-12d3-e456-789012345678
      
    3. টোকেন কপি করুন (যেমন, 123a4567-b89c-12d3-e456-789012345678)।

  4. App Check-এর সাথে আপনার ডিবাগ টোকেন রেজিস্টার করুন:

    1. Firebase কনসোলে, নিরাপত্তা > App Check > অ্যাপ ট্যাব বিকল্পে যান।

    2. আপনার অ্যাপ খুঁজে নিন, তিন-ডট ওভারফ্লো মেনুতে () ক্লিক করুন এবং তারপরে ডিবাগ টোকেন ম্যানেজ করুন বিকল্প বেছে নিন।

    3. আপনার ডিবাগ টোকেন রেজিস্টার করতে অন-স্ক্রিন নির্দেশাবলী অনুসরণ করুন।

    Firebase কনসোলে 'ডিবাগ টোকেন ম্যানেজ করুন' মেনু আইটেমের স্ক্রিনশট

App Check-এর মাধ্যমে টোকেন রেজিস্টার করার পরে, আপনার ব্যাকএন্ড পরিষেবা এটিকে সঠিক হিসেবে গ্রহণ করবে।

এই টোকেনটি কোনও বৈধ ডিভাইস ছাড়াই আপনার ব্যাকএন্ড পরিষেবাগুলিতে অ্যাক্সেসের অনুমতি দেয়, তাই এটি গোপন রাখা অত্যন্ত গুরুত্বপূর্ণ। এটি কোনও পাবলিক রিপোজিটরিতে কমিট করবেন না বা আপনার অ্যাপের প্রোডাকশন বিল্ডে শিপ করবেন না। কোনও রেজিস্টার করা টোকেন কখনও কম্প্রোমাইজ হলে, Firebase কনসোলে ডিবাগ টোকেন ম্যানেজ করুন বিকল্প ব্যবহার করে অবিলম্বে এটি মুছে দিন।

CI এনভায়রনমেন্টে ইউনিট টেস্ট করার জন্য ডিবাগ প্রোভাইডার ব্যবহার করা

কন্টিনিউয়াস ইন্টিগ্রেশন (CI) এনভায়রনমেন্টে ইউনিট টেস্টিংয়ের জন্য ডিবাগ প্রোভাইডার কীভাবে ব্যবহার করবেন তা এখানে দেওয়া হল:

  1. Firebase কনসোলে, একটি ডিবাগ টোকেন তৈরি করুন:

    1. Firebase কনসোলে, নিরাপত্তা > App Check > অ্যাপ ট্যাব বিকল্পে যান।

    2. আপনার অ্যাপ খুঁজে নিন, তিন-ডট ওভারফ্লো মেনুতে () ক্লিক করুন এবং তারপরে ডিবাগ টোকেন ম্যানেজ করুন বিকল্প বেছে নিন।

    3. নতুন ডিবাগ টোকেন তৈরি করতে অন-স্ক্রিন নির্দেশাবলী অনুসরণ করুন।

    এই টোকেনটি কোনও বৈধ ডিভাইস ছাড়াই আপনার ব্যাকএন্ড পরিষেবাগুলিতে অ্যাক্সেসের অনুমতি দেয়, তাই এটি গোপন রাখা অত্যন্ত গুরুত্বপূর্ণ। এটি কোনও পাবলিক রিপোজিটরিতে কমিট করবেন না বা আপনার অ্যাপের প্রোডাকশন বিল্ডে শিপ করবেন না। কোনও রেজিস্টার করা টোকেন কখনও কম্প্রোমাইজ হলে, Firebase কনসোলে ডিবাগ টোকেন ম্যানেজ করুন বিকল্প ব্যবহার করে অবিলম্বে এটি মুছে দিন।

    'ডিবাগ টোকেন ম্যানেজ করুন' মেনু আইটেমের স্ক্রিনশট

  2. আপনার CI সিস্টেমের সুরক্ষিত কী স্টোরে এইমাত্র তৈরি করা ডিবাগ টোকেন যোগ করুন (যেমন, GitHub অ্যাকশনের এনক্রিপ্ট করা সিক্রেট বা Travis CI-এর এনক্রিপ্ট করা ভেরিয়েবল)।

  3. প্রয়োজন হলে, CI এনভায়রনমেন্টে এনভায়রনমেন্ট ভেরিয়েবল হিসেবে আপনার ডিবাগ টোকেন উপলভ্য করতে CI সিস্টেম কনফিগার করুন। ভেরিয়েবলের নাম দিন যেমন APP_CHECK_DEBUG_TOKEN_FROM_CI।

  4. আপনার মডিউল (অ্যাপ-লেভেল) Gradle ফাইলে (সাধারণত <project>/<app-module>/build.gradle.kts বা <project>/<app-module>/build.gradle), Android-এর জন্য App Check লাইব্রেরির ডিপেন্ডেন্সি যোগ করুন। লাইব্রেরি ভার্সনিং নিয়ন্ত্রণ করতে আমরা Firebase Android BoM ব্যবহার করার সাজেশন দিই।

    Kotlin

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

    Firebase Android BoM ব্যবহার করার মাধ্যমে, আপনার অ্যাপ সবসময় Firebase Android লাইব্রেরির মানানসই ভার্সন ব্যবহার করবে।

    (বিকল্প)  BoM ব্যবহার না করে Firebase লাইব্রেরি ডিপেন্ডেন্সি যোগ করুন

    আপনি যদি 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-debug:20.0.0")
    }

    Java

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

    Firebase Android BoM ব্যবহার করার মাধ্যমে, আপনার অ্যাপ সবসময় Firebase Android লাইব্রেরির মানানসই ভার্সন ব্যবহার করবে।

    (বিকল্প)  BoM ব্যবহার না করে Firebase লাইব্রেরি ডিপেন্ডেন্সি যোগ করুন

    আপনি যদি 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-debug:20.0.0")
    }

  5. আপনার CI বিল্ড ভেরিয়েন্টের কনফিগারেশনে নিম্নলিখিতগুলি যোগ করুন:

    testInstrumentationRunnerArguments["firebaseAppCheckDebugSecret"] =
        System.getenv("APP_CHECK_DEBUG_TOKEN_FROM_CI") ?: ""
    
  6. আপনার টেস্ট ক্লাসে, App Check টোকেন প্রয়োজন এমন যেকোনও কোড র‌্যাপ করতে DebugAppCheckTestHelper ব্যবহার করুন:

    Kotlin

    @RunWith(AndroidJunit4::class)
    class MyTests {
        private val debugAppCheckTestHelper =
            DebugAppCheckTestHelper.fromInstrumentationArgs()
    
        @Test
        fun testWithDefaultApp() {
            debugAppCheckTestHelper.withDebugProvider {
                // Test code that requires a debug AppCheckToken.
            }
        }
    
        @Test
        fun testWithNonDefaultApp() {
            debugAppCheckTestHelper.withDebugProvider(
                FirebaseApp.getInstance("nonDefaultApp")
            ) {
                // Test code that requires a debug AppCheckToken.
            }
        }
    }
    

    Java

    @RunWith(AndroidJunit4.class)
    public class YourTests {
        private final DebugAppCheckTestHelper debugAppCheckTestHelper =
                DebugAppCheckTestHelper.fromInstrumentationArgs();
    
        @Test
        public void testWithDefaultApp() {
            debugAppCheckTestHelper.withDebugProvider(() -> {
                // Test code that requires a debug AppCheckToken.
            });
        }
    
        @Test
        public void testWithNonDefaultApp() {
            debugAppCheckTestHelper.withDebugProvider(
                    FirebaseApp.getInstance("nonDefaultApp"),
                    () -> {
                        // Test code that requires a debug AppCheckToken.
                    });
        }
    }
    

আপনার অ্যাপ CI এনভায়রনমেন্টে রান করলে, আপনার ব্যাকএন্ড পরিষেবা এটি যে টোকেন পাঠায় সেটি বৈধ হিসেবে গ্রহণ করবে।