JavaScript के साथ GitHub का इस्तेमाल करके पुष्टि करें

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

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

  1. अपने JavaScript प्रोजेक्ट में Firebase जोड़ें.
  2. Firebase कंसोल में, Auth सेक्शन खोलें.
  3. साइन इन करने का तरीका टैब में, GitHub की सेवा देने वाली कंपनी को चालू करें.
  4. सेवा देने वाली कंपनी के डेवलपर कंसोल से, क्लाइंट आईडी और क्लाइंट सीक्रेट को सेवा देने वाली कंपनी के कॉन्फ़िगरेशन में जोड़ें:
    1. GitHub पर डेवलपर ऐप्लिकेशन के तौर पर अपना ऐप्लिकेशन रजिस्टर करें और अपने ऐप्लिकेशन का OAuth 2.0 क्लाइंट आईडी और क्लाइंट सीक्रेट पाएं.
    2. पक्का करें कि आपके Firebase OAuth रीडायरेक्ट यूआरआई (उदाहरण के लिए, my-app-12345.firebaseapp.com/__/auth/handler) को GitHub ऐप्लिकेशन के कॉन्फ़िगरेशन पर, ऐप्लिकेशन के सेटिंग पेज में अनुमति के लिए कॉलबैक यूआरआई के तौर पर सेट किया गया हो.
  5. सेव करें पर क्लिक करें.

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

अगर कोई वेब ऐप्लिकेशन बनाया जा रहा है, तो अपने उपयोगकर्ताओं के GitHub खातों का इस्तेमाल करके, Firebase की मदद से उनकी पुष्टि करने का सबसे आसान तरीका यह है कि Firebase JavaScript SDK टूल की मदद से साइन-इन फ़्लो को मैनेज किया जाए. (अगर आपको Node.js या किसी ऐसे अन्य एनवायरमेंट में उपयोगकर्ता की पुष्टि करनी है जो ब्राउज़र नहीं है, तो आपको साइन-इन फ़्लो को मैन्युअल तरीके से मैनेज करना होगा.)

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

  1. GitHub प्रोवाइडर ऑब्जेक्ट का इंस्टेंस बनाएं:

    Web

    import { GithubAuthProvider } from "firebase/auth";
    
    const provider = new GithubAuthProvider();

    Web

    var provider = new firebase.auth.GithubAuthProvider();
  2. ज़रूरी नहीं: OAuth 2.0 के ऐसे अन्य स्कोप बताएं जिनके लिए आपको पुष्टि करने वाली सेवा देने वाली कंपनी से अनुरोध करना है. स्कोप जोड़ने के लिए, addScope को कॉल करें. उदाहरण के लिए:

    Web

    provider.addScope('repo');

    Web

    provider.addScope('repo');
    पुष्टि करने वाली कंपनी का दस्तावेज़ देखें.
  3. ज़रूरी नहीं: OAuth प्रोवाइडर के ऐसे अतिरिक्त कस्टम पैरामीटर बताएं जिन्हें आपको OAuth अनुरोध के साथ भेजना है. कस्टम पैरामीटर जोड़ने के लिए, शुरू किए गए प्रोवाइडर पर setCustomParameters को कॉल करें. इसके लिए, OAuth प्रोवाइडर के दस्तावेज़ में बताई गई कुंजी और उससे जुड़ी वैल्यू वाला ऑब्जेक्ट इस्तेमाल करें. उदाहरण के लिए:

    Web

    provider.setCustomParameters({
      'allow_signup': 'false'
    });

    Web

    provider.setCustomParameters({
      'allow_signup': 'false'
    });
    ज़रूरी OAuth पैरामीटर का इस्तेमाल नहीं किया जा सकता. इन पैरामीटर को अनदेखा कर दिया जाएगा. ज़्यादा जानकारी के लिए, पुष्टि करने वाली कंपनी का रेफ़रंस देखें.
  4. GitHub प्रोवाइडर ऑब्जेक्ट का इस्तेमाल करके, Firebase से पुष्टि करें. आपके पास अपने उपयोगकर्ताओं को GitHub खातों से साइन इन करने के लिए कहने का विकल्प है. इसके लिए, पॉप-अप विंडो खोलें या साइन-इन पेज पर रीडायरेक्ट करें. मोबाइल डिवाइसों पर, रीडायरेक्ट करने का तरीका इस्तेमाल करना बेहतर होता है.
    • पॉप-अप विंडो से साइन इन करने के लिए, signInWithPopup को कॉल करें:

      Web

      import { getAuth, signInWithPopup, GithubAuthProvider } from "firebase/auth";
      
      const auth = getAuth();
      signInWithPopup(auth, provider)
        .then((result) => {
          // This gives you a GitHub Access Token. You can use it to access the GitHub API.
          const credential = GithubAuthProvider.credentialFromResult(result);
          const token = credential.accessToken;
      
          // The signed-in user info.
          const user = result.user;
          // IdP data available using getAdditionalUserInfo(result)
          // ...
        }).catch((error) => {
          // Handle Errors here.
          const errorCode = error.code;
          const errorMessage = error.message;
          // The email of the user's account used.
          const email = error.customData.email;
          // The AuthCredential type that was used.
          const credential = GithubAuthProvider.credentialFromError(error);
          // ...
        });

      Web

      firebase
        .auth()
        .signInWithPopup(provider)
        .then((result) => {
          /** @type {firebase.auth.OAuthCredential} */
          var credential = result.credential;
      
          // This gives you a GitHub Access Token. You can use it to access the GitHub API.
          var token = credential.accessToken;
      
          // The signed-in user info.
          var user = result.user;
          // IdP data available in result.additionalUserInfo.profile.
            // ...
        }).catch((error) => {
          // Handle Errors here.
          var errorCode = error.code;
          var errorMessage = error.message;
          // The email of the user's account used.
          var email = error.email;
          // The firebase.auth.AuthCredential type that was used.
          var credential = error.credential;
          // ...
        });
      यह भी ध्यान दें कि GitHub की सेवा देने वाली कंपनी का OAuth टोकन वापस पाया जा सकता है. इसका इस्तेमाल, GitHub के एपीआई का इस्तेमाल करके ज़्यादा डेटा फ़ेच करने के लिए किया जा सकता है.

      यहां गड़बड़ियों का पता लगाया जा सकता है और उन्हें ठीक किया जा सकता है. गड़बड़ी के कोड की सूची के लिए, पुष्टि करने से जुड़े रेफ़रंस दस्तावेज़ देखें.

    • साइन इन पेज पर रीडायरेक्ट करके साइन इन करने के लिए, signInWithRedirect को कॉल करें: `signInWithRedirect` का इस्तेमाल करते समय, सबसे सही तरीके अपनाएं.

      Web

      import { getAuth, signInWithRedirect } from "firebase/auth";
      
      const auth = getAuth();
      signInWithRedirect(auth, provider);

      Web

      firebase.auth().signInWithRedirect(provider);
      इसके बाद, पेज लोड होने पर, GitHub की सेवा देने वाली कंपनी का OAuth टोकन भी पाया जा सकता है. इसके लिए, getRedirectResult को कॉल करें:

      Web

      import { getAuth, getRedirectResult, GithubAuthProvider } from "firebase/auth";
      
      const auth = getAuth();
      getRedirectResult(auth)
        .then((result) => {
          const credential = GithubAuthProvider.credentialFromResult(result);
          if (credential) {
            // This gives you a GitHub Access Token. You can use it to access the GitHub API.
            const token = credential.accessToken;
            // ...
          }
      
          // The signed-in user info.
          const user = result.user;
          // IdP data available using getAdditionalUserInfo(result)
          // ...
        }).catch((error) => {
          // Handle Errors here.
          const errorCode = error.code;
          const errorMessage = error.message;
          // The email of the user's account used.
          const email = error.customData.email;
          // The AuthCredential type that was used.
          const credential = GithubAuthProvider.credentialFromError(error);
          // ...
        });

      Web

      firebase.auth()
        .getRedirectResult()
        .then((result) => {
          if (result.credential) {
            /** @type {firebase.auth.OAuthCredential} */
            var credential = result.credential;
      
            // This gives you a GitHub Access Token. You can use it to access the GitHub API.
            var token = credential.accessToken;
            // ...
          }
      
          // The signed-in user info.
          var user = result.user;
          // IdP data available in result.additionalUserInfo.profile.
            // ...
        }).catch((error) => {
          // Handle Errors here.
          var errorCode = error.code;
          var errorMessage = error.message;
          // The email of the user's account used.
          var email = error.email;
          // The firebase.auth.AuthCredential type that was used.
          var credential = error.credential;
          // ...
        });
      यहां गड़बड़ियों का पता लगाया जा सकता है और उन्हें ठीक किया जा सकता है. गड़बड़ी के कोड की सूची के लिए, पुष्टि करने से जुड़े रेफ़रंस दस्तावेज़ देखें.

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

GitHub खाते का इस्तेमाल करके भी Firebase की पुष्टि की जा सकती है. इसके लिए, GitHub OAuth 2.0 एंडपॉइंट को कॉल करके, साइन-इन फ़्लो को मैनेज करें:

  1. डेवलपर के दस्तावेज़ में दिए गए निर्देशों का पालन करके, अपने ऐप्लिकेशन में GitHub की पुष्टि करने की सुविधा को इंटिग्रेट करें. GitHub में साइन-इन करने के फ़्लो के आखिर में, आपको एक OAuth 2.0 ऐक्सेस टोकन मिलेगा.
  2. अगर आपको किसी Node.js ऐप्लिकेशन में साइन इन करना है, तो Node.js ऐप्लिकेशन को OAuth ऐक्सेस टोकन भेजें.
  3. जब कोई उपयोगकर्ता GitHub से साइन इन कर ले, तो OAuth 2.0 ऐक्सेस टोकन को Firebase क्रेडेंशियल के लिए बदलें:

    Web

    import { GithubAuthProvider } from "firebase/auth";
    
    const credential = GithubAuthProvider.credential(token);

    Web

    var credential = firebase.auth.GithubAuthProvider.credential(token);
  4. Firebase क्रेडेंशियल का इस्तेमाल करके, Firebase से पुष्टि करना:

    Web

    import { getAuth, signInWithCredential } from "firebase/auth";
    
    // Sign in with the credential from the user.
    const auth = getAuth();
    signInWithCredential(auth, credential)
      .then((result) => {
        // Signed in 
        // ...
      })
      .catch((error) => {
        // Handle Errors here.
        const errorCode = error.code;
        const errorMessage = error.message;
        // The email of the user's account used.
        const email = error.customData.email;
        // ...
      });

    Web

    // Sign in with the credential from the user.
    firebase.auth()
      .signInWithCredential(credential)
      .then((result) => {
        // Signed in 
        // ...
      })
      .catch((error) => {
        // Handle Errors here.
        const errorCode = error.code;
        const errorMessage = error.message;
        // The email of the user's account used.
        const email = error.email;
        // ...
      });

Chrome एक्सटेंशन में Firebase की मदद से पुष्टि करना

अगर आपको Chrome एक्सटेंशन ऐप्लिकेशन बनाना है, तो ऑफ़स्क्रीन दस्तावेज़ों से जुड़ी गाइड देखें.

अगले चरण

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

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

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

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

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

Web

import { getAuth, signOut } from "firebase/auth";

const auth = getAuth();
signOut(auth).then(() => {
  // Sign-out successful.
}).catch((error) => {
  // An error happened.
});

Web

firebase.auth().signOut().then(() => {
  // Sign-out successful.
}).catch((error) => {
  // An error happened.
});