[$csp2 adblockpluscore] Issue 6329 - Add the CSP filter type

test/filterClasses.js

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
  * Copyright (C) 2006-present eyeo GmbH
  *
  * Adblock Plus is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License version 3 as
  * published by the Free Software Foundation.
  *
  * Adblock Plus is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
@@ skipping 26 matching lines @@
 exports.setUp = function(callback)
 {
   let sandboxedRequire = createSandbox();
   (
     {Filter, InvalidFilter, CommentFilter, ActiveFilter, RegExpFilter,
      BlockingFilter, WhitelistFilter, ElemHideBase, ElemHideFilter,
      ElemHideException,
      ElemHideEmulationFilter} = sandboxedRequire("../lib/filterClasses")
   );
   t = RegExpFilter.typeMap;
-  defaultTypes = 0x7FFFFFFF & ~(t.ELEMHIDE | t.DOCUMENT | t.POPUP |
+  defaultTypes = 0x7FFFFFFF & ~(t.CSP | t.ELEMHIDE | t.DOCUMENT | t.POPUP |
                                 t.GENERICHIDE | t.GENERICBLOCK);
 
   callback();
 };
 
 function serializeFilter(filter)
 {
   // Filter serialization only writes out essential properties, need to do a full serialization here
   let result = [];
   result.push("text=" + filter.text);
@@ skipping 28 matching lines @@
       result.push("matchCase=" + filter.matchCase);
 
       let sitekeys = filter.sitekeys || [];
       result.push("sitekeys=" + sitekeys.slice().sort().join("|"));
 
       result.push("thirdParty=" + filter.thirdParty);
       if (filter instanceof BlockingFilter)
       {
         result.push("type=filterlist");
         result.push("collapse=" + filter.collapse);
+        result.push("csp=" + filter.csp);
       }
       else if (filter instanceof WhitelistFilter)
         result.push("type=whitelist");
     }
     else if (filter instanceof ElemHideBase)
     {
       if (filter instanceof ElemHideFilter)
         result.push("type=elemhide");
       else if (filter instanceof ElemHideException)
         result.push("type=elemhideexception");
@@ skipping 28 matching lines @@
   if (type == "whitelist" || type == "filterlist" || type == "elemhide" ||
       type == "elemhideexception" || type == "elemhideemulation")
   {
     addProperty("disabled", "false");
     addProperty("lastHit", "0");
     addProperty("hitCount", "0");
   }
   if (type == "whitelist" || type == "filterlist")
   {
     addProperty("contentType", 0x7FFFFFFF & ~(
-      RegExpFilter.typeMap.DOCUMENT | RegExpFilter.typeMap.ELEMHIDE |
-      RegExpFilter.typeMap.POPUP | RegExpFilter.typeMap.GENERICHIDE |
-      RegExpFilter.typeMap.GENERICBLOCK
+      t.CSP | t.DOCUMENT | t.ELEMHIDE | t.POPUP | t.GENERICHIDE | t.GENERICBLOCK
     ));
     addProperty("matchCase", "false");
     addProperty("thirdParty", "null");
     addProperty("domains", "");
     addProperty("sitekeys", "");
   }
   if (type == "filterlist")
+  {
     addProperty("collapse", "null");
+    addProperty("csp", "null");
+  }
   if (type == "elemhide" || type == "elemhideexception" ||
       type == "elemhideemulation")
   {
     addProperty("selectorDomain", "");
     addProperty("domains", "");
   }
 }
 
 function compareFilter(test, text, expected, postInit)
 {
@@ skipping 112 matching lines @@
   compareFilter(test, "@@/ddd|f?a[s]d/", ["type=whitelist", "text=@@/ddd|f?a[s]d/", "regexp=ddd|f?a[s]d", "contentType=" + defaultTypes]);
   compareFilter(test, "@@*asdf*d**dd*", ["type=whitelist", "text=@@*asdf*d**dd*", "regexp=asdf.*d.*dd", "contentType=" + defaultTypes]);
   compareFilter(test, "@@|*asd|f*d**dd*|", ["type=whitelist", "text=@@|*asd|f*d**dd*|", "regexp=^.*asd\\|f.*d.*dd.*$", "contentType=" + defaultTypes]);
   compareFilter(test, "@@dd[]{}$%<>&()d", ["type=whitelist", "text=@@dd[]{}$%<>&()d", "regexp=dd\\[\\]\\{\\}\\$\\%\\<\\>\\&\\(\\)d", "contentType=" + defaultTypes]);
 
   test.done();
 };
 
 exports.testFilterOptions = function(test)
 {
-  compareFilter(test, "bla$match-case,script,other,third-party,domain=foo.com,sitekey=foo", ["type=filterlist", "text=bla$match-case,script,other,third-party,domain=foo.com,sitekey=foo", "regexp=bla", "matchCase=true", "contentType=" + (t.SCRIPT | t.OTHER), "thirdParty=true", "domains=FOO.COM", "sitekeys=FOO"]);
-  compareFilter(test, "bla$~match-case,~script,~other,~third-party,domain=~bar.com", ["type=filterlist", "text=bla$~match-case,~script,~other,~third-party,domain=~bar.com", "regexp=bla", "contentType=" + (defaultTypes & ~(t.SCRIPT | t.OTHER)), "thirdParty=false", "domains=~BAR.COM"]);
+  compareFilter(test, "bla$match-case,csp=first csp,script,other,third-party,domain=foo.com,sitekey=foo,csp=second csp", ["type=filterlist", "text=bla$match-case,csp=first csp,script,other,third-party,domain=foo.com,sitekey=foo,csp=second csp", "regexp=bla", "matchCase=true", "contentType=" + (t.SCRIPT | t.OTHER | t.CSP), "thirdParty=true", "domains=FOO.COM", "sitekeys=FOO", "csp=first csp; second csp"]);
+  compareFilter(test, "bla$~match-case,~csp=csp,~script,~other,~third-party,domain=~bar.com", ["type=filterlist", "text=bla$~match-case,~csp=csp,~script,~other,~third-party,domain=~bar.com", "regexp=bla", "contentType=" + (defaultTypes & ~(t.SCRIPT | t.OTHER)), "thirdParty=false", "domains=~BAR.COM"]);
+  compareFilter(test, "@@bla$match-case,script,other,third-party,domain=foo.com|bar.com|~bar.foo.com|~foo.bar.com,csp=c s p,sitekey=foo|bar", ["type=whitelist", "text=@@bla$match-case,script,other,third-party,domain=foo.com|bar.com|~bar.foo.com|~foo.bar.com,csp=c s p,sitekey=foo|bar", "regexp=bla", "matchCase=true", "contentType=" + (t.SCRIPT | t.OTHER | t.CSP), "thirdParty=true", "domains=BAR.COM|FOO.COM|~BAR.FOO.COM|~FOO.BAR.COM", "sitekeys=BAR|FOO"]);
   compareFilter(test, "@@bla$match-case,script,other,third-party,domain=foo.com|bar.com|~bar.foo.com|~foo.bar.com,sitekey=foo|bar", ["type=whitelist", "text=@@bla$match-case,script,other,third-party,domain=foo.com|bar.com|~bar.foo.com|~foo.bar.com,sitekey=foo|bar", "regexp=bla", "matchCase=true", "contentType=" + (t.SCRIPT | t.OTHER), "thirdParty=true", "domains=BAR.COM|FOO.COM|~BAR.FOO.COM|~FOO.BAR.COM", "sitekeys=BAR|FOO"]);
 
   // background and image should be the same for backwards compatibility
   compareFilter(test, "bla$image", ["type=filterlist", "text=bla$image", "regexp=bla", "contentType=" + (t.IMAGE)]);
   compareFilter(test, "bla$background", ["type=filterlist", "text=bla$background", "regexp=bla", "contentType=" + (t.IMAGE)]);
   compareFilter(test, "bla$~image", ["type=filterlist", "text=bla$~image", "regexp=bla", "contentType=" + (defaultTypes & ~t.IMAGE)]);
   compareFilter(test, "bla$~background", ["type=filterlist", "text=bla$~background", "regexp=bla", "contentType=" + (defaultTypes & ~t.IMAGE)]);
 
   compareFilter(test, "@@bla$~script,~other", ["type=whitelist", "text=@@bla$~script,~other", "regexp=bla", "contentType=" + (defaultTypes & ~(t.SCRIPT | t.OTHER))]);
   compareFilter(test, "@@http://bla$~script,~other", ["type=whitelist", "text=@@http://bla$~script,~other", "regexp=http\\:\\/\\/bla", "contentType=" + (defaultTypes & ~(t.SCRIPT | t.OTHER))]);
   compareFilter(test, "@@|ftp://bla$~script,~other", ["type=whitelist", "text=@@|ftp://bla$~script,~other", "regexp=^ftp\\:\\/\\/bla", "contentType=" + (defaultTypes & ~(t.SCRIPT | t.OTHER))]);
   compareFilter(test, "@@bla$~script,~other,document", ["type=whitelist", "text=@@bla$~script,~other,document", "regexp=bla", "contentType=" + (defaultTypes & ~(t.SCRIPT | t.OTHER) | t.DOCUMENT)]);
   compareFilter(test, "@@bla$~script,~other,~document", ["type=whitelist", "text=@@bla$~script,~other,~document", "regexp=bla", "contentType=" + (defaultTypes & ~(t.SCRIPT | t.OTHER))]);
   compareFilter(test, "@@bla$document", ["type=whitelist", "text=@@bla$document", "regexp=bla", "contentType=" + t.DOCUMENT]);
   compareFilter(test, "@@bla$~script,~other,elemhide", ["type=whitelist", "text=@@bla$~script,~other,elemhide", "regexp=bla", "contentType=" + (defaultTypes & ~(t.SCRIPT | t.OTHER) | t.ELEMHIDE)]);
   compareFilter(test, "@@bla$~script,~other,~elemhide", ["type=whitelist", "text=@@bla$~script,~other,~elemhide", "regexp=bla", "contentType=" + (defaultTypes & ~(t.SCRIPT | t.OTHER))]);
   compareFilter(test, "@@bla$elemhide", ["type=whitelist", "text=@@bla$elemhide", "regexp=bla", "contentType=" + t.ELEMHIDE]);
 
   compareFilter(test, "@@bla$~script,~other,donottrack", ["type=invalid", "text=@@bla$~script,~other,donottrack", "reason=filter_unknown_option"]);
   compareFilter(test, "@@bla$~script,~other,~donottrack", ["type=invalid", "text=@@bla$~script,~other,~donottrack", "reason=filter_unknown_option"]);
   compareFilter(test, "@@bla$donottrack", ["type=invalid", "text=@@bla$donottrack", "reason=filter_unknown_option"]);
   compareFilter(test, "@@bla$foobar", ["type=invalid", "text=@@bla$foobar", "reason=filter_unknown_option"]);
   compareFilter(test, "@@bla$image,foobar", ["type=invalid", "text=@@bla$image,foobar", "reason=filter_unknown_option"]);
   compareFilter(test, "@@bla$foobar,image", ["type=invalid", "text=@@bla$foobar,image", "reason=filter_unknown_option"]);
 
+  compareFilter(test, "bla$csp=report-uri", ["type=invalid", "text=bla$csp=report-uri", "reason=filter_invalid_csp"]);

[Manish Jethani, 2018/03/16 08:54:40]

We should add mixed case tests here for these privacy-sensitive directives (i.e.
"rePort-uRi"), what do you think?

[kzar, 2018/03/16 11:29:06]

Done.

+  compareFilter(test, "bla$csp=foo,csp=report-to", ["type=invalid", "text=bla$csp=foo,csp=report-to", "reason=filter_invalid_csp"]);
+  compareFilter(test, "bla$csp=foo,csp=referrer foo", ["type=invalid", "text=bla$csp=foo,csp=referrer foo", "reason=filter_invalid_csp"]);
+
   test.done();
 };
 
 exports.testElementHidingRules = function(test)
 {
   compareFilter(test, "##ddd", ["type=elemhide", "text=##ddd", "selector=ddd"]);
   compareFilter(test, "##body > div:first-child", ["type=elemhide", "text=##body > div:first-child", "selector=body > div:first-child"]);
   compareFilter(test, "foo##ddd", ["type=elemhide", "text=foo##ddd", "selectorDomain=foo", "selector=ddd", "domains=FOO"]);
   compareFilter(test, "foo,bar##ddd", ["type=elemhide", "text=foo,bar##ddd", "selectorDomain=foo,bar", "selector=ddd", "domains=BAR|FOO"]);
   compareFilter(test, "foo,~bar##ddd", ["type=elemhide", "text=foo,~bar##ddd", "selectorDomain=foo", "selector=ddd", "domains=FOO|~BAR"]);
@@ skipping 75 matching lines @@
     test, "foo.com#?#:-abp-properties(/margin: [3-4]{2}/)", [
       "type=elemhideemulation",
       "text=foo.com#?#:-abp-properties(/margin: [3-4]{2}/)",
       "selectorDomain=foo.com",
       "selector=:-abp-properties(/margin: [3-4]\\7B 2\\7D /)",
       "domains=FOO.COM"
     ]
   );
   test.done();
 };
+
+exports.testFilterNormalization = function(test)
+{
+  // Line breaks etc
+  test.equal(Filter.normalize("\n\t\nad\ns"),
+             "ads");
+
+  // Comment filters
+  test.equal(Filter.normalize("   !  fo  o##  bar   "),
+             "!  fo  o##  bar");
+
+  // Element hiding filters
+  test.equal(Filter.normalize("   domain.c  om## # sele ctor   "),
+             "domain.com### sele ctor");
+
+  // Regular filters
+  let normalized = Filter.normalize(
+    "    b$l     a$sitekey=  foo  ,domain= do main.com |foo   .com,c sp= c   s p  "
+  );
+  test.equal(
+    normalized,
+    "b$la$sitekey=foo,domain=domain.com|foo.com,csp=c s p"
+  );
+  compareFilter(
+    test, normalized, [
+      "type=filterlist",
+      "text=" + normalized,
+      "csp=c s p",
+      "domains=DOMAIN.COM|FOO.COM",
+      "sitekeys=FOO",
+      "regexp=b\\$la",
+      "contentType=" + t.CSP
+    ]
+  );
+
+  // Some $csp edge cases
+  test.equal(Filter.normalize("foo?csp=b a r$csp=script-src  'self'"),
+             "foo?csp=bar$csp=script-src 'self'");
+  test.equal(Filter.normalize("foo$bar=c s p = ba z,cs p = script-src  'self'"),
+             "foo$bar=csp=baz,csp=script-src 'self'");
+  test.equal(Filter.normalize("foo$csp=c s p csp= ba z,cs p  = script-src  'self'"),
+             "foo$csp=c s p csp= ba z,csp=script-src 'self'");
+  test.equal(Filter.normalize("foo$csp=bar,$c sp=c s p"),
+             "foo$csp=bar,$csp=c s p");
+  test.equal(Filter.normalize(" f o   o   $      bar   $csp=ba r"),
+             "foo$bar$csp=ba r");
+  test.equal(Filter.normalize("/foo$/$ csp = script-src  http://example.com/?$1=1&$2=2&$3=3"),
+             "/foo$/$csp=script-src http://example.com/?$1=1&$2=2&$3=3");
+
+  test.done();
+};