mihari 5.6.0 → 5.6.2

data/frontend/package.json

@@ -19,8 +19,8 @@
     "@fortawesome/vue-fontawesome": "^3.0.3",
     "@vueuse/core": "^10.5.0",
     "@vueuse/router": "^10.5.0",
-    "ace-builds": "^1.30.0",
-    "axios": "^1.5.1",
+    "ace-builds": "^1.31.0",
+    "axios": "^1.6.0",
     "bulma": "^0.9.4",
     "bulma-helpers": "^0.4.3",
     "dayjs": "^1.11.10",
@@ -30,21 +30,21 @@
     "ts-dedent": "^2.2.0",
     "url-parse": "^1.5.10",
     "uuidv4": "^6.2.13",
-    "vue": "^3.3.6",
+    "vue": "^3.3.7",
     "vue-concurrency": "4.0.1",
     "vue-json-pretty": "^2.2.4",
     "vue-router": "^4.2.5",
     "vue3-ace-editor": "^2.2.3"
   },
   "devDependencies": {
-    "@redocly/cli": "1.3.0",
+    "@redocly/cli": "1.4.0",
     "@rushstack/eslint-patch": "^1.5.1",
     "@tsconfig/node20": "^20.1.2",
     "@types/jsdom": "^21.1.4",
-    "@types/node": "^20.8.7",
+    "@types/node": "^20.8.9",
     "@types/url-parse": "^1.4.10",
-    "@typescript-eslint/eslint-plugin": "^6.8.0",
-    "@typescript-eslint/parser": "^6.8.0",
+    "@typescript-eslint/eslint-plugin": "^6.9.0",
+    "@typescript-eslint/parser": "^6.9.0",
     "@vitejs/plugin-vue": "^4.4.0",
     "@vue/eslint-config-prettier": "^8.0.0",
     "@vue/eslint-config-typescript": "^12.0.0",
@@ -54,7 +54,7 @@
     "eslint-config-prettier": "^9.0.0",
     "eslint-plugin-prettier": "^5.0.1",
     "eslint-plugin-simple-import-sort": "^10.0.0",
-    "eslint-plugin-vue": "^9.17.0",
+    "eslint-plugin-vue": "^9.18.1",
     "husky": "^8.0.3",
     "jsdom": "^22.1.0",
     "npm-run-all": "^4.1.5",
@@ -62,6 +62,6 @@
     "typescript": "~5.2.2",
     "vite": "^4.5.0",
     "vitest": "^0.34.6",
-    "vue-tsc": "^1.8.19"
+    "vue-tsc": "^1.8.22"
   }
 }

data/lib/mihari/{base.rb → actor.rb}

@@ -4,7 +4,12 @@ module Mihari
   #
   # Base class for Analyzer, Emitter and Enricher
   #
-  class Base
+  class Actor
+    include Dry::Monads[:result, :try]
+
+    include Mixins::Configurable
+    include Mixins::Retriable
+
     # @return [Hash]
     attr_reader :options
 
@@ -43,6 +48,15 @@ module Mihari
       options[:timeout]
     end
 
+    def validate_configuration!
+      return if configured?
+
+      joined = configuration_keys.join(", ")
+      be = (configuration_keys.length > 1) ? "are" : "is"
+      message = "#{self.class.class_key} is not configured correctly. #{joined} #{be} missing."
+      raise ConfigurationError, message
+    end
+
     class << self
       #
       # @return [String]
@@ -62,7 +76,7 @@ module Mihari
       # @return [Array<String>]
       #
       def class_keys
-        ([class_key] + [class_key_aliases]).flatten.compact
+        ([class_key] + [class_key_aliases]).flatten.compact.map(&:downcase)
       end
     end
   end

data/lib/mihari/analyzers/base.rb

@@ -2,12 +2,7 @@
 
 module Mihari
   module Analyzers
-    class Base < Mihari::Base
-      include Dry::Monads[:result, :try]
-
-      include Mixins::Configurable
-      include Mixins::Retriable
-
+    class Base < Actor
       # @return [String]
       attr_reader :query
 
@@ -45,7 +40,7 @@ module Mihari
         Mihari.config.ignore_error
       end
 
-      # @return [Array<String>, Array<Mihari::Artifact>]
+      # @return [Array<String>, Array<Mihari::Models::Artifact>]
       def artifacts
         raise NotImplementedError, "You must implement #{self.class}##{__method__}"
       end
@@ -55,14 +50,14 @@ module Mihari
       # - Convert data (string) into an artifact
       # - Reject an invalid artifact
       #
-      # @return [Array<Mihari::Artifact>]
+      # @return [Array<Mihari::Models::Artifact>]
       #
       def normalized_artifacts
         retry_on_error(times: retry_times, interval: retry_interval, exponential_backoff: retry_exponential_backoff) do
           artifacts.compact.sort.map do |artifact|
             # No need to set data_type manually
             # It is set automatically in #initialize
-            artifact = artifact.is_a?(Artifact) ? artifact : Artifact.new(data: artifact)
+            artifact = artifact.is_a?(Models::Artifact) ? artifact : Models::Artifact.new(data: artifact)
             artifact.source = self.class.class_key
             artifact
           end.select(&:valid?).uniq(&:data)
@@ -70,7 +65,7 @@ module Mihari
       end
 
       #
-      # @return [Dry::Monads::Result::Success<Array<Mihari::Artifact>>, Dry::Monads::Result::Failure]
+      # @return [Dry::Monads::Result::Success<Array<Mihari::Models::Artifact>>, Dry::Monads::Result::Failure]
       #
       def result
         Try[StandardError] { normalized_artifacts }.to_result

data/lib/mihari/analyzers/censys.rb

@@ -24,7 +24,7 @@ module Mihari
       end
 
       #
-      # @return [Array<Mihari::Artifact>]
+      # @return [Array<Mihari::Models::Artifact>]
       #
       def artifacts
         client.search_with_pagination(query, pagination_limit: pagination_limit).map do |res|

data/lib/mihari/analyzers/circl.rb

@@ -51,7 +51,7 @@ module Mihari
       private
 
       def client
-        @client ||= Clients::CIRCL.new(username: username, password: password)
+        @client ||= Clients::CIRCL.new(username: username, password: password, timeout: timeout)
       end
 
       def username?

data/lib/mihari/analyzers/crtsh.rb

@@ -28,7 +28,7 @@ module Mihari
       # @return [Mihari::Clients::Crtsh]
       #
       def client
-        @client ||= Mihari::Clients::Crtsh.new
+        @client ||= Mihari::Clients::Crtsh.new(timeout: timeout)
       end
     end
   end

data/lib/mihari/analyzers/dnstwister.rb

@@ -39,7 +39,7 @@ module Mihari
       end
 
       def client
-        @client ||= Clients::DNSTwister.new
+        @client ||= Clients::DNSTwister.new(timeout: timeout)
       end
 
       #

data/lib/mihari/analyzers/hunterhow.rb

@@ -27,7 +27,7 @@ module Mihari
       end
 
       #
-      # @return [Array<Mihari::Artifact>]
+      # @return [Array<Mihari::Models::Artifact>]
       #
       def artifacts
         client.search_with_pagination(

data/lib/mihari/analyzers/otx.rb

@@ -42,7 +42,7 @@ module Mihari
       private
 
       def client
-        @client ||= Mihari::Clients::OTX.new(api_key: api_key)
+        @client ||= Mihari::Clients::OTX.new(api_key: api_key, timeout: timeout)
       end
 
       #

data/lib/mihari/analyzers/passivetotal.rb

@@ -54,7 +54,7 @@ module Mihari
         #
         # @return [Array<String>, nil]
         #
-        def key_aliases
+        def class_key_aliases
           ["pt"]
         end
       end
@@ -62,7 +62,7 @@ module Mihari
       private
 
       def client
-        @client ||= Clients::PassiveTotal.new(username: username, api_key: api_key)
+        @client ||= Clients::PassiveTotal.new(username: username, api_key: api_key, timeout: timeout)
       end
 
       #

data/lib/mihari/analyzers/pulsedive.rb

@@ -35,7 +35,7 @@ module Mihari
             nil
           else
             data = property["value"]
-            Artifact.new(data: data, metadata: property)
+            Models::Artifact.new(data: data, metadata: property)
           end
         end
       end
@@ -47,7 +47,7 @@ module Mihari
       private
 
       def client
-        @client ||= Clients::PulseDive.new(api_key: api_key)
+        @client ||= Clients::PulseDive.new(api_key: api_key, timeout: timeout)
       end
 
       #

data/lib/mihari/analyzers/securitytrails.rb

@@ -48,7 +48,7 @@ module Mihari
         #
         # @return [Array<String>, nil]
         #
-        def key_aliases
+        def class_key_aliases
           ["st"]
         end
       end
@@ -56,7 +56,7 @@ module Mihari
       private
 
       def client
-        @client ||= Clients::SecurityTrails.new(api_key: api_key)
+        @client ||= Clients::SecurityTrails.new(api_key: api_key, timeout: timeout)
       end
 
       #

data/lib/mihari/analyzers/urlscan.rb

@@ -29,7 +29,7 @@ module Mihari
       end
 
       def artifacts
-        # @type [Array<Mihari::Artifact>]
+        # @type [Array<Mihari::Models::Artifact>]
         artifacts = client.search_with_pagination(query, pagination_limit: pagination_limit).map(&:artifacts).flatten
 
         artifacts.select do |artifact|

data/lib/mihari/analyzers/virustotal.rb

@@ -43,7 +43,7 @@ module Mihari
         #
         # @return [Array<String>, nil]
         #
-        def key_aliases
+        def class_key_aliases
           ["vt"]
         end
       end
@@ -66,7 +66,7 @@ module Mihari
       #
       # Domain search
       #
-      # @return [Array<Mihari::Artifact>]
+      # @return [Array<Mihari::Models::Artifact>]
       #
       def domain_search
         res = client.domain_search(query)
@@ -74,14 +74,14 @@ module Mihari
         data = res["data"] || []
         data.filter_map do |item|
           data = item.dig("attributes", "ip_address")
-          data.nil? ? nil : Artifact.new(data: data, metadata: item)
+          data.nil? ? nil : Models::Artifact.new(data: data, metadata: item)
         end
       end
 
       #
       # IP search
       #
-      # @return [Array<Mihari::Artifact>]
+      # @return [Array<Mihari::Models::Artifact>]
       #
       def ip_search
         res = client.ip_search(query)
@@ -89,7 +89,7 @@ module Mihari
         data = res["data"] || []
         data.filter_map do |item|
           data = item.dig("attributes", "host_name")
-          Artifact.new(data: data, metadata: item)
+          Models::Artifact.new(data: data, metadata: item)
         end.uniq
       end
     end

data/lib/mihari/analyzers/zoomeye.rb

@@ -65,7 +65,7 @@ module Mihari
       #
       # @param [Hash] response
       #
-      # @return [Array<Mihari::Artifact>]
+      # @return [Array<Mihari::Models::Artifact>]
       #
       def convert(res)
         matches = res["matches"] || []
@@ -73,9 +73,9 @@ module Mihari
           data = match["ip"]
 
           if data.is_a?(Array)
-            data.map { |d| Artifact.new(data: d, metadata: match) }
+            data.map { |d| Models::Artifact.new(data: d, metadata: match) }
           else
-            Artifact.new(data: data, metadata: match)
+            Models::Artifact.new(data: data, metadata: match)
           end
         end.flatten
       end

data/lib/mihari/clients/base.rb

@@ -18,10 +18,10 @@ module Mihari
       #
       # @param [String] base_url
       # @param [Hash] headers
-      # @param [Integer] interval
+      # @param [Integer] pagination_interval
       # @param [Integer, nil] timeout
       #
-      def initialize(base_url, headers: {}, pagination_interval: 0, timeout: nil)
+      def initialize(base_url, headers: {}, pagination_interval: Mihari.config.pagination_interval, timeout: nil)
         @base_url = base_url
         @headers = headers || {}
         @pagination_interval = pagination_interval

data/lib/mihari/clients/binaryedge.rb

@@ -7,21 +7,19 @@ module Mihari
       # @param [String] base_url
       # @param [String, nil] api_key
       # @param [Hash] headers
-      # @param [Integer] pagnation_interval
       # @param [Integer, nil] timeout
+      # @param [Integer] pagination_interval
       #
       def initialize(
         base_url = "https://api.binaryedge.io/v2",
         api_key:,
         headers: {},
-        pagination_interval: 0,
+        pagination_interval: Mihari.config.pagination_interval,
         timeout: nil
       )
-        raise(ArgumentError, "'api_key' argument is required") unless api_key
-
         headers["x-key"] = api_key
 
-        super(base_url, headers: headers, pagination_interval: pagination_interval, timeout: timeout)
+        super(base_url, headers: headers, timeout: timeout, pagination_interval: pagination_interval)
       end
 
       #

data/lib/mihari/clients/censys.rb

@@ -18,11 +18,11 @@ module Mihari
         id:,
         secret:,
         headers: {},
-        pagination_interval: 0,
+        pagination_interval: Mihari.config.pagination_interval,
         timeout: nil
       )
-        raise(ArgumentError, "'id' argument is required") if id.nil?
-        raise(ArgumentError, "'secret' argument is required") if secret.nil?
+        raise(ArgumentError, "id is required") if id.nil?
+        raise(ArgumentError, "secret is required") if secret.nil?
 
         headers["authorization"] = "Basic #{Base64.strict_encode64("#{id}:#{secret}")}"
 

data/lib/mihari/clients/circl.rb

@@ -10,14 +10,15 @@ module Mihari
       # @param [String, nil] username
       # @param [String, nil] password
       # @param [Hash] headers
+      # @param [Integer, nil] timeout
       #
-      def initialize(base_url = "https://www.circl.lu", username:, password:, headers: {})
-        raise(ArgumentError, "'username' argument is required") if username.nil?
-        raise(ArgumentError, "'password' argument is required") if password.nil?
+      def initialize(base_url = "https://www.circl.lu", username:, password:, headers: {}, timeout: nil)
+        raise(ArgumentError, "username is required") if username.nil?
+        raise(ArgumentError, "password is required") if password.nil?
 
         headers["authorization"] = "Basic #{Base64.strict_encode64("#{username}:#{password}")}"
 
-        super(base_url, headers: headers)
+        super(base_url, headers: headers, timeout: timeout)
       end
 
       #

data/lib/mihari/clients/crtsh.rb

@@ -6,9 +6,10 @@ module Mihari
       #
       # @param [String] base_url
       # @param [Hash] headers
+      # @param [Integer, nil] timeout
       #
-      def initialize(base_url = "https://crt.sh", headers: {})
-        super(base_url, headers: headers)
+      def initialize(base_url = "https://crt.sh", headers: {}, timeout: nil)
+        super(base_url, headers: headers, timeout: timeout)
       end
 
       #
@@ -18,7 +19,7 @@ module Mihari
       # @param [String, nil] match "=", "ILIKE", "LIKE", "single", "any" or nil
       # @param [String, nil] exclude "expired" or nil
       #
-      # @return [Array<Mihari::Artifact>]
+      # @return [Array<Mihari::Models::Artifact>]
       #
       def search(identity, match: nil, exclude: nil)
         params = { identity: identity, match: match, exclude: exclude, output: "json" }.compact
@@ -28,7 +29,7 @@ module Mihari
 
         parsed.map do |result|
           values = result["name_value"].to_s.lines.map(&:chomp)
-          values.map { |value| Artifact.new(data: value, metadata: result) }
+          values.map { |value| Models::Artifact.new(data: value, metadata: result) }
         end.flatten
       end
     end

data/lib/mihari/clients/dnstwister.rb

@@ -6,9 +6,10 @@ module Mihari
       #
       # @param [String] base_url
       # @param [Hash] headers
+      # @param [Integer, nil] timeout
       #
-      def initialize(base_url = "https://dnstwister.report", headers: {})
-        super(base_url, headers: headers)
+      def initialize(base_url = "https://dnstwister.report", headers: {}, timeout: nil)
+        super(base_url, headers: headers, timeout: timeout)
       end
 
       #

data/lib/mihari/clients/greynoise.rb

@@ -16,10 +16,10 @@ module Mihari
         base_url = "https://api.greynoise.io",
         api_key:,
         headers: {},
-        pagination_interval: 0,
+        pagination_interval: Mihari.config.pagination_interval,
         timeout: nil
       )
-        raise(ArgumentError, "'api_key' argument is required") unless api_key
+        raise(ArgumentError, "api_key is required") unless api_key
 
         headers["key"] = api_key
         super(base_url, headers: headers, pagination_interval: pagination_interval, timeout: timeout)

data/lib/mihari/clients/hunterhow.rb

@@ -21,10 +21,10 @@ module Mihari
         base_url = "https://api.hunter.how/",
         api_key:,
         headers: {},
-        pagination_interval: 0,
+        pagination_interval: Mihari.config.pagination_interval,
         timeout: nil
       )
-        raise(ArgumentError, "'api_key' argument is required") unless api_key
+        raise(ArgumentError, "api_key is required") unless api_key
 
         super(base_url, headers: headers, pagination_interval: pagination_interval, timeout: timeout)
 

data/lib/mihari/clients/misp.rb

@@ -10,7 +10,7 @@ module Mihari
       # @param [Integer, nil] timeout
       #
       def initialize(base_url, api_key:, headers: {}, timeout: nil)
-        raise(ArgumentError, "'api_key' argument is required") unless api_key
+        raise(ArgumentError, "api_key is required") unless api_key
 
         headers["authorization"] = api_key
         headers["accept"] = "application/json"

data/lib/mihari/clients/onyphe.rb

@@ -19,10 +19,10 @@ module Mihari
         base_url = "https://www.onyphe.io",
         api_key:,
         headers: {},
-        pagination_interval: 0,
+        pagination_interval: Mihari.config.pagination_interval,
         timeout: nil
       )
-        raise(ArgumentError, "'api_key' argument is required") if api_key.nil?
+        raise(ArgumentError, "api_key is required") if api_key.nil?
 
         super(base_url, headers: headers, pagination_interval: pagination_interval, timeout: timeout)
 

data/lib/mihari/clients/otx.rb

@@ -7,12 +7,13 @@ module Mihari
       # @param [String] base_url
       # @param [String, nil] api_key
       # @param [Hash] headers
+      # @param [Integer, nil] timeout
       #
-      def initialize(base_url = "https://otx.alienvault.com", api_key:, headers: {})
-        raise(ArgumentError, "'api_key' argument is required") unless api_key
+      def initialize(base_url = "https://otx.alienvault.com", api_key:, headers: {}, timeout: nil)
+        raise(ArgumentError, "api_key is required") unless api_key
 
         headers["x-otx-api-key"] = api_key
-        super(base_url, headers: headers)
+        super(base_url, headers: headers, timeout: timeout)
       end
 
       #

data/lib/mihari/clients/passivetotal.rb

@@ -10,14 +10,15 @@ module Mihari
       # @param [String, nil] username
       # @param [String, nil] api_key
       # @param [Hash] headers
+      # @param [Integer, nil] timeout
       #
-      def initialize(base_url = "https://api.passivetotal.org", username:, api_key:, headers: {})
-        raise(ArgumentError, "'username' argument is required") if username.nil?
-        raise(ArgumentError, "'api_key' argument is required") if api_key.nil?
+      def initialize(base_url = "https://api.passivetotal.org", username:, api_key:, headers: {}, timeout: nil)
+        raise(ArgumentError, "username is required") if username.nil?
+        raise(ArgumentError, "api_key is required") if api_key.nil?
 
         headers["authorization"] = "Basic #{Base64.strict_encode64("#{username}:#{api_key}")}"
 
-        super(base_url, headers: headers)
+        super(base_url, headers: headers, timeout: timeout)
       end
 
       #
@@ -38,7 +39,7 @@ module Mihari
       #
       # @param [String] query
       #
-      # @return [Array<Mihari::Artifact>]
+      # @return [Array<Mihari::Models::Artifact>]
       #
       def reverse_whois_search(query)
         params = {
@@ -49,7 +50,7 @@ module Mihari
         results = res["results"] || []
         results.map do |result|
           data = result["domain"]
-          Artifact.new(data: data, metadata: result)
+          Models::Artifact.new(data: data, metadata: result)
         end.flatten
       end
 
@@ -58,7 +59,7 @@ module Mihari
       #
       # @param [String] query
       #
-      # @return [Array<Mihari::Artifact>]
+      # @return [Array<Mihari::Models::Artifact>]
       #
       def ssl_search(query)
         params = { query: query }
@@ -66,7 +67,7 @@ module Mihari
         results = res["results"] || []
         results.map do |result|
           data = result["ipAddresses"]
-          data.map { |d| Artifact.new(data: d, metadata: result) }
+          data.map { |d| Models::Artifact.new(data: d, metadata: result) }
         end.flatten
       end
 

data/lib/mihari/clients/publsedive.rb

@@ -10,13 +10,14 @@ module Mihari
       # @param [String] base_url
       # @param [String, nil] api_key
       # @param [Hash] headers
+      # @param [Integer, nil] timeout
       #
-      def initialize(base_url = "https://pulsedive.com", api_key:, headers: {})
-        super(base_url, headers: headers)
+      def initialize(base_url = "https://pulsedive.com", api_key:, headers: {}, timeout: nil)
+        raise(ArgumentError, "api_key is required") unless api_key
 
         @api_key = api_key
 
-        raise(ArgumentError, "'api_key' argument is required") unless api_key
+        super(base_url, headers: headers, timeout: timeout)
       end
 
       #

data/lib/mihari/clients/securitytrails.rb

@@ -7,12 +7,14 @@ module Mihari
       # @param [String] base_url
       # @param [String, nil] api_key
       # @param [Hash] headers
+      # @param [Integer, nil] timeout
       #
-      def initialize(base_url = "https://api.securitytrails.com", api_key:, headers: {})
-        raise(ArgumentError, "'api_key' argument is required") unless api_key
+      def initialize(base_url = "https://api.securitytrails.com", api_key:, headers: {}, timeout: nil)
+        raise(ArgumentError, "api_key is required") unless api_key
 
         headers["apikey"] = api_key
-        super(base_url, headers: headers)
+
+        super(base_url, headers: headers, timeout: timeout)
       end
 
       #
@@ -34,13 +36,13 @@ module Mihari
       #
       # @param [String] query
       #
-      # @return [Array<Mihari::Artifact>]
+      # @return [Array<Mihari::Models::Artifact>]
       #
       def ip_search(query)
         records = search_by_ip(query)
         records.filter_map do |record|
           data = record["hostname"]
-          Artifact.new(data: data, metadata: record)
+          Models::Artifact.new(data: data, metadata: record)
         end
       end
 
@@ -55,7 +57,7 @@ module Mihari
         records = search_by_mail(query)
         records.filter_map do |record|
           data = record["hostname"]
-          Artifact.new(data: data, metadata: record)
+          Models::Artifact.new(data: data, metadata: record)
         end
       end
 

data/lib/mihari/clients/shodan.rb

@@ -19,10 +19,10 @@ module Mihari
         base_url = "https://api.shodan.io",
         api_key:,
         headers: {},
-        pagination_interval: 0,
+        pagination_interval: Mihari.config.pagination_interval,
         timeout: nil
       )
-        raise(ArgumentError, "'api_key' argument is required") unless api_key
+        raise(ArgumentError, "api_key is required") unless api_key
 
         super(base_url, headers: headers, pagination_interval: pagination_interval, timeout: timeout)