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

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

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

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

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

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

  • Issuer: यह एक स्ट्रिंग है, जिससे आपके सेवा देने वाले की पहचान होती है. यह वैल्यू एक ऐसा यूआरएल होना चाहिए जो /.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 का एक इंस्टेंस बनाएं. इसके लिए, Builder का इस्तेमाल करके, प्रोवाइडर के आईडी का इस्तेमाल करें

    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 की मदद से पुष्टि करने के लिए, सीधे तौर पर आईडी टोकन का इस्तेमाल किया जा सकता है:

Kotlin 

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

Java 

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 को कॉल करें:

Kotlin

Firebase.auth.signOut()
MainActivity.kt

Java

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