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

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

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

खास जानकारी

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

Web

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

Web

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

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

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

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

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

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

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

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

Web

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

Web

// 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

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

Web

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

Web

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() को कॉल करना होगा, ताकि इसे इस तरह सेटअप किया जा सके मौजूदा पेज के लिए नियंत्रक है.

Web

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

Web

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

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

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

Web

// 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

Web

// 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

जब उपयोगकर्ता प्रवेश करता है और किसी अन्य पृष्ठ पर रीडायरेक्ट करता है, तो सर्विस वर्कर रीडायरेक्ट पूरा होने से पहले, हेडर में आईडी टोकन इंजेक्ट कर पाएगा.

Web

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

Web

// 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

नतीजा

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

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

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

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