Issue 698 - Added tests for $sitekey option

chrome/content/tests/policy.js

 (function()
 {
   let server = null;
   let frame = null;
   let requestNotifier = null;
+  let httpProtocol = null;
 
   module("Content policy", {
     setup: function()
     {
       prepareFilterComponents.call(this);
       preparePrefs.call(this);
 
       server = new nsHttpServer();
       server.start(1234);
 
       frame = document.createElement("iframe");
       frame.style.visibility = "collapse";
       document.body.appendChild(frame);
 
       requestNotifier = new RequestNotifier(window, onPolicyHit);
+
+      httpProtocol = Utils.httpProtocol;
+      Utils.httpProtocol = {userAgent: "Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:30.0) Gecko/20100101 Firefox/30.0"};
     },
     teardown: function()
     {
       restoreFilterComponents.call(this);
       restorePrefs.call(this);
 
       stop();
       server.stop(function()
       {
         frame.parentElement.removeChild(frame);
         requestNotifier.shutdown();
 
         server = null;
         frame = null;
         requestNotifier = null;
 
         start();
       });
+
+      Utils.httpProtocol = httpProtocol;
     }
   });
 
+  /*
+  -----BEGIN RSA PRIVATE KEY-----
+  MIIBOgIBAAJBANLNgMGCl6kc3QE/73/ESBsuhzCNQWApqWS1nKVWf+RjDTiF80LD
+  2TiTdQhlW9mlWsDDbttsDlEcCmPVz6H3OUMCAwEAAQJBALo/ZSYTqsl4ve7vvTwG
+  gKq7ZihIdV1wEcDwELGoBiESo87zl//7q2q9/7VE3dB3Qp6uZMLtxVvXzF8bh074
+  OuECIQDzzenwgPVMtg6OjMtZBAB95oKaTzd+x/8JienKW4edEQIhAN1Y+vlB/waB
+  miRjGMrsOQDHhUbxyL6NXaPfxYlosYETAiBg0M9qgztl+BH1x7FkqvMrC+OnNXf7
+  L552gj7F7ez/kQIgOBNhyaHxlNlijpNYZZhAvLTPS/DXFYdE0M5RAgW26mcCIDrR
+  fi2xaM2NqJQCmyshtNmDxW2FCrtrQn1n0211WCEe
+  -----END RSA PRIVATE KEY-----
+  */
+  let publickey = "MFwwDQYJKoZIhvcNAQEBBQADSwAwSAJBANLNgMGCl6kc3QE/73/ESBsuhzCNQWApqWS1nKVWf+RjDTiF80LD2TiTdQhlW9mlWsDDbttsDlEcCmPVz6H3OUMCAwEAAQ";

[Wladimir Palant, 2014/09/10 21:55:06]

There are some RSA keys in
https://hg.adblockplus.org/adblockpluschrome/file/b8f283613e94/qunit/tests/si...
- how about using the 512 bit key from there instead?

[Thomas Greiner, 2014/12/11 14:33:55]

Done.

+
+  /**
+   * Content:
+   * /test\0127.0.0.1:1234\0Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:30.0) Gecko/20100101 Firefox/30.0
+   */
+  let sitekey = "MFwwDQYJKoZIhvcNAQEBBQADSwAwSAJBANLNgMGCl6kc3QE/73/ESBsuhzCNQWApqWS1nKVWf+RjDTiF80LD2TiTdQhlW9mlWsDDbttsDlEcCmPVz6H3OUMCAwEAAQ==_peQ1CvuHieDHAXURwy9K8VQFaPWHHU0oDGT3pnIoQ6Nm7DUvCPw6FsnqfpdoIcq+kwqtkgWIcxM95gytuphvzQ==";

[Wladimir Palant, 2014/09/10 21:55:06]

Call this variable "signature"?

[Thomas Greiner, 2014/12/11 14:33:55]

Technically, it's a concatentation of public key and signature. Therefore I
called it adblockkey now to be more consistent with how it's called in the
site's HTML code and HTTP header.

+
   let tests = [
     [
       "HTML image with relative URL",
       '<img src="test.gif">',
       "http://127.0.0.1:1234/test.gif", "image", false, false
     ],
     [
       "HTML image with absolute URL",
       '<img src="http://localhost:1234/test.gif">',
       "http://localhost:1234/test.gif", "image", true, false
@@ skipping 158 matching lines @@
     {
       return;
     }
     if (item.filter instanceof WhitelistFilter)
       return;
 
     if (policyHits.length > 0)
     {
       // Ignore duplicate policy calls (possible due to prefetching)
       let [prevWnd, prevNode, prevItem] = policyHits[policyHits.length - 1];
-      if (prevWnd == wnd && prevItem.location == item.location && prevItem.type == item.type &&  prevItem.docDomain == item.docDomain)
+      if (prevWnd == wnd && prevItem.location == item.location && prevItem.type == item.type && prevItem.docDomain == item.docDomain)
         policyHits.pop();
     }
     policyHits.push([wnd, node, item]);
   }
 
   function runTest([name, body, expectedURL, expectedType, expectedThirdParty, waitForMessage], stage)
   {
     defaultMatcher.clear();
 
     if (stage > 1)
       defaultMatcher.add(Filter.fromText(expectedURL));
     if (stage == 3)
       defaultMatcher.add(Filter.fromText("@@||127.0.0.1:1234/test|$document"));
     if (stage == 4)
       defaultMatcher.add(Filter.fromText("@@||127.0.0.1:1234/test|$~document"));
+    if (stage == 5)
+      defaultMatcher.add(Filter.fromText("@@||127.0.0.1:1234/test|$document,sitekey=" + publickey));
 
     let serverHit = false;
     server.registerPathHandler("/test", function(metadata, response)
     {
       response.setStatusLine("1.1", "200", "OK");
 
       let contentType = "text/html";
       if (body.indexOf("2000/svg") >= 0)
+      {
         contentType = "image/svg+xml";
+        body = body.replace(/^<svg/, "<svg data-adblockkey='" + sitekey + "'");
+      }
+      else
+        body = "<html data-adblockkey='" + sitekey + "'>" + body + "</html>";
       response.setHeader("Content-Type", contentType + "; charset=utf-8");
 
       response.bodyOutputStream.write(body, body.length);
     });
     server.registerPathHandler("/redirect.gif", function(metadata, response)
     {
       response.setStatusLine("1.1", "302", "Moved Temporarily");
       response.setHeader("Location", "http://127.0.0.1:1234/test.gif");
     });
     server.registerPathHandler("/redirect2.gif", function(metadata, response)
@@ skipping 11 matching lines @@
       var error = "<b>Not found...<b>";
       response.bodyOutputStream.write(error, error.length);
     });
 
     policyHits = [];
     var callback = function()
     {
       let expectedStatus = "allowed";
       if (stage == 3)
         equal(policyHits.length, 0, "Number of policy hits");
-      else
+      // We cannot rely on the correctness of policy hits for sitekey filters due to blocking
+      // filter hits being counted even if the resource doesn't end up getting blocked
+      else if (stage != 5)
       {
         equal(policyHits.length, 1, "Number of policy hits");
         if (policyHits.length == 1)
         {
           let [wnd, node, item] = policyHits[0];
 
           equal(item.location, expectedURL, "Request URL");
 
           expectedStatus = (stage == 1 ? "allowed" : "blocked");
           let actualStatus = (item.filter ? "blocked" : "allowed");
@@ skipping 18 matching lines @@
       window.addEventListener("message", callback, false, true);
     else
       frame.addEventListener("load", callback, false);
   }
 
   let stageDescriptions = {
     1: "running without filters",
     2: "running with filter %S",
     3: "running with filter %S and site exception",
     4: "running with filter %S and exception not applicable to sites",
+    5: "running with filter %S and sitekey exception"
   };
 
   for (let test = 0; test < tests.length; test++)
   {
     let [name, body, expectedURL, expectedType, expectedDomain, expectedThirdParty] = tests[test];
     for (let stage = 1; stage in stageDescriptions; stage++)
     {
       let stageDescription = stageDescriptions[stage];
       if (stageDescription.indexOf("%S") >= 0)
         stageDescription = stageDescription.replace("%S", expectedURL);
 
       asyncTest(name + " (" + stageDescription + ")", runTest.bind(null, tests[test], stage));
     }
   }
 })();