webRequest.onSendHeaders

Syntax

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

Ereignisse haben drei Funktionen:

addListener(listener, filter, extraInfoSpec)

Fügt diesem Ereignis einen Listener hinzu.

removeListener(listener)

Stoppt das Hören auf dieses Ereignis. Das Argument listener ist der Listener, der entfernt werden soll.

hasListener(listener)

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

addListener-Syntax

Parameter

listener

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

details

object. Details zur Anfrage. Siehe den Abschnitt details für weitere Informationen.

filter

webRequest.RequestFilter. Ein Filter, der die Ereignisse einschränkt, die an diesen Listener gesendet werden.

extraInfoSpec Optional

array von string. Zusätzliche Optionen für das Ereignis. Sie können hier nur einen Wert übergeben:

• "requestHeaders": Einschließen der Anforderungs-Header im details-Objekt, das an den Listener übergeben wird

Zusätzliche Objekte

details

cookieStoreId

string. Wenn die Anfrage von einem Tab stammt, der in einer kontextuellen Identität geöffnet ist, die Cookie-Store-ID der kontextuellen Identität. Weitere Informationen finden Sie unter Arbeiten mit kontextuellen Identitäten.

documentUrl

string. URL des Dokuments, in dem die Ressource geladen wird. Beispiel: Wenn die Webseite unter "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 Dokument auf oberster Ebene ist documentUrl undefiniert.

frameId

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

incognito

boolean. Ob die Anfrage aus einem privaten Browserfenster stammt.

method

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

originUrl

string. URL der Ressource, die die Anfrage ausgelöst hat. Beispiel: Wenn "https://example.com" einen Link enthält und der Benutzer auf den Link klickt, dann ist die originUrl für die resultierende Anfrage "https://example.com".

Die originUrl ist häufig, aber nicht immer identisch mit der documentUrl. Beispiel: Wenn eine Seite ein Iframe enthält und das Iframe einen Link enthält, der ein neues Dokument in das Iframe lädt, dann ist die documentUrl für die resultierende Anfrage das Iframe-übergeordnete Dokument, aber die originUrl ist die URL des Dokuments im Iframe, das den Link enthielt.

parentFrameId

integer. ID des Frames, der den Frame enthält, der die Anfrage gesendet hat. Setzt auf -1, wenn kein übergeordneter Frame 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 Proxy-Servers.

port

integer. Die Portnummer des Proxy-Servers.

type

string. Der Typ des Proxy-Servers. Einer von:

• "http": HTTP-Proxy (oder SSL CONNECT für HTTPS)
• "https": HTTP-Proxy ü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 angegebenen Hostnamen durchführt, was bedeutet, dass der Client keine eigene DNS-Abfrage durchführen sollte.

failoverTimeout

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

requestId

string. Die ID der Anfrage. Anfragen-IDs sind innerhalb einer Browsersitzung eindeutig, sodass Sie sie verwenden können, um verschiedene Ereignisse zu verknüpfen, die mit derselben Anfrage verbunden sind.

requestHeaders Optional

webRequest.HttpHeaders. Die HTTP-Anforderungs-Header, die mit dieser Anfrage gesendet wurden.

tabId

integer. ID des Tabs, in dem die Anfrage stattfindet. Setzt auf -1, wenn die Anfrage nicht mit einem Tab verbunden ist.

thirdParty

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

timeStamp

number. Der Zeitpunkt, zu dem 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 Typ der Verfolgung, die mit der Anfrage verbunden ist, falls die Anfrage durch Firefox Tracking Protection klassifiziert wird. Dies ist ein Objekt mit diesen Eigenschaften:

firstParty

array von string. Klassifizierungsflags für den First-Party-Teil der Anfrage.

thirdParty

array von string. Klassifizierungsflags für die Drittparteien der Anfrage oder ihrer Fensterhierarchie.

Die Klassifizierungsflags beinhalten:

• fingerprinting und fingerprinting_content: gibt an, dass die Anfrage mit Fingerabdruckserstellung zu tun hat ("ein Ursprung, der Fingerabdruck erstellt").
  • fingerprinting gibt an, dass die Domain in der Kategorie für Fingerabdruckserstellung und -verfolgung ist. Beispiele für diese Art von Domain sind Werbetreibende, die ein Profil mit dem besuchenden Benutzer verknüpfen möchten.
  • fingerprinting_content gibt an, dass die Domain in der Kategorie für Fingerabdruckserstellung, aber nicht in der Verfolgungskategorie ist. Beispiele für diese Art von Domain sind Zahlungsanbieter, die Fingerabdrucktechniken verwenden, um den besuchenden Benutzer zu Identifizierung bei Betrugsbekämpfung zu nutzen.
• cryptomining und cryptomining_content: ähnlich der Fingerabdruckskategorie, aber für Ressourcen zum Krypto-Mining.
• tracking, tracking_ad, tracking_analytics, tracking_social und tracking_content: gibt an, dass die Anfrage mit Verfolgung zu tun hat. tracking ist jede allgemeine Verfolgungsanfrage, die Suffixe ad, analytics, social und content identifizieren den Typ des Verfolgers.
• emailtracking und emailtracking_content: gibt an, dass die Anfrage mit der Verfolgung von E-Mails zu tun hat.
• any_basic_tracking: ein Metaflag, das Tracking- und Fingerabdrucksflags kombiniert, mit Ausnahme von tracking_content und fingerprinting_content.
• any_strict_tracking: ein Metaflag, das alle Tracking- und Fingerabdrucksflags kombiniert.
• any_social_tracking: ein Metaflag, das alle sozialen Tracking-Flags kombiniert.

Weitere Informationen über Typen von Trackern finden Sie auf der disconnect.me Webseite. Das content-Suffix zeigt Tracker an, die verfolgen und Inhalte bereitstellen. Die Blockierung schützt Benutzer, kann jedoch dazu führen, dass Websites nicht richtig funktionieren oder Elemente nicht angezeigt werden.

Beispiele

Dieser Code protokolliert alle Cookies, die beim Anfragen an das Ziel Übereinstimmungsmuster gesendet werden:

// The target match pattern
let targetPage = "*://*.google.ca/*";

// Log cookies sent with this request
function logCookies(e) {
  for (const header of e.requestHeaders) {
    if (header.name === "Cookie") {
      console.log(header.value);
    }
  }
}

// Listen for onSendHeaders, and pass
// "requestHeaders" so we get the headers
browser.webRequest.onSendHeaders.addListener(
  logCookies,
  { urls: [targetPage] },
  ["requestHeaders"],
);

Browser-Kompatibilität