सर्विस वर्कर के साथ सेशन मैनेजमेंट

Firebase आईडी, सेशन मैनेजमेंट के लिए Firebase आईडी टोकन का पता लगाने और उन्हें पास करने के लिए, सर्विस वर्कर का इस्तेमाल करने की सुविधा देता है. इससे ये फ़ायदे मिलते हैं:

  • सर्वर से मिलने वाले हर एचटीटीपी अनुरोध पर, आईडी टोकन पास करने की सुविधा. इसके लिए अलग से कोई काम नहीं करना पड़ता.
  • किसी अतिरिक्त राउंड ट्रिप या इंतज़ार के समय के बिना आईडी टोकन को रीफ़्रेश करने की सुविधा.
  • सिंक किए गए सेशन का बैकएंड और फ़्रंटएंड. जिन ऐप्लिकेशन को रीयलटाइम डेटाबेस, Firestore जैसी Firebase सेवाओं और कुछ बाहरी सर्वर साइड रिसॉर्स (SQL डेटाबेस वगैरह) को ऐक्सेस करने की ज़रूरत होती है वे इस समाधान का इस्तेमाल कर सकते हैं. इसके अलावा, उसी सेशन को सर्विस वर्कर, वेब वर्कर या शेयर किए गए वर्कर से भी ऐक्सेस किया जा सकता है.
  • हर पेज पर Firebase पुष्टि करने वाले सोर्स कोड को शामिल करने की ज़रूरत नहीं होती है (इंतज़ार का समय कम होता है). सर्विस वर्कर, जो एक बार लोड और शुरू होता है, बैकग्राउंड में सभी क्लाइंट के लिए सेशन मैनेजमेंट को हैंडल करता है.

खास जानकारी

Firebase से पुष्टि करने की सुविधा को क्लाइंट-साइड पर काम करने के लिए ऑप्टिमाइज़ किया गया है. टोकन, वेब स्टोरेज में सेव किए जाते हैं. इससे, Firebase की अन्य सेवाओं, जैसे कि रीयलटाइम डेटाबेस, Cloud Firestore, Cloud Storage वगैरह के साथ भी इंटिग्रेट करना आसान हो जाता है. सर्वर साइड के नज़रिए से सेशन मैनेज करने के लिए, आईडी टोकन को फिर से पाना होगा और सर्वर पर भेजना होगा.

वेब मॉड्यूलर एपीआई

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

const auth = getAuth();
getIdToken(auth.currentUser)
  .then((idToken) => {
    // idToken can be passed back to server.
  })
  .catch((error) => {
    // Error occurred.
  });
auth_svc_get_idtoken.js

वेब नेमस्पेस किया गया एपीआई

firebase.auth().currentUser.getIdToken()
  .then((idToken) => {
    // idToken can be passed back to server.
  })
  .catch((error) => {
    // Error occurred.
  });
service-worker-sessions.js

हालांकि, इसका मतलब यह है कि कुछ स्क्रिप्ट को सबसे नया आईडी टोकन पाने के लिए, क्लाइंट से चलाना पड़ता है. इसके बाद, स्क्रिप्ट को अनुरोध के हेडर, पोस्ट बॉडी वगैरह की मदद से सर्वर पर भेजना होता है.

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

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

इसके बजाय, सर्विस वर्कर का इस्तेमाल सर्वर साइड इस्तेमाल के लिए उपयोगकर्ता सेशन को मैनेज करने के लिए किया जा सकता है. यह इन वजहों से काम करता है:

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

सर्विस वर्कर में बदलाव

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

वेब मॉड्यूलर एपीआई

import { initializeApp } from "firebase/app";
import { getAuth, onAuthStateChanged, getIdToken } from "firebase/auth";

// Initialize the Firebase app in the service worker script.
initializeApp(config);

/**
 * Returns a promise that resolves with an ID token if available.
 * @return {!Promise<?string>} The promise that resolves with an ID token if
 *     available. Otherwise, the promise resolves with null.
 */
const auth = getAuth();
const getIdTokenPromise = () => {
  return new Promise((resolve, reject) => {
    const unsubscribe = onAuthStateChanged(auth, (user) => {
      unsubscribe();
      if (user) {
        getIdToken(user).then((idToken) => {
          resolve(idToken);
        }, (error) => {
          resolve(null);
        });
      } else {
        resolve(null);
      }
    });
  });
};
auth_svc_subscribe.js

वेब नेमस्पेस किया गया एपीआई

// Initialize the Firebase app in the service worker script.
firebase.initializeApp(config);

/**
 * Returns a promise that resolves with an ID token if available.
 * @return {!Promise<?string>} The promise that resolves with an ID token if
 *     available. Otherwise, the promise resolves with null.
 */
const getIdToken = () => {
  return new Promise((resolve, reject) => {
    const unsubscribe = firebase.auth().onAuthStateChanged((user) => {
      unsubscribe();
      if (user) {
        user.getIdToken().then((idToken) => {
          resolve(idToken);
        }, (error) => {
          resolve(null);
        });
      } else {
        resolve(null);
      }
    });
  });
};
service-worker-sessions.js

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

वेब मॉड्यूलर एपीआई

const getOriginFromUrl = (url) => {
  // https://stackoverflow.com/questions/1420881/how-to-extract-base-url-from-a-string-in-javascript
  const pathArray = url.split('/');
  const protocol = pathArray[0];
  const host = pathArray[2];
  return protocol + '//' + host;
};

// Get underlying body if available. Works for text and json bodies.
const getBodyContent = (req) => {
  return Promise.resolve().then(() => {
    if (req.method !== 'GET') {
      if (req.headers.get('Content-Type').indexOf('json') !== -1) {
        return req.json()
          .then((json) => {
            return JSON.stringify(json);
          });
      } else {
        return req.text();
      }
    }
  }).catch((error) => {
    // Ignore error.
  });
};

self.addEventListener('fetch', (event) => {
  /** @type {FetchEvent} */
  const evt = event;

  const requestProcessor = (idToken) => {
    let req = evt.request;
    let processRequestPromise = Promise.resolve();
    // For same origin https requests, append idToken to header.
    if (self.location.origin == getOriginFromUrl(evt.request.url) &&
        (self.location.protocol == 'https:' ||
         self.location.hostname == 'localhost') &&
        idToken) {
      // Clone headers as request headers are immutable.
      const headers = new Headers();
      req.headers.forEach((val, key) => {
        headers.append(key, val);
      });
      // Add ID token to header.
      headers.append('Authorization', 'Bearer ' + idToken);
      processRequestPromise = getBodyContent(req).then((body) => {
        try {
          req = new Request(req.url, {
            method: req.method,
            headers: headers,
            mode: 'same-origin',
            credentials: req.credentials,
            cache: req.cache,
            redirect: req.redirect,
            referrer: req.referrer,
            body,
            // bodyUsed: req.bodyUsed,
            // context: req.context
          });
        } catch (e) {
          // This will fail for CORS requests. We just continue with the
          // fetch caching logic below and do not pass the ID token.
        }
      });
    }
    return processRequestPromise.then(() => {
      return fetch(req);
    });
  };
  // Fetch the resource after checking for the ID token.
  // This can also be integrated with existing logic to serve cached files
  // in offline mode.
  evt.respondWith(getIdTokenPromise().then(requestProcessor, requestProcessor));
});
auth_svc_intercept.js

वेब नेमस्पेस किया गया एपीआई

const getOriginFromUrl = (url) => {
  // https://stackoverflow.com/questions/1420881/how-to-extract-base-url-from-a-string-in-javascript
  const pathArray = url.split('/');
  const protocol = pathArray[0];
  const host = pathArray[2];
  return protocol + '//' + host;
};

// Get underlying body if available. Works for text and json bodies.
const getBodyContent = (req) => {
  return Promise.resolve().then(() => {
    if (req.method !== 'GET') {
      if (req.headers.get('Content-Type').indexOf('json') !== -1) {
        return req.json()
          .then((json) => {
            return JSON.stringify(json);
          });
      } else {
        return req.text();
      }
    }
  }).catch((error) => {
    // Ignore error.
  });
};

self.addEventListener('fetch', (event) => {
  /** @type {FetchEvent} */
  const evt = event;

  const requestProcessor = (idToken) => {
    let req = evt.request;
    let processRequestPromise = Promise.resolve();
    // For same origin https requests, append idToken to header.
    if (self.location.origin == getOriginFromUrl(evt.request.url) &&
        (self.location.protocol == 'https:' ||
         self.location.hostname == 'localhost') &&
        idToken) {
      // Clone headers as request headers are immutable.
      const headers = new Headers();
      req.headers.forEach((val, key) => {
        headers.append(key, val);
      });
      // Add ID token to header.
      headers.append('Authorization', 'Bearer ' + idToken);
      processRequestPromise = getBodyContent(req).then((body) => {
        try {
          req = new Request(req.url, {
            method: req.method,
            headers: headers,
            mode: 'same-origin',
            credentials: req.credentials,
            cache: req.cache,
            redirect: req.redirect,
            referrer: req.referrer,
            body,
            // bodyUsed: req.bodyUsed,
            // context: req.context
          });
        } catch (e) {
          // This will fail for CORS requests. We just continue with the
          // fetch caching logic below and do not pass the ID token.
        }
      });
    }
    return processRequestPromise.then(() => {
      return fetch(req);
    });
  };
  // Fetch the resource after checking for the ID token.
  // This can also be integrated with existing logic to serve cached files
  // in offline mode.
  evt.respondWith(getIdToken().then(requestProcessor, requestProcessor));
});
service-worker-sessions.js

इस वजह से, पुष्टि किए गए सभी अनुरोधों के हेडर में हमेशा एक आईडी टोकन पास होगा. साथ ही, इन्हें प्रोसेस नहीं किया जाएगा.

सर्विस वर्कर को पुष्टि की स्थिति में होने वाले बदलावों का पता लगाने के लिए, इसे साइन-इन/साइन-अप पेज पर इंस्टॉल करना होगा. पक्का करें कि सर्विस वर्कर को बंडल किया गया है, ताकि यह ब्राउज़र के बंद होने के बाद भी काम कर सके.

इंस्टॉल करने के बाद, सर्विस वर्कर को चालू होने पर clients.claim() को कॉल करना होगा, ताकि उसे मौजूदा पेज के लिए कंट्रोलर के तौर पर सेट किया जा सके.

वेब मॉड्यूलर एपीआई

self.addEventListener('activate', (event) => {
  event.waitUntil(clients.claim());
});
auth_svc_listen_activate.js

वेब नेमस्पेस किया गया एपीआई

self.addEventListener('activate', (event) => {
  event.waitUntil(clients.claim());
});
service-worker-sessions.js

क्लाइंट-साइड में किए गए बदलाव

अगर सर्विस वर्कर काम करता है, तो उसे क्लाइंट-साइड साइन-इन/साइन-अप पेज पर इंस्टॉल करना ज़रूरी है.

वेब मॉड्यूलर एपीआई

// Install servicerWorker if supported on sign-in/sign-up page.
if ('serviceWorker' in navigator) {
  navigator.serviceWorker.register('/service-worker.js', {scope: '/'});
}
auth_svc_register.js

वेब नेमस्पेस किया गया एपीआई

// Install servicerWorker if supported on sign-in/sign-up page.
if ('serviceWorker' in navigator) {
  navigator.serviceWorker.register('/service-worker.js', {scope: '/'});
}
service-worker-sessions.js

जब उपयोगकर्ता साइन इन करके किसी दूसरे पेज पर रीडायरेक्ट होगा, तो सर्विस वर्कर, रीडायरेक्ट के पूरा होने से पहले हेडर में आईडी टोकन इंजेक्ट कर पाएगा.

वेब मॉड्यूलर एपीआई

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

// Sign in screen.
const auth = getAuth();
signInWithEmailAndPassword(auth, email, password)
  .then((result) => {
    // Redirect to profile page after sign-in. The service worker will detect
    // this and append the ID token to the header.
    window.location.assign('/profile');
  })
  .catch((error) => {
    // Error occurred.
  });
auth_svc_sign_in_email.js

वेब नेमस्पेस किया गया एपीआई

// Sign in screen.
firebase.auth().signInWithEmailAndPassword(email, password)
  .then((result) => {
    // Redirect to profile page after sign-in. The service worker will detect
    // this and append the ID token to the header.
    window.location.assign('/profile');
  })
  .catch((error) => {
    // Error occurred.
  });
service-worker-sessions.js

सर्वर साइड बदलाव

सर्वर साइड कोड हर अनुरोध पर आईडी टोकन की पहचान कर पाएगा. यह कार्रवाई Node.js के एडमिन SDK या FirebaseServerApp का इस्तेमाल करने वाले वेब SDK टूल के साथ काम करती है.

Node.js

  // Server side code.
  const admin = require('firebase-admin');

  // The Firebase Admin SDK is used here to verify the ID token.
  admin.initializeApp();

  function getIdToken(req) {
    // Parse the injected ID token from the request header.
    const authorizationHeader = req.headers.authorization || '';
    const components = authorizationHeader.split(' ');
    return components.length > 1 ? components[1] : '';
  }

  function checkIfSignedIn(url) {
    return (req, res, next) => {
      if (req.url == url) {
        const idToken = getIdToken(req);
        // Verify the ID token using the Firebase Admin SDK.
        // User already logged in. Redirect to profile page.
        admin.auth().verifyIdToken(idToken).then((decodedClaims) => {
          // User is authenticated, user claims can be retrieved from
          // decodedClaims.
          // In this sample code, authenticated users are always redirected to
          // the profile page.
          res.redirect('/profile');
        }).catch((error) => {
          next();
        });
      } else {
        next();
      }
    };
  }

  // If a user is signed in, redirect to profile page.
  app.use(checkIfSignedIn('/'));
service-worker-sessions.js

वेब मॉड्यूलर एपीआई

import { initializeServerApp } from 'firebase/app';
import { getAuth } from 'firebase/auth';
import { headers } from 'next/headers';
import { redirect } from 'next/navigation';

export default function MyServerComponent() {

    // Get relevant request headers (in Next.JS)
    const authIdToken = headers().get('Authorization')?.split('Bearer ')[1];

    // Initialize the FirebaseServerApp instance.
    const serverApp = initializeServerApp(firebaseConfig, { authIdToken });

    // Initialize Firebase Authentication using the FirebaseServerApp instance.
    const auth = getAuth(serverApp);

    if (auth.currentUser) {
        redirect('/profile');
    }

    // ...
}
firebaseserverapp.js

नतीजा

इसके अलावा, सर्विस वर्कर के ज़रिए आईडी टोकन सेट किए जाएंगे और सर्विस वर्कर को एक ही ऑरिजिन से चलाया जा सकता है. ऐसे में CSRF का खतरा नहीं होता है, क्योंकि आपके एंडपॉइंट को कॉल करने की कोशिश करने वाले अलग ऑरिजिन की वेबसाइट, सर्विस वर्कर को शुरू नहीं कर पाएगी. इसकी वजह से सर्वर के हिसाब से अनुरोध बिना पुष्टि वाला दिखेगा.

सर्विस वर्कर अब सभी आधुनिक मुख्य ब्राउज़र में काम करते हैं, लेकिन कुछ पुराने ब्राउज़र पर ये काम नहीं करते. इस वजह से, जब सर्विस वर्कर उपलब्ध नहीं होते या किसी ऐप्लिकेशन को सिर्फ़ उन ब्राउज़र पर चलाने के लिए सीमित किया जा सकता है जिन पर सर्विस वर्कर काम करते हैं, तब कुछ फ़ॉलबैक को आपके सर्वर को आईडी टोकन पास करने की ज़रूरत हो सकती है.

ध्यान दें कि सर्विस वर्कर सिर्फ़ एक ऑरिजिन के लिए होते हैं और उन्हें सिर्फ़ https कनेक्शन या localhost के ज़रिए काम करने वाली वेबसाइटों पर इंस्टॉल किया जाएगा.

caniuse.com पर जाकर सर्विस वर्कर के लिए ब्राउज़र सहायता के बारे में ज़्यादा जानें.