webRequest.onSendHeaders

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

事件具有三个函数

addListener(listener, filter, extraInfoSpec)

为该事件添加监听器。

removeListener(listener)

停止监听此事件。listener 参数是要移除的监听器。

hasListener(listener)

检查listener是否已为此事件注册。如果正在监听，则返回true，否则返回false。

listener

当此事件发生时调用的函数。该函数将传递此参数

details

object。关于请求的详细信息。有关更多信息，请参阅details部分。

filter

webRequest.RequestFilter。一个限制发送到此监听器的事件的过滤器。

extraInfoSpec 可选

array of string。事件的额外选项。您只能在此处传递一个值

• "requestHeaders"：在传递给监听器的details对象中包含请求标头

cookieStoreId

string。如果请求来自在上下文身份中打开的选项卡，则为上下文身份的 Cookie 存储 ID。有关更多信息，请参阅使用上下文身份。

documentUrl

string。将在其中加载资源的文档的 URL。例如，如果https://example.com处的网页包含图像或 iframe，则图像或 iframe 的documentUrl将为https://example.com。对于顶级文档，documentUrl未定义。

frameId

integer。如果请求发生在主框架中，则为零；正值是发生请求的子框架的 ID。如果（子）框架的文档已加载（type为main_frame或sub_frame），则frameId指示此框架的 ID，而不是外部框架的 ID。框架 ID 在选项卡内是唯一的

incognito

boolean。请求是否来自隐身窗口。

method

string。标准 HTTP 方法：例如，“GET”或“POST”。

originUrl

string。触发请求的资源的 URL。例如，如果https://example.com包含链接，并且用户单击该链接，则结果请求的originUrl为https://example.com。

originUrl通常但不总是与documentUrl相同。例如，如果页面包含 iframe，并且 iframe 包含加载新文档到 iframe 中的链接，则结果请求的documentUrl将是 iframe 的父文档，但originUrl将是包含链接的 iframe 中文档的 URL。

parentFrameId

integer。包含发送请求的框架的框架的 ID。如果不存在父框架，则设置为 -1。

proxyInfo

object。仅当请求正在被代理时，此属性才存在。它包含以下属性

host

string。代理服务器的主机名。

port

integer。代理服务器的端口号。

type

string。代理服务器的类型。其中之一

• "http"：HTTP 代理（或 HTTPS 的 SSL CONNECT）
• "https"：通过到代理的 TLS 连接进行 HTTP 代理
• "socks"：SOCKS v5 代理
• "socks4"：SOCKS v4 代理
• "direct"：无代理
• "unknown"：未知代理

username

string。代理服务的用户名。

proxyDNS

boolean。如果代理将根据提供的主机名执行域名解析，则为 true，这意味着客户端不应执行自己的 DNS 查找。

failoverTimeout

integer。故障转移超时（秒）。如果代理连接失败，则在此期间内不会再次使用该代理。

requestId

string。请求的 ID。请求 ID 在浏览器会话内是唯一的，因此您可以使用它们来关联与同一请求关联的不同事件。

requestHeaders 可选

webRequest.HttpHeaders。已与此请求一起发送的 HTTP 请求标头。

tabId

integer。请求发生的选项卡的 ID。如果请求与选项卡无关，则设置为 -1。

thirdParty

boolean。指示请求及其内容窗口层次结构是否为第三方。

timeStamp

number。此事件触发的时刻，以自纪元以来的毫秒数表示。

type

webRequest.ResourceType。正在请求的资源类型：例如，“image”、“script”、“stylesheet”。

url

string。请求的目标。

urlClassification

object。如果请求由Firefox 跟踪保护分类，则与请求关联的跟踪类型。这是一个具有以下属性的对象

firstParty

array of strings。请求的第一方的分类标志。

thirdParty

array of strings。请求或其窗口层次结构的第三方的分类标志。

分类标志包括

• fingerprinting和fingerprinting_content：指示请求参与指纹识别（“发现指纹识别的来源”）。
  • fingerprinting指示域属于指纹识别和跟踪类别。此类域的示例包括希望将个人资料与访问用户关联的广告商。
  • fingerprinting_content 表示该域名属于指纹识别类别，但不属于跟踪类别。此类域名的示例包括使用指纹识别技术识别访问用户的支付提供商，用于反欺诈目的。
• cryptomining 和 cryptomining_content：与指纹识别类别类似，但用于加密货币挖矿资源。
• tracking、tracking_ad、tracking_analytics、tracking_social 和 tracking_content：表示请求涉及跟踪。tracking 是任何通用的跟踪请求，ad、analytics、social 和 content 后缀标识跟踪器的类型。
• any_basic_tracking：一个元标记，结合了跟踪和指纹识别标记，但不包括 tracking_content 和 fingerprinting_content。
• any_strict_tracking：一个元标记，结合了所有跟踪和指纹识别标记。
• any_social_tracking：一个元标记，结合了所有社交跟踪标记。

此代码记录了将在向目标 匹配模式 发出请求时发送的所有 Cookie。

// 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"],
);