mihari 7.1.0 → 7.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6930da0e95068ca8e30d1f226be5692e85375f796b7246cafdd2bec566d00ff7
-  data.tar.gz: 2bf34b1231bffcd88d402ffda335960ad929b1de91cd51b257c9c24f7b2fc16f
+  metadata.gz: 8ea0adf73bba53f264c22f8885d44e24de5657a2a77c2b7ea3533bb5acf6e78b
+  data.tar.gz: 77ab077d9322a22b0e399c81c057485aec1c4cdb1a14f15cbd81f1a3650f37a6
 SHA512:
-  metadata.gz: fd515cdbde67d10c3fcae14c8e45a7929a34931701be176c9f9a294d3db310f522a3e186aefe548d6f119c5c8552723114da4ee6f790dbbe0391138dca9cc00e
-  data.tar.gz: 5f4a3e1049ad55af018cf9ed2186dda49bd18517d37bc84cad6e6f60b10589834ac3bd1f09333e7f9773fab43442400c097c1063f1c304d5be5eb8991af7ec77
+  metadata.gz: 3b68702c146819189140c0c5626c27f7b53f94021dd21138f0ac2758366486cebb7c450e0168f76cfc3d9940ee86eb2b279eb1725a3922614f51930dcb0e6b71
+  data.tar.gz: e30c01360a6d382e73a8e88a40a5cd3f1dba6bac9ebbbe9b87b9b51cff4a6dc59676d19eec4fe757a3a40d78a560886e434802b74fdf125e663b73ae4c7abd8a

data/.rubocop.yml

@@ -17,6 +17,8 @@ RSpec/MultipleMemoizedHelpers:
   Max: 10
 RSpec/ExampleLength:
   Max: 20
+RSpec/FilePath:
+  SpecSuffixOnly: true
 require:
   - rubocop-factory_bot
   - rubocop-rake

data/README.md

@@ -1,7 +1,8 @@
 # mihari
 
 [![Gem Version](https://badge.fury.io/rb/mihari.svg)](https://badge.fury.io/rb/mihari)
-[![Ruby CI](https://github.com/ninoseki/mihari/actions/workflows/test.yml/badge.svg)](https://github.com/ninoseki/mihari/actions/workflows/test.yml)
+[![Ruby CI](https://github.com/ninoseki/mihari/actions/workflows/ruby.yml/badge.svg)](https://github.com/ninoseki/mihari/actions/workflows/ruby.yml)
+[![Node.js CI](https://github.com/ninoseki/mihari/actions/workflows/node.yml/badge.svg)](https://github.com/ninoseki/mihari/actions/workflows/node.yml)
 [![Coverage Status](https://coveralls.io/repos/github/ninoseki/mihari/badge.svg?branch=master)](https://coveralls.io/github/ninoseki/mihari?branch=master)
 [![CodeFactor](https://www.codefactor.io/repository/github/ninoseki/mihari/badge)](https://www.codefactor.io/repository/github/ninoseki/mihari)
 

data/Rakefile

@@ -7,11 +7,49 @@ RSpec::Core::RakeTask.new(:spec)
 
 task default: :spec
 
-desc "run rackup (via rerun)"
+desc "Run rackup (with rerun)"
 task :rackup do
   sh "rerun --pattern '{Gemfile.lock,lib/**/*.rb,lib/*.rb}' -- rackup config.ru"
 end
 
+def recursive_delete(hash, to_remove)
+  hash.delete(to_remove)
+  hash.each_value do |value|
+    recursive_delete(value, to_remove) if value.is_a? Hash
+  end
+end
+
+def build_swagger_doc(path)
+  require_relative "lib/mihari"
+  require_relative "lib/mihari/web/application"
+
+  require "rack/test"
+
+  app = Mihari::Web::App.new
+  session = Rack::Test::Session.new(app)
+
+  res = session.request("/api/swagger_doc")
+
+  json = JSON.parse(res.body.to_s)
+  # remove host because it can be varied
+  keys_to_remove = %w[host]
+  keys_to_remove.each do |key|
+    recursive_delete json, key
+  end
+
+  f = File.open(path, "w")
+  f.write json.to_yaml
+  f.close
+end
+
+namespace :build do
+  desc "Build Swagger doc"
+  task :swagger, [:path] do |_t, args|
+    args.with_defaults(path: "./frontend/swagger.yaml")
+    build_swagger_doc args.path
+  end
+end
+
 def ci?
   ENV.fetch("CI", false)
 end

data/lib/mihari/analyzers/base.rb

@@ -80,7 +80,7 @@ module Mihari
       end
 
       def result(...)
-        res = Try[StandardError] do
+        result = Try[StandardError] do
           retry_on_error(
             times: retry_times,
             interval: retry_interval,
@@ -88,19 +88,17 @@ module Mihari
           ) do
             call(...)
           end
-        end
-
-        return res.recover { [] } if ignore_error?
+        end.to_result
 
-        result = res.to_result
         return result if result.success?
 
         # Wrap failure with AnalyzerError to explicitly name a failed analyzer
-        Failure AnalyzerError.new(
-          result.failure.message,
-          self.class.class_key,
-          cause: result.failure
-        )
+        error = AnalyzerError.new(result.failure.message, self.class.class_key, cause: result.failure)
+        return Failure(error) unless ignore_error?
+
+        # Return Success if ignore_error? is true with logging
+        Mihari.logger.warn("Analyzer:#{self.class.class_key} failed - #{result.failure}")
+        Success([])
       end
 
       class << self

data/lib/mihari/cli/application.rb

@@ -38,6 +38,21 @@ module Mihari
       include Concerns::ErrorUnwrappable
 
       no_commands do
+        #
+        # @param [StandardError] error
+        #
+        # @return [String, Hash, nil]
+        #
+        def error_to_detail(error)
+          # Dirty hack to show the DB error message
+          # (NOTE: #safe_execute block suppress #with_db_connection's error message)
+          if error.is_a?(ActiveRecord::StatementInvalid)
+            return "DB migration is not yet complete. Please run 'mihari db migrate'."
+          end
+
+          error.respond_to?(:detail) ? error.detail : nil
+        end
+
         def safe_execute
           yield
         rescue StandardError => e
@@ -48,10 +63,7 @@ module Mihari
           # Raise error if debug is set as true
           raise error if options["debug"]
 
-          data = Entities::ErrorMessage.represent(
-            message: error.message,
-            detail: error.respond_to?(:detail) ? error.detail : nil
-          )
+          data = Entities::ErrorMessage.represent(message: error.message, detail: error_to_detail(error))
           warn JSON.pretty_generate(data.as_json)
 
           Sentry.capture_exception(error) if Sentry.initialized? && !error.is_a?(ValidationError)

data/lib/mihari/commands/alert.rb

@@ -26,7 +26,7 @@ module Mihari
               end
             end
 
-            desc "create [PATH]", "Create an alert"
+            desc "create PATH", "Create an alert"
             around :with_db_connection
             #
             # @param [String] path
@@ -46,7 +46,7 @@ module Mihari
               puts JSON.pretty_generate(data.as_json)
             end
 
-            desc "list [QUERY]", "List/search alerts"
+            desc "list QUERY", "List/search alerts"
             around :with_db_connection
             method_option :page, type: :numeric, default: 1
             method_option :limit, type: :numeric, default: 10
@@ -67,7 +67,7 @@ module Mihari
             desc "list-transform QUERY", "List/search alerts with transformation"
             around :with_db_connection
             method_option :template, type: :string, required: true, aliases: "-t",
-              description: "Jbuilder template itself or a path to a template file"
+              desc: "Jbuilder template stringor a path to a template"
             method_option :page, type: :numeric, default: 1
             method_option :limit, type: :numeric, default: 10
             #
@@ -86,7 +86,7 @@ module Mihari
               )
             end
 
-            desc "get [ID]", "Get an alert"
+            desc "get ID", "Get an alert"
             around :with_db_connection
             #
             # @param [Integer] id
@@ -97,7 +97,7 @@ module Mihari
               puts JSON.pretty_generate(data.as_json)
             end
 
-            desc "delete [ID]", "Delete an alert"
+            desc "delete ID", "Delete an alert"
             around :with_db_connection
             #
             # @param [Integer] id

data/lib/mihari/commands/artifact.rb

@@ -25,7 +25,7 @@ module Mihari
               end
             end
 
-            desc "list [QUERY]", "List/search artifacts"
+            desc "list QUERY", "List/search artifacts"
             around :with_db_connection
             method_option :page, type: :numeric, default: 1
             method_option :limit, type: :numeric, default: 10
@@ -46,7 +46,7 @@ module Mihari
             desc "list-transform QUERY", "List/search artifacts with transformation"
             around :with_db_connection
             method_option :template, type: :string, required: true, aliases: "-t",
-              description: "Jbuilder template itself or a path to a template file"
+              desc: "Jbuilder template stringor a path to a template"
             method_option :page, type: :numeric, default: 1
             method_option :limit, type: :numeric, default: 10
             #
@@ -65,7 +65,7 @@ module Mihari
               )
             end
 
-            desc "get [ID]", "Get an artifact"
+            desc "get ID", "Get an artifact"
             around :with_db_connection
             #
             # @param [Integer] id
@@ -76,7 +76,7 @@ module Mihari
               puts JSON.pretty_generate(data.as_json)
             end
 
-            desc "enrich [ID]", "Enrich an artifact"
+            desc "enrich ID", "Enrich an artifact"
             around :with_db_connection
             #
             # @param [Integer] id
@@ -85,7 +85,7 @@ module Mihari
               Services::ArtifactEnricher.result(id).value!
             end
 
-            desc "delete [ID]", "Delete an artifact"
+            desc "delete ID", "Delete an artifact"
             around :with_db_connection
             #
             # @param [Integer] id

data/lib/mihari/commands/rule.rb

@@ -26,7 +26,7 @@ module Mihari
               end
             end
 
-            desc "validate [PATH]", "Validate a rule file"
+            desc "validate PATH", "Validate a rule"
             #
             # Validate format of a rule
             #
@@ -37,7 +37,7 @@ module Mihari
               puts rule.data.to_yaml
             end
 
-            desc "init [PATH]", "Initialize a new rule file"
+            desc "init PATH", "Initialize a new rule"
             #
             # Initialize a new rule file
             #
@@ -50,7 +50,7 @@ module Mihari
               Services::RuleInitializer.call(path)
             end
 
-            desc "list [QUERY]", "List/search rules"
+            desc "list QUERY", "List/search rules"
             around :with_db_connection
             method_option :page, type: :numeric, default: 1
             method_option :limit, type: :numeric, default: 10
@@ -71,7 +71,7 @@ module Mihari
             desc "list-transform QUERY", "List/search rules with transformation"
             around :with_db_connection
             method_option :template, type: :string, required: true, aliases: "-t",
-              description: "Jbuilder template itself or a path to a template file"
+              desc: "Jbuilder template stringor a path to a template"
             method_option :page, type: :numeric, default: 1
             method_option :limit, type: :numeric, default: 10
             #
@@ -90,7 +90,7 @@ module Mihari
               )
             end
 
-            desc "get [ID]", "Get a rule"
+            desc "get ID", "Get a rule"
             around :with_db_connection
             def get(id)
               value = Services::RuleGetter.result(id).value!
@@ -98,7 +98,7 @@ module Mihari
               puts JSON.pretty_generate(data.as_json)
             end
 
-            desc "delete [ID]", "Delete a rule"
+            desc "delete ID", "Delete a rule"
             around :with_db_connection
             #
             # @param [String] id

data/lib/mihari/commands/search.rb

@@ -11,7 +11,7 @@ module Mihari
           thor.class_eval do
             include Concerns::DatabaseConnectable
 
-            desc "search [PATH_OR_ID]", "Search by a rule"
+            desc "search PATH_OR_ID", "Search by a rule"
             around :with_db_connection
             method_option :force_overwrite, type: :boolean, default: false, aliases: "-f",
               desc: "Force overwriting a rule"

data/lib/mihari/commands/tag.rb

@@ -25,7 +25,7 @@ module Mihari
               end
             end
 
-            desc "list", "List/search tags"
+            desc "list QUERY", "List/search tags"
             around :with_db_connection
             method_option :page, type: :numeric, default: 1
             method_option :limit, type: :numeric, default: 10
@@ -46,7 +46,7 @@ module Mihari
             desc "list-transform QUERY", "List/search tags with transformation"
             around :with_db_connection
             method_option :template, type: :string, required: true, aliases: "-t",
-              description: "Jbuilder template itself or a path to a template file"
+              desc: "Jbuilder template stringor a path to a template"
             method_option :page, type: :numeric, default: 1
             method_option :limit, type: :numeric, default: 10
             #
@@ -65,7 +65,7 @@ module Mihari
               )
             end
 
-            desc "delete [ID]", "Delete a tag"
+            desc "delete ID", "Delete a tag"
             around :with_db_connection
             #
             # @param [Integer] id

data/lib/mihari/concerns/retriable.rb

@@ -21,7 +21,7 @@ module Mihari
 
         case error
         when StatusError
-          error.status_code != 404
+          ![401, 404].include?(error.status_code)
         else
           false
         end

data/lib/mihari/database.rb

@@ -156,7 +156,7 @@ module Mihari
         Mihari::Database.connect unless connected?
         yield
       rescue ActiveRecord::StatementInvalid
-        Mihari.logger.error("The DB migration is not yet complete. Please run 'mihari db migrate'.")
+        Mihari.logger.error("DB migration is not yet complete. Please run 'mihari db migrate'.")
       ensure
         Mihari::Database.close
       end

data/lib/mihari/emitters/base.rb

@@ -30,13 +30,17 @@ module Mihari
       # @return [Dry::Monads::Result::Success<Object>, Dry::Monads::Result::Failure]
       #
       def result(artifacts)
-        Try[StandardError] do
+        result = Try[StandardError] do
           retry_on_error(
             times: retry_times,
             interval: retry_interval,
             exponential_backoff: retry_exponential_backoff
           ) { call(artifacts) }
         end.to_result
+
+        Mihari.logger.warn("Emitter:#{self.class.class_key} failed - #{result.failure}") if result.failure?
+
+        result
       end
 
       class << self

data/lib/mihari/enrichers/base.rb

@@ -19,17 +19,23 @@ module Mihari
         raise NotImplementedError, "You must implement #{self.class}##{__method__}"
       end
 
+      #
+      # @param [Mihari::Models::Artifact] value
       #
       # @return [Dry::Monads::Result::Success<Object>, Dry::Monads::Result::Failure]
       #
       def result(value)
-        Try[StandardError] do
+        result = Try[StandardError] do
           retry_on_error(
             times: retry_times,
             interval: retry_interval,
             exponential_backoff: retry_exponential_backoff
           ) { call value }
         end.to_result
+
+        Mihari.logger.warn("Enricher:#{self.class.class_key} failed: #{result.failure}") if result.failure?
+
+        result
       end
 
       class << self

data/lib/mihari/rule.rb

@@ -188,20 +188,8 @@ module Mihari
     def bulk_emit
       return [] if enriched_artifacts.empty?
 
-      # NOTE: separate parallel execution and logging
-      #       because the logger does not work along with Parallel
-      results = Parallel.map(emitters) { |emitter| emitter.result enriched_artifacts }
-      results.zip(emitters).map do |result_and_emitter|
-        result, emitter = result_and_emitter
-
-        case result
-        when Success
-          Mihari.logger.info "Emission by #{emitter.class} succeed"
-        else
-          Mihari.logger.info "Emission by #{emitter.class} failed: #{result.failure}"
-        end
-
-        result.value_or nil
+      Parallel.map(emitters) do |emitter|
+        emitter.result(enriched_artifacts).value_or nil
       end.compact
     end
 

data/lib/mihari/version.rb

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