mihari 5.6.1 → 5.7.0

data/lib/mihari/structs/config.rb

@@ -3,38 +3,21 @@
 module Mihari
   module Structs
     class Config < Dry::Struct
+      # @!attribute [r] name
+      #   @return [String]
       attribute :name, Types::String
-      attribute :type, Types::String
-      attribute :is_configured, Types::Bool
-      attribute :values, Types.Array(Types::Hash).optional
 
-      #
-      # @return [String]
-      #
-      def name
-        attributes[:name]
-      end
-
-      #
-      # @return [String]
-      #
-      def type
-        attributes[:type]
-      end
+      # @!attribute [r] type
+      #   @return [String]
+      attribute :type, Types::String
 
-      #
-      # @return [Boolean]
-      #
-      def is_configured
-        attributes[:is_configured]
-      end
+      # @!attribute [r] is_configured
+      #   @return [Boolean]
+      attribute :is_configured, Types::Bool
 
-      #
-      # @return [Array<Hash>]
-      #
-      def values
-        attributes[:values]
-      end
+      # @!attribute [r] values
+      #   @return [Array<Hash>, nil]
+      attribute :values, Types.Array(Types::Hash).optional
 
       class << self
         #
@@ -61,8 +44,14 @@ module Mihari
         #
         def get_dummy(klass)
           type = get_type(klass)
-          is_analyzer = type == "Analyzer"
-          is_analyzer ? klass.new("dummy") : klass.new(artifacts: [], rule: nil)
+          case type
+          when "Analyzer"
+            klass.new("dummy")
+          when "Emitter"
+            klass.new(rule: nil)
+          else
+            klass.new
+          end
         end
 
         #
@@ -71,7 +60,7 @@ module Mihari
         # @return [Mihari::Structs::Config, nil] config
         #
         def from_class(klass)
-          return nil if klass == Mihari::Analyzers::Rule
+          return nil if klass == Mihari::Rule
 
           type = get_type(klass)
           return nil if type.nil?

data/lib/mihari/structs/filters.rb

@@ -5,15 +5,34 @@ module Mihari
     module Filters
       module Alert
         class SearchFilter < Dry::Struct
+          # @!attribute [r] artifact_data
+          #   @return [String, nil]
           attribute? :artifact_data, Types::String.optional
+
+          # @!attribute [r] rule_id
+          #   @return [String, nil]
           attribute? :rule_id, Types::String.optional
+
+          # @!attribute [r] tag_name
+          #   @return [String, nil]
           attribute? :tag_name, Types::String.optional
+
+          # @!attribute [r] from_at
+          #   @return [DateTime, nil]
           attribute? :from_at, Types::DateTime.optional
+
+          # @!attribute [r] to_at
+          #   @return [DateTime, nil]
           attribute? :to_at, Types::DateTime.optional
         end
 
         class SearchFilterWithPagination < SearchFilter
+          # @!attribute [r] page
+          #   @return [Integer, nil]
           attribute? :page, Types::Int.default(1)
+
+          # @!attribute [r] limit
+          #   @return [Integer, nil]
           attribute? :limit, Types::Int.default(10)
 
           def without_pagination
@@ -30,15 +49,34 @@ module Mihari
 
       module Rule
         class SearchFilter < Dry::Struct
+          # @!attribute [r] description
+          #   @return [String, nil]
           attribute? :description, Types::String.optional
+
+          # @!attribute [r] tag_name
+          #   @return [String, nil]
           attribute? :tag_name, Types::String.optional
+
+          # @!attribute [r] title
+          #   @return [String, nil]
           attribute? :title, Types::String.optional
+
+          # @!attribute [r] from_at
+          #   @return [DateTime, nil]
           attribute? :from_at, Types::DateTime.optional
+
+          # @!attribute [r] to_at
+          #   @return [DateTime, nil]
           attribute? :to_at, Types::DateTime.optional
         end
 
         class SearchFilterWithPagination < SearchFilter
+          # @!attribute [r] page
+          #   @return [Integer, nil]
           attribute? :page, Types::Int.default(1)
+
+          # @!attribute [r] limit
+          #   @return [Integer, nil]
           attribute? :limit, Types::Int.default(10)
 
           def without_pagination

data/lib/mihari/structs/fofa.rb

@@ -0,0 +1,44 @@
+module Mihari
+  module Structs
+    module Fofa
+      class Response < Dry::Struct
+        # @!attribute [r] error
+        #   @return [Boolean]
+        attribute :error, Types::Bool
+
+        # @!attribute [r] size
+        #   @return [Integer, nil]
+        attribute? :size, Types::Int.optional
+
+        # @!attribute [r] page
+        #   @return [Integer, nil]
+        attribute? :page, Types::Int.optional
+
+        # @!attribute [r] mode
+        #   @return [String, nil]
+        attribute? :mode, Types::String.optional
+
+        # @!attribute [r] query
+        #   @return [String, nil]
+        attribute? :query, Types::String.optional
+
+        # @!attribute [r] results
+        #   @return [Array<String>, nil]
+        attribute? :results, Types.Array(Types.Array(Types::String)).optional
+
+        class << self
+          def from_dynamic!(d)
+            new(
+              error: d.fetch("error"),
+              size: d["size"],
+              page: d["page"],
+              mode: d["mode"],
+              query: d["query"],
+              results: d["results"]
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mihari/structs/google_public_dns.rb

@@ -12,30 +12,17 @@ module Mihari
       }.freeze
 
       class Answer < Dry::Struct
+        # @!attribute [r] name
+        #   @return [String]
         attribute :name, Types::String
-        attribute :data, Types::String
-        attribute :resource_type, Types::String
 
-        #
-        # @return [String]
-        #
-        def name
-          attributes[:name]
-        end
-
-        #
-        # @return [String]
-        #
-        def data
-          attributes[:data]
-        end
+        # @!attribute [r] data
+        #   @return [String]
+        attribute :data, Types::String
 
-        #
-        # @return [String]
-        #
-        def resource_type
-          attributes[:resource_type]
-        end
+        # @!attribute [r] resource_type
+        #   @return [String]
+        attribute :resource_type, Types::String
 
         class << self
           #
@@ -56,15 +43,10 @@ module Mihari
       end
 
       class Response < Dry::Struct
+        # @!attribute [r] answers
+        #   @return [Array<Answer>]
         attribute :answers, Types.Array(Answer)
 
-        #
-        # @return [Array<Answer>]
-        #
-        def answers
-          attributes[:answers]
-        end
-
         class << self
           #
           # @param [Hash] d

data/lib/mihari/structs/greynoise.rb

@@ -6,43 +6,30 @@ module Mihari
       class Metadata < Dry::Struct
         include Mixins::AutonomousSystem
 
+        # @!attribute [r] country
+        #   @return [String]
         attribute :country, Types::String
-        attribute :country_code, Types::String
-        attribute :asn, Types::String
-
-        #
-        # @return [String]
-        #
-        def country
-          attributes[:country]
-        end
 
-        #
-        # @return [String]
-        #
-        def country_code
-          attributes[:country_code]
-        end
+        # @!attribute [r] country_code
+        #   @return [String]
+        attribute :country_code, Types::String
 
-        #
-        # @return [String]
-        #
-        def asn
-          attributes[:asn]
-        end
+        # @!attribute [r] asn
+        #   @return [String]
+        attribute :asn, Types::String
 
         #
         # @return [Mihari::AutonomousSystem]
         #
         def as
-          Mihari::AutonomousSystem.new(asn: normalize_asn(asn))
+          Mihari::Models::AutonomousSystem.new(asn: normalize_asn(asn))
         end
 
         #
         # @return [Mihari::Geolocation]
         #
         def geolocation
-          Mihari::Geolocation.new(
+          Mihari::Models::Geolocation.new(
             country: country,
             country_code: country_code
           )
@@ -66,36 +53,23 @@ module Mihari
       end
 
       class Datum < Dry::Struct
+        # @!attribute [r] ip
+        #   @return [String]
         attribute :ip, Types::String
-        attribute :metadata, Metadata
-        attribute :metadata_, Types::Hash
 
-        #
-        # @return [String]
-        #
-        def ip
-          attributes[:ip]
-        end
-
-        #
-        # @return [Metadata]
-        #
-        def metadata
-          attributes[:metadata]
-        end
+        # @!attribute [r] metadata
+        #   @return [Metadata]
+        attribute :metadata, Metadata
 
-        #
-        # @return [Hash]
-        #
-        def metadata_
-          attributes[:metadata_]
-        end
+        # @!attribute [r] metadata_
+        #   @return [Hash]
+        attribute :metadata_, Types::Hash
 
         #
-        # @return [Mihari::Artifact]
+        # @return [Mihari::Models::Artifact]
         #
         def artifact
-          Mihari::Artifact.new(
+          Mihari::Models::Artifact.new(
             data: ip,
             metadata: metadata_,
             autonomous_system: metadata.as,
@@ -121,57 +95,32 @@ module Mihari
       end
 
       class Response < Dry::Struct
+        # @!attribute [r] complete
+        #   @return [Boolean]
         attribute :complete, Types::Bool
-        attribute :count, Types::Int
-        attribute :data, Types.Array(Datum)
-        attribute :message, Types::String
-        attribute :query, Types::String
-        attribute :scroll, Types::String.optional
-
-        #
-        # @return [Boolean]
-        #
-        def complete
-          attributes[:complete]
-        end
 
-        #
-        # @return [Integer]
-        #
-        def count
-          attributes[:count]
-        end
+        # @!attribute [r] count
+        #   @return [Integer]
+        attribute :count, Types::Int
 
-        #
-        # @return [Array<Datum>]
-        #
-        def data
-          attributes[:data]
-        end
+        # @!attribute [r] data
+        #   @return [Array<Datnum>]
+        attribute :data, Types.Array(Datum)
 
-        #
-        # @return [String]
-        #
-        def message
-          attributes[:message]
-        end
+        # @!attribute [r] message
+        #   @return [String]
+        attribute :message, Types::String
 
-        #
-        # @return [String]
-        #
-        def query
-          attributes[:query]
-        end
+        # @!attribute [r] query
+        #   @return [String]
+        attribute :query, Types::String
 
-        #
-        # @return [String, nil]
-        #
-        def scroll
-          attributes[:scroll]
-        end
+        # @!attribute [r] scroll
+        #   @return [String, nil]
+        attribute :scroll, Types::String.optional
 
         #
-        # @return [Array<Mihari::Artifact>]
+        # @return [Array<Mihari::Models::Artifact>]
         #
         def artifacts
           data.map(&:artifact)

data/lib/mihari/structs/hunterhow.rb

@@ -1,23 +1,26 @@
+# frozen_string_literal: true
+
 module Mihari
   module Structs
     module HunterHow
       class ListItem < Dry::Struct
+        # @!attribute [r] domain
+        #   @return [String]
         attribute :domain, Types::String
+
+        # @!attribute [r] ip
+        #   @return [String]
         attribute :ip, Types::String
-        attribute :port, Types::Integer
 
-        #
-        # @return [String]
-        #
-        def ip
-          attributes[:ip]
-        end
+        # @!attribute [r] port
+        #   @return [Integer]
+        attribute :port, Types::Int
 
         #
-        # @return [Mihari::Artifact]
+        # @return [Mihari::Models::Artifact]
         #
         def artifact
-          Artifact.new(data: ip)
+          Models::Artifact.new(data: ip)
         end
 
         class << self
@@ -38,18 +41,16 @@ module Mihari
       end
 
       class DataClass < Dry::Struct
+        # @!attribute [r] list
+        #   @return [Array<ListItem>]
         attribute :list, Types.Array(ListItem)
-        attribute :total, Types::Integer
 
-        #
-        # @return [Array<ListItem>]
-        #
-        def list
-          attributes[:list]
-        end
+        # @!attribute [r] total
+        #   @return [Integer]
+        attribute :total, Types::Int
 
         #
-        # @return [Array<Mihari::Artifact>]
+        # @return [Array<Mihari::Models::Artifact>]
         #
         def artifacts
           list.map(&:artifact)
@@ -72,16 +73,17 @@ module Mihari
       end
 
       class Response < Dry::Struct
-        attribute :code, Types::Integer
+        # @!attribute [r] code
+        #   @return [Integer]
+        attribute :code, Types::Int
+
+        # @!attribute [r] data
+        #   @return [DataClass]
         attribute :data, DataClass
-        attribute :message, Types::String
 
-        #
-        # @return [DataClass]
-        #
-        def data
-          attributes[:data]
-        end
+        # @!attribute [r] message
+        #   @return [String]
+        attribute :message, Types::String
 
         class << self
           #

data/lib/mihari/structs/ipinfo.rb

@@ -4,46 +4,25 @@ module Mihari
   module Structs
     module IPInfo
       class Response < Dry::Struct
+        # @!attribute [r] ip
+        #   @return [String]
         attribute :ip, Types::String
-        attribute :hostname, Types::String.optional
-        attribute :loc, Types::String.optional
-        attribute :country_code, Types::String.optional
-        attribute :asn, Types::Integer.optional
 
-        #
-        # @return [String]
-        #
-        def ip
-          attributes[:ip]
-        end
-
-        #
-        # @return [String, nil]
-        #
-        def hostname
-          attributes[:hostname]
-        end
+        # @!attribute [r] hostname
+        #   @return [String, nil]
+        attribute :hostname, Types::String.optional
 
-        #
-        # @return [String, nil]
-        #
-        def loc
-          attributes[:loc]
-        end
+        # @!attribute [r] loc
+        #   @return [String, nil]
+        attribute :loc, Types::String.optional
 
-        #
-        # @return [String, nil]
-        #
-        def country_code
-          attributes[:country_code]
-        end
+        # @!attribute [r] country_code
+        #   @return [String, nil]
+        attribute :country_code, Types::String.optional
 
-        #
-        # @return [Integer, nil]
-        #
-        def asn
-          attributes[:asn]
-        end
+        # @!attribute [r] asn
+        #   @return [Integer, nil]
+        attribute :asn, Types::Int.optional
 
         class << self
           include Mixins::AutonomousSystem