वेब पर काम करने वाले सामान्य OAuth लॉगिन को Firebase SDK टूल की मदद से अपने ऐप्लिकेशन में इंटिग्रेट करके, उपयोगकर्ताओं को अपने GitHub खातों से Firebase में पुष्टि करने की अनुमति दी जा सकती है. इससे, साइन-इन की पूरी प्रोसेस को मैनेज किया जा सकता है.
शुरू करने से पहले
GitHub खातों का इस्तेमाल करके उपयोगकर्ताओं को साइन इन करने की अनुमति देने के लिए, आपको सबसे पहले अपने Firebase प्रोजेक्ट के लिए, GitHub को साइन-इन करने की सुविधा देने वाले प्रोवाइडर के तौर पर चालू करना होगा:
अगर आपने अब तक ऐसा नहीं किया है, तो अपने Android प्रोजेक्ट में Firebase जोड़ें.
- Firebase console में, सुरक्षा > पुष्टि करने की सुविधा पर जाएं.
- साइन-इन करने का तरीका टैब में, GitHub को साइन-इन करने की सुविधा देने वाले प्रोवाइडर को चालू करें.
-
उस प्रोवाइडर के डेवलपर कंसोल से क्लाइंट आईडी और क्लाइंट सीक्रेट को, प्रोवाइडर के कॉन्फ़िगरेशन में जोड़ें:
- अपने ऐप्लिकेशन को रजिस्टर करें GitHub पर डेवलपर ऐप्लिकेशन के तौर पर और अपने ऐप्लिकेशन का OAuth 2.0 पाएं क्लाइंट आईडी और क्लाइंट सीक्रेट.
-
पक्का करें कि आपका Firebase OAuth रीडायरेक्ट यूआरआई (उदाहरण के लिए,
my-app-12345.firebaseapp.com/__/auth/handler) आपके GitHub ऐप्लिकेशन के कॉन्फ़िगरेशन में, आपके ऐप्लिकेशन के सेटिंग पेज पर ऑथराइज़ेशन कॉलबैक यूआरएल के तौर पर सेट हो.
- सेव करें पर क्लिक करें.
अपने मॉड्यूल (ऐप्लिकेशन-लेवल) की Gradle फ़ाइल (आम तौर पर,
<project>/<app-module>/build.gradle.ktsया<project>/<app-module>/build.gradle), में, Android के लिए Firebase Authentication लाइब्रेरी की डिपेंडेंसी जोड़ें. हमारा सुझाव है कि लाइब्रेरी के वर्शन को कंट्रोल करने के लिए, Firebase Android BoM का इस्तेमाल करें.dependencies { // Import the BoM for the Firebase platform implementation(platform("com.google.firebase:firebase-bom:34.15.0")) // Add the dependency for the Firebase Authentication library // When using the BoM, you don't specify versions in Firebase library dependencies implementation("com.google.firebase:firebase-auth") }
Firebase Android BoM का इस्तेमाल करने पर, आपका ऐप्लिकेशन हमेशा Firebase Android लाइब्रेरी के ऐसे वर्शन का इस्तेमाल करेगा जो एक-दूसरे के साथ काम करते हैं.
(दूसरा तरीका) BoM का इस्तेमाल किए बिना Firebase लाइब्रेरी की डिपेंडेंसी जोड़नाBoM
अगर आपने Firebase BoM का इस्तेमाल न करने का विकल्प चुना है, तो आपको हर Firebase लाइब्रेरी का वर्शन उसकी डिपेंडेंसी लाइन में बताना होगा.
ध्यान दें कि अगर आपके ऐप्लिकेशन में Firebase की एक से ज़्यादा लाइब्रेरी इस्तेमाल की जाती हैं, तो हमारा सुझाव है कि लाइब्रेरी के वर्3/} मैनेज करने के लिए BoM का इस्तेमाल करें. इससे यह पक्का होता है कि सभी वर्शन एक-दूसरे के साथ काम करते हैं.
dependencies { // Add the dependency for the Firebase Authentication library // When NOT using the BoM, you must specify versions in Firebase library dependencies implementation("com.google.firebase:firebase-auth:24.1.0") }
अगर आपने अब तक अपने ऐप्लिकेशन का SHA-1 फ़िंगरप्रिंट नहीं बताया है, तो उसे बताएं.
Firebase console में,
सेटिंग > सामान्य टैब पर जाएं.स्क्रोल करके आपके ऐप्लिकेशन कार्ड पर जाएं. इसके बाद, अपना Android ऐप्लिकेशन चुनें और SHA सर्टिफ़िकेट फ़िंगरप्रिंट फ़ील्ड में अपना SHA-1 फ़िंगरप्रिंट जोड़ें.
अपने ऐप्लिकेशन का SHA फ़िंगरप्रिंट पाने के तरीके के बारे में जानने के लिए, क्लाइंट की पुष्टि करना लेख पढ़ें.
Firebase SDK टूल की मदद से, साइन-इन की प्रोसेस को मैनेज करना
अगर Android ऐप्लिकेशन बनाया जा रहा है, तो उपयोगकर्ताओं को उनके GitHub खातों का इस्तेमाल करके Firebase में पुष्टि करने की अनुमति देने का सबसे आसान तरीका है कि Firebase Android SDK टूल की मदद से, साइन-इन की पूरी प्रोसेस को मैनेज किया जाए.
Firebase Android SDK टूल की मदद से, साइन-इन की प्रोसेस को मैनेज करने के लिए, यह तरीका अपनाएं:
github.com प्रोवाइडर आईडी के साथ, OAuthProvider का इंस्टेंस बनाने के लिए, उसके बिल्डर का इस्तेमाल करें
Kotlin
val provider = OAuthProvider.newBuilder("github.com")
Java
OAuthProvider.Builder provider = OAuthProvider.newBuilder("github.com");
ज़रूरी नहीं: OAuth के ऐसे कस्टम पैरामीटर बताएं जिन्हें OAuth के अनुरोध के साथ भेजना है.
Kotlin
// Target specific email with login hint. provider.addCustomParameter("login", "your-email@gmail.com")
Java
// Target specific email with login hint. provider.addCustomParameter("login", "your-email@gmail.com");
GitHub के साथ काम करने वाले पैरामीटर के बारे में जानने के लिए, GitHub का OAuth दस्तावेज़ देखें. ध्यान दें कि
setCustomParameters()के साथ, Firebase के लिए ज़रूरी पैरामीटर पास नहीं किए जा सकते. ये पैरामीटर client_id, response_type, redirect_uri, state, scope और response_mode हैं.ज़रूरी नहीं: OAuth 2.0 के ऐसे दायरे बताएं जिन्हें पुष्टि करने की सुविधा देने वाले प्रोवाइडर से अनुरोध करना है. ये दायरे, बुनियादी प्रोफ़ाइल के अलावा होने चाहिए. अगर आपके ऐप्लिकेशन को GitHub API से, उपयोगकर्ता के निजी डेटा को ऐक्सेस करने की ज़रूरत है, तो आपको GitHub डेवलपर कंसोल में एपीआई की अनुमतियां में जाकर, GitHub API को ऐक्सेस करने की अनुमतियों का अनुरोध करना होगा. OAuth के लिए अनुरोध किए गए दायरे, ऐप्लिकेशन की एपीआई अनुमतियों में पहले से कॉन्फ़िगर किए गए दायरों से पूरी तरह मेल खाने चाहिए.
Kotlin
// Request read access to a user's email addresses. // This must be preconfigured in the app's API permissions. provider.scopes = listOf("user:email")
Java
// Request read access to a user's email addresses. // This must be preconfigured in the app's API permissions. List<String> scopes = new ArrayList<String>() { { add("user:email"); } }; provider.setScopes(scopes);
OAuth प्रोवाइडर ऑब्जेक्ट का इस्तेमाल करके, Firebase में पुष्टि करें. ध्यान दें कि FirebaseAuth की अन्य कार्रवाइयों के उलट, यह कार्रवाई Chrome के कस्टम टैब को पॉप-अप करके, आपके यूज़र इंटरफ़ेस (यूआई) को कंट्रोल करेगी. इसलिए,
OnSuccessListenerऔरOnFailureListenerमें अपनी गतिविधि का रेफ़रंस न दें. ऐसा इसलिए, क्योंकि कार्रवाई के यूआई शुरू करते ही, ये तुरंत अलग हो जाएंगे.आपको सबसे पहले यह देखना चाहिए कि आपको पहले से कोई जवाब मिला है या नहीं. इस तरीके से साइन इन करने पर, आपकी ऐक्टिविटी बैकग्राउंड में चली जाती है. इसका मतलब है कि साइन-इन की प्रोसेस के दौरान, सिस्टम इसे वापस पा सकता है. यह पक्का करने के लिए कि ऐसा होने पर, उपयोगकर्ता को फिर से कोशिश न करनी पड़े, आपको यह देखना चाहिए कि कोई नतीजा पहले से मौजूद है या नहीं.
यह देखने के लिए कि कोई नतीजा पेंडिंग है या नहीं,
getPendingAuthResultको कॉल करें:Kotlin
val pendingResultTask = firebaseAuth.pendingAuthResult if (pendingResultTask != null) { // There's something already here! Finish the sign-in for your user. pendingResultTask .addOnSuccessListener { // User is signed in. // IdP data available in // authResult.getAdditionalUserInfo().getProfile(). // The OAuth access token can also be retrieved: // ((OAuthCredential)authResult.getCredential()).getAccessToken(). // The OAuth secret can be retrieved by calling: // ((OAuthCredential)authResult.getCredential()).getSecret(). } .addOnFailureListener { // Handle failure. } } else { // There's no pending result so you need to start the sign-in flow. // See below. }
Java
Task<AuthResult> pendingResultTask = firebaseAuth.getPendingAuthResult(); if (pendingResultTask != null) { // There's something already here! Finish the sign-in for your user. pendingResultTask .addOnSuccessListener( new OnSuccessListener<AuthResult>() { @Override public void onSuccess(AuthResult authResult) { // User is signed in. // IdP data available in // authResult.getAdditionalUserInfo().getProfile(). // The OAuth access token can also be retrieved: // ((OAuthCredential)authResult.getCredential()).getAccessToken(). // The OAuth secret can be retrieved by calling: // ((OAuthCredential)authResult.getCredential()).getSecret(). } }) .addOnFailureListener( new OnFailureListener() { @Override public void onFailure(@NonNull Exception e) { // Handle failure. } }); } else { // There's no pending result so you need to start the sign-in flow. // See below. }
साइन-इन की प्रोसेस शुरू करने के लिए,
startActivityForSignInWithProviderको कॉल करें:Kotlin
firebaseAuth .startActivityForSignInWithProvider(activity, provider.build()) .addOnSuccessListener { // User is signed in. // IdP data available in // authResult.getAdditionalUserInfo().getProfile(). // The OAuth access token can also be retrieved: // ((OAuthCredential)authResult.getCredential()).getAccessToken(). // The OAuth secret can be retrieved by calling: // ((OAuthCredential)authResult.getCredential()).getSecret(). } .addOnFailureListener { // Handle failure. }
Java
firebaseAuth .startActivityForSignInWithProvider(/* activity= */ this, provider.build()) .addOnSuccessListener( new OnSuccessListener<AuthResult>() { @Override public void onSuccess(AuthResult authResult) { // User is signed in. // IdP data available in // authResult.getAdditionalUserInfo().getProfile(). // The OAuth access token can also be retrieved: // ((OAuthCredential)authResult.getCredential()).getAccessToken(). // The OAuth secret can be retrieved by calling: // ((OAuthCredential)authResult.getCredential()).getSecret(). } }) .addOnFailureListener( new OnFailureListener() { @Override public void onFailure(@NonNull Exception e) { // Handle failure. } });
प्रोसेस पूरी होने पर, प्रोवाइडर से जुड़े OAuth ऐक्सेस टोकन को, दिखाए गए
OAuthCredentialऑब्जेक्ट से वापस पाया जा सकता है.OAuth ऐक्सेस टोकन का इस्तेमाल करके, GitHub API को कॉल किया जा सकता है.
उदाहरण के लिए, बुनियादी प्रोफ़ाइल की जानकारी पाने के लिए, REST API को कॉल किया जा सकता है. इसके लिए,
Authorizationहेडर में ऐक्सेस टोकन पास करें:ऊपर दिए गए उदाहरणों में, साइन-इन की प्रोसेस पर फ़ोकस किया गया है. हालांकि, आपके पास
startActivityForLinkWithProviderका इस्तेमाल करके, किसी मौजूदा उपयोगकर्ता से GitHub प्रोवाइडर को लिंक करने की सुविधा भी होती है. उदाहरण के लिए, एक ही उपयोगकर्ता से कई प्रोवाइडर लिंक किए जा सकते हैं. इससे उपयोगकर्ता, इनमें से किसी भी प्रोवाइडर से साइन इन कर सकता है.Kotlin
// The user is already signed-in. val firebaseUser = firebaseAuth.currentUser!! firebaseUser .startActivityForLinkWithProvider(activity, provider.build()) .addOnSuccessListener { // Provider credential is linked to the current user. // IdP data available in // authResult.getAdditionalUserInfo().getProfile(). // The OAuth access token can also be retrieved: // authResult.getCredential().getAccessToken(). // The OAuth secret can be retrieved by calling: // authResult.getCredential().getSecret(). } .addOnFailureListener { // Handle failure. }
Java
// The user is already signed-in. FirebaseUser firebaseUser = firebaseAuth.getCurrentUser(); firebaseUser .startActivityForLinkWithProvider(/* activity= */ this, provider.build()) .addOnSuccessListener( new OnSuccessListener<AuthResult>() { @Override public void onSuccess(AuthResult authResult) { // Provider credential is linked to the current user. // IdP data available in // authResult.getAdditionalUserInfo().getProfile(). // The OAuth access token can also be retrieved: // authResult.getCredential().getAccessToken(). // The OAuth secret can be retrieved by calling: // authResult.getCredential().getSecret(). } }) .addOnFailureListener( new OnFailureListener() { @Override public void onFailure(@NonNull Exception e) { // Handle failure. } });
startActivityForReauthenticateWithProviderके साथ भी इसी पैटर्न का इस्तेमाल किया जा सकता है. इसका इस्तेमाल, संवेदनशील कार्रवाइयों के लिए नए क्रेडेंशियल पाने के लिए किया जा सकता है. इन कार्रवाइयों के लिए, हाल ही में लॉगिन करना ज़रूरी होता है.Kotlin
// The user is already signed-in. val firebaseUser = firebaseAuth.currentUser!! firebaseUser .startActivityForReauthenticateWithProvider(activity, provider.build()) .addOnSuccessListener { // User is re-authenticated with fresh tokens and // should be able to perform sensitive operations // like account deletion and email or password // update. } .addOnFailureListener { // Handle failure. }
Java
// The user is already signed-in. FirebaseUser firebaseUser = firebaseAuth.getCurrentUser(); firebaseUser .startActivityForReauthenticateWithProvider(/* activity= */ this, provider.build()) .addOnSuccessListener( new OnSuccessListener<AuthResult>() { @Override public void onSuccess(AuthResult authResult) { // User is re-authenticated with fresh tokens and // should be able to perform sensitive operations // like account deletion and email or password // update. } }) .addOnFailureListener( new OnFailureListener() { @Override public void onFailure(@NonNull Exception e) { // Handle failure. } });
अगले चरण
पहली बार साइन इन करने के बाद, एक नया उपयोगकर्ता खाता बनाया जाता है. इसे उन क्रेडेंशियल से लिंक किया जाता है जिनका इस्तेमाल करके उपयोगकर्ता ने साइन इन किया है. जैसे, उपयोगकर्ता नाम और पासवर्ड, फ़ोन नंबर या पुष्टि करने की सुविधा देने वाले प्रोवाइडर की जानकारी. यह नया खाता, आपके Firebase प्रोजेक्ट के हिस्से के तौर पर सेव किया जाता है. इसका इस्तेमाल, आपके प्रोजेक्ट के हर ऐप्लिकेशन में किसी उपयोगकर्ता की पहचान करने के लिए किया जा सकता है. भले ही, उपयोगकर्ता किसी भी तरीके से साइन इन करे.
-
आपके ऐप्लिकेशन में,
FirebaseUserऑब्जेक्ट से उपयोगकर्ता की बुनियादी प्रोफ़ाइल की जानकारी पाई जा सकती है. उपयोगकर्ताओं को मैनेज करना लेख पढ़ें. अपने Firebase Realtime Database और Cloud Storage सुरक्षा नियमों में, आप साइन-इन किए हुए उपयोगकर्ता की यूनीक User-ID,
authवैरिएबल से पा सकते हैं. इसका इस्तेमाल, यह कंट्रोल करने के लिए किया जा सकता है कि उपयोगकर्ता किस डेटा को ऐक्सेस कर सकता है.
किसी उपयोगकर्ता को साइन आउट करने के लिए,
signOut को कॉल करें:
Kotlin
Firebase.auth.signOut()
Java
FirebaseAuth.getInstance().signOut();