إدارة الجلسات مع مشغّلي الخدمات

توفّر Firebase Auth إمكانية استخدام مشغّلي الخدمات لرصد رموز تعريف Firebase المميزة وتمريرها لإدارة الجلسات. ويوفّر ذلك المزايا التالية:

  • إمكانية تمرير رمز مميّز للرقم التعريفي في كل طلب HTTP من الخادم بدون أي عمل إضافي
  • إمكانية إعادة تحميل الرمز المميّز للرقم التعريفي بدون أي رحلة ذهاب وعودة إضافية أو فترات استجابة
  • جلسات متزامنة بين الواجهة الخلفية والواجهة الأمامية يمكن استخدام هذا الحلّ في التطبيقات التي تحتاج إلى الوصول إلى خدمات Firebase، مثل "قاعدة بيانات الوقت الفعلي" وFirestore وغيرهما، وبعض الموارد الخارجية من جهة الخادم (قاعدة بيانات SQL وغيرها). بالإضافة إلى ذلك، يمكن أيضًا الوصول إلى الجلسة نفسها من مشغّل الخدمات أو مشغّل الويب أو المشغّل المشترَك.
  • يغني عن الحاجة إلى تضمين الرمز المصدر لـ Firebase Auth في كل صفحة (يقلل من وقت الاستجابة). سيتولى مشغّل الخدمات، الذي يتم تحميله وإعداده مرة واحدة، إدارة الجلسات لجميع العملاء في الخلفية.

نظرة عامة

تم تحسين Firebase Auth ليعمل من جهة العميل. يتم حفظ الرموز المميزة في مساحة تخزين الويب. يسهّل ذلك أيضًا عملية الدمج مع خدمات Firebase الأخرى، مثل قاعدة بيانات الوقت الفعلي و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 الحالية. يمكن استرداد الرمز المميّز الحالي لرقم تعريف المستخدم من مشغّل الخدمات. إذا انتهت صلاحية الرمز المميّز، ستعمل حزمة تطوير البرامج (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);
      }
    });
  });
};

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

عندما يسجّل المستخدم الدخول وتتم إعادة توجيهه إلى صفحة أخرى، سيتمكّن مشغّل الخدمات من إدخال الرمز المميّز للمعرّف في العنوان قبل اكتمال عملية إعادة التوجيه.

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 أو في SDK للويب باستخدام 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');
    }

    // ...
}

الخاتمة

بالإضافة إلى ذلك، بما أنّه سيتم ضبط الرموز المميّزة للتعريف من خلال مشغّلي الخدمات، وبما أنّ مشغّلي الخدمات يقتصر تشغيلهم على المصدر نفسه، لن يكون هناك خطر من حدوث هجمات CSRF لأنّ أي موقع إلكتروني من مصدر مختلف يحاول الاتصال بنقاط النهاية سيفشل في استدعاء مشغّل الخدمات، ما يؤدي إلى ظهور الطلب على أنّه غير مصادَق عليه من منظور الخادم.

على الرغم من أنّ مشغّلي الخدمات متوافقون الآن مع جميع المتصفّحات الرئيسية الحديثة، فإنّ بعض المتصفّحات القديمة لا تتوافق معهم. نتيجةً لذلك، قد تكون هناك حاجة إلى بعض الإجراءات الاحتياطية لتمرير الرمز المميّز للمعرّف إلى الخادم عندما لا تكون مشغّلات الخدمات متاحة أو عندما يكون التطبيق مقصورًا على العمل فقط على المتصفّحات التي تتيح مشغّلات الخدمات.

يُرجى العِلم أنّ مشغّلات الخدمات تقتصر على مصدر واحد فقط ولن يتم تثبيتها إلا على المواقع الإلكترونية التي يتم عرضها عبر اتصال https أو المضيف المحلي.

يمكنك الاطّلاع على مزيد من المعلومات حول المتصفّحات المتوافقة مع مشغِّل الخدمات على الموقع الإلكتروني caniuse.com.