Writing Adblock Plus filters
- Introduction to Adblock Plus filters
- Element hiding
- Implementing a sitekey on the server
Current Adblock Plus versions allow you to "tweak" your filters in many different ways. This document explains the choices that you have and how they can be used.
Disclaimer: All filter examples given here are really only examples and are not meant to be used.
Introduction to Adblock Plus filters
The options described in this section should be enough for users who have to create a filter occasionally.
Basic filter rules
The most trivial filter you can define is of course the address of banner you want to block. However, often this address changes every time you open a page. For example it could be
http://example.com/ads/banner123.gif where 123 is a random number. Here blocking the complete address won't help you, you need a more general filter — like
http://example.com/ads/banner*.gif. Or maybe even
Note: Make sure that you are not replacing too much by wildcards. The filter
http://example.com/* will definitely block all banners but it will also block everything else from example.com that you still might want to see.
Defining exception rules
Sometimes you will notice that one of your filters that is usually working quite well blocks in some case blocks something that it shouldn't be blocking. You don't want to remove this filter but you still don't want it to match in this one case.
That's what exception rules are good for — they allow you to define cases where filters shouldn't be applied. For example if you are unhappy with your filter
http://example.com/advice.html, you can define an exception rule
@@advice. Exception rules are no different from filter rules, you can use wildcards or regular expressions. You only have to precede them by
@@ to indicate an exception rule.
Exception rules can do more. If an exception rule starts with http:// or https:// (optionally with a pipe before it) it will make whole pages an exception. For example, if your exception rule is
@@|http://example.com and you open some page from example.com — Adblock Plus will be entirely disabled on this page and nothing will be blocked.
Matching at beginning/end of an address
Usually Adblock Plus treats every filter as if it had a wildcard at its beginning and end, e.g. there is not difference between the filters
*ad*. While this is usually unproblematic, sometimes you wish that the filter you defined only matches at the beginning or end of an address. For example you might want to block all Flash, but if you add the filter
swf the address
http://example.com/swf/index.html will also be blocked.
Solution to this problem: add a pipe symbol to the filter to show that there should be definitely the end of the address at this point. For example the filter
swf| will block
http://example.com/annoyingflash.swf but not
http://example.com/swf/index.html. And the filter
|http://baddomain.example/ will block
http://baddomain.example/banner.gif but not
Sometimes one wants to block
http://example.com/banner.gif as well as
http://www.example.com/banner.gif. This can be achieved by putting two pipe symbols in front of the filter which makes sure the filter matches at the beginning of the domain name:
||example.com/banner.gif will block all these addresses while not blocking
http://gooddomain.example/analyze?http://example.com/banner.gif (requires Adblock Plus 1.1 or higher).
Marking separator characters
Often you need to accept any separator character in a filter. For example, you might write a filter that blocks
http://example.com:8000/ but not
http://example.com.ar/. Here the symbol ^ can be used as a placeholder for a single separator character:
http://example.com^ (requires Adblock Plus 1.1 or higher).
Separator character is anything but a letter, a digit, or one of the following: _ - . %. The end of the address is also accepted as separator. In the following example all separator characters are shown in red: http://example.com:8000/foo.bar?a=12&b=%D1%82%D0%B5%D1%81%D1%82. So this address can be blocked with the filter
Any rule that starts with an exclamation mark is considered a comment. It will still show up in the filter list but in grey instead of black. Adblock Plus will ignore this rule for actual blocking so it is safe to write there whatever you want. You can place a comment rule above a real filter to describe what it is doing. Or you can put a comment on top of your filter list stating your authorship (most filter list authors do that).
Special comments will only have an effect in downloaded filter lists, not in custom filters. They can set a number of parameters for the filter list:
! Homepage: http://example.com/
This comment determines which webpage should be linked as filter list homepage.
! Title: FooList
This comment sets a fixed title for the filter list. If this comment is present the user will no longer be able to change the title.
! Expires: 5 days
This comment sets the update interval for the filter list, the value can be given in days (e.g.
5 days) or hours (e.g.
8 hours). Any value between 1 hour and 14 days is possible. Note that the update will not necessarily happen after this time interval. The actual update time is slightly randomized and depends on some additional factors to reduce server load.
! Checksum: OaopkIiiAl77sSHk/VAWDA
This comment makes sure that accidental corruption of the data won't result in broken filters. For example, some firewall software might modify the filter
*/adnetwork/*on download in an attempt to protect the user against ads. It will remove part of the filter so that Adblock Plus will only see the filter
**. A checksum comment in the filter list protects against this scenario, any modifications will have the result that the checksum no longer matches and Adblock Plus will ignore the data.
To calculate the checksum the following steps need to be performed:
- Remove the existing checksum comment if any.
- Encode filter list text using UTF-8 encoding.
- Convert all line breaks to Unix style (replace
- Remove empty lines (replace sequences of the
\ncharacter by a single
- Calculate the base64-encoded MD5 checksum of the text, remove trailing
=characters if any.
! Redirect: http://example.com/list.txt
This comment indicates that the filter list has moved to a new download address. Adblock Plus will ignore any file contents beyond that comment and immediately try downloading from the new address. In case of success the address of the filter list will be updated in the settings. This comment is ignored if the new address is the same as the current address, meaning that it can be used to enforce the "canonical" address of the filter list.
! Version: 1234
This comment defines a numerical version of the filter list. This version number will be displayed in issue reports and can be used to verify that the report refers to the current version of the filter list.
The features described in this section are usually used only by power users and filterlist creators. Feel free to skip it.
Specifying filter options
Adblock Plus allows you to specify a number of options to modify the behavior of a filter. You list these options separated with commas after a dollar sign ($) at the end of the filter, for example:
*/ads/* is the actual filter and
match-case are its options. Currently the following options are supported:
- Type options: determine which types of elements a filter can block (or whitelist in case of an exception rule). Multiple type options can be specified to indicate that the filter should be applied to several types of elements. Possible types are:
script— external scripts loaded via HTML script tag
image— regular images, typically loaded via HTML img tag
stylesheet— external CSS stylesheet files
object— content handled by browser plugins, e.g. Flash or Java
xmlhttprequest— requests started by the XMLHttpRequest object
object-subrequest— requests started plugins like Flash
subdocument— embedded pages, usually included via HTML frames
document— the page itself (only exception rules can be applied to the page)
elemhide— for exception rules only, similar to
documentbut only disables element hiding rules on the page rather than all filter rules (Adblock Plus 1.2 and higher required)
other— types of requests not covered in the list above
dtdare outdated and should no longer be used.
- Inverse type options: specify the element types the filter should not be applied to. Possible inverse type options:
- Restriction to third-party/first-party requests: If the
third-partyoption is specified, the filter is only applied to requests from a different origin than the currently viewed page. Similarly,
~third-partyrestricts the filter to requests from the same origin as the currently viewed page.
- Domain restrictions: The option
domain=example.commeans that the filter should only be applied on pages from "example.com" domain. Multiple domains can be specified using "|" as separator: with the option
domain=example.com|example.netthe filter will only be applied on pages from "example.com" or "example.net" domains. If a domain name is preceded with "~", the filter should not be applied on pages from this domain. For example,
domain=~example.commeans that the filter should be applied on pages from any domain but "example.com" and
domain=example.com|~foo.example.comrestricts the filter to the "example.com" domain with the exception of "foo.example.com" subdomain.
Sitekey restrictions: The option
sitekey=abcdsitekeydcbameans that the filter should only be applied on pages that provide a public key and a signature which can be verified by that very same public key that is also contained in the filter (but without the trailing =). Multiple sitekeys can be specified using "|" as separator: with the option
sitekey=abcdsitekeydcba|bcdesitekeyedcbthe filter will only be applied on pages providing either sitekey "abcdsitekeydcba" or "bcdesitekeyedcb". This is similar to domain restrictions but allows covering scenarios where a single filter should apply to a very large number of domains. Note that sitekey restrictions require modifications on the server-side.
match-case— makes the filter only apply to addresses with matching letter case, e.g. the filter
collapse— this option will override the global "Hide placeholders of blocked elements" option and make sure the filter always hides the element. Similarly the
~collapseoption will make sure the filter never hides the element.
donottrack— for any address matching a blocking rule with this option and not matching any exception rules with this option a Do-Not-Track header will be sent (requires Adblock Plus 1.3.5 or higher). For backwards compatibility it is recommended to use this option in combination with contradicting type options, this will prevent this filter from blocking anything in earlier Adblock Plus versions:
Using regular expressions
If you want even more control about what your filters match and what they don't match, you can use regular expressions. For example the filter
/banner\d+/ will match
banner321 but not
banners. You can check out documentation on regular expressions to learn how to write them.
Note: For performance reasons it is recommended not to use regular expressions if they can be avoided.
Sometimes you will find advertisements that can't be blocked because they are embedded as text in the web page itself. If you look at the source code of the web page you might find something like this:
<div class="textad"> Cheapest tofu, only here and now! </div> <div id="sponsorad"> Really cheap tofu, click here! </div> <textad> Only here you get the best tofu! </textad>
You need to download the web page so you will necessarily download the advertisements. All you can do here is to hide the advertisement so you don't need to see it. That's what element hiding is meant for.
The first advertisement above is contained inside a div element with class attribute "textad". The following rule will hide exactly this combination:
##div.textad. Here ## marks an element hiding rule while the rest is a selector identifying the elements that need to be hidden. You can hide elements by their id attribute similarly,
##div#sponsorad will hide the second advertisement. You don't need to specify the element name, the rule
##*#sponsorad will work just as well. And you can hide elements by element name only, e.g.
##textad for the third advertisement.
The Element Hiding Helper extension helps selecting the correct element and writing the corresponding rule without having to view the source code of the page. Basic HTML knowledge is useful nevertheless.
Note: Element hiding works very differently from normal filters. This has the implication that no wildcards are supported in element hiding rules.
Limiting rules to certain domains
Usually you want to hide a specific ad on one specific site, you don't want your rule to be applied on other sites. For example the rule
##*.sponsor might hide valid code on some sites. But if you write it as
example.com##*.sponsor it will be applied on
http://something.example.com/ but not on
http://example.org/. You can also specify multiple domains — simply separate them with commas:
If a domain name is preceded with "~", the rule will not be applied on pages from this domain (requires Adblock Plus 1.1 or higher). For example,
~example.com##*.sponsor will be be applied on pages from any domain but "example.com" and
example.com,~foo.example.com##*.sponsor makes the rule apply on "example.com" domain with the exception of "foo.example.com" subdomain.
Note: Due to the way how element hiding is implemented, you really can only limit it to full domain names. You cannot use any other part of the address and you cannot use
domain as a replacement for
Note: Element hiding rules with domain limitation can be used to hide browser's user interface elements as well. For example the filter rule
Some advertisers don't make it easy for you — their text advertisements have neither an id nor a class attribute. You can use other attributes to hide those, for example
##table[width="80%"] will hide tables with width attribute set to 80%. If you don't want to specify the full value of the attribute,
##div[title*="adv"] will hide all div elements with title attribute containing the string "adv". You can also check the beginning and the end of an attribute, for example
##div[title^="adv"][title$="ert"] will hide div elements with title starting with "adv" and ending with "ert". As you see, you can also use multiple conditions —
table[width="80%"][bgcolor="white"] will match tables with width attribute set to 80% and bgcolor attribute set to white.
In general, any CSS selector supported by Firefox can be used for element hiding. For example the following rule will hide anything following a div element with class "adheader":
##div.adheader + *. For a full list of CSS list see W3C CSS specification (note that not all selectors are supported by Firefox yet).
Exception rules can disable existing rules on particular domains. These are mostly
useful to filter subscription authors who are extending another filter subscription that they
cannot change. For example, the rule
##div.textad can be
example.com using the exception rule
example.com#@#div.textad. The combination of these two
rules has exactly the same effect as the single rule
~example.com##div.textad. It is recommended that you use
exception rules only when you cannot change an overly general element hiding rule, in all the
other cases limiting this rule to the necessary domains is preferable.
Simplified element hiding syntax
Adblock Plus supports simplified element hiding syntax (e.g.
#div(id=foo)) for backwards compatibility only. Using this syntax is discouraged, usual CSS selectors are preferred. Support for this syntax might be removed at some point.
Implementing a sitekey on the server
For a sitekey-restricted filter to apply, a webpage needs to return base64-encoded versions of the public key and a signature which Adblock Plus can validate. Currently, this means including them in both the HTTP response header (
X-Adblock-Key: abcdpublickeydcba_abcdsignaturedcba) and the root tag of the document (
First you need to create a private RSA key (preferably 512 bit to keep the transfer volume low) and then a DER representation of the public key.
The data used for creating the signature is a concatenated list of request variables (namely URI, host and user agent) separated by the
NUL character "\0". For example:
/index.html?q=foo\0www.example.com\0Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:30.0) Gecko/20100101 Firefox/30.0
Finally, generate the signature for this string by using the signature algorithm SEC_OID_ISO_SHA_WITH_RSA_SIGNATURE (default when using OpenSSL).