একটি Chrome এক্সটেনশনে Firebase দিয়ে প্রমাণীকরণ করুন

এই ডকুমেন্টটি আপনাকে দেখায় যে কীভাবে Firebase Authentication ব্যবহার করে ব্যবহারকারীদের একটি Chrome এক্সটেনশনে সাইন ইন করতে হয় যা Manifest V3 ব্যবহার করে।

Firebase Authentication একটি Chrome এক্সটেনশন থেকে ব্যবহারকারীদের সাইন ইন করার জন্য একাধিক প্রমাণীকরণ পদ্ধতি প্রদান করে, কিছুতে অন্যদের তুলনায় বেশি ডেভেলপমেন্ট প্রচেষ্টার প্রয়োজন হয়।

ম্যানিফেস্ট V3 ক্রোম এক্সটেনশনে নিম্নলিখিত পদ্ধতিগুলি ব্যবহার করতে, আপনাকে কেবল firebase/auth/web-extension থেকে এগুলি আমদানি করতে হবে:

  • ইমেল এবং পাসওয়ার্ড দিয়ে সাইন ইন করুন ( createUserWithEmailAndPassword এবং signInWithEmailAndPassword )
  • ইমেল লিঙ্ক দিয়ে সাইন ইন করুন ( sendSignInLinkToEmail , isSignInWithEmailLink , এবং signInWithEmailLink )
  • বেনামে সাইন ইন করুন ( signInAnonymously )
  • একটি কাস্টম প্রমাণীকরণ সিস্টেম ( signInWithCustomToken ) দিয়ে সাইন ইন করুন।
  • প্রোভাইডার সাইন-ইন স্বাধীনভাবে পরিচালনা করুন তারপর signInWithCredential ব্যবহার করুন

নিম্নলিখিত সাইন ইন পদ্ধতিগুলিও সমর্থিত তবে কিছু অতিরিক্ত কাজ প্রয়োজন:

  • একটি পপ-আপ উইন্ডো দিয়ে সাইন ইন করুন ( signInWithPopup , linkWithPopup , এবং reauthenticateWithPopup )
  • সাইন-ইন পৃষ্ঠায় পুনঃনির্দেশিত করে সাইন ইন করুন ( signInWithRedirect , linkWithRedirect , এবং reauthenticateWithRedirect )
  • reCAPTCHA ব্যবহার করে ফোন নম্বর দিয়ে সাইন ইন করুন
  • reCAPTCHA ব্যবহার করে SMS মাল্টি-ফ্যাক্টর অথেনটিকেশন
  • reCAPTCHA এন্টারপ্রাইজ সুরক্ষা

ম্যানিফেস্ট V3 ক্রোম এক্সটেনশনে এই পদ্ধতিগুলি ব্যবহার করতে, আপনাকে অবশ্যই অফস্ক্রিন ডকুমেন্টস ব্যবহার করতে হবে।

ফায়ারবেস/অথ/ওয়েব-এক্সটেনশন এন্ট্রি পয়েন্ট ব্যবহার করুন

firebase/auth/web-extension থেকে আমদানি করলে Chrome এক্সটেনশন থেকে সাইন ইন করা ব্যবহারকারীদের ওয়েব অ্যাপের মতোই হয়ে ওঠে।

firebase/auth/web-extension শুধুমাত্র ওয়েব SDK ভার্সন v10.8.0 এবং তার পরবর্তী ভার্সনে সমর্থিত।

import { getAuth, signInWithEmailAndPassword } from 'firebase/auth/web-extension';

const auth = getAuth();
signInWithEmailAndPassword(auth, email, password)
  .then((userCredential) => {
    // Signed in
    const user = userCredential.user;
    // ...
  })
  .catch((error) => {
    const errorCode = error.code;
    const errorMessage = error.message;
  });

অফস্ক্রিন ডকুমেন্ট ব্যবহার করুন

কিছু প্রমাণীকরণ পদ্ধতি, যেমন signInWithPopup , linkWithPopup , এবং reauthenticateWithPopup , Chrome এক্সটেনশনের সাথে সরাসরি সামঞ্জস্যপূর্ণ নয়, কারণ তাদের এক্সটেনশন প্যাকেজের বাইরে থেকে কোড লোড করতে হয়। ম্যানিফেস্ট V3 থেকে শুরু করে, এটি অনুমোদিত নয় এবং এক্সটেনশন প্ল্যাটফর্ম দ্বারা এটি ব্লক করা হবে। এটি এড়াতে, আপনি একটি অফস্ক্রিন ডকুমেন্ট ব্যবহার করে একটি আইফ্রেমের মধ্যে সেই কোডটি লোড করতে পারেন। অফস্ক্রিন ডকুমেন্টে, স্বাভাবিক প্রমাণীকরণ প্রবাহ বাস্তবায়ন করুন এবং অফস্ক্রিন ডকুমেন্ট থেকে ফলাফলটি এক্সটেনশনে প্রক্সি করুন।

এই নির্দেশিকাটি উদাহরণ হিসেবে signInWithPopup ব্যবহার করে, তবে একই ধারণা অন্যান্য প্রমাণীকরণ পদ্ধতির ক্ষেত্রেও প্রযোজ্য।

শুরু করার আগে

এই কৌশলটির জন্য আপনাকে ওয়েবে উপলব্ধ একটি ওয়েব পৃষ্ঠা সেট আপ করতে হবে, যা আপনি একটি আইফ্রেমে লোড করবেন। ফায়ারবেস হোস্টিং সহ যেকোনো হোস্ট এর জন্য কাজ করে। নিম্নলিখিত সামগ্রী সহ একটি ওয়েবসাইট তৈরি করুন:

<!DOCTYPE html>
<html>
  <head>
    <title>signInWithPopup</title>
    <script src="signInWithPopup.js"></script>
  </head>
  <body><h1>signInWithPopup</h1></body>
</html>

ফেডারেটেড সাইন ইন

যদি আপনি ফেডারেটেড সাইন ইন ব্যবহার করেন, যেমন Google, Apple, SAML, অথবা OIDC দিয়ে সাইন ইন, তাহলে আপনাকে অবশ্যই অনুমোদিত ডোমেনের তালিকায় আপনার Chrome এক্সটেনশন আইডি যোগ করতে হবে:

  1. Firebase কনসোলে আপনার প্রকল্পটি খুলুন।
  2. প্রমাণীকরণ বিভাগে, সেটিংস পৃষ্ঠাটি খুলুন।
  3. অনুমোদিত ডোমেনের তালিকায় নিচের মতো একটি URI যোগ করুন: 
    chrome-extension://CHROME_EXTENSION_ID

আপনার Chrome এক্সটেনশনের ম্যানিফেস্ট ফাইলে content_security_policy allowlist-এ নিম্নলিখিত URL গুলি যোগ করুন:

  • https://apis.google.com
  • https://www.gstatic.com
  • https://www.googleapis.com
  • https://securetoken.googleapis.com

প্রমাণীকরণ বাস্তবায়ন করুন

আপনার HTML ডকুমেন্টে, signInWithPopup.js হল জাভাস্ক্রিপ্ট কোড যা প্রমাণীকরণ পরিচালনা করে। এক্সটেনশনে সরাসরি সমর্থিত একটি পদ্ধতি বাস্তবায়নের দুটি ভিন্ন উপায় রয়েছে:

  • আপনার এক্সটেনশন কোড যেমন ব্যাকগ্রাউন্ড স্ক্রিপ্ট, সার্ভিস ওয়ার্কার, অথবা পপআপ স্ক্রিপ্টে firebase/auth/web-extension ব্যবহার করুন। শুধুমাত্র আপনার অফস্ক্রিন আইফ্রেমের ভিতরেই firebase/auth ব্যবহার করুন, কারণ সেই আইফ্রেমটি একটি স্ট্যান্ডার্ড ওয়েব পৃষ্ঠার প্রসঙ্গে চলে।
  • প্রমাণীকরণের অনুরোধ এবং প্রতিক্রিয়া প্রক্সি করার জন্য, প্রমাণীকরণের যুক্তিটি একটি postMessage শ্রোতাতে মুড়ে দিন। 
import { signInWithPopup, GoogleAuthProvider, getAuth } from'firebase/auth';
import { initializeApp } from 'firebase/app';
import firebaseConfig from './firebaseConfig.js'

const app = initializeApp(firebaseConfig);
const auth = getAuth();

// This code runs inside of an iframe in the extension's offscreen document.
// This gives you a reference to the parent frame, i.e. the offscreen document.
// You will need this to assign the targetOrigin for postMessage.
const PARENT_FRAME = document.location.ancestorOrigins[0];

// This demo uses the Google auth provider, but any supported provider works.
// Make sure that you enable any provider you want to use in the Firebase Console.
// https://console.firebase.google.com/project/_/authentication/providers
const PROVIDER = new GoogleAuthProvider();

function sendResponse(result) {
  globalThis.parent.self.postMessage(JSON.stringify(result), PARENT_FRAME);
}

globalThis.addEventListener('message', function({data}) {
  if (data.initAuth) {
    // Opens the Google sign-in page in a popup, inside of an iframe in the
    // extension's offscreen document.
    // To centralize logic, all respones are forwarded to the parent frame,
    // which goes on to forward them to the extension's service worker.
    signInWithPopup(auth, PROVIDER)
      .then(sendResponse)
      .catch(sendResponse)
  }
});

আপনার Chrome এক্সটেনশন তৈরি করুন

আপনার ওয়েবসাইটটি লাইভ হওয়ার পরে, আপনি এটি আপনার Chrome এক্সটেনশনে ব্যবহার করতে পারেন।

  1. আপনার manifest.json ফাইলে offscreen অনুমতি যোগ করুন: 
    2.     {
      "name": "signInWithPopup Demo",
      "manifest_version" 3,
      "background": {
        "service_worker": "background.js"
      },
      "permissions": [
        "offscreen"
      ]
    }
  2. অফস্ক্রিন ডকুমেন্ট নিজেই তৈরি করুন। এটি আপনার এক্সটেনশন প্যাকেজের ভিতরে একটি ন্যূনতম HTML ফাইল যা আপনার অফস্ক্রিন ডকুমেন্টের লজিক লোড করে। জাভাস্ক্রিপ্ট: 
    3.     <!DOCTYPE html>
    <script src="./offscreen.js"></script>
  3. আপনার এক্সটেনশন প্যাকেজে offscreen.js অন্তর্ভুক্ত করুন। এটি ধাপ ১ এ সেট আপ করা পাবলিক ওয়েবসাইট এবং আপনার এক্সটেনশনের মধ্যে প্রক্সি হিসেবে কাজ করে। 
    4.     // This URL must point to the public site
    const _URL = 'https://example.com/signInWithPopupExample';
    const iframe = document.createElement('iframe');
    iframe.src = _URL;
    document.documentElement.appendChild(iframe);
    chrome.runtime.onMessage.addListener(handleChromeMessages);

    function handleChromeMessages(message, sender, sendResponse) {
      // Extensions may have an number of other reasons to send messages, so you
      // should filter out any that are not meant for the offscreen document.
      if (message.target !== 'offscreen') {
        return false;
      }

      function handleIframeMessage({data}) {
        try {
          if (data.startsWith('!_{')) {
            // Other parts of the Firebase library send messages using postMessage.
            // You don't care about them in this context, so return early.
            return;
          }
          data = JSON.parse(data);
          self.removeEventListener('message', handleIframeMessage);

          sendResponse(data);
        } catch (e) {
          console.log(`json parse failed - ${e.message}`);
        }
      }

      globalThis.addEventListener('message', handleIframeMessage, false);

      // Initialize the authentication flow in the iframed document. You must set the
      // second argument (targetOrigin) of the message in order for it to be successfully
      // delivered.
      iframe.contentWindow.postMessage({"initAuth": true}, new URL(_URL).origin);
      return true;
    }
  4. আপনার background.js পরিষেবা কর্মী থেকে অফস্ক্রিন ডকুমেন্ট সেট আপ করুন। 
    5.     import { getAuth } from 'firebase/auth/web-extension';

    const OFFSCREEN_DOCUMENT_PATH = '/offscreen.html';

    // A global promise to avoid concurrency issues
    let creatingOffscreenDocument;

    // Chrome only allows for a single offscreenDocument. This is a helper function
    // that returns a boolean indicating if a document is already active.
    async function hasDocument() {
      // Check all windows controlled by the service worker to see if one
      // of them is the offscreen document with the given path
      const matchedClients = await clients.matchAll();
      return matchedClients.some(
        (c) => c.url === chrome.runtime.getURL(OFFSCREEN_DOCUMENT_PATH)
      );
    }

    async function setupOffscreenDocument(path) {
      // If we do not have a document, we are already setup and can skip
      if (!(await hasDocument())) {
        // create offscreen document
        if (creating) {
          await creating;
        } else {
          creating = chrome.offscreen.createDocument({
            url: path,
            reasons: [
                chrome.offscreen.Reason.DOM_SCRAPING
            ],
            justification: 'authentication'
          });
          await creating;
          creating = null;
        }
      }
    }

    async function closeOffscreenDocument() {
      if (!(await hasDocument())) {
        return;
      }
      await chrome.offscreen.closeDocument();
    }

    function getAuth() {
      return new Promise(async (resolve, reject) => {
        const auth = await chrome.runtime.sendMessage({
          type: 'firebase-auth',
          target: 'offscreen'
        });
        auth?.name !== 'FirebaseError' ? resolve(auth) : reject(auth);
      })
    }

    async function firebaseAuth() {
      await setupOffscreenDocument(OFFSCREEN_DOCUMENT_PATH);

      const auth = await getAuth()
        .then((auth) => {
          console.log('User Authenticated', auth);
          return auth;
        })
        .catch(err => {
          if (err.code === 'auth/operation-not-allowed') {
            console.error('You must enable an OAuth provider in the Firebase' +
                          ' console in order to use signInWithPopup. This sample' +
                          ' uses Google by default.');
          } else {
            console.error(err);
            return err;
          }
        })
        .finally(closeOffscreenDocument)

      return auth;
    }

    এখন, যখন আপনি আপনার সার্ভিস ওয়ার্কারের মধ্যে firebaseAuth() কল করবেন, তখন এটি অফস্ক্রিন ডকুমেন্ট তৈরি করবে এবং সাইটটিকে একটি আইফ্রেমে লোড করবে। সেই আইফ্রেমটি ব্যাকগ্রাউন্ডে প্রক্রিয়া করবে এবং ফায়ারবেস স্ট্যান্ডার্ড অথেনটিকেশন ফ্লোয়ের মধ্য দিয়ে যাবে। একবার এটি সমাধান হয়ে গেলে বা প্রত্যাখ্যান হয়ে গেলে, অফস্ক্রিন ডকুমেন্ট ব্যবহার করে অথেনটিকেশন অবজেক্টটি আপনার আইফ্রেম থেকে আপনার সার্ভিস ওয়ার্কারের কাছে প্রক্সি করা হবে।