Uwierzytelnianie za pomocą Firebase w rozszerzeniu do Chrome

Z tego dokumentu dowiesz się, jak używać Firebase Authentication do logowania użytkowników w rozszerzeniu Chrome, które korzysta z Manifestu V3.

Firebase Authentication udostępnia wiele metod uwierzytelniania, które umożliwiają logowanie użytkowników z poziomu rozszerzenia Chrome. Niektóre z nich wymagają większego nakładu pracy niż inne.

Aby używać tych metod w rozszerzeniu do Chrome z Manifestem V3, wystarczy zaimportować je z firebase/auth/web-extension:

  • Zaloguj się za pomocą adresu e-mail i hasła (createUserWithEmailAndPassword i signInWithEmailAndPassword).
  • Logowanie za pomocą linku w e-mailu (sendSignInLinkToEmail, isSignInWithEmailLink i signInWithEmailLink)
  • Zaloguj się anonimowo (signInAnonymously)
  • Logowanie się za pomocą niestandardowego systemu uwierzytelniania (signInWithCustomToken)
  • Obsługuj logowanie u dostawcy niezależnie, a potem używaj signInWithCredential

Obsługiwane są też te metody logowania, ale wymagają dodatkowych działań:

  • Logowanie w wyskakującym okienku (signInWithPopup, linkWithPopup i reauthenticateWithPopup)
  • Logowanie przez przekierowanie na stronę logowania (signInWithRedirect, linkWithRedirect i reauthenticateWithRedirect)
  • Logowanie się za pomocą numeru telefonu z reCAPTCHA
  • Uwierzytelnianie wielopoziomowe z użyciem SMS-ów i reCAPTCHA
  • Ochrona reCAPTCHA Enterprise

Aby używać tych metod w rozszerzeniu do Chrome w wersji Manifest V3, musisz korzystać z dokumentów poza ekranem.

Użyj punktu wejścia firebase/auth/web-extension

Importowanie z firebase/auth/web-extension sprawia, że logowanie użytkowników z rozszerzenia do Chrome jest podobne do logowania w aplikacji internetowej.

firebase/auth/web-extension jest obsługiwany tylko w przypadku pakietu SDK do klienta internetowego w wersji 10.8.0 lub nowszej.

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

Korzystanie z dokumentów poza ekranem

Niektóre metody uwierzytelniania, takie jak signInWithPopup, linkWithPopup i reauthenticateWithPopup, nie są bezpośrednio zgodne z rozszerzeniami do Chrome, ponieważ wymagają wczytywania kodu spoza pakietu rozszerzenia. Od platformy Manifest V3 jest to niedozwolone i będzie blokowane przez platformę rozszerzeń. Aby to obejść, możesz załadować ten kod w elemencie iframe za pomocą dokumentu poza ekranem. W dokumencie poza ekranem zaimplementuj normalny proces uwierzytelniania i przekaż wynik z dokumentu poza ekranem z powrotem do rozszerzenia.

W tym przewodniku jako przykładu używamy signInWithPopup, ale ta sama koncepcja dotyczy innych metod uwierzytelniania.

Zanim zaczniesz

Ta technika wymaga skonfigurowania strony internetowej dostępnej w internecie, którą załadujesz w ramce iframe. W tym celu możesz użyć dowolnego hosta, w tym Hostingu Firebase. Utwórz witrynę z tą treścią:

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

Logowanie sfederowane

Jeśli używasz logowania sfederowanego, np. logowania przez Google, Apple, SAML lub OIDC, musisz dodać identyfikator rozszerzenia Chrome do listy autoryzowanych domen:

  1. Otwórz projekt w Firebasekonsoli.
  2. W sekcji Uwierzytelnianie otwórz stronę Ustawienia.
  3. Dodaj do listy autoryzowanych domen identyfikator URI podobny do tego: 
    chrome-extension://CHROME_EXTENSION_ID

W pliku manifestu rozszerzenia Chrome dodaj te adresy URL do listy dozwolonych content_security_policy:

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

Wdrażanie uwierzytelniania

W dokumencie HTML plik signInWithPopup.js to kod JavaScript, który obsługuje uwierzytelnianie. Metodę bezpośrednio obsługiwaną w rozszerzeniu można wdrożyć na 2 sposoby:

  • Używaj firebase/auth/web-extension w kodzie rozszerzenia, np. w skryptach działających w tle, service workerach lub skryptach wyskakujących okien. Używaj funkcji firebase/auth tylko w niewidocznym elemencie iframe, ponieważ działa on w standardowym kontekście strony internetowej.
  • Umieść logikę uwierzytelniania w obiekcie nasłuchującym postMessage, aby przekazywać żądanie i odpowiedź uwierzytelniania.
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)
  }
});

Tworzenie rozszerzenia do Chrome

Gdy Twoja witryna będzie aktywna, możesz jej używać w rozszerzeniu do Chrome.

  1. Dodaj uprawnienie offscreen do pliku manifest.json:
    2.     {
      "name": "signInWithPopup Demo",
      "manifest_version" 3,
      "background": {
        "service_worker": "background.js"
      },
      "permissions": [
        "offscreen"
      ]
    }
  2. Utwórz sam dokument poza ekranem. Jest to minimalny plik HTML w pakiecie rozszerzenia, który wczytuje logikę kodu JavaScript dokumentu poza ekranem:
    3.     <!DOCTYPE html>
    <script src="./offscreen.js"></script>
  3. Do pakietu rozszerzenia dodaj offscreen.js. Działa jako serwer proxy między publiczną witryną skonfigurowaną w kroku 1 a rozszerzeniem.
    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. Skonfiguruj dokument poza ekranem w usłudze 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;
    }

    Teraz, gdy wywołasz funkcję firebaseAuth() w usłudze, utworzy ona dokument poza ekranem i załaduje witrynę w elemencie iframe. Ta ramka iframe będzie działać w tle, a Firebase przejdzie standardowy proces uwierzytelniania. Gdy problem zostanie rozwiązany lub odrzucony, obiekt uwierzytelniania zostanie przekazany z elementu iframe do procesu roboczego usługi za pomocą dokumentu poza ekranem.