mihari 8.2.0 → 8.3.0

data/lib/mihari/structs/censys.rb

@@ -3,243 +3,337 @@
 module Mihari
   module Structs
     module Censys
-      class AutonomousSystem < Dry::Struct
-        include Concerns::AutonomousSystemNormalizable
-
-        # @!attribute [r] asn
-        #   @return [Integer]
-        attribute :asn, Types::Int
-
-        #
-        # @return [Mihari::AutonomousSystem]
-        #
-        def as
-          Mihari::Models::AutonomousSystem.new(number: normalize_asn(asn))
-        end
+      module V2
+        class AutonomousSystem < Dry::Struct
+          include Concerns::AutonomousSystemNormalizable
+
+          # @!attribute [r] asn
+          #   @return [Integer]
+          attribute :asn, Types::Int
 
-        class << self
           #
-          # @param [Hash] d
+          # @return [Mihari::AutonomousSystem]
           #
-          def from_dynamic!(d)
-            return nil if d.nil?
+          def as
+            Mihari::Models::AutonomousSystem.new(number: normalize_asn(asn))
+          end
 
-            d = Types::Hash[d]
-            new(
-              asn: d.fetch("asn")
-            )
+          class << self
+            #
+            # @param [Hash] d
+            #
+            def from_dynamic!(d)
+              return nil if d.nil?
+
+              d = Types::Hash[d]
+              new(
+                asn: d.fetch("asn")
+              )
+            end
           end
         end
-      end
 
-      class Location < Dry::Struct
-        # @!attribute [r] country
-        #   @return [String, nil]
-        attribute :country, Types::String.optional
-
-        # @!attribute [r] country_code
-        #   @return [String, nil]
-        attribute :country_code, Types::String.optional
-
-        #
-        # @return [Mihari::Geolocation] <description>
-        #
-        def geolocation
-          # sometimes Censys overlooks country
-          # then set geolocation as nil
-          return nil if country.nil?
-
-          Mihari::Models::Geolocation.new(
-            country:,
-            country_code:
-          )
-        end
+        class Location < Dry::Struct
+          # @!attribute [r] country
+          #   @return [String, nil]
+          attribute :country, Types::String.optional
+
+          # @!attribute [r] country_code
+          #   @return [String, nil]
+          attribute :country_code, Types::String.optional
 
-        class << self
           #
-          # @param [Hash] d
+          # @return [Mihari::Geolocation] <description>
           #
-          def from_dynamic!(d)
-            d = Types::Hash[d]
-            new(
-              country: d["country"],
-              country_code: d["country_code"]
+          def geolocation
+            # sometimes Censys overlooks country
+            # then set geolocation as nil
+            return nil if country.nil?
+
+            Mihari::Models::Geolocation.new(
+              country:,
+              country_code:
             )
           end
-        end
-      end
-
-      class Service < Dry::Struct
-        # @!attribute [r] port
-        #   @return [Integer, nil]
-        attribute :port, Types::Int
 
-        #
-        # @return [Mihari::Port]
-        #
-        def _port
-          Models::Port.new(number: port)
+          class << self
+            #
+            # @param [Hash] d
+            #
+            def from_dynamic!(d)
+              d = Types::Hash[d]
+              new(
+                country: d["country"],
+                country_code: d["country_code"]
+              )
+            end
+          end
         end
 
-        class << self
+        class Service < Dry::Struct
+          # @!attribute [r] port
+          #   @return [Integer, nil]
+          attribute :port, Types::Int
+
           #
-          # @param [Hash] d
+          # @return [Mihari::Port]
           #
-          def from_dynamic!(d)
-            d = Types::Hash[d]
-            new(
-              port: d.fetch("port")
-            )
+          def _port
+            Models::Port.new(number: port)
           end
-        end
-      end
 
-      class Hit < Dry::Struct
-        # @!attribute [r] ip
-        #   @return [String]
-        attribute :ip, Types::String
+          class << self
+            #
+            # @param [Hash] d
+            #
+            def from_dynamic!(d)
+              d = Types::Hash[d]
+              new(
+                port: d.fetch("port")
+              )
+            end
+          end
+        end
 
-        # @!attribute [r] location
-        #   @return [Location]
-        attribute :location, Location
+        class Hit < Dry::Struct
+          # @!attribute [r] ip
+          #   @return [String]
+          attribute :ip, Types::String
 
-        # @!attribute [r] autonomous_system
-        #   @return [AutonomousSystem, nil]
-        attribute :autonomous_system, AutonomousSystem.optional
+          # @!attribute [r] location
+          #   @return [Location]
+          attribute :location, Location
 
-        # @!attribute [r] metadata
-        #   @return [Hash]
-        attribute :metadata, Types::Hash
+          # @!attribute [r] autonomous_system
+          #   @return [AutonomousSystem, nil]
+          attribute :autonomous_system, AutonomousSystem.optional
 
-        # @!attribute [r] services
-        #   @return [Array<Service>]
-        attribute :services, Types.Array(Service)
+          # @!attribute [r] metadata
+          #   @return [Hash]
+          attribute :metadata, Types::Hash
 
-        #
-        # @return [Array<Mihari::Port>]
-        #
-        def ports
-          services.map(&:_port)
-        end
+          # @!attribute [r] services
+          #   @return [Array<Service>]
+          attribute :services, Types.Array(Service)
 
-        #
-        # @return [Mihari::Models::Artifact]
-        #
-        def artifact
-          Models::Artifact.new(
-            data: ip,
-            metadata:,
-            autonomous_system: autonomous_system&.as,
-            geolocation: location.geolocation,
-            ports:
-          )
-        end
+          #
+          # @return [Array<Mihari::Port>]
+          #
+          def ports
+            services.map(&:_port)
+          end
 
-        class << self
           #
-          # @param [Hash] d
+          # @return [Mihari::Models::Artifact]
           #
-          def from_dynamic!(d)
-            d = Types::Hash[d]
-            new(
-              ip: d.fetch("ip"),
-              location: Location.from_dynamic!(d.fetch("location")),
-              autonomous_system: AutonomousSystem.from_dynamic!(d["autonomous_system"]),
-              metadata: d,
-              services: d.fetch("services", []).map { |x| Service.from_dynamic!(x) }
+          def artifact
+            Models::Artifact.new(
+              data: ip,
+              metadata:,
+              autonomous_system: autonomous_system&.as,
+              geolocation: location.geolocation,
+              ports:
             )
           end
+
+          class << self
+            #
+            # @param [Hash] d
+            #
+            def from_dynamic!(d)
+              d = Types::Hash[d]
+              new(
+                ip: d.fetch("ip"),
+                location: Location.from_dynamic!(d.fetch("location")),
+                autonomous_system: AutonomousSystem.from_dynamic!(d["autonomous_system"]),
+                metadata: d,
+                services: d.fetch("services", []).map { |x| Service.from_dynamic!(x) }
+              )
+            end
+          end
+        end
+
+        class Links < Dry::Struct
+          # @!attribute [r] next
+          #   @return [String, nil]
+          attribute :next, Types::String.optional
+
+          # @!attribute [r] prev
+          #   @return [String, nil]
+          attribute :prev, Types::String.optional
+
+          class << self
+            #
+            # @param [Hash] d
+            #
+            def from_dynamic!(d)
+              d = Types::Hash[d]
+              new(
+                next: d["next"],
+                prev: d["prev"]
+              )
+            end
+          end
         end
-      end
 
-      class Links < Dry::Struct
-        # @!attribute [r] next
-        #   @return [String, nil]
-        attribute :next, Types::String.optional
+        class Result < Dry::Struct
+          # @!attribute [r] query
+          #   @return [String]
+          attribute :query, Types::String
 
-        # @!attribute [r] prev
-        #   @return [String, nil]
-        attribute :prev, Types::String.optional
+          # @!attribute [r] total
+          #   @return [Integer]
+          attribute :total, Types::Int
+
+          # @!attribute [r] hits
+          #   @return [Array<Hit>]
+          attribute :hits, Types.Array(Hit)
+
+          # @!attribute [r] links
+          #   @return [Links]
+          attribute :links, Links
 
-        class << self
           #
-          # @param [Hash] d
+          # @return [Array<Mihari::Models::Artifact>]
           #
-          def from_dynamic!(d)
-            d = Types::Hash[d]
-            new(
-              next: d["next"],
-              prev: d["prev"]
-            )
+          def artifacts
+            hits.map(&:artifact)
+          end
+
+          class << self
+            #
+            # @param [Hash] d
+            #
+            def from_dynamic!(d)
+              d = Types::Hash[d]
+              new(
+                query: d.fetch("query"),
+                total: d.fetch("total"),
+                hits: d.fetch("hits", []).map { |x| Hit.from_dynamic!(x) },
+                links: Links.from_dynamic!(d.fetch("links"))
+              )
+            end
           end
         end
-      end
 
-      class Result < Dry::Struct
-        # @!attribute [r] query
-        #   @return [String]
-        attribute :query, Types::String
+        class Response < Dry::Struct
+          # @!attribute [r] code
+          #   @return [Integer]
+          attribute :code, Types::Int
 
-        # @!attribute [r] total
-        #   @return [Integer]
-        attribute :total, Types::Int
+          # @!attribute [r] status
+          #   @return [String]
+          attribute :status, Types::String
 
-        # @!attribute [r] hits
-        #   @return [Array<Hit>]
-        attribute :hits, Types.Array(Hit)
+          # @!attribute [r] result
+          #   @return [Result]
+          attribute :result, Result
 
-        # @!attribute [r] links
-        #   @return [Links]
-        attribute :links, Links
+          def artifacts
+            result.artifacts
+          end
 
-        #
-        # @return [Array<Mihari::Models::Artifact>]
-        #
-        def artifacts
-          hits.map(&:artifact)
+          class << self
+            #
+            # @param [Hash] d
+            #
+            def from_dynamic!(d)
+              d = Types::Hash[d]
+              new(
+                code: d.fetch("code"),
+                status: d.fetch("status"),
+                result: Result.from_dynamic!(d.fetch("result"))
+              )
+            end
+          end
         end
+      end
 
-        class << self
-          #
-          # @param [Hash] d
-          #
-          def from_dynamic!(d)
-            d = Types::Hash[d]
-            new(
-              query: d.fetch("query"),
-              total: d.fetch("total"),
-              hits: d.fetch("hits", []).map { |x| Hit.from_dynamic!(x) },
-              links: Links.from_dynamic!(d.fetch("links"))
+      module V3
+        class Hit < Dry::Struct
+          include Mihari::Concerns::AutonomousSystemNormalizable
+
+          attribute :ip, Types::String
+          attribute :autonomous_system, Types::Hash.optional
+          attribute :location, Types::Hash.optional
+          attribute :services, Types.Array(Types::Hash).optional
+          attribute :metadata, Types::Hash
+
+          def ports
+            (services || []).filter_map { |svc| svc["port"] }
+          end
+
+          def artifact
+            Mihari::Models::Artifact.new(
+              data: ip,
+              metadata: metadata,
+              autonomous_system: autonomous_system_model,
+              geolocation: geolocation_model,
+              ports: ports.map { |p| Mihari::Models::Port.new(number: p) }
             )
           end
-        end
-      end
 
-      class Response < Dry::Struct
-        # @!attribute [r] code
-        #   @return [Integer]
-        attribute :code, Types::Int
+          def autonomous_system_model
+            return nil if autonomous_system.nil?
 
-        # @!attribute [r] status
-        #   @return [String]
-        attribute :status, Types::String
+            Mihari::Models::AutonomousSystem.new(number: normalize_asn(autonomous_system["asn"]))
+          end
 
-        # @!attribute [r] result
-        #   @return [Result]
-        attribute :result, Result
+          def geolocation_model
+            return nil if location.nil?
 
-        class << self
-          #
-          # @param [Hash] d
-          #
-          def from_dynamic!(d)
-            d = Types::Hash[d]
-            new(
-              code: d.fetch("code"),
-              status: d.fetch("status"),
-              result: Result.from_dynamic!(d.fetch("result"))
+            Mihari::Models::Geolocation.new(
+              country: location["country"],
+              country_code: location["country_code"]
             )
           end
+
+          class << self
+            def from_dynamic!(d)
+              res = d.dig("host_v1", "resource") || {}
+              new(
+                ip: res["ip"],
+                autonomous_system: res["autonomous_system"],
+                location: res["location"],
+                services: res["services"],
+                metadata: d
+              )
+            end
+          end
+        end
+
+        class Result < Dry::Struct
+          attribute :hits, Types.Array(Hit)
+          attribute :next_page_token, Types::String.optional
+
+          def artifacts
+            hits.map(&:artifact)
+          end
+
+          class << self
+            def from_dynamic!(d)
+              new(
+                hits: (d["hits"] || []).map { |x| Hit.from_dynamic!(x) },
+                next_page_token: d["next_page_token"]
+              )
+            end
+          end
+        end
+
+        class Response < Dry::Struct
+          attribute :result, Result
+
+          def artifacts
+            result.artifacts
+          end
+
+          class << self
+            def from_dynamic!(d)
+              new(
+                result: Result.from_dynamic!(d["result"])
+              )
+            end
+          end
         end
       end
     end

data/lib/mihari/version.rb

@@ -1,3 +1,3 @@
 module Mihari
-  VERSION = "8.2.0"
+  VERSION = "8.3.0"
 end

data/lib/mihari/web/endpoints/alerts.rb

@@ -42,7 +42,7 @@ module Mihari
           get "/:id" do
             id = params[:id].to_i
             result = Services::AlertGetter.get_result(id)
-            return present(result.value!, with: Entities::Alert) if result.success?
+            next present(result.value!, with: Entities::Alert) if result.success?
 
             case result.failure
             when ActiveRecord::RecordNotFound
@@ -62,7 +62,7 @@ module Mihari
           delete "/:id" do
             id = params["id"].to_i
             result = Services::AlertDestroyer.get_result(id)
-            return if result.success?
+            next if result.success?
 
             case result.failure
             when ActiveRecord::RecordNotFound
@@ -87,7 +87,7 @@ module Mihari
             status 201
 
             result = Services::AlertCreator.get_result(params)
-            return present(result.value!, with: Entities::Alert) if result.success?
+            next present(result.value!, with: Entities::Alert) if result.success?
 
             case result.failure
             when ActiveRecord::RecordNotFound

data/lib/mihari/web/endpoints/artifacts.rb

@@ -42,7 +42,7 @@ module Mihari
           get "/:id" do
             id = params[:id].to_i
             result = Services::ArtifactGetter.get_result(id)
-            return present(result.value!, with: Entities::Artifact) if result.success?
+            next present(result.value!, with: Entities::Artifact) if result.success?
 
             case result.failure
             when ActiveRecord::RecordNotFound
@@ -75,7 +75,7 @@ module Mihari
             end.to_result
 
             message = queued ? "ID:#{id}'s enrichment is queued" : "ID:#{id}'s enrichment is successful"
-            return present({message:, queued:}, with: Entities::QueueMessage) if result.success?
+            next present({message:, queued:}, with: Entities::QueueMessage) if result.success?
 
             case result.failure
             when UnenrichableError
@@ -99,7 +99,7 @@ module Mihari
 
             id = params["id"].to_i
             result = Services::ArtifactDestroyer.get_result(id)
-            return if result.success?
+            next if result.success?
 
             case result.failure
             when ActiveRecord::RecordNotFound

data/lib/mihari/web/endpoints/ip_addresses.rb

@@ -24,7 +24,7 @@ module Mihari
             result = Services::IPGetter.get_result(ip)
             if result.success?
               value = result.value!
-              return present(
+              next present(
                 {
                   country_code: value.country_code,
                   asn: value.asn,

data/lib/mihari/web/endpoints/rules.rb

@@ -60,7 +60,7 @@ module Mihari
           get "/:id" do
             id = params[:id].to_s
             result = Services::RuleGetter.get_result(params[:id].to_s)
-            return present(result.value!, with: Entities::Rule) if result.success?
+            next present(result.value!, with: Entities::Rule) if result.success?
 
             case result.failure
             when ActiveRecord::RecordNotFound
@@ -95,7 +95,7 @@ module Mihari
             end.to_result
 
             message = queued ? "ID:#{id}'s search is queued" : "ID:#{id}'s search is successful"
-            return present({message:, queued:}, with: Entities::QueueMessage) if result.success?
+            next present({message:, queued:}, with: Entities::QueueMessage) if result.success?
 
             case result.failure
             when ActiveRecord::RecordNotFound
@@ -121,7 +121,7 @@ module Mihari
             yaml = params[:yaml].to_s
 
             result = RuleCreateUpdater.get_result(yaml, overwrite: false)
-            return present(result.value!.model, with: Entities::Rule) if result.success?
+            next present(result.value!.model, with: Entities::Rule) if result.success?
 
             failure = result.failure
             case failure
@@ -152,7 +152,7 @@ module Mihari
             yaml = params[:yaml].to_s
 
             result = RuleCreateUpdater.get_result(yaml, overwrite: true)
-            return present(result.value!.model, with: Entities::Rule) if result.success?
+            next present(result.value!.model, with: Entities::Rule) if result.success?
 
             failure = result.failure
             case failure
@@ -179,7 +179,7 @@ module Mihari
 
             id = params[:id].to_s
             result = Services::RuleDestroyer.get_result(id)
-            return if result.success?
+            next if result.success?
 
             case result.failure
             when ActiveRecord::RecordNotFound

data/lib/mihari/web/endpoints/tags.rb

@@ -44,7 +44,7 @@ module Mihari
 
             id = params[:id].to_i
             result = Services::TagDestroyer.get_result(id)
-            return if result.success?
+            next if result.success?
 
             case result.failure
             when ActiveRecord::RecordNotFound