Merge pull request #134 from ninoseki/refactor

add SearchableType & ScannableType for more clear type definitions
ninoseki · Nov 7, 2018 · 6eebdb6 · 6eebdb6
2 parents 53bde6c + 2098fa6
commit 6eebdb6
Show file tree

Hide file tree

Showing 38 changed files with 77 additions and 73 deletions.
diff --git a/src/lib/scanner/index.ts b/src/lib/scanner/index.ts
@@ -1,4 +1,4 @@
-export { Scanner } from "./scanner";
+export { ScannableType, Scanner } from "./scanner";
 export { Urlscan } from "./urlscan";
 export { VirusTotal } from "./virustotal";
 

diff --git a/src/lib/scanner/scanner.ts b/src/lib/scanner/scanner.ts
@@ -1,7 +1,9 @@
+export type ScannableType = "ip" | "domain" | "url";
+
 export interface Scanner {
   endpoint: string;
   name: string;
-  supportedTypes: string[];
+  supportedTypes: ScannableType[];
   scanByIP?(query: string);
   scanByDomain?(query: string);
   scanByURL?(query: string);

diff --git a/src/lib/scanner/urlscan.ts b/src/lib/scanner/urlscan.ts
@@ -1,10 +1,10 @@
 import axios from "axios";
-import { Scanner } from "./scanner";
+import { ScannableType, Scanner } from "./scanner";
 
 export class Urlscan implements Scanner {
   public endpoint: string;
   public name: string;
-  public supportedTypes: string[] = ["ip", "domain", "url"];
+  public supportedTypes: ScannableType[] = ["ip", "domain", "url"];
   protected apiKey: string | undefined;
 
   constructor() {

diff --git a/src/lib/scanner/virustotal.ts b/src/lib/scanner/virustotal.ts
@@ -1,12 +1,12 @@
 import axios from "axios";
 import * as qs from "qs";
-import { Scanner } from "./scanner";
+import { ScannableType, Scanner } from "./scanner";
 
 export class VirusTotal implements Scanner {
 
   public endpoint: string;
   public name: string;
-  public supportedTypes: string[] = ["url"];
+  public supportedTypes: ScannableType[] = ["url"];
   protected apiKey: string | undefined;
 
   constructor() {

diff --git a/src/lib/searcher/blockcypher.ts b/src/lib/searcher/blockcypher.ts
@@ -1,10 +1,10 @@
-import { Searcher } from "./searcher";
+import { SearchableType, Searcher } from "./searcher";
 
 export class BlockCypher implements Searcher {
 
   public endpoint: string;
   public name: string;
-  public supportedTypes: string[] = ["btc"];
+  public supportedTypes: SearchableType[] = ["btc"];
 
   constructor() {
     this.endpoint = "https://live.blockcypher.com";

diff --git a/src/lib/searcher/censys.ts b/src/lib/searcher/censys.ts
@@ -1,10 +1,10 @@
-import { Searcher } from "./searcher";
+import { SearchableType, Searcher } from "./searcher";
 
 export class Censys implements Searcher {
 
   public endpoint: string;
   public name: string;
-  public supportedTypes: string[] = ["text"];
+  public supportedTypes: SearchableType[] = ["text"];
 
   constructor() {
     this.endpoint = "https://censys.io";

diff --git a/src/lib/searcher/cymon.ts b/src/lib/searcher/cymon.ts
@@ -1,10 +1,10 @@
-import { Searcher } from "./searcher";
+import { SearchableType, Searcher } from "./searcher";
 
 export class Cymon implements Searcher {
 
   public endpoint: string;
   public name;
-  public supportedTypes: string[] = ["ip", "domain"];
+  public supportedTypes: SearchableType[] = ["ip", "domain"];
 
   constructor() {
     this.endpoint = "https://cymon.io";

diff --git a/src/lib/searcher/dnslytics.ts b/src/lib/searcher/dnslytics.ts
@@ -1,10 +1,10 @@
-import { Searcher } from "./searcher";
+import { SearchableType, Searcher } from "./searcher";
 
 export class DNSlytics implements Searcher {
 
   public endpoint: string;
   public name;
-  public supportedTypes: string[] = ["ip", "domain"];
+  public supportedTypes: SearchableType[] = ["ip", "domain"];
 
   constructor() {
     this.endpoint = "https://dnslytics.com";

diff --git a/src/lib/searcher/domainbigdata.ts b/src/lib/searcher/domainbigdata.ts
@@ -1,10 +1,10 @@
-import { Searcher } from "./searcher";
+import { SearchableType, Searcher } from "./searcher";
 
 export class DomainBigData implements Searcher {
 
   public endpoint: string;
   public name;
-  public supportedTypes: string[] = ["domain"];
+  public supportedTypes: SearchableType[] = ["domain"];
 
   constructor() {
     this.endpoint = "https://domainbigdata.com";

diff --git a/src/lib/searcher/domainwatch.ts b/src/lib/searcher/domainwatch.ts
@@ -1,10 +1,10 @@
-import { Searcher } from "./searcher";
+import { SearchableType, Searcher } from "./searcher";
 
 export class DomainWatch implements Searcher {
 
   public endpoint: string;
   public name;
-  public supportedTypes: string[] = ["domain", "email"];
+  public supportedTypes: SearchableType[] = ["domain", "email"];
 
   constructor() {
     this.endpoint = "https://domainwat.ch";

diff --git a/src/lib/searcher/findsubdomains.ts b/src/lib/searcher/findsubdomains.ts
@@ -1,10 +1,10 @@
-import { Searcher } from "./searcher";
+import { SearchableType, Searcher } from "./searcher";
 
 export class FindSubDomains implements Searcher {
 
   public endpoint: string;
   public name: string;
-  public supportedTypes: string[] = ["domain"];
+  public supportedTypes: SearchableType[] = ["domain"];
 
   constructor() {
     this.endpoint = "https://findsubdomains.com";

diff --git a/src/lib/searcher/fortiguard.ts b/src/lib/searcher/fortiguard.ts
@@ -1,10 +1,10 @@
-import { Searcher } from "./searcher";
+import { SearchableType, Searcher } from "./searcher";
 
 export class FortiGuard implements Searcher {
 
   public endpoint: string;
   public name: string;
-  public supportedTypes: string[] = ["ip", "url", "cve"];
+  public supportedTypes: SearchableType[] = ["ip", "url", "cve"];
 
   constructor() {
     this.endpoint = "https://fortiguard.com";

diff --git a/src/lib/searcher/hybridanalysis.ts b/src/lib/searcher/hybridanalysis.ts
@@ -1,9 +1,9 @@
-import { Searcher } from "./searcher";
+import { SearchableType, Searcher } from "./searcher";
 
 export class HybridAnalysis implements Searcher {
   public endpoint: string;
   public name: string;
-  public supportedTypes: string[] = ["ip", "domain", "hash"];
+  public supportedTypes: SearchableType[] = ["ip", "domain", "hash"];
 
   constructor() {
     this.endpoint = "https://www.hybrid-analysis.com";

diff --git a/src/lib/searcher/index.ts b/src/lib/searcher/index.ts
@@ -15,7 +15,7 @@ export { PubDB } from "./pubdb";
 export { PublicWWW } from "./publicwww";
 export { Pulsedive } from "./pulsedive";
 export { RiskIQ } from "./riskiq";
-export { Searcher } from "./searcher";
+export { SearchableType, Searcher } from "./searcher";
 export { SecurityTrails } from "./securitytrails";
 export { Shodan } from "./shodan";
 export { Sploitus } from "./sploitus";

diff --git a/src/lib/searcher/intelligencex.ts b/src/lib/searcher/intelligencex.ts
@@ -1,12 +1,12 @@
 import * as crypto from "crypto-js";
 import * as url from "url";
-import { Searcher } from "./searcher";
+import { SearchableType, Searcher } from "./searcher";
 
 export class IntelligenceX implements Searcher {
 
   public endpoint: string;
   public name: string;
-  public supportedTypes: string[] = ["ip", "domain", "url", "email", "btc"];
+  public supportedTypes: SearchableType[] = ["ip", "domain", "url", "email", "btc"];
 
   constructor() {
     this.endpoint = "https://intelx.io";

diff --git a/src/lib/searcher/onyphe.ts b/src/lib/searcher/onyphe.ts
@@ -1,10 +1,10 @@
-import { Searcher } from "./searcher";
+import { SearchableType, Searcher } from "./searcher";
 
 export class ONYPHE implements Searcher {
 
   public endpoint: string;
   public name: string;
-  public supportedTypes: string[] = ["ip"];
+  public supportedTypes: SearchableType[] = ["ip"];
 
   constructor() {
     this.endpoint = "https://www.onyphe.io";

diff --git a/src/lib/searcher/otx.ts b/src/lib/searcher/otx.ts
@@ -1,10 +1,10 @@
-import { Searcher } from "./searcher";
+import { SearchableType, Searcher } from "./searcher";
 
 export class OTX implements Searcher {
 
   public endpoint: string;
   public name: string;
-  public supportedTypes: string[] = ["ip", "domain", "hash"];
+  public supportedTypes: SearchableType[] = ["ip", "domain", "hash"];
 
   constructor() {
     this.endpoint = "https://otx.alienvault.com";

diff --git a/src/lib/searcher/pipl.ts b/src/lib/searcher/pipl.ts
@@ -1,10 +1,10 @@
-import { Searcher } from "./searcher";
+import { SearchableType, Searcher } from "./searcher";
 
 export class Pipl implements Searcher {
 
   public endpoint: string;
   public name;
-  public supportedTypes: string[] = ["email"];
+  public supportedTypes: SearchableType[] = ["email"];
 
   constructor() {
     this.endpoint = "https://pipl.com";

diff --git a/src/lib/searcher/pubdb.ts b/src/lib/searcher/pubdb.ts
@@ -1,10 +1,10 @@
-import { Searcher } from "./searcher";
+import { SearchableType, Searcher } from "./searcher";
 
 export class PubDB implements Searcher {
 
   public endpoint: string;
   public name;
-  public supportedTypes: string[] = ["gaTrackID", "gaPubID"];
+  public supportedTypes: SearchableType[] = ["gaTrackID", "gaPubID"];
 
   constructor() {
     this.endpoint = "http://pub-db.com";

diff --git a/src/lib/searcher/publicwww.ts b/src/lib/searcher/publicwww.ts
@@ -1,10 +1,10 @@
-import { Searcher } from "./searcher";
+import { SearchableType, Searcher } from "./searcher";
 
 export class PublicWWW implements Searcher {
 
   public endpoint: string;
   public name: string;
-  public supportedTypes: string[] = ["text"];
+  public supportedTypes: SearchableType[] = ["text"];
 
   constructor() {
     this.endpoint = "https://publicwww.com/websites";

diff --git a/src/lib/searcher/pulsedive.ts b/src/lib/searcher/pulsedive.ts
@@ -1,11 +1,11 @@
 import * as crypto from "crypto-js";
-import { Searcher } from "./searcher";
+import { SearchableType, Searcher } from "./searcher";
 
 export class Pulsedive implements Searcher {
 
   public endpoint: string;
   public name: string;
-  public supportedTypes: string[] = ["ip", "domain", "url", "hash"];
+  public supportedTypes: SearchableType[] = ["ip", "domain", "url", "hash"];
 
   constructor() {
     this.endpoint = "https://pulsedive.com";

diff --git a/src/lib/searcher/riskiq.ts b/src/lib/searcher/riskiq.ts
@@ -1,10 +1,10 @@
-import { Searcher } from "./searcher";
+import { SearchableType, Searcher } from "./searcher";
 
 export class RiskIQ implements Searcher {
 
   public endpoint: string;
   public name;
-  public supportedTypes: string[] = ["ip", "domain", "email"];
+  public supportedTypes: SearchableType[] = ["ip", "domain", "email"];
 
   constructor() {
     this.endpoint = "https://community.riskiq.com";

diff --git a/src/lib/searcher/searcher.ts b/src/lib/searcher/searcher.ts
@@ -1,7 +1,9 @@
+export type SearchableType = "text" | "ip" | "domain" | "url" | "email" | "hash" | "cve" | "btc" | "xmr" | "gaTrackID" | "gaPubID";
+
 export interface Searcher {
   endpoint: string;
   name: string;
-  supportedTypes: string[];
+  supportedTypes: SearchableType[];
   searchByText?(query: string);
   searchByIP?(query: string);
   searchByDomain?(query: string);

diff --git a/src/lib/searcher/searchers.ts b/src/lib/searcher/searchers.ts
@@ -20,6 +20,7 @@ import {
   SecurityTrails,
   Shodan,
   Sploitus,
+  SpyOnWeb,
   Talos,
   ThreatCrowd,
   Urlscan,
@@ -30,7 +31,6 @@ import {
   XForceExchange,
   ZoomEye,
 } from ".";
-import { SpyOnWeb } from "./spyonweb";
 
 export const Searchers: Searcher[] = [
   new BlockCypher(),

diff --git a/src/lib/searcher/securitytrails.ts b/src/lib/searcher/securitytrails.ts
@@ -1,10 +1,10 @@
-import { Searcher } from "./searcher";
+import { SearchableType, Searcher } from "./searcher";
 
 export class SecurityTrails implements Searcher {
 
   public endpoint: string;
   public name: string;
-  public supportedTypes: string[] = ["domain", "ip"];
+  public supportedTypes: SearchableType[] = ["domain", "ip"];
 
   constructor() {
     this.endpoint = "https://securitytrails.com";

diff --git a/src/lib/searcher/shodan.ts b/src/lib/searcher/shodan.ts
@@ -1,10 +1,10 @@
-import { Searcher } from "./searcher";
+import { SearchableType, Searcher } from "./searcher";
 
 export class Shodan implements Searcher {
 
   public endpoint: string;
   public name: string;
-  public supportedTypes: string[] = ["text"];
+  public supportedTypes: SearchableType[] = ["text"];
 
   constructor() {
     this.endpoint = `https://www.shodan.io`;

diff --git a/src/lib/searcher/sploitus.ts b/src/lib/searcher/sploitus.ts
@@ -1,10 +1,10 @@
-import { Searcher } from "./searcher";
+import { SearchableType, Searcher } from "./searcher";
 
 export class Sploitus implements Searcher {
 
   public endpoint: string;
   public name;
-  public supportedTypes: string[] = ["cve"];
+  public supportedTypes: SearchableType[] = ["cve"];
 
   constructor() {
     this.endpoint = "https://sploitus.com";

diff --git a/src/lib/searcher/spyonweb.ts b/src/lib/searcher/spyonweb.ts
@@ -1,10 +1,10 @@
-import { Searcher } from "./searcher";
+import { SearchableType, Searcher } from "./searcher";
 
 export class SpyOnWeb implements Searcher {
 
   public endpoint: string;
   public name;
-  public supportedTypes: string[] = ["ip", "domain", "gaPubID", "gaTrackID"];
+  public supportedTypes: SearchableType[] = ["ip", "domain", "gaPubID", "gaTrackID"];
 
   constructor() {
     this.endpoint = "http://spyonweb.com";

diff --git a/src/lib/searcher/talos.ts b/src/lib/searcher/talos.ts
@@ -1,10 +1,10 @@
-import { Searcher } from "./searcher";
+import { SearchableType, Searcher } from "./searcher";
 
 export class Talos implements Searcher {
 
   public endpoint: string;
   public name;
-  public supportedTypes: string[] = ["ip", "domain"];
+  public supportedTypes: SearchableType[] = ["ip", "domain"];
 
   constructor() {
     this.endpoint = "https://talosintelligence.com";

diff --git a/src/lib/searcher/threatcrowd.ts b/src/lib/searcher/threatcrowd.ts
@@ -1,10 +1,10 @@
-import { Searcher } from "./searcher";
+import { SearchableType, Searcher } from "./searcher";
 
 export class ThreatCrowd implements Searcher {
 
   public endpoint: string;
   public name;
-  public supportedTypes: string[] = ["ip", "domain", "email"];
+  public supportedTypes: SearchableType[] = ["ip", "domain", "email"];
 
   constructor() {
     this.endpoint = "https://www.threatcrowd.org";

diff --git a/src/lib/searcher/urlscan.ts b/src/lib/searcher/urlscan.ts
@@ -1,10 +1,10 @@
-import { Searcher } from "./searcher";
+import { SearchableType, Searcher } from "./searcher";
 
 export class Urlscan implements Searcher {
 
   public endpoint: string;
   public name: string;
-  public supportedTypes: string[] = ["ip", "domain", "url"];
+  public supportedTypes: SearchableType[] = ["ip", "domain", "url"];
 
   constructor() {
     this.endpoint = "https://urlscan.io/api/v1";