مدیریت جلسه با کارگزاران خدمات

Firebase Auth امکان استفاده از کارگران سرویس را برای شناسایی و ارسال کدهای Firebase ID برای مدیریت جلسه فراهم می‌کند. این کار مزایای زیر را به‌همراه دارد:

  • امکان ارسال یک شناسه توکن در هر درخواست HTTP از سرور بدون هیچ کار اضافی.
  • امکان بازآوری کردن کد شناسه بدون هیچ‌گونه رفت‌وبرگشت یا تأخیر اضافی.
  • جلسه‌های همگام‌سازی‌شده باطن و ظاهر. برنامه‌هایی که نیاز به دسترسی به سرویس‌های Firebase مانند Realtime Database،‏ Firestore، و غیره و برخی منابع سمت سرور خارجی (پایگاه داده SQL، و غیره) دارند می‌توانند از این راه‌حل استفاده کنند. علاوه‌براین، ازطریق کارگر سرویس، کارگر وب، یا کارگر مشترک نیز می‌توان به همان جلسه دسترسی داشت.
  • نیاز به گنجاندن کد منبع Firebase Auth در هر صفحه را ازبین می‌برد (تأخیر را کاهش می‌دهد). عامل خدماتی که یک‌بار بارگیری و مقداردهی اولیه شده است، مدیریت جلسه را برای همه کارخواهان در پس‌زمینه انجام می‌دهد.

نمای کلی

Firebase Auth برای اجرا در سمت کارخواه بهینه‌سازی شده است. کدها در فضای ذخیره‌سازی وب ذخیره می‌شوند. این کار ادغام با سایر سرویس‌های Firebase مانند Realtime Database،‏ 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.
  });

Web

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

بااین‌حال، این یعنی برخی‌از اسکریپت‌ها باید از کارخواه اجرا شوند تا جدیدترین کلید شناسه را دریافت کنند و سپس آن را ازطریق سرایند درخواست، بدنه POST، و غیره به سرور ارسال کنند.

این ممکن است مقیاس‌پذیر نباشد و درعوض کوکی‌های جلسه سمت سرور لازم باشد. کدهای شناسه را می‌توان به‌عنوان کوکی‌های جلسه تنظیم کرد، اما این کوکی‌ها عمر کوتاهی دارند و باید از کارخواه بازآوری شوند و سپس پس‌از انقضا به‌عنوان کوکی‌های جدید تنظیم شوند که ممکن است به یک رفت‌وبرگشت اضافی نیاز داشته باشد اگر کاربر مدتی از سایت بازدید نکرده باشد.

درحالی‌که Firebase Auth یک راهکار مدیریت جلسه مبتنی بر کوکی سنتی‌تر ارائه می‌دهد، این راهکار برای برنامه‌های مبتنی بر کوکی httpOnly سمت سرور بهترین عملکرد را دارد و مدیریت آن دشوارتر است زیرا توکن‌های کارخواه و توکن‌های سمت سرور ممکن است از همگام‌سازی خارج شوند، به‌ویژه اگر نیاز به استفاده از دیگر سرویس‌های Firebase مبتنی بر کارخواه نیز داشته باشید.

درعوض، می‌توان از کارگران سرویس برای مدیریت جلسه‌های کاربر برای مصرف سمت سرور استفاده کرد. این ویژگی به‌دلایل زیر کار می‌کند:

  • کارگران خدماتی به وضعیت Firebase Auth فعلی دسترسی دارند. نشان شناسه کاربر فعلی را می‌توان از کارگر سرویس بازیابی کرد. اگر توکن منقضی شده باشد، کیت توسعه نرم‌افزار کارخواه آن را بازآوری می‌کند و توکن جدیدی برمی‌گرداند.
  • کارگران خدمات می‌توانند درخواست‌های واکشی را رهگیری و آن‌ها را اصلاح کنند.

تغییرات عامل خدماتی

اگر کاربر به سیستم وارد شده باشد، کارگر سرویس باید شامل کتابخانه Auth و توانایی دریافت شناسه فعلی باشد.

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);
      }
    });
  });
};

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);
      }
    });
  });
};

همه درخواست‌های واکشی به مبدأ برنامه رهگیری می‌شود و اگر یک شناسه ژتون دردسترس باشد، ازطریق سرصفحه به درخواست اضافه می‌شود. در سمت سرور، سرایندهای درخواست برای بررسی، درستی‌سنجی، و پردازش شناسه توکن بررسی خواهند شد. در اسکریپت عامل خدماتی، درخواست واکشی رهگیری و اصلاح می‌شود.

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 if (
        req.headers.get('Content-Type').indexOf('multipart/form-data') !== -1
      ) {
        return req.clone().arrayBuffer();
      } 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));
});

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 if (
        req.headers.get('Content-Type').indexOf('multipart/form-data') !== -1
      ) {
        return req.clone().arrayBuffer();
      } 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));
});

درنتیجه، همه درخواست‌های اصالت‌سنجی‌شده همیشه یک شناسه ژتون در سرایند خواهند داشت که بدون پردازش اضافی منتقل می‌شود.

برای اینکه کارگر سرویس بتواند تغییرات وضعیت «اصالت‌سنجی» را شناسایی کند، باید در صفحه ورود به سیستم/ ثبت‌نام نصب شود. مطمئن شوید که سرویس‌کار بسته‌بندی شده باشد تا پس‌از بسته شدن مرورگر همچنان کار کند.

پس‌از نصب، کارگر سرویس باید clients.claim() را هنگام فعال‌سازی فراخوانی کند تا بتواند به‌عنوان کنترل‌کننده صفحه فعلی راه‌اندازی شود.

Web

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

Web

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

تغییرات سمت کارخواه

عامل خدماتی، درصورت پشتیبانی شدن، باید در صفحه ورود به سیستم/ ثبت‌نام سمت کارخواه نصب شود.

Web

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

Web

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

وقتی کاربر به سیستم وارد می‌شود و به صفحه دیگری هدایت می‌شود، عامل خدماتی می‌تواند پیش‌از تکمیل هدایت، شناسه ID را در سرصفحه تزریق کند.

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

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

تغییرات سمت سرور

کد سمت سرور می‌تواند شناسه را در هر درخواست شناسایی کند. این رفتار توسط «سرپرست SDK» برای Node.js یا با «کیت توسعه نرم‌افزار» وب بااستفاده از FirebaseServerApp پشتیبانی می‌شود.

Node.js

  // Server side code.
  const { initializeApp } = require('firebase-admin/app');
  const { getAuth } = require('firebase-admin/auth');

  // The Firebase Admin SDK is used here to verify the ID token.
  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.
        getAuth().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('/'));

Web modular API

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');
    }

    // ...
}

نتیجه‌گیری

In addition, since ID tokens will be set via the service workers, and service workers are restricted to run from the same origin, there is no risk of CSRF since a website of different origin attempting to call your endpoints will fail to invoke the service worker, causing the request to appear unauthenticated from the server's perspective.

درحالی‌که اکنون همه مرورگرهای اصلی مدرن از کارگران خدمات پشتیبانی می‌کنند، برخی مرورگرهای قدیمی‌تر از آن‌ها پشتیبانی نمی‌کنند. درنتیجه، ممکن است برای ارسال کردن شناسه توکن به سرور شما در زمانی که کارگران سرویس دردسترس نیستند، به برخی‌از موارد جایگزین نیاز باشد یا ممکن است برنامه محدود شود تا فقط در مرورگرهایی اجرا شود که از کارگران سرویس پشتیبانی می‌کنند.

توجه داشته باشید که عاملان خدماتی فقط تک‌مبدأ هستند و فقط در وب‌سایت‌هایی نصب می‌شوند که ازطریق اتصال https یا localhost ارائه می‌شوند.

درباره پشتیبانی مرورگر از کارگر سرویس در caniuse.com بیشتر بدانید.