Android पर OpenID Connect का इस्तेमाल करके पुष्टि करें

अगर आपने Firebase Authentication with Identity Platform में अपग्रेड किया है, तो OpenID Connect (OIDC) के साथ काम करने वाले अपनी पसंद के प्रोवाइडर का इस्तेमाल करके, Firebase के ज़रिए अपने उपयोगकर्ताओं की पुष्टि की जा सकती है. इससे, पहचान देने वाले उन प्रोवाइडर का इस्तेमाल किया जा सकता है जो Firebase के साथ काम नहीं करते.

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

OIDC प्रोवाइडर का इस्तेमाल करके, उपयोगकर्ताओं को साइन इन करने की सुविधा देने के लिए, आपको सबसे पहले प्रोवाइडर से कुछ जानकारी इकट्ठा करनी होगी:

• क्लाइंट आईडी: यह प्रोवाइडर के लिए यूनीक स्ट्रिंग होती है, जिससे आपके ऐप्लिकेशन की पहचान होती है. आपका प्रोवाइडर हो सकता है कि आपके हर प्लैटफ़ॉर्म के लिए अलग-अलग क्लाइंट आईडी असाइन करे. यह आपके प्रोवाइडर की ओर से जारी किए गए आईडी टोकन में, aud दावे की वैल्यू में से एक है.

• क्लाइंट सीक्रेट: यह एक सीक्रेट स्ट्रिंग होती है, जिसका इस्तेमाल प्रोवाइडर, क्लाइंट आईडी के मालिकाना हक की पुष्टि करने के लिए करता है. हर क्लाइंट आईडी के लिए, आपको उससे मेल खाने वाला क्लाइंट सीक्रेट चाहिए होगा. (यह वैल्यू सिर्फ़ तब ज़रूरी होती है, जब ऑथ कोड फ़्लो का इस्तेमाल किया जा रहा हो. हमारा सुझाव है कि आप इसी फ़्लो का इस्तेमाल करें.)

• जारी करने वाला: यह एक स्ट्रिंग होती है, जिससे आपके प्रोवाइडर की पहचान होती है. यह वैल्यू एक यूआरएल होना चाहिए. इस यूआरएल में /.well-known/openid-configuration जोड़ने पर, यह प्रोवाइडर के OIDC डिस्कवरी दस्तावेज़ की जगह बन जाता है. उदाहरण के लिए, अगर जारी करने वाला व्यक्ति https://auth.example.com है, तो डिस्कवरी दस्तावेज़ https://auth.example.com/.well-known/openid-configuration पर उपलब्ध होना चाहिए.

ऊपर दी गई जानकारी मिलने के बाद, अपने Firebase प्रोजेक्ट के लिए OpenID Connect को साइन-इन प्रोवाइडर के तौर पर चालू करें:

1. अपने Android प्रोजेक्ट में Firebase जोड़ें.

2. अगर आपने Firebase Authentication with Identity Platform में अपग्रेड नहीं किया है, तो ऐसा करें. OpenID Connect ऑथेंटिकेशन की सुविधा, सिर्फ़ अपग्रेड किए गए प्रोजेक्ट में उपलब्ध होती है.

3. साइन-इन प्रोवाइडर पेज पर, Firebase कंसोल पर, नया प्रोवाइडर जोड़ें पर क्लिक करें. इसके बाद, OpenID Connect पर क्लिक करें.

4. चुनें कि आपको ऑथराइज़ेशन कोड फ़्लो या इंप्लिसिट ग्रांट फ़्लो का इस्तेमाल करना है.

   अगर आपका प्रोवाइडर कोड फ़्लो के साथ काम करता है, तो आपको हमेशा इसका इस्तेमाल करना चाहिए. इंप्लिसिट फ़्लो कम सुरक्षित होता है. इसलिए, हमारा सुझाव है कि इसका इस्तेमाल न करें.

5. इस प्रोवाइडर को कोई नाम दें. जनरेट किया गया प्रोवाइडर आईडी नोट करें. यह oidc.example-provider जैसा कुछ हो सकता है. अपने ऐप्लिकेशन में साइन-इन कोड जोड़ते समय, आपको इस आईडी की ज़रूरत होगी.

6. अपना क्लाइंट आईडी और क्लाइंट सीक्रेट, और अपने प्रोवाइडर की जारी करने वाली स्ट्रिंग डालें. ये वैल्यू, आपके प्रोवाइडर की ओर से असाइन की गई वैल्यू से पूरी तरह मेल खानी चाहिए.

7. बदलावों को सेव करें.

Firebase SDK टूल की मदद से, साइन-इन फ़्लो को मैनेज करना

अगर Android ऐप्लिकेशन बनाया जा रहा है, तो OIDC प्रोवाइडर का इस्तेमाल करके, Firebase के ज़रिए अपने उपयोगकर्ताओं की पुष्टि करने का सबसे आसान तरीका है कि Firebase Android SDK टूल की मदद से, पूरे साइन-इन फ़्लो को मैनेज किया जाए.

Firebase Android SDK टूल की मदद से, साइन-इन फ़्लो को मैनेज करने के लिए, यह तरीका अपनाएं:

1. प्रोवाइडर के आईडी के साथ, OAuthProvider का कोई इंस्टेंस बनाने के लिए, उसके बिल्डर का इस्तेमाल करना

   Kotlin

   val providerBuilder = OAuthProvider.newBuilder("oidc.example-provider")
   GenericIdpActivity.kt

   Java

   OAuthProvider.Builder providerBuilder = OAuthProvider.newBuilder("oidc.example-provider");
   GenericIdpActivity.java

2. ज़रूरी नहीं: OAuth के ऐसे अन्य कस्टम पैरामीटर डालें जिन्हें OAuth के अनुरोध के साथ भेजना है.

   Kotlin

   // Target specific email with login hint.
   providerBuilder.addCustomParameter("login_hint", "user@example.com")
   GenericIdpActivity.kt

   Java

   // Target specific email with login hint.
   providerBuilder.addCustomParameter("login_hint", "user@example.com");
   GenericIdpActivity.java

   OIDC प्रोवाइडर से पूछें कि वे किन पैरामीटर के साथ काम करते हैं. ध्यान दें कि setCustomParameters() के साथ, Firebase के लिए ज़रूरी पैरामीटर पास नहीं किए जा सकते. ये पैरामीटर client_id, response_type, redirect_uri, state, scope और response_mode हैं.

3. ज़रूरी नहीं: OAuth 2.0 के ऐसे अन्य स्कोप डालें जिन्हें ऑथेंटिकेशन प्रोवाइडर से अनुरोध करना है. ये स्कोप, बुनियादी प्रोफ़ाइल के अलावा होने चाहिए.

   Kotlin

   // Request read access to a user's email addresses.
   // This must be preconfigured in the app's API permissions.
   providerBuilder.scopes = listOf("mail.read", "calendars.read")
   GenericIdpActivity.kt

   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("mail.read");
                   add("calendars.read");
               }
           };
   providerBuilder.setScopes(scopes);
   GenericIdpActivity.java

   OIDC प्रोवाइडर से पूछें कि वे किन स्कोप का इस्तेमाल करते हैं.

4. 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.
   }
   GenericIdpActivity.kt

   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.
   }
   GenericIdpActivity.java

   साइन इन फ़्लो शुरू करने के लिए, 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.
       }
   GenericIdpActivity.kt

   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.
                       }
                   });
   GenericIdpActivity.java

5. ऊपर दिए गए उदाहरणों में, साइन-इन फ़्लो पर फ़ोकस किया गया है. हालांकि, startActivityForLinkWithProvider का इस्तेमाल करके, OIDC प्रोवाइडर को किसी मौजूदा उपयोगकर्ता से लिंक भी किया जा सकता है. उदाहरण के लिए, एक ही उपयोगकर्ता से कई प्रोवाइडर लिंक किए जा सकते हैं. इससे उपयोगकर्ता, इनमें से किसी भी प्रोवाइडर से साइन इन कर सकता है.

   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.
       }
   GenericIdpActivity.kt

   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.
                       }
                   });
   GenericIdpActivity.java

6. 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.
       }
   GenericIdpActivity.kt

   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.
                       }
                   });
   GenericIdpActivity.java

मैन्युअल तरीके से साइन-इन फ़्लो को मैनेज करना

अगर आपने अपने ऐप्लिकेशन में OpenID Connect साइन-इन फ़्लो पहले ही लागू कर लिया है, तो Firebase से पुष्टि करने के लिए, सीधे आईडी टोकन का इस्तेमाल किया जा सकता है:

val providerId = "oidc.example-provider" // As registered in Firebase console.
val credential = oAuthCredential(providerId) {
    setIdToken(idToken) // ID token from OpenID Connect flow.
}
Firebase.auth
    .signInWithCredential(credential)
    .addOnSuccessListener { authResult ->
        // User is signed in.

        // IdP data available in:
        //    authResult.additionalUserInfo.profile
    }
    .addOnFailureListener { e ->
        // Handle failure.
    }
GenericIdpActivity.kt

AuthCredential credential = OAuthProvider
        .newCredentialBuilder("oidc.example-provider")  // As registered in Firebase console.
        .setIdToken(idToken)  // ID token from OpenID Connect flow.
        .build();
FirebaseAuth.getInstance()
        .signInWithCredential(credential)
        .addOnSuccessListener(new OnSuccessListener<AuthResult>() {
            @Override
            public void onSuccess(AuthResult authResult) {
                // User is signed in.

                // IdP data available in:
                //    authResult.getAdditionalUserInfo().getProfile()
            }
        })
        .addOnFailureListener(new OnFailureListener() {
            @Override
            public void onFailure(@NonNull Exception e) {
                // Handle failure.
            }
        });
GenericIdpActivity.java

अगले चरण

जब कोई उपयोगकर्ता पहली बार साइन इन करता है, तो एक नया उपयोगकर्ता खाता बनता है. यह खाता, उन क्रेडेंशियल से लिंक होता है जिनका इस्तेमाल करके उपयोगकर्ता ने साइन इन किया है. जैसे, उपयोगकर्ता नाम और पासवर्ड, फ़ोन नंबर या ऑथ प्रोवाइडर की जानकारी. यह नया खाता, आपके Firebase प्रोजेक्ट के हिस्से के तौर पर सेव होता है. इसका इस्तेमाल, आपके प्रोजेक्ट में मौजूद हर ऐप्लिकेशन में किसी उपयोगकर्ता की पहचान करने के लिए किया जा सकता है. भले ही, उपयोगकर्ता किसी भी तरीके से साइन इन करे.

• अपने ऐप्लिकेशन में, उपयोगकर्ता की बुनियादी प्रोफ़ाइल की जानकारी FirebaseUser ऑब्जेक्ट से पाई जा सकती है. उपयोगकर्ताओं को मैनेज करना लेख पढ़ें.

• आपके Firebase Realtime Database और Cloud Storage सुरक्षा से जुड़े नियमों में, साइन इन किए हुए उपयोगकर्ता का यूनीक यूज़र आईडी auth वैरिएबल से पाया जा सकता है. इसका इस्तेमाल, यह कंट्रोल करने के लिए किया जा सकता है कि कोई उपयोगकर्ता किस डेटा को ऐक्सेस कर सकता है.

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

किसी उपयोगकर्ता को साइन आउट करने के लिए, signOut को कॉल करें:

Firebase.auth.signOut()
MainActivity.kt

FirebaseAuth.getInstance().signOut();
MainActivity.java