mihari 4.1.2 → 4.2.0

data/lib/mihari/cli/mixins/utils.rb

@@ -1,72 +0,0 @@
-# frozen_string_literal: true
-
-module Mihari
-  module CLI
-    module Mixins
-      module Utils
-        #
-        # Send an exception notification if there is any error in a block
-        #
-        # @return [Nil]
-        #
-        def with_error_handling
-          yield
-        rescue StandardError => e
-          notifier = Notifiers::ExceptionNotifier.new
-          notifier.notify e
-        end
-
-        #
-        # Check required keys in JSON
-        #
-        # @param [Hash] json
-        #
-        # @return [Boolean]
-        #
-        def required_alert_keys?(json)
-          %w[title description artifacts].all? { |key| json.key? key }
-        end
-
-        #
-        # Run analyzer
-        #
-        # @param [Class<Mihari::Analyzers::Base>] analyzer_class
-        # @param [String] query
-        # @param [Hash] options
-        #
-        # @return [nil]
-        #
-        def run_analyzer(analyzer_class, query:, options:)
-          # options = Thor::CoreExt::HashWithIndifferentAccess
-          # ref. https://www.rubydoc.info/github/wycats/thor/Thor/CoreExt/HashWithIndifferentAccess
-          # so need to covert it to a plain hash
-          hash_options = options.to_hash
-
-          hash_options = hash_options.symbolize_keys
-          hash_options = normalize_options(hash_options)
-
-          analyzer = analyzer_class.new(query, **hash_options)
-
-          analyzer.ignore_old_artifacts = options[:ignore_old_artifacts] || false
-          analyzer.ignore_threshold = options[:ignore_threshold] || 0
-
-          analyzer.run
-        end
-
-        #
-        # Normalize options (reject keys not for analyzers)
-        #
-        # @param [Hash] options
-        #
-        # @return [Hash]
-        #
-        def normalize_options(options)
-          [:ignore_old_artifacts, :ignore_threshold].each do |ignore_key|
-            options.delete(ignore_key)
-          end
-          options
-        end
-      end
-    end
-  end
-end

data/lib/mihari/emitters/stdout.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-module Mihari
-  module Emitters
-    class StandardOutput < Base
-      def valid?
-        true
-      end
-
-      def emit(title:, description:, artifacts:, source:, tags:)
-        h = {
-          title: title,
-          description: description,
-          artifacts: artifacts.map(&:data),
-          source: source,
-          tags: tags
-        }
-        puts JSON.pretty_generate(h)
-      end
-    end
-  end
-end

data/lib/mihari/notifiers/base.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-module Mihari
-  module Notifiers
-    class Base
-      # Validate notifier availability
-      #
-      # @return [Boolean]
-      #
-      def valid?
-        raise NotImplementedError, "You must implement #{self.class}##{__method__}"
-      end
-
-      #
-      # Send a notification
-      #
-      # @return [nil]
-      #
-      def notify
-        raise NotImplementedError, "You must implement #{self.class}##{__method__}"
-      end
-    end
-  end
-end

data/lib/mihari/notifiers/exception_notifier.rb

@@ -1,126 +0,0 @@
-# frozen_string_literal: true
-
-module Mihari
-  module Notifiers
-    class ExceptionNotifier
-      def initialize
-        @backtrace_lines = 10
-        @color = "danger"
-
-        @slack = Notifiers::Slack.new
-      end
-
-      def valid?
-        @slack.valid?
-      end
-
-      def notify(exception)
-        notify_to_stdout exception
-
-        clean_message = exception.message.tr("`", "'")
-        attachments = to_attachments(exception, clean_message)
-        notify_to_slack(text: clean_message, attachments: attachments) if @slack.valid?
-      end
-
-      #
-      # Send notification to Slack
-      #
-      # @param [String] text
-      # @param [Array<Hash>] attachments
-      #
-      # @return [nil]
-      #
-      def notify_to_slack(text:, attachments:)
-        @slack.notify(text: text, attachments: attachments)
-      end
-
-      #
-      # Send notification to STDOUT
-      #
-      # @param [Exception] exception
-      #
-      # @return [nil]
-      #
-      def notify_to_stdout(exception)
-        text = to_text(exception.class).chomp
-        message = "#{text}: #{exception.message}"
-        puts message
-        puts format_backtrace(exception.backtrace) if exception.backtrace
-      end
-
-      #
-      # Convert exception to attachments (for Slack)
-      #
-      # @param [Exception] exception
-      # @param [String] clean_message
-      #
-      # @return [Array<Hash>]
-      #
-      def to_attachments(exception, clean_message)
-        text = to_text(exception.class)
-        backtrace = exception.backtrace
-        fields = to_fields(clean_message, backtrace)
-
-        [color: @color, text: text, fields: fields, mrkdwn_in: %w[text fields]]
-      end
-
-      #
-      # Convert exception class to text
-      #
-      # @param [Class<Exception>] exception_class
-      #
-      # @return [String]
-      #
-      def to_text(exception_class)
-        measure_word = /^[aeiou]/i.match?(exception_class.to_s) ? "An" : "A"
-        exception_name = "*#{measure_word}* `#{exception_class}`"
-        "#{exception_name} *occured in background*\n"
-      end
-
-      #
-      # Convert clean_message and backtrace into fields (for Slack)
-      #
-      # @param [String] clean_message
-      # @param [Array] backtrace
-      #
-      # @return [Array<Hash>]
-      #
-      def to_fields(clean_message, backtrace)
-        fields = [
-          { title: "Exception", value: clean_message },
-          { title: "Hostname", value: hostname }
-        ]
-
-        if backtrace
-          formatted_backtrace = format_backtrace(backtrace)
-          fields << { title: "Backtrace", value: formatted_backtrace }
-        end
-        fields
-      end
-
-      #
-      # Hostname of runnning instance
-      #
-      # @return [String]
-      #
-      def hostname
-        Socket.gethostname
-      rescue StandardError => _e
-        "N/A"
-      end
-
-      #
-      # Format backtrace in string
-      #
-      # @param [Array] backtrace
-      #
-      # @return [String]
-      #
-      def format_backtrace(backtrace)
-        return nil unless backtrace
-
-        "```#{backtrace.first(@backtrace_lines).join("\n")}```"
-      end
-    end
-  end
-end

data/lib/mihari/notifiers/slack.rb

@@ -1,63 +0,0 @@
-# frozen_string_literal: true
-
-require "slack-notifier"
-
-module Mihari
-  module Notifiers
-    class Slack < Base
-      SLACK_WEBHOOK_URL_KEY = "SLACK_WEBHOOK_URL"
-      SLACK_CHANNEL_KEY = "SLACK_CHANNEL"
-      DEFAULT_USERNAME = "mihari"
-
-      #
-      # Slack channel to post
-      #
-      # @return [String]
-      #
-      def slack_channel
-        Mihari.config.slack_channel || "#general"
-      end
-
-      #
-      # Slack webhook URL
-      #
-      # @return [String]
-      #
-      def slack_webhook_url
-        Mihari.config.slack_webhook_url
-      end
-
-      #
-      # Check Slack webhook URL is set
-      #
-      # @return [Boolean]
-      #
-      def slack_webhook_url?
-        !Mihari.config.slack_webhook_url.nil?
-      end
-
-      #
-      # Check Slack webhook URL is set. Alias of #slack_webhook_url?.
-      #
-      # @return [Boolean]
-      #
-      def valid?
-        slack_webhook_url?
-      end
-
-      #
-      # Send notification to Slack
-      #
-      # @param [String] text
-      # @param [Array<Hash>] attachments
-      # @param [Boolean] mrkdwn
-      #
-      # @return [nil]
-      #
-      def notify(text:, attachments: [], mrkdwn: true)
-        notifier = ::Slack::Notifier.new(slack_webhook_url, channel: slack_channel, username: DEFAULT_USERNAME)
-        notifier.post(text: text, attachments: attachments, mrkdwn: mrkdwn)
-      end
-    end
-  end
-end

data/sig/lib/mihari/cli/mixins/utils.rbs

@@ -1,50 +0,0 @@
-module Mihari
-  module CLI
-    module Mixins
-      module Utils
-        #
-        # Send an exception notification if there is any error in a block
-        #
-        # @return [Nil]
-        #
-        def with_error_handling: () { () -> untyped } -> void
-
-        #
-        # Check required keys in JSON
-        #
-        # @param [Hash] json
-        #
-        # @return [Boolean]
-        #
-        def required_alert_keys?: (Hash[(String | Symbol), untyped] json) -> bool
-
-        #
-        # Load configuration and establish DB connection
-        #
-        # @return [Hash]
-        #
-        def load_configuration: () -> Hash[(String | Symbol), untyped]
-
-        #
-        # Run analyzer
-        #
-        # @param [Class<Mihari::Analyzers::Base>] analyzer_class
-        # @param [String] query
-        # @param [Hash] options
-        #
-        # @return [nil]
-        #
-        def run_analyzer: (untyped analyzer_class, query: String query, options: untyped options) -> void
-
-        #
-        # Normalize options (reject keys not for analyzers)
-        #
-        # @param [Hash] options
-        #
-        # @return [Hash]
-        #
-        def normalize_options: (Hash[(String | Symbol), untyped] options) -> Hash[(String | Symbol), untyped]
-      end
-    end
-  end
-end

data/sig/lib/mihari/notifiers/base.rbs

@@ -1,18 +0,0 @@
-module Mihari
-  module Notifiers
-    class Base
-      # Validate notifier availability
-      #
-      # @return [Boolean]
-      #
-      def valid?: () -> bool
-
-      #
-      # Send a notification
-      #
-      # @return [nil]
-      #
-      def notify: () -> void
-    end
-  end
-end

data/sig/lib/mihari/notifiers/exception_notifier.rbs

@@ -1,75 +0,0 @@
-module Mihari
-  module Notifiers
-    class ExceptionNotifier
-      def initialize: () -> void
-
-      def valid?: () -> bool
-
-      def notify: (Exception exception) -> void
-
-      #
-      # Send notification to Slack
-      #
-      # @param [String] text
-      # @param [Array<Hash>] attachments
-      #
-      # @return [nil]
-      #
-      def notify_to_slack: (text: String text, attachments: Array[Hash[(String | Symbol), untyped]] attachments) -> void
-
-      #
-      # Send notification to STDOUT
-      #
-      # @param [Exception] exception
-      #
-      # @return [nil]
-      #
-      def notify_to_stdout: (Exception exception) -> void
-
-      #
-      # Convert exception to attachments (for Slack)
-      #
-      # @param [Exception] exception
-      # @param [String] clean_message
-      #
-      # @return [Array<Hash>]
-      #
-      def to_attachments: (Exception exception, String clean_message) -> ::Array[{ color: untyped, text: untyped, fields: untyped, :mrkdwn_in => ::Array["text" | "fields"] }]
-
-      #
-      # Convert exception class to text
-      #
-      # @param [Class<Exception>] exception_class
-      #
-      # @return [String]
-      #
-      def to_text: (singleton(Exception) exception_class) -> ::String
-
-      #
-      # Convert clean_message and backtrace into fields (for Slack)
-      #
-      # @param [String] clean_message
-      # @param [Array] backtrace
-      #
-      # @return [Array<Hash>]
-      #
-      def to_fields: (String clean_message, untyped backtrace) -> Array[Hash[(String | Symbol), untyped]]
-
-      #
-      # Hostname of runnning instance
-      #
-      # @return [String]
-      #
-      def hostname: () -> String
-
-      #
-      # Format backtrace in string
-      #
-      # @param [Array] backtrace
-      #
-      # @return [String]
-      #
-      def format_backtrace: (untyped backtrace) -> (nil | ::String)
-    end
-  end
-end

data/sig/lib/mihari/notifiers/slack.rbs

@@ -1,50 +0,0 @@
-module Mihari
-  module Notifiers
-    class Slack < Base
-      SLACK_WEBHOOK_URL_KEY: ::String
-
-      SLACK_CHANNEL_KEY: ::String
-
-      DEFAULT_USERNAME: ::String
-
-      #
-      # Slack channel to post
-      #
-      # @return [String]
-      #
-      def slack_channel: () -> String
-
-      #
-      # Slack webhook URL
-      #
-      # @return [String]
-      #
-      def slack_webhook_url: () -> String
-
-      #
-      # Check Slack webhook URL is set
-      #
-      # @return [Boolean]
-      #
-      def slack_webhook_url?: () -> bool
-
-      #
-      # Check Slack webhook URL is set. Alias of #slack_webhook_url?.
-      #
-      # @return [Boolean]
-      #
-      def valid?: () -> bool
-
-      #
-      # Send notification to Slack
-      #
-      # @param [String] text
-      # @param [Array<Hash>] attachments
-      # @param [Boolean] mrkdwn
-      #
-      # @return [nil]
-      #
-      def notify: (text: String text, ?attachments: Array[Hash[(String | Symbol), untyped]] attachments, ?mrkdwn: bool mrkdwn) -> untyped
-    end
-  end
-end