webRequest.onHeadersReceived

Syntax

browser.webRequest.onHeadersReceived.addListener(
  listener,             // function
  filter,               //  object
  extraInfoSpec         //  optional array of strings
)
browser.webRequest.onHeadersReceived.removeListener(listener)
browser.webRequest.onHeadersReceived.hasListener(listener)

Ereignisse haben drei Funktionen:

addListener(listener, filter, extraInfoSpec)

Fügt einen Listener zu diesem Ereignis hinzu.

removeListener(listener)

Stoppt das Lauschen auf dieses Ereignis. Das listener-Argument ist der zu entfernende Listener.

hasListener(listener)

Überprüft, ob listener für dieses Ereignis registriert ist. Gibt true zurück, wenn es zuhört, ansonsten false.

addListener-Syntax

Parameter

listener

Die Funktion, die aufgerufen wird, wenn dieses Ereignis eintritt. Der Funktion wird folgendes Argument übergeben:

details

object. Details der Anfrage. Dies wird Antwort-Header enthalten, wenn Sie "responseHeaders" in extraInfoSpec aufgenommen haben.

Gibt zurück: webRequest.BlockingResponse. Wenn "blocking" im extraInfoSpec-Parameter angegeben ist, gibt der Ereignis-Listener ein BlockingResponse-Objekt zurück und kann dessen responseHeaders-Eigenschaft setzen. In Firefox kann der Rückgabewert ein Promise sein, der sich in ein BlockingResponse auflöst.

filter

webRequest.RequestFilter. Eine Reihe von Filtern, die die an diesen Listener gesendeten Ereignisse einschränken.

extraInfoSpec Optional

array von string. Zusätzliche Optionen für das Ereignis. Sie können einen der folgenden Werte übergeben:

• "blocking" um die Anfrage synchron zu machen, sodass Sie Anfrage- und Antwort-Header ändern können
• "responseHeaders" um die Antwort-Header im details-Objekt einzuschließen, das an den Listener übergeben wird

Zusätzliche Objekte

details

documentId Optional

string. Die UUID des Dokuments, das die Anfrage stellt. Siehe den Artikel Arbeiten mit documentId für weitere Informationen.

documentLifecycle

string. Der Lebenszyklus, in dem sich das Dokument befindet. Gibt die Werte "prerender", "active", "cached", oder "pending_deletion" zurück.

cookieStoreId

string. Wenn die Anfrage von einem Tab kommt, der in einer kontextuellen Identität geöffnet ist, die Cookie-Store-ID der kontextuellen Identität. Siehe Arbeiten mit kontextuellen Identitäten für weitere Informationen.

documentUrl

string. Die URL des Dokuments, in dem die Ressource geladen wird. Wenn zum Beispiel die Webseite bei "https://example.com" ein Bild oder ein iframe enthält, dann ist die documentUrl für das Bild oder iframe "https://example.com". Für ein oberstes Dokument ist documentUrl nicht definiert.

frameAncestors

array. Informationen für jedes Dokument in der Rahmenhierarchie bis zum obersten Dokument. Das erste Element im Array enthält Informationen über das unmittelbare Elternteil des angeforderten Dokuments und das letzte Element enthält Informationen über das oberste Dokument. Ist der Ladevorgang für das oberste Dokument, ist dieses Array leer.

url

string. Die URL, von der das Dokument geladen wurde.

frameId

integer. Die frameId des Dokuments. details.frameAncestors[0].frameId ist dasselbe wie details.parentFrameId.

frameId

integer. Null, wenn die Anfrage im Hauptframe stattfindet; ein positiver Wert ist die ID eines Unterrahmens, in dem die Anfrage stattfindet. Wenn das Dokument eines (Unter-)Rahmens geladen wird (type ist main_frame oder sub_frame), gibt frameId die ID dieses Rahmens an und nicht die ID des äußeren Rahmens. Frame-IDs sind innerhalb eines Tabs eindeutig.

frameType

string. Der Typ des Rahmens, in dem die Anfrage stattgefunden hat. Gibt die Werte "outermost_frame", "fenced_frame", oder "sub_frame" zurück.

fromCache

boolean. Ob die Antwort aus dem Festplattencache abgerufen wurde.

incognito

boolean. Ob die Anfrage aus einem privaten Browserfenster stammt.

ip

string. Die IP-Adresse des Servers, an den die Anfrage gesendet wurde. Es kann sich um eine literal IPv6-Adresse handeln.

method

string. Standard-HTTP-Methode: Zum Beispiel, "GET" oder "POST".

originUrl

string. Die URL der Ressource, die die Anfrage ausgelöst hat. Zum Beispiel, wenn "https://example.com" einen Link enthält und der Nutzer den Link anklickt, dann ist die originUrl für die resultierende Anfrage "https://example.com".

Die originUrl ist oft, aber nicht immer, die gleiche wie die documentUrl. Zum Beispiel, wenn eine Seite ein iframe enthält und das iframe einen Link enthält, der ein neues Dokument ins iframe lädt, dann ist die documentUrl für die resultierende Anfrage das übergeordnete Dokument des iframes, aber die originUrl ist die URL des Dokuments im iframe, das den Link enthielt.

parentDocumentId Optional

string. Eine UUID des Eltern-Dokuments, das den Rahmen besitzt. Nicht gesetzt, wenn kein Elternteil vorhanden ist. Siehe den Artikel Arbeiten mit documentId für weitere Informationen.

parentFrameId

integer. ID des Rahmens, der den Rahmen enthält, der die Anfrage gesendet hat. Auf -1 gesetzt, wenn kein Elternrahmen existiert.

proxyInfo

object. Diese Eigenschaft ist nur vorhanden, wenn die Anfrage über einen Proxy geleitet wird. Sie enthält die folgenden Eigenschaften:

host

string. Der Hostname des Proxyservers.

port

integer. Die Portnummer des Proxyservers.

type

string. Der Typ des Proxyservers. Einer der folgenden:

• "http": HTTP-Proxy (oder SSL CONNECT für HTTPS)
• "https": HTTP-Proxys über TLS-Verbindung zum Proxy
• "socks": SOCKS v5-Proxy
• "socks4": SOCKS v4-Proxy
• "direct": kein Proxy
• "unknown": unbekannter Proxy

username

string. Benutzername für den Proxydienst.

proxyDNS

boolean. Wahr, wenn der Proxy die DNS-Auflösung basierend auf dem bereitgestellten Hostnamen durchführen wird, was bedeutet, dass der Client keinen eigenen DNS-Lookup durchführen sollte.

failoverTimeout

integer. Failover-Timeout in Sekunden. Wenn die Proxyverbindung fehlschlägt, wird der Proxy für diesen Zeitraum nicht wieder verwendet.

requestId

string. Die ID der Anfrage. Anfrage-IDs sind innerhalb einer Browsersitzung eindeutig, sodass Sie sie verwenden können, um verschiedene Ereignisse zuzuordnen, die derselben Anfrage zugeordnet sind.

responseHeaders Optional

webRequest.HttpHeaders. Die HTTP-Antwort-Header, die für diese Anfrage empfangen wurden.

statusCode

integer. Standard-HTTP-Statuscode, der vom Server zurückgegeben wird.

statusLine

string. HTTP-Statuszeile der Antwort oder die Zeichenkette 'HTTP/0.9 200 OK' für HTTP/0.9-Antworten (d.h. Antworten, denen eine Statuszeile fehlt).

tabId

integer. ID des Tabs, in dem die Anfrage stattfindet. Auf -1 gesetzt, wenn die Anfrage nicht mit einem Tab in Zusammenhang steht.

thirdParty

boolean. Gibt an, ob die Anfrage und ihre Inhaltsfensterhierarchie Drittanbieter sind.

timeStamp

number. Die Zeit, zu der dieses Ereignis ausgelöst wurde, in Millisekunden seit der Epoche.

type

webRequest.ResourceType. Der Typ der angeforderten Ressource, zum Beispiel, "image", "script", "stylesheet".

url

string. Ziel der Anfrage.

urlClassification

object. Der mit der Anfrage verbundene Tracking-Typ, wenn die Anfrage durch den Firefox-Tracking-Schutz klassifiziert ist. Dies ist ein Objekt mit folgenden Eigenschaften:

firstParty

array von string. Klassifikationsflags für die Anfrage des ersten Anbieters.

thirdParty

array von string. Klassifikationsflags für die Anfrage oder die Drittanbieter der Fensterhierarchie.

Die Klassifikationsflags umfassen:

• fingerprinting und fingerprinting_content: zeigt an, dass die Anfrage in Fingerprinting verwickelt ist ("eine Quelle, die zum Fingerprinting gefunden wurde").
  • fingerprinting zeigt an, dass die Domain der Kategorie Fingerprinting und Tracking zugeordnet ist. Beispiele für diese Domain-Art sind Werbetreibende, die ein Profil mit dem Besuchenden Benutzer in Verbindung bringen wollen.
  • fingerprinting_content zeigt an, dass die Domain der Kategorie Fingerprinting, aber nicht der Kategorie Tracking zugeordnet ist. Beispiele für diese Domain-Art sind Zahlungsanbieter, die Fingerprinting-Techniken verwenden, um den Besuchenden Benutzer zu Identifikationszwecken gegen Betrug zu erkennen.
• cryptomining und cryptomining_content: ähnlich der Fingerprinting-Kategorie, jedoch für Krypto-Mining-Ressourcen.
• tracking, tracking_ad, tracking_analytics, tracking_social und tracking_content: zeigt an, dass die Anfrage im Tracking verwickelt ist. tracking ist jede generische Tracking-Anfrage, mit den Suffix-Feldern ad, analytics, social und content, die den Typ des Trackers identifizieren.
• emailtracking und emailtracking_content: zeigt an, dass die Anfrage im E-Mail-Tracking verwickelt ist.
• any_basic_tracking: ein Meta-Flag, das Tracking- und Fingerprinting-Flags kombiniert, mit Ausnahme von tracking_content und fingerprinting_content.
• any_strict_tracking: ein Meta-Flag, das alle Tracking- und Fingerprinting-Flags kombiniert.
• any_social_tracking: ein Meta-Flag, das alle sozialen Tracking-Flags kombiniert.

Sie können weitere Informationen zu Trackertypen auf der Website disconnect.me finden. Das Suffix content zeigt Tracker an, die Inhalte verfolgen und bereitstellen. Das Blockieren dieser Tracker schützt Benutzer, kann jedoch dazu führen, dass Websites nicht korrekt funktionieren oder Elemente nicht angezeigt werden.

Beispiele

Dieser Code setzt ein zusätzliches Cookie, wenn eine Ressource von der Ziel-URL angefordert wird:

let targetPage =
  "https://developer.mozilla.org/en-US/Firefox/Developer_Edition";

// Add the new header to the original array,
// and return it.
function setCookie(e) {
  const setMyCookie = {
    name: "Set-Cookie",
    value: "my-cookie1=my-cookie-value1",
  };
  e.responseHeaders.push(setMyCookie);
  return { responseHeaders: e.responseHeaders };
}

// Listen for onHeaderReceived for the target page.
// Set "blocking" and "responseHeaders".
browser.webRequest.onHeadersReceived.addListener(
  setCookie,
  { urls: [targetPage] },
  ["blocking", "responseHeaders"],
);

Dieser Code tut dasselbe wie das vorherige Beispiel, außer dass der Listener asynchron ist und ein Promise zurückgibt, welches mit den neuen Headern aufgelöst wird:

const targetPage =
  "https://developer.mozilla.org/en-US/Firefox/Developer_Edition";

// Return a Promise that sets a timer.
// When the timer fires, resolve the promise with
// modified set of response headers.
function setCookieAsync(e) {
  const asyncSetCookie = new Promise((resolve, reject) => {
    setTimeout(() => {
      const setMyCookie = {
        name: "Set-Cookie",
        value: "my-cookie1=my-cookie-value1",
      };
      e.responseHeaders.push(setMyCookie);
      resolve({ responseHeaders: e.responseHeaders });
    }, 2000);
  });

  return asyncSetCookie;
}

// Listen for onHeaderReceived for the target page.
// Set "blocking" and "responseHeaders".
browser.webRequest.onHeadersReceived.addListener(
  setCookieAsync,
  { urls: [targetPage] },
  ["blocking", "responseHeaders"],
);

Browser-Kompatibilität