mihari 5.6.2 → 5.7.1

data/lib/mihari/service.rb

@@ -0,0 +1,26 @@
+module Mihari
+  #
+  # Base class for services
+  #
+  class Service
+    include Dry::Monads[:result, :try]
+
+    def call(*args, **kwargs)
+      raise NotImplementedError, "You must implement #{self.class}##{__method__}"
+    end
+
+    def result(...)
+      Try[StandardError] { call(...) }.to_result
+    end
+
+    class << self
+      def call(...)
+        new.call(...)
+      end
+
+      def result(...)
+        new.result(...)
+      end
+    end
+  end
+end

data/lib/mihari/services/alert_builder.rb

@@ -8,21 +8,91 @@ require "yaml"
 
 module Mihari
   module Services
-    class AlertBuilder
-      include Dry::Monads[:result, :try]
+    #
+    # Alert proxy
+    #
+    class AlertProxy
+      # @return [Hash]
+      attr_reader :data
 
-      # @return [String]
-      attr_reader :path
+      # @return [Array, nil]
+      attr_reader :errors
 
       #
       # Initialize
       #
-      # @param [String] path
+      # @param [Hash] data
       #
-      def initialize(path)
-        @path = path
+      def initialize(**data)
+        super()
+
+        @data = data.deep_symbolize_keys
+        @errors = nil
+
+        validate!
+      end
+
+      #
+      # @return [Boolean]
+      #
+      def errors?
+        return false if @errors.nil?
+
+        !@errors.empty?
+      end
+
+      def validate!
+        contract = Schemas::AlertContract.new
+        result = contract.call(data)
+
+        @data = result.to_h
+        @errors = result.errors
+
+        raise ValidationError.new("Validation failed", errors) if errors?
+      end
+
+      def [](key)
+        data key.to_sym
+      end
+
+      #
+      # @return [String]
+      #
+      def rule_id
+        @rule_id ||= data[:rule_id]
+      end
+
+      #
+      # @return [Array<Mihari::Models::Artifact>]
+      #
+      def artifacts
+        @artifacts ||= data[:artifacts].map do |data|
+          artifact = Models::Artifact.new(data: data)
+          artifact.rule_id = rule_id
+          artifact
+        end.uniq(&:data).select(&:valid?)
       end
 
+      #
+      # @return [Mihari::Rule]
+      #
+      def rule
+        @rule ||= [].tap do |out|
+          data = Mihari::Models::Rule.find(rule_id).data
+          out << Rule.new(**data)
+        end.first
+      end
+    end
+
+    #
+    # Alert builder
+    #
+    class AlertBuilder < Service
+      # @return [String]
+      attr_reader :path
+
+      #
+      # @param [String] path
       #
       # @return [Hash]
       #
@@ -35,8 +105,14 @@ module Mihari
         )
       end
 
-      def result
-        Try[StandardError] { AlertProxy.new(**data) }.to_result
+      #
+      # @param [String] path
+      #
+      # @return [Mihari::AlertProxy]
+      #
+      def call(path)
+        @path = path
+        AlertProxy.new(**data)
       end
     end
   end

data/lib/mihari/services/alert_runner.rb

@@ -2,29 +2,18 @@
 
 module Mihari
   module Services
-    class AlertRunner
-      include Dry::Monads[:result, :try]
-
-      # @return [Mihari::Services::AlertProxy]
-      attr_reader :alert
-
-      def initialize(alert)
-        @alert = alert
-      end
-
+    #
+    # Alert runner
+    #
+    class AlertRunner < Service
+      #
+      # @param [Mihari::Services::AlertProxy] alert
       #
       # @return [Mihari::Models::Alert]
       #
-      def run
+      def call(alert)
         emitter = Emitters::Database.new(rule: alert.rule)
-        emitter.emit alert.artifacts
-      end
-
-      #
-      # @return [Dry::Monads::Result::Success<Mihari::Models::Alert, nil>, Dry::Monads::Result::Failure]
-      #
-      def result
-        Try[StandardError] { run }.to_result
+        emitter.call alert.artifacts
       end
     end
   end

data/lib/mihari/services/rule_builder.rb

@@ -7,21 +7,15 @@ require "yaml"
 
 module Mihari
   module Services
-    class RuleBuilder
-      include Dry::Monads[:result, :try]
-
+    #
+    # Rule builder
+    #
+    class RuleBuilder < Service
       # @return [String]
       attr_reader :path_or_id
 
-      #
-      # Initialize
       #
       # @param [String] path_or_id
-      #
-      def initialize(path_or_id)
-        @path_or_id = path_or_id
-      end
-
       #
       # @return [Hash]
       #
@@ -39,8 +33,15 @@ module Mihari
         )
       end
 
-      def result
-        Try[StandardError] { Rule.new(**data) }.to_result
+      #
+      # @param [String] path_or_id
+      #
+      # @return [Mihari::Rule]
+      #
+      def call(path_or_id)
+        @path_or_id = path_or_id
+
+        Rule.new(**data)
       end
     end
   end

data/lib/mihari/services/rule_runner.rb

@@ -2,42 +2,17 @@
 
 module Mihari
   module Services
-    class RuleRunner
-      include Dry::Monads[:result, :try]
-
-      # @return [Mihari::Rule]
-      attr_reader :rule
-
-      def initialize(rule)
-        @rule = rule
-      end
-
+    #
+    # Rule runner
+    #
+    class RuleRunner < Service
       #
-      # @return [Boolean]
-      #
-      def diff?
-        model = Mihari::Models::Rule.find(rule.id)
-        model.data != rule.data.deep_stringify_keys
-      rescue ActiveRecord::RecordNotFound
-        false
-      end
-
-      def update_or_create
-        rule.model.save
-      end
-
+      # @params [Mihari::Rule]
       #
       # @return [Mihari::Models::Alert, nil]
       #
-      def run
-        rule.run
-      end
-
-      #
-      # @return [Dry::Monads::Result::Success<Mihari::Models::Alert, nil>, Dry::Monads::Result::Failure]
-      #
-      def result
-        Try[StandardError] { run }.to_result
+      def call(rule)
+        rule.call
       end
     end
   end

data/lib/mihari/structs/binaryedge.rb

@@ -1,17 +1,17 @@
+# frozen_string_literal: true
+
 module Mihari
   module Structs
     module BinaryEdge
       class Target < Dry::Struct
+        # @!attribute [r] ip
+        #   @return [String]
         attribute :ip, Types::String
 
-        #
-        # @return [String]
-        #
-        def ip
-          attributes[:ip]
-        end
-
         class << self
+          #
+          # @param [Hash] d
+          #
           def from_dynamic!(d)
             d = Types::Hash[d]
             new(
@@ -22,16 +22,14 @@ module Mihari
       end
 
       class Event < Dry::Struct
+        # @!attribute [r] target
+        #   @return [Target]
         attribute :target, Target
 
-        #
-        # @return [Target]
-        #
-        def target
-          attributes[:target]
-        end
-
         class << self
+          #
+          # @param [Hash] d
+          #
           def from_dynamic!(d)
             d = Types::Hash[d]
             new(
@@ -43,28 +41,21 @@ module Mihari
 
       class Response < Dry::Struct
         # @!attribute [r] page
-        # @return [Integer]
-        attribute :page, Types::Integer
+        #   @return [Integer]
+        attribute :page, Types::Int
 
         # @!attribute [r] pagesize
-        # @return [Integer]
-        attribute :pagesize, Types::Integer
+        #   @return [Integer]
+        attribute :pagesize, Types::Int
 
         # @!attribute [r] total
-        # @return [Integer]
-        attribute :total, Types::Integer
+        #   @return [Integer]
+        attribute :total, Types::Int
 
         # @!attribute [r] events
-        # @return [Array<Event>]
+        #   @return [Array<Event>]
         attribute :events, Types.Array(Event)
 
-        #
-        # @return [Array<Event>]
-        #
-        def events
-          attributes[:events]
-        end
-
         #
         # @return [Array<Artifact>]
         #
@@ -73,6 +64,9 @@ module Mihari
         end
 
         class << self
+          #
+          # @param [Hash] d
+          #
           def from_dynamic!(d)
             d = Types::Hash[d]
             new(

data/lib/mihari/structs/censys.rb

@@ -6,15 +6,10 @@ module Mihari
       class AutonomousSystem < Dry::Struct
         include Mixins::AutonomousSystem
 
+        # @!attribute [r] asn
+        #   @return [Integer]
         attribute :asn, Types::Int
 
-        #
-        # @return [Integer]
-        #
-        def asn
-          attributes[:asn]
-        end
-
         #
         # @return [Mihari::AutonomousSystem]
         #
@@ -26,8 +21,6 @@ module Mihari
           #
           # @param [Hash] d
           #
-          # @return [AutonomousSystem]
-          #
           def from_dynamic!(d)
             d = Types::Hash[d]
             new(
@@ -38,22 +31,13 @@ module Mihari
       end
 
       class Location < Dry::Struct
+        # @!attribute [r] country
+        #   @return [String, nil]
         attribute :country, Types::String.optional
-        attribute :country_code, Types::String.optional
 
-        #
-        # @return [String, nil]
-        #
-        def country
-          attributes[:country]
-        end
-
-        #
-        # @return [String, nil]
-        #
-        def country_code
-          attributes[:country_code]
-        end
+        # @!attribute [r] country_code
+        #   @return [String, nil]
+        attribute :country_code, Types::String.optional
 
         #
         # @return [Mihari::Geolocation] <description>
@@ -73,8 +57,6 @@ module Mihari
           #
           # @param [Hash] d
           #
-          # @return [Location]
-          #
           def from_dynamic!(d)
             d = Types::Hash[d]
             new(
@@ -86,14 +68,9 @@ module Mihari
       end
 
       class Service < Dry::Struct
-        attribute :port, Types::Integer
-
-        #
-        # @return [Integer]
-        #
-        def port
-          attributes[:port]
-        end
+        # @!attribute [r] port
+        #   @return [Integer, nil]
+        attribute :port, Types::Int
 
         #
         # @return [Mihari::Port]
@@ -106,8 +83,6 @@ module Mihari
           #
           # @param [Hash] d
           #
-          # @return [Service]
-          #
           def from_dynamic!(d)
             d = Types::Hash[d]
             new(
@@ -118,46 +93,25 @@ module Mihari
       end
 
       class Hit < Dry::Struct
+        # @!attribute [r] ip
+        #   @return [String]
         attribute :ip, Types::String
-        attribute :location, Location
-        attribute :autonomous_system, AutonomousSystem
-        attribute :metadata, Types::Hash
-        attribute :services, Types.Array(Service)
-
-        #
-        # @return [String]
-        #
-        def ip
-          attributes[:ip]
-        end
 
-        #
-        # @return [Location]
-        #
-        def location
-          attributes[:location]
-        end
+        # @!attribute [r] location
+        #   @return [Location]
+        attribute :location, Location
 
-        #
-        # @return [AutonomousSystem]
-        #
-        def autonomous_system
-          attributes[:autonomous_system]
-        end
+        # @!attribute [r] autonomous_system
+        #   @return [AutonomousSystem]
+        attribute :autonomous_system, AutonomousSystem
 
-        #
-        # @return [Hash]
-        #
-        def metadata
-          attributes[:metadata]
-        end
+        # @!attribute [r] metadata
+        #   @return [Hash]
+        attribute :metadata, Types::Hash
 
-        #
-        # @return [Array<Service>]
-        #
-        def services
-          attributes[:services]
-        end
+        # @!attribute [r] services
+        #   @return [Array<Service>]
+        attribute :services, Types.Array(Service)
 
         #
         # @return [Array<Mihari::Port>]
@@ -183,8 +137,6 @@ module Mihari
           #
           # @param [Hash] d
           #
-          # @return [Hit]
-          #
           def from_dynamic!(d)
             d = Types::Hash[d]
             new(
@@ -199,29 +151,18 @@ module Mihari
       end
 
       class Links < Dry::Struct
+        # @!attribute [r] next
+        #   @return [String, nil]
         attribute :next, Types::String.optional
-        attribute :prev, Types::String.optional
-
-        #
-        # @return [String, nil]
-        #
-        def next
-          attributes[:next]
-        end
 
-        #
-        # @return [String, nil]
-        #
-        def prev
-          attributes[:prev]
-        end
+        # @!attribute [r] prev
+        #   @return [String, nil]
+        attribute :prev, Types::String.optional
 
         class << self
           #
           # @param [Hash] d
           #
-          # @return [Links]
-          #
           def from_dynamic!(d)
             d = Types::Hash[d]
             new(
@@ -233,38 +174,21 @@ module Mihari
       end
 
       class Result < Dry::Struct
+        # @!attribute [r] query
+        #   @return [String]
         attribute :query, Types::String
-        attribute :total, Types::Int
-        attribute :hits, Types.Array(Hit)
-        attribute :links, Links
-
-        #
-        # @return [String]
-        #
-        def query
-          attributes[:query]
-        end
 
-        #
-        # @return [Integer]
-        #
-        def total
-          attributes[:total]
-        end
+        # @!attribute [r] total
+        #   @return [Integer]
+        attribute :total, Types::Int
 
-        #
-        # @return [Array<Hit>]
-        #
-        def hits
-          attributes[:hits]
-        end
+        # @!attribute [r] hits
+        #   @return [Array<Hit>]
+        attribute :hits, Types.Array(Hit)
 
-        #
-        # @return [Links]
-        #
-        def links
-          attributes[:links]
-        end
+        # @!attribute [r] links
+        #   @return [Links]
+        attribute :links, Links
 
         #
         # @return [Array<Mihari::Models::Artifact>]
@@ -277,8 +201,6 @@ module Mihari
           #
           # @param [Hash] d
           #
-          # @return [Result]
-          #
           def from_dynamic!(d)
             d = Types::Hash[d]
             new(
@@ -292,37 +214,22 @@ module Mihari
       end
 
       class Response < Dry::Struct
+        # @!attribute [r] code
+        #   @return [Integer]
         attribute :code, Types::Int
-        attribute :status, Types::String
-        attribute :result, Result
-
-        #
-        # @return [Integer]
-        #
-        def code
-          attributes[:code]
-        end
 
-        #
-        # @return [String]
-        #
-        def status
-          attributes[:status]
-        end
+        # @!attribute [r] status
+        #   @return [String]
+        attribute :status, Types::String
 
-        #
-        # @return [Result]
-        #
-        def result
-          attributes[:result]
-        end
+        # @!attribute [r] result
+        #   @return [Result]
+        attribute :result, Result
 
         class << self
           #
           # @param [Hash] d
           #
-          # @return [Response]
-          #
           def from_dynamic!(d)
             d = Types::Hash[d]
             new(