mihari 5.3.0 → 5.3.2

data/lib/mihari/analyzers/rule.rb

@@ -37,14 +37,14 @@ module Mihari
     class Rule
       include Mixins::FalsePositive
 
-      # @return [Mihari::Structs::Rule]
+      # @return [Mihari::Services::Rule]
       attr_reader :rule
 
       # @return [Time]
       attr_reader :base_time
 
       #
-      # @param [Mihari::Structs::Rule] rule
+      # @param [Mihari::Services::Rule] rule
       #
       def initialize(rule)
         @rule = rule
@@ -146,11 +146,8 @@ module Mihari
       def falsepositive?(value)
         return true if rule.falsepositives.include?(value)
 
-        rule.falsepositives.select do |falsepositive|
-          falsepositive.is_a?(Regexp)
-        end.any? do |falseposistive|
-          falseposistive.match?(value)
-        end
+        regexps = rule.falsepositives.select { |fp| fp.is_a?(Regexp) }
+        regexps.any? { |fp| fp.match?(value) }
       end
 
       #

data/lib/mihari/analyzers/shodan.rb

@@ -60,7 +60,7 @@ module Mihari
           break if res.total <= page * PAGE_SIZE
 
           # sleep #{interval} seconds to avoid the rate limitation (if it is set)
-          sleep interval
+          sleep_interval
         rescue JSON::ParserError
           # ignore JSON::ParserError
           # ref. https://github.com/ninoseki/mihari/issues/197

data/lib/mihari/analyzers/urlscan.rb

@@ -77,7 +77,7 @@ module Mihari
           search_after = res.results.last.sort.join(",")
 
           # sleep #{interval} seconds to avoid the rate limitation (if it is set)
-          sleep(interval) if interval
+          sleep_interval
         end
 
         responses

data/lib/mihari/analyzers/virustotal_intelligence.rb

@@ -53,7 +53,7 @@ module Mihari
 
           cursor = response.meta.cursor
           # sleep #{interval} seconds to avoid the rate limitation (if it is set)
-          sleep(interval) if interval
+          sleep_interval
         end
 
         responses

data/lib/mihari/analyzers/zoomeye.rb

@@ -104,7 +104,7 @@ module Mihari
           break if total <= page * PAGE_SIZE
 
           # sleep #{interval} seconds to avoid the rate limitation (if it is set)
-          sleep(interval) if interval
+          sleep_interval
         end
         convert_responses responses.compact
       end
@@ -137,7 +137,7 @@ module Mihari
           break if total <= page * PAGE_SIZE
 
           # sleep #{interval} seconds to avoid the rate limitation (if it is set)
-          sleep(interval) if interval
+          sleep_interval
         end
         convert_responses responses.compact
       end

data/lib/mihari/commands/rule.rb

@@ -15,7 +15,7 @@ module Mihari
             # @param [String] path
             #
             def validate(path)
-              rule = Structs::Rule.from_path_or_id(path)
+              rule = Services::Rule.from_path_or_id(path)
 
               begin
                 rule.validate!
@@ -44,10 +44,10 @@ module Mihari
 
             no_commands do
               #
-              # @return [Mihari::Structs::Rule]
+              # @return [Mihari::Services::Rule]
               #
               def rule_template
-                Structs::Rule.from_path File.expand_path("../templates/rule.yml.erb", __dir__)
+                Services::Rule.from_path File.expand_path("../templates/rule.yml.erb", __dir__)
               end
 
               #

data/lib/mihari/commands/search.rb

@@ -33,12 +33,12 @@ module Mihari
           end
 
           def update_or_create
-            rule.model.save
+            rule.to_model.save
           end
 
           def run
             begin
-              analyzer = rule.analyzer
+              analyzer = rule.to_analyzer
             rescue ConfigurationError => e
               # if there is a configuration error, output that error without the stack trace
               Mihari.logger.error e.to_s
@@ -69,7 +69,7 @@ module Mihari
             #
             def search(path_or_id)
               Mihari::Database.with_db_connection do
-                rule = Structs::Rule.from_path_or_id path_or_id
+                rule = Services::Rule.from_path_or_id path_or_id
 
                 begin
                   rule.validate!

data/lib/mihari/constants.rb

@@ -1,10 +1,13 @@
 # frozen_string_literal: true
 
 module Mihari
+  # @return [Array<String>]
   DEFAULT_DATA_TYPES = %w[hash ip domain url mail].freeze
 
+  # @return [Array<Hash>]
   DEFAULT_EMITTERS = %w[database misp slack the_hive].map { |name| { emitter: name } }.freeze
 
+  # @return [Array<Hash>]
   DEFAULT_ENRICHERS = %w[whois ipinfo shodan google_public_dns].map { |name| { enricher: name } }.freeze
 
   DEFAULT_RETRY_TIMES = 3

data/lib/mihari/emitters/base.rb

@@ -9,12 +9,12 @@ module Mihari
       # @return [Array<Mihari::Artifact>]
       attr_reader :artifacts
 
-      # @return [Mihari::Structs::Rule]
+      # @return [Mihari::Services::Rule]
       attr_reader :rule
 
       #
       # @param [Array<Mihari::Artifact>] artifacts
-      # @param [Mihari::Structs::Rule] rule
+      # @param [Mihari::Services::Rule] rule
       # @param [Hash] **_options
       #
       def initialize(artifacts:, rule:, **_options)

data/lib/mihari/emitters/misp.rb

@@ -12,12 +12,12 @@ module Mihari
       # @return [Array<Mihari::Artifact>]
       attr_reader :artifacts
 
-      # @return [Mihari::Structs::Rule]
+      # @return [Mihari::Services::Rule]
       attr_reader :rule
 
       #
       # @param [Array<Mihari::Artifact>] artifacts
-      # @param [Mihari::Structs::Rule] rule
+      # @param [Mihari::Services::Rule] rule
       # @param [Hash] **options
       #
       def initialize(artifacts:, rule:, **options)
@@ -47,7 +47,7 @@ module Mihari
       # Create a MISP event
       #
       # @param [Arra<Mihari::Artifact>] artifacts
-      # @param [Mihari::Structs::Rule] rule
+      # @param [Mihari::Services::Rule] rule
       #
       # @return [::MISP::Event]
       #

data/lib/mihari/emitters/slack.rb

@@ -133,7 +133,7 @@ module Mihari
 
       #
       # @param [Array<Mihari::Artifact>] artifacts
-      # @param [Mihari::Structs::Rule] rule
+      # @param [Mihari::Services::Rule] rule
       # @param [Hash] **_options
       #
       def initialize(artifacts:, rule:, **options)

data/lib/mihari/emitters/the_hive.rb

@@ -14,7 +14,7 @@ module Mihari
 
       #
       # @param [Array<Mihari::Artifact>] artifacts
-      # @param [Mihari::Structs::Rule] rule
+      # @param [Mihari::Services::Rule] rule
       # @param [Hash] **options
       #
       def initialize(artifacts:, rule:, **options)

data/lib/mihari/emitters/webhook.rb

@@ -57,7 +57,7 @@ module Mihari
 
       #
       # @param [Array<Mihari::Artifact>] artifacts
-      # @param [Mihari::Structs::Rule] rule
+      # @param [Mihari::Services::Rule] rule
       # @param [Hash] **options
       #
       def initialize(artifacts:, rule:, **options)

data/lib/mihari/mixins/configurable.rb

@@ -49,6 +49,11 @@ module Mihari
 
       private
 
+      #
+      # Check whether API key is set or not
+      #
+      # @return [Boolean]
+      #
       def api_key?
         value = method(:api_key).call
         !value.nil?

data/lib/mihari/mixins/falsepositive.rb

@@ -22,7 +22,7 @@ module Mihari
       memoize :normalize_falsepositive
 
       #
-      # Check whetehr a value is valid format as a disallowed data value
+      # Check whether a value is valid format as a disallowed data value
       #
       # @param [String] value Data value
       #

data/lib/mihari/mixins/retriable.rb

@@ -21,8 +21,6 @@ module Mihari
       # @param [Integer] interval
       # @param [Array<StandardError>] on
       #
-      # @return [nil]
-      #
       def retry_on_error(times: 3, interval: 5, on: DEFAULT_ON)
         try = 0
         begin

data/lib/mihari/{structs → services}/rule.rb

@@ -8,7 +8,7 @@ require "securerandom"
 require "yaml"
 
 module Mihari
-  module Structs
+  module Services
     class Rule
       include Mixins::FalsePositive
 
@@ -49,16 +49,16 @@ module Mihari
       end
 
       def validate!
-        raise RuleValidationError if errors?
-      rescue RuleValidationError => e
+        return unless errors?
+
         Mihari.logger.error "Failed to parse the input as a rule:"
         Mihari.logger.error JSON.pretty_generate(errors.to_h)
 
-        raise e
+        raise RuleValidationError, errors
       end
 
       def [](key)
-        data[key.to_sym]
+        data key.to_sym
       end
 
       #
@@ -141,7 +141,7 @@ module Mihari
       #
       # @return [Mihari::Rule]
       #
-      def model
+      def to_model
         rule = Mihari::Rule.find(id)
 
         rule.title = title
@@ -161,8 +161,8 @@ module Mihari
       #
       # @return [Mihari::Analyzers::Rule]
       #
-      def analyzer
-        Mihari::Analyzers::Rule.new(self)
+      def to_analyzer
+        Mihari::Analyzers::Rule.new self
       end
 
       class << self
@@ -171,10 +171,10 @@ module Mihari
         #
         # @param [String] yaml
         #
-        # @return [Mihari::Structs::Rule]
+        # @return [Mihari::Services::Rule]
         #
         def from_yaml(yaml)
-          Structs::Rule.new YAML.safe_load(ERB.new(yaml).result, permitted_classes: [Date, Symbol])
+          Services::Rule.new YAML.safe_load(ERB.new(yaml).result, permitted_classes: [Date, Symbol])
         rescue Psych::SyntaxError => e
           raise YAMLSyntaxError, e.message
         end
@@ -182,10 +182,10 @@ module Mihari
         #
         # @param [Mihari::Rule] model
         #
-        # @return [Mihari::Structs::Rule]
+        # @return [Mihari::Services::Rule]
         #
         def from_model(model)
-          Structs::Rule.new(model.data)
+          Services::Rule.new model.data
         end
 
         #
@@ -193,7 +193,7 @@ module Mihari
         #
         # @param [String] path
         #
-        # @return [Mihari::Structs::Rule, nil]
+        # @return [Mihari::Services::Rule, nil]
         #
         def from_path(path)
           return nil unless Pathname(path).exist?
@@ -206,18 +206,18 @@ module Mihari
         #
         # @param [String] id
         #
-        # @return [Mihari::Structs::Rule, nil]
+        # @return [Mihari::Services::Rule, nil]
         #
         def from_id(id)
           return nil unless Mihari::Rule.exists?(id)
 
-          Structs::Rule.from_model Mihari::Rule.find(id)
+          Services::Rule.from_model Mihari::Rule.find(id)
         end
 
         #
         # @param [String] path_or_id Path to YAML file or YAML string or ID of a rule in the database
         #
-        # @return [Mihari::Structs::Rule]
+        # @return [Mihari::Services::Rule]
         #
         def from_path_or_id(path_or_id)
           rule = from_path(path_or_id)

data/lib/mihari/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Mihari
-  VERSION = "5.3.0"
+  VERSION = "5.3.2"
 end

data/lib/mihari/web/endpoints/rules.rb

@@ -83,12 +83,13 @@ module Mihari
           id = params["id"].to_s
 
           begin
-            rule = Mihari::Structs::Rule.from_model(Mihari::Rule.find(id))
+            rule = Mihari::Services::Rule.from_model(Mihari::Rule.find(id))
           rescue ActiveRecord::RecordNotFound
             error!({ message: "ID:#{id} is not found" }, 404)
           end
 
-          rule.analyzer.run
+          analyzer = rule.to_analyzer
+          analyzer.run
 
           status 201
           present({ message: "ID:#{id} is ran successfully" }, with: Entities::Message)
@@ -105,7 +106,7 @@ module Mihari
           yaml = params[:yaml]
 
           begin
-            rule = Structs::Rule.from_yaml(yaml)
+            rule = Services::Rule.from_yaml(yaml)
           rescue YAMLSyntaxError => e
             error!({ message: e.message }, 400)
           end
@@ -128,13 +129,13 @@ module Mihari
           end
 
           begin
-            rule.model.save
+            rule.to_model.save
           rescue ActiveRecord::RecordNotUnique
             error!({ message: "ID:#{rule.id} is already registered" }, 400)
           end
 
           status 201
-          present rule.model, with: Entities::Rule
+          present rule.to_model, with: Entities::Rule
         end
 
         desc "Update a rule", {
@@ -156,7 +157,7 @@ module Mihari
           end
 
           begin
-            rule = Structs::Rule.from_yaml(yaml)
+            rule = Services::Rule.from_yaml(yaml)
           rescue YAMLSyntaxError => e
             error!({ message: e.message }, 400)
           end
@@ -171,13 +172,13 @@ module Mihari
           end
 
           begin
-            rule.model.save
+            rule.to_model.save
           rescue ActiveRecord::RecordNotUnique
             error!({ message: "ID:#{id} is already registered" }, 400)
           end
 
           status 201
-          present rule.model, with: Entities::Rule
+          present rule.to_model, with: Entities::Rule
         end
 
         desc "Delete a rule", {