Merge pull request #635 from ninoseki/add-enable-refang-option

feat: add "enable refang" option
ninoseki · Jan 27, 2022 · e9635de · e9635de
2 parents d80226f + 13290f6
commit e9635de
Show file tree

Hide file tree

Showing 11 changed files with 87 additions and 32 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -49,7 +49,7 @@
     "@github/mini-throttle": "^2.1.0",
     "axios": "^0.25.0",
     "bulma": "^0.9.3",
-    "ioc-extractor": "4.0.2",
+    "ioc-extractor": "4.0.4",
     "js-base64": "^3.7.2",
     "js-sha256": "^0.9.0",
     "mustache": "^4.2.0",

diff --git a/src/background.ts b/src/background.ts
@@ -77,6 +77,7 @@ export async function createContextMenus(
   const selector: Selector = new Selector(text, {
     enableIDN: generalSettings.enableIDN,
     strictTLD: generalSettings.strictTLD,
+    enableRefang: generalSettings.enableRefang,
   });
   // create searchers context menus based on a type of the input
   const searcherEntries: AnalyzerEntry[] = selector.getSearcherEntries();

diff --git a/src/options.ts b/src/options.ts
@@ -51,10 +51,14 @@ export async function saveGeneralSettings(): Promise<void> {
   const strictTLDInput = document.getElementById(
     "strict-tld"
   ) as HTMLInputElement;
+  const enableRefangInput = document.getElementById(
+    "enable-refang"
+  ) as HTMLInputElement;
 
   const generalSettings: GeneralSettings = {
     enableIDN: enableIDNInput.checked,
     strictTLD: strictTLDInput.checked,
+    enableRefang: enableRefangInput.checked,
   };
 
   await browser.storage.sync.set({ generalSettings });

diff --git a/src/options/options.html b/src/options/options.html
@@ -111,6 +111,18 @@ <h2 class="title is-2">Searcher settings</h2>
         <label>Enable</label>
       </div>
     </div>
+
+    <div class="field has-addons">
+      <div class="control is-expanded">
+        <label class="label">
+          Enable refang
+        </label>
+      </div>
+      <div class="control">
+        <input id="enable-refang" type="checkbox" {{#enableRefang}}checked="checked"{{/enableRefang}}>
+        <label>Enable</label>
+      </div>
+    </div>
   </script>
 </body>
 

diff --git a/src/selector.ts b/src/selector.ts
@@ -38,9 +38,9 @@ export class Selector {
 
   public constructor(
     input: string,
-    options: Options = { enableIDN: true, strictTLD: true }
+    options: Options = { enableIDN: true, strictTLD: true, enableRefang: true }
   ) {
-    this.input = refang(input);
+    this.input = options.enableRefang ? refang(input) : input;
     this.options = options;
   }
 

diff --git a/src/types.ts b/src/types.ts
@@ -91,6 +91,7 @@ export interface ScannerTable {
 export interface GeneralSettings {
   enableIDN: boolean;
   strictTLD: boolean;
+  enableRefang: boolean;
 }
 
 export interface Config {
@@ -112,4 +113,5 @@ export const SHA256_LENGTH = 64;
 export interface Options {
   enableIDN: boolean;
   strictTLD: boolean;
+  enableRefang: boolean;
 }
diff --git a/src/utility.ts b/src/utility.ts
@@ -36,6 +36,7 @@ function convertToGeneralSettings(value: StorageValue): GeneralSettings {
   const generalSettings: GeneralSettings = {
     enableIDN: false,
     strictTLD: false,
+    enableRefang: false,
   };
 
   if (hasGeneralSettings) {
@@ -44,6 +45,8 @@ function convertToGeneralSettings(value: StorageValue): GeneralSettings {
       _generalSettings.enableIDN || generalSettings.enableIDN;
     generalSettings.strictTLD =
       _generalSettings.strictTLD || generalSettings.strictTLD;
+    generalSettings.enableRefang =
+      _generalSettings.enableRefang || generalSettings.enableRefang;
   }
   return generalSettings;
 }

diff --git a/test/backgroud.spec.ts b/test/backgroud.spec.ts
@@ -201,7 +201,7 @@ describe("Background script", function () {
       await createContextMenus(
         { request: "updateContextMenu", selection: "test" },
         {},
-        { enableIDN: true, strictTLD: true }
+        { enableIDN: true, strictTLD: true, enableRefang: true }
       );
 
       browserMock.contextMenus.create.assertNoCall();

diff --git a/test/options.spec.ts b/test/options.spec.ts
@@ -112,6 +112,7 @@ describe("Options script", function () {
       );
       stub.withArgs("enable-idn").returns(input);
       stub.withArgs("strict-tld").returns(input);
+      stub.withArgs("enable-refang").returns(input);
     });
 
     it("should save generalSettings via chrome.storage.sync.set", async function () {
@@ -122,6 +123,7 @@ describe("Options script", function () {
             generalSettings: {
               enableIDN: true,
               strictTLD: true,
+              enableRefang: true,
             },
           },
         ],
@@ -215,7 +217,7 @@ describe("Options script", function () {
       });
     });
 
-    it("should compose a searcerList based on searcherStates via chrome.storage.sync.get", async function () {
+    it("should compose a searcherList based on searcherStates via chrome.storage.sync.get", async function () {
       sandbox
         .stub(browserMock.storage.sync, "get")
         .withArgs("searcherStates")
@@ -307,7 +309,10 @@ describe("Options script", function () {
       );
       stub.withArgs("general-settings").returns(wrapper);
       stub.withArgs("general-settings-template").returns({
-        innerHTML: `<input id="enable-idn" type="checkbox" {{#enableIDN}}checked="checked"{{/enableIDN}}><input id="strict-tld" type="checkbox" {{#strictTLD}}checked="checked"{{/strictTLD}}>`,
+        innerHTML: `
+        <input id="enable-idn" type="checkbox" {{#enableIDN}}checked="checked"{{/enableIDN}}>
+        <input id="strict-tld" type="checkbox" {{#strictTLD}}checked="checked"{{/strictTLD}}>
+        <input id="enable-refang" type="checkbox" {{#enableRefang}}checked="checked"{{/enableRefang}}>`,
       });
     });
 
@@ -319,6 +324,7 @@ describe("Options script", function () {
           generalSettings: {
             enableIDN: true,
             strictTLD: true,
+            enableRefang: true,
           },
         });
 
@@ -337,6 +343,11 @@ describe("Options script", function () {
         "input#strict-tld"
       ) as HTMLInputElement;
       expect(strictTLD.checked).to.equal(true);
+
+      const enableRefang = generalSettings.querySelector(
+        "input#enable-refang"
+      ) as HTMLInputElement;
+      expect(enableRefang.checked).to.equal(true);
     });
   });
 });
diff --git a/test/selector.spec.ts b/test/selector.spec.ts
@@ -13,7 +13,7 @@ function numberOfSelectorsByType(type: SearchableType): number {
   ).length;
 }
 
-describe("Seletor", function () {
+describe("Selector", function () {
   const stats = {
     asn: numberOfSelectorsByType("asn"),
     btc: numberOfSelectorsByType("btc"),
@@ -38,13 +38,13 @@ describe("Seletor", function () {
         });
       });
 
-      describe("#getSearchersForIP", function () {
+      describe("#getSearchersByType with ip", function () {
         it("should return searchers which support ip", function () {
           expect(selector.getSearchersByType("ip").length).to.equal(stats.ip);
         });
       });
 
-      describe("#getAnalyzerEntrys", function () {
+      describe("#getSearcherEntries", function () {
         it("should return entries which support ip", function () {
           const entries: AnalyzerEntry[] = selector.getSearcherEntries();
           for (const entry of entries) {
@@ -65,7 +65,7 @@ describe("Seletor", function () {
         });
       });
 
-      describe("#getSearchersForDomain", function () {
+      describe("#getSearchersByType with domain", function () {
         it("should return searchers which support domain", function () {
           expect(selector.getSearchersByType("domain").length).to.equal(
             stats.domain
@@ -93,7 +93,7 @@ describe("Seletor", function () {
         });
       });
 
-      describe("#getSearchersForUrl", function () {
+      describe("#getSearchersByType with url", function () {
         it("should return searchers which support url", function () {
           expect(selector.getSearchersByType("url").length).to.equal(stats.url);
         });
@@ -119,15 +119,15 @@ describe("Seletor", function () {
         });
       });
 
-      describe("#getSearchersForEmail", function () {
+      describe("#getSearchersByType with email", function () {
         it("should return searchers which support email", function () {
           expect(selector.getSearchersByType("email").length).to.equal(
             stats.email
           );
         });
       });
 
-      describe("#getAnalyzerEntrys", function () {
+      describe("#getSearcherEntries", function () {
         it("should return entries which support email", function () {
           const entries: AnalyzerEntry[] = selector.getSearcherEntries();
           for (const entry of entries) {
@@ -147,13 +147,13 @@ describe("Seletor", function () {
         });
       });
 
-      describe("#getSearchersForASN", function () {
+      describe("#getSearchersByType with asn", function () {
         it("should return searchers which support asn", function () {
           expect(selector.getSearchersByType("asn").length).to.equal(stats.asn);
         });
       });
 
-      describe("#getAnalyzerEntrys", function () {
+      describe("#getSearcherEntries", function () {
         it("should return entries which support asn", function () {
           const entries: AnalyzerEntry[] = selector.getSearcherEntries();
           for (const entry of entries) {
@@ -184,15 +184,15 @@ describe("Seletor", function () {
         });
       });
 
-      describe("#getSearchersForHash", function () {
+      describe("#getSearchersByType with hash", function () {
         it("should return searchers which support hash", function () {
           expect(selector.getSearchersByType("hash").length).to.equal(
             stats.hash
           );
         });
       });
 
-      describe("#getAnalyzerEntrys", function () {
+      describe("#getSearcherEntries", function () {
         it("should return entries which support hash", function () {
           const entries: AnalyzerEntry[] = selector.getSearcherEntries();
           for (const entry of entries) {
@@ -212,13 +212,13 @@ describe("Seletor", function () {
         });
       });
 
-      describe("#getSearchersForCVE", function () {
+      describe("#getSearchersByType with cve", function () {
         it("should return searchers which support CVE", function () {
           expect(selector.getSearchersByType("cve").length).to.equal(stats.cve);
         });
       });
 
-      describe("#getAnalyzerEntrys", function () {
+      describe("#getSearcherEntries", function () {
         it("should return entries which support cve", function () {
           const entries: AnalyzerEntry[] = selector.getSearcherEntries();
           for (const entry of entries) {
@@ -238,13 +238,13 @@ describe("Seletor", function () {
         });
       });
 
-      describe("#getSearchersForBTC", function () {
+      describe("#getSearchersByType with btc", function () {
         it("should return searchers which support BTC", function () {
           expect(selector.getSearchersByType("btc").length).to.equal(stats.btc);
         });
       });
 
-      describe("#getAnalyzerEntrys", function () {
+      describe("#getSearcherEntries", function () {
         it("should return entries which support btc", function () {
           const entries: AnalyzerEntry[] = selector.getSearcherEntries();
           for (const entry of entries) {
@@ -264,7 +264,7 @@ describe("Seletor", function () {
         });
       });
 
-      describe("#getSearchersForGATrackID", function () {
+      describe("#getSearchersByType with gaTrackID", function () {
         it("should return searchers which support GATrackID", function () {
           expect(selector.getSearchersByType("gaTrackID").length).to.equal(
             stats.gaTrackID
@@ -282,7 +282,7 @@ describe("Seletor", function () {
         });
       });
 
-      describe("#getSearchersForGAPubID", function () {
+      describe("#getSearchersByType with gaPubID", function () {
         it("should return searchers support GAPubID", function () {
           expect(selector.getSearchersByType("gaPubID").length).to.equal(
             stats.gaPubID
@@ -300,13 +300,13 @@ describe("Seletor", function () {
         });
       });
 
-      describe("#getSearchersForETH", function () {
+      describe("#getSearchersByType with eth", function () {
         it("should return searchers which support ETH", function () {
           expect(selector.getSearchersByType("eth").length).to.equal(stats.eth);
         });
       });
 
-      describe("#getAnalyzerEntrys", function () {
+      describe("#getSearcherEntries", function () {
         it("should return entries which support ETH", function () {
           const entries: AnalyzerEntry[] = selector.getSearcherEntries();
           for (const entry of entries) {
@@ -316,5 +316,27 @@ describe("Seletor", function () {
         });
       });
     });
+
+    context("without refang", function () {
+      const ip = "1[.]1.1.1";
+      const selector: Selector = new Selector(ip, {
+        enableIDN: true,
+        strictTLD: true,
+        enableRefang: false,
+      });
+
+      describe("#getIP", function () {
+        it("should return null", function () {
+          expect(selector.getIP()).to.equal(null);
+        });
+      });
+
+      describe("#getSearcherEntries", function () {
+        it("should return an empty array", function () {
+          const entries: AnalyzerEntry[] = selector.getSearcherEntries();
+          expect(entries.length).to.equal(0);
+        });
+      });
+    });
   });
 });