Skip to content

Latest commit

 

History

History
112 lines (95 loc) · 9.2 KB

index.md

File metadata and controls

112 lines (95 loc) · 9.2 KB
Raw
title slug page-type browser-compat
declarativeNetRequest.RuleCondition
Mozilla/Add-ons/WebExtensions/API/declarativeNetRequest/RuleCondition
webextension-api-type
webextensions.api.declarativeNetRequest.RuleCondition

{{AddonSidebar()}}

Details of the condition that determines whether a rule matches a request, as the condition property of a {{WebExtAPIRef("declarativeNetRequest.Rule")}}.

Type

Values of this type are objects. They contain these properties:

  • domainType {{optional_inline}}

    • : A string. Specifies whether the network request is first-party or third-party to the domain from where it originated. If omitted, all requests are accepted. Possible values are "firstParty" and "thirdParty".

  • domains {{deprecated_inline}} {{optional_inline}}

    • : An array of string. Use initiatorDomains instead. The rule only matches network requests originating from this list of domains.

  • excludedDomains {{deprecated_inline}} {{optional_inline}}

    • : An array of string. Use excludedInitiatorDomains instead. The rule does not match network requests originating from this list of domains.

  • initiatorDomains {{optional_inline}}

    • : An array of string. The rule only matches network requests originating from this list of domains. If the list is omitted, the rule is applied to requests from all domains. An empty list is not allowed. A canonical domain should be used. This matches against the request initiator and not the request URL.

  • excludedInitiatorDomains {{optional_inline}}

    • : An array of string. The rule does not match network requests originating from this list of domains. If the list is empty or omitted, no domains are excluded. This takes precedence over initiatorDomains. A canonical domain should be used. This matches against the request initiator and not the request URL.

  • isUrlFilterCaseSensitive {{optional_inline}}

    • : A boolean. Whether the urlFilter or regexFilter (whichever is specified) is case sensitive. While there is consensus on defaulting to false across browsers in WECG issue 269, the value used to be true in (older) versions of Chrome and Safari. See Browser compatibility for details.

  • regexFilter {{optional_inline}}

    • : A string. Regular expression to match against the network request URL. Note that:

  • requestDomains {{optional_inline}}

    • : An array of string. The rule only matches network requests when the domain matches one from this list. If the list is omitted, the rule is applied to requests from all domains. An empty list is not allowed. A canonical domain should be used.

  • excludedRequestDomains {{optional_inline}}

    • : An array of string. The rule does not match network requests when the domains matches one from this list. If the list is empty or omitted, no domains are excluded. This takes precedence over requestDomains. A canonical domain should be used.

  • requestMethods {{optional_inline}}

    • : An array of string. List of HTTP request methods that the rule matches. An empty list is not allowed. Specifying a requestMethods rule condition also excludes non-HTTP(s) requests, whereas specifying excludedRequestMethods does not.

  • excludedRequestMethods {{optional_inline}}

    • : An array of string. List of request methods that the rule does not match on. Only one of requestMethods and excludedRequestMethods should be specified. If neither of them is specified, all request methods are matched.

  • resourceTypes {{optional_inline}}

    • : An array of {{WebExtAPIRef("declarativeNetRequest.ResourceType")}}. List of resource types that the rule matches with. An empty list is not allowed. This must be specified for "allowAllRequests" rules and may only include the "sub_frame" and "main_frame" resource types.

  • excludedResourceTypes {{optional_inline}}

    • : An array of {{WebExtAPIRef("declarativeNetRequest.ResourceType")}}. List of resource types that the rule does not match on. Only one of resourceTypes and excludedResourceTypes should be specified. If neither of them is specified, all resource types except "main_frame" are blocked.

  • tabIds {{optional_inline}}

    • : An array of number. List of {{WebExtAPIRef("tabs.Tab")}}.id that the rule should match. An ID of {{WebExtAPIRef("tabs.TAB_ID_NONE")}} matches requests that don't originate from a tab. An empty list is not allowed. Only supported for session-scoped rules.

  • excludedTabIds {{optional_inline}}

    • : An array of number. List of {{WebExtAPIRef("tabs.Tab")}}.id that the rule should not match. An ID of {{WebExtAPIRef("tabs.TAB_ID_NONE")}} excludes requests that do not originate from a tab. Only supported for session-scoped rules.

  • urlFilter {{optional_inline}}

    • : A string. The pattern that is matched against the network request URL. Supported constructs:

      • * : Wildcard: Matches any number of characters.
      • | : Left or right anchor: If used at either end of the pattern, specifies the beginning or end of the URL respectively.
      • || : Domain name anchor: If used at the beginning of the pattern, specifies the start of a (sub-)domain of the URL.
      • ^ : Separator character: This matches anything except a letter, a digit, or one of _, -, ., or %. The last ^ may also match the end of the URL instead of a separator character.

      urlFilter is composed of the following parts: (optional left/domain name anchor) + pattern + (optional right anchor). If omitted, all URLs are matched. An empty string is not allowed. A pattern beginning with ||* is not allowed. Use * instead. Note that:

      • Only one of urlFilter or regexFilter can be specified.
      • The urlFilter must be composed of only ASCII characters. This is matched against a URL where the host is encoded in the punycode format (in case of internationalized domains) and any other non-ASCII characters are URL encoded in utf-8. For example, when the request URL is http://abc.рф?q=ф, the urlFilter is matched against the URL http://abc.xn--p1ai/?q=%D1%84.

Canonical domain

Domains specified in initiatorDomains, excludedInitiatorDomains, requestDomains, or excludedRequestDomains should comply with the following:

  • Sub-domains such as "a.example.com" are allowed.
  • The entries must consist of only lowercase ASCII characters.
  • Use Punycode encoding for internationalized domains.
  • IPv4 addresses must be represented as 4 numbers separated by a dot.
  • IPv6 addresses should be represented in their canonical form, wrapped in square brackets.

To programmatically generate the canonical domain for a URL, use the URL API and read its hostname property, i.e., new URL(url).hostname.

{{WebExtExamples("h2")}}

Browser compatibility

{{Compat}}