यह पृष्ठ आपको दिखाता है कि अपने कस्टम ऐप चेक प्रदाता का उपयोग करके एंड्रॉइड ऐप में ऐप चेक कैसे सक्षम करें। जब आप ऐप चेक सक्षम करते हैं, तो आप यह सुनिश्चित करने में मदद करते हैं कि केवल आपका ऐप ही आपके प्रोजेक्ट के फायरबेस संसाधनों तक पहुंच सकता है।
यदि आप डिफ़ॉल्ट प्ले इंटीग्रिटी प्रदाता के साथ ऐप चेक का उपयोग करना चाहते हैं, तो एंड्रॉइड पर प्ले इंटीग्रिटी के साथ ऐप चेक सक्षम करें देखें।
शुरू करने से पहले
यदि आपने पहले से ऐसा नहीं किया है तो अपने Android प्रोजेक्ट में Firebase जोड़ें ।
अपने कस्टम ऐप चेक प्रदाता के सर्वर-साइड लॉजिक को लागू करें ।
1. अपने ऐप में ऐप चेक लाइब्रेरी जोड़ें
अपने मॉड्यूल (ऐप-स्तर) ग्रैडल फ़ाइल में (आमतौर पर<project>/<app-module>/build.gradle.kts
या <project>/<app-module>/build.gradle
), ऐप चेक के लिए निर्भरता जोड़ें एंड्रॉइड लाइब्रेरी. हम लाइब्रेरी वर्जनिंग को नियंत्रित करने के लिए फायरबेस एंड्रॉइड BoM का उपयोग करने की सलाह देते हैं। Kotlin+KTX
dependencies { // Import the BoM for the Firebase platform implementation(platform("com.google.firebase:firebase-bom:32.3.1")) // 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-ktx") }
फायरबेस एंड्रॉइड बीओएम का उपयोग करके, आपका ऐप हमेशा फायरबेस एंड्रॉइड लाइब्रेरी के संगत संस्करणों का उपयोग करेगा।
(वैकल्पिक) BoM का उपयोग किए बिना फायरबेस लाइब्रेरी निर्भरताएँ जोड़ें
यदि आप फायरबेस बीओएम का उपयोग नहीं करना चुनते हैं, तो आपको प्रत्येक फायरबेस लाइब्रेरी संस्करण को उसकी निर्भरता पंक्ति में निर्दिष्ट करना होगा।
ध्यान दें कि यदि आप अपने ऐप में एकाधिक फायरबेस लाइब्रेरी का उपयोग करते हैं, तो हम लाइब्रेरी संस्करणों को प्रबंधित करने के लिए 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-ktx:17.0.1") }
Java
dependencies { // Import the BoM for the Firebase platform implementation(platform("com.google.firebase:firebase-bom:32.3.1")) // 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") }
फायरबेस एंड्रॉइड बीओएम का उपयोग करके, आपका ऐप हमेशा फायरबेस एंड्रॉइड लाइब्रेरी के संगत संस्करणों का उपयोग करेगा।
(वैकल्पिक) BoM का उपयोग किए बिना फायरबेस लाइब्रेरी निर्भरताएँ जोड़ें
यदि आप फायरबेस बीओएम का उपयोग नहीं करना चुनते हैं, तो आपको प्रत्येक फायरबेस लाइब्रेरी संस्करण को उसकी निर्भरता पंक्ति में निर्दिष्ट करना होगा।
ध्यान दें कि यदि आप अपने ऐप में एकाधिक फायरबेस लाइब्रेरी का उपयोग करते हैं, तो हम लाइब्रेरी संस्करणों को प्रबंधित करने के लिए 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:17.0.1") }
2. ऐप चेक इंटरफेस लागू करें
सबसे पहले, आपको ऐसी कक्षाएं बनाने की आवश्यकता है जो AppCheckProvider
और AppCheckProviderFactory
इंटरफेस को लागू करें।
आपके AppCheckProvider
वर्ग में एक getToken()
विधि होनी चाहिए, जो आपके कस्टम ऐप चेक प्रदाता को प्रामाणिकता के प्रमाण के रूप में आवश्यक सभी जानकारी एकत्र करती है, और ऐप चेक टोकन के बदले में इसे आपकी टोकन अधिग्रहण सेवा में भेजती है। ऐप चेक एसडीके टोकन कैशिंग को संभालता है, इसलिए 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. ऐप चेक आरंभ करें
अपने ऐप में निम्नलिखित आरंभीकरण कोड जोड़ें ताकि यह आपके द्वारा किसी अन्य फायरबेस एसडीके का उपयोग करने से पहले चले:
Kotlin+KTX
Firebase.initialize(context) Firebase.appCheck.installAppCheckProviderFactory( YourCustomAppCheckProviderFactory(), )
Java
FirebaseApp.initializeApp(/*context=*/ context); FirebaseAppCheck firebaseAppCheck = FirebaseAppCheck.getInstance(); firebaseAppCheck.installAppCheckProviderFactory( new YourCustomAppCheckProviderFactory());
अगले कदम
एक बार जब आपके ऐप में ऐप चेक लाइब्रेरी इंस्टॉल हो जाए, तो अपने उपयोगकर्ताओं को अपडेटेड ऐप वितरित करना शुरू करें।
अपडेट किया गया क्लाइंट ऐप फायरबेस को किए गए प्रत्येक अनुरोध के साथ ऐप चेक टोकन भेजना शुरू कर देगा, लेकिन जब तक आप फायरबेस कंसोल के ऐप चेक अनुभाग में प्रवर्तन सक्षम नहीं करते हैं, तब तक फायरबेस उत्पादों को टोकन वैध होने की आवश्यकता नहीं होगी।
मेट्रिक्स की निगरानी करें और प्रवर्तन सक्षम करें
हालाँकि, प्रवर्तन सक्षम करने से पहले, आपको यह सुनिश्चित करना चाहिए कि ऐसा करने से आपके मौजूदा वैध उपयोगकर्ता बाधित नहीं होंगे। दूसरी ओर, यदि आप अपने ऐप संसाधनों का संदिग्ध उपयोग देख रहे हैं, तो आप जल्द ही प्रवर्तन सक्षम करना चाहेंगे।
यह निर्णय लेने में सहायता के लिए, आप अपने द्वारा उपयोग की जाने वाली सेवाओं के लिए ऐप चेक मेट्रिक्स देख सकते हैं:
- मॉनिटर ऐप रीयलटाइम डेटाबेस, क्लाउड फायरस्टोर, क्लाउड स्टोरेज और प्रमाणीकरण (बीटा) के लिए अनुरोध मेट्रिक्स की जांच करें ।
- मॉनिटर ऐप क्लाउड फ़ंक्शंस के लिए अनुरोध मेट्रिक्स की जांच करें ।
ऐप जांच प्रवर्तन सक्षम करें
जब आप समझ जाते हैं कि ऐप चेक आपके उपयोगकर्ताओं को कैसे प्रभावित करेगा और आप आगे बढ़ने के लिए तैयार हैं, तो आप ऐप चेक प्रवर्तन सक्षम कर सकते हैं:
- रीयलटाइम डेटाबेस, क्लाउड फायरस्टोर, क्लाउड स्टोरेज और प्रमाणीकरण (बीटा) के लिए ऐप चेक प्रवर्तन सक्षम करें ।
- क्लाउड फ़ंक्शंस के लिए ऐप चेक प्रवर्तन सक्षम करें ।
डिबग परिवेश में ऐप चेक का उपयोग करें
यदि, अपने ऐप को ऐप चेक के लिए पंजीकृत करने के बाद, आप अपने ऐप को ऐसे वातावरण में चलाना चाहते हैं जिसे ऐप चेक आमतौर पर वैध के रूप में वर्गीकृत नहीं करेगा, जैसे कि विकास के दौरान एक एमुलेटर, या निरंतर एकीकरण (सीआई) वातावरण से, तो आप ऐसा कर सकते हैं अपने ऐप का एक डिबग बिल्ड बनाएं जो वास्तविक सत्यापन प्रदाता के बजाय ऐप चेक डिबग प्रदाता का उपयोग करता है।
एंड्रॉइड पर डिबग प्रदाता के साथ ऐप चेक का उपयोग करें देखें।