mihari 5.6.2 → 5.7.0

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]
         #
@@ -38,22 +33,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>
@@ -86,14 +72,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]
@@ -118,46 +99,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>]
@@ -199,22 +159,13 @@ 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
           #
@@ -233,38 +184,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>]
@@ -292,30 +226,17 @@ 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
           #

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
 
         #

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,30 +6,17 @@ 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]
@@ -66,30 +53,17 @@ 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::Models::Artifact]
@@ -121,54 +95,29 @@ 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::Models::Artifact>]

data/lib/mihari/structs/hunterhow.rb

@@ -1,17 +1,20 @@
+# 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::Models::Artifact]
@@ -38,15 +41,13 @@ 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::Models::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
           #