mihari 3.5.0 → 3.7.1

data/lib/mihari/serializers/autonomous_system.rb

@@ -0,0 +1,9 @@
+require "active_model_serializers"
+
+module Mihari
+  module Serializers
+    class AutonomousSystemSerializer < ActiveModel::Serializer
+      attributes :asn
+    end
+  end
+end

data/lib/mihari/serializers/dns.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "active_model_serializers"
+
+module Mihari
+  module Serializers
+    class DnsRecordSerializer < ActiveModel::Serializer
+      attributes :resource, :value
+    end
+  end
+end

data/lib/mihari/serializers/geolocation.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "active_model_serializers"
+
+module Mihari
+  module Serializers
+    class GeolocationSerializer < ActiveModel::Serializer
+      attributes :country, :country_code
+    end
+  end
+end

data/lib/mihari/serializers/reverse_dns.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "active_model_serializers"
+
+module Mihari
+  module Serializers
+    class ReverseDnsNameSerializer < ActiveModel::Serializer
+      attributes :name
+    end
+  end
+end

data/lib/mihari/serializers/tag.rb

@@ -3,7 +3,9 @@
 require "active_model_serializers"
 
 module Mihari
-  class TagSerializer < ActiveModel::Serializer
-    attributes :id, :name
+  module Serializers
+    class TagSerializer < ActiveModel::Serializer
+      attributes :id, :name
+    end
   end
 end

data/lib/mihari/serializers/whois.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "active_model_serializers"
+
+module Mihari
+  module Serializers
+    class WhoisRecordSerializer < ActiveModel::Serializer
+      attributes :domain, :created_on, :updated_on, :expires_on, :registrar, :contacts
+    end
+  end
+end

data/lib/mihari/status.rb

@@ -18,7 +18,7 @@ module Mihari
     # @return [Array<Hash>]
     #
     def statuses
-      (Mihari.analyzers + Mihari.emitters).map do |klass|
+      (Mihari.analyzers + Mihari.emitters + Mihari.enrichers).map do |klass|
         name = klass.to_s.split("::").last.to_s
 
         [name, build_status(klass)]
@@ -36,11 +36,16 @@ module Mihari
       return nil if klass == Mihari::Analyzers::Rule
 
       is_analyzer = klass.ancestors.include?(Mihari::Analyzers::Base)
+      is_emitter = klass.ancestors.include?(Mihari::Emitters::Base)
+      is_enricher = klass.ancestors.include?(Mihari::Enrichers::Base)
 
       instance = is_analyzer ? klass.new("dummy") : klass.new
       is_configured = instance.configured?
       values = instance.configuration_values
-      type = is_analyzer ? "Analyzer" : "Emitter"
+
+      type = "Analyzer"
+      type = "Emitter" if is_emitter
+      type = "Enricher" if is_enricher
 
       values ? { is_configured: is_configured, values: values, type: type } : nil
     rescue ArgumentError => _e

data/lib/mihari/structs/censys.rb

@@ -0,0 +1,92 @@
+require "json"
+require "dry/struct"
+
+module Mihari
+  module Structs
+    module Censys
+      class AutonomousSystem < Dry::Struct
+        attribute :asn, Types::Int
+
+        def self.from_dynamic!(d)
+          d = Types::Hash[d]
+          new(
+            asn: d.fetch("asn")
+          )
+        end
+      end
+
+      class Location < Dry::Struct
+        attribute :country, Types::String.optional
+        attribute :country_code, Types::String.optional
+
+        def self.from_dynamic!(d)
+          d = Types::Hash[d]
+          new(
+            country: d["country"],
+            country_code: d["country_code"]
+          )
+        end
+      end
+
+      class Hit < Dry::Struct
+        attribute :ip, Types::String
+        attribute :location, Location
+        attribute :autonomous_system, AutonomousSystem
+
+        def self.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.fetch("autonomous_system"))
+          )
+        end
+      end
+
+      class Links < Dry::Struct
+        attribute :next, Types::String
+        attribute :prev, Types::String
+
+        def self.from_dynamic!(d)
+          d = Types::Hash[d]
+          new(
+            next: d.fetch("next"),
+            prev: d.fetch("prev")
+          )
+        end
+      end
+
+      class Result < Dry::Struct
+        attribute :query, Types::String
+        attribute :total, Types::Int
+        attribute :hits, Types.Array(Hit)
+        attribute :links, Links
+
+        def self.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
+
+      class Response < Dry::Struct
+        attribute :code, Types::Int
+        attribute :status, Types::String
+        attribute :result, Result
+
+        def self.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
+end

data/lib/mihari/structs/ipinfo.rb

@@ -0,0 +1,39 @@
+require "json"
+require "dry/struct"
+
+module Mihari
+  module Structs
+    module IPInfo
+      class Response < Dry::Struct
+        attribute :ip, Types::String
+        attribute :hostname, Types::String.optional
+        attribute :loc, Types::String
+        attribute :country_code, Types::String
+        attribute :asn, Types::Integer.optional
+
+        class << self
+          include Mixins::AutonomousSystem
+
+          def from_dynamic!(d)
+            d = Types::Hash[d]
+
+            asn = nil
+            org = d["org"]
+            unless org.nil?
+              asn = org.split.first
+              asn = normalize_asn(asn)
+            end
+
+            new(
+              ip: d.fetch("ip"),
+              loc: d.fetch("loc"),
+              hostname: d["hostname"],
+              country_code: d.fetch("country"),
+              asn: asn
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mihari/structs/onyphe.rb

@@ -0,0 +1,47 @@
+require "json"
+require "dry/struct"
+
+module Mihari
+  module Structs
+    module Onyphe
+      class Result < Dry::Struct
+        attribute :asn, Types::String
+        attribute :country_code, Types::String.optional
+        attribute :ip, Types::String
+
+        def self.from_dynamic!(d)
+          d = Types::Hash[d]
+          new(
+            asn: d.fetch("asn"),
+            ip: d.fetch("ip"),
+            # Onyphe's country = 2-letter country code
+            country_code: d["country"]
+          )
+        end
+      end
+
+      class Response < Dry::Struct
+        attribute :count, Types::Int
+        attribute :error, Types::Int
+        attribute :max_page, Types::Int
+        attribute :page, Types::String
+        attribute :results, Types.Array(Result)
+        attribute :status, Types::String
+        attribute :total, Types::Int
+
+        def self.from_dynamic!(d)
+          d = Types::Hash[d]
+          new(
+            count: d.fetch("count"),
+            error: d.fetch("error"),
+            max_page: d.fetch("max_page"),
+            page: d.fetch("page"),
+            results: d.fetch("results").map { |x| Result.from_dynamic!(x) },
+            status: d.fetch("status"),
+            total: d.fetch("total")
+          )
+        end
+      end
+    end
+  end
+end

data/lib/mihari/structs/shodan.rb

@@ -0,0 +1,53 @@
+require "json"
+require "dry/struct"
+
+module Mihari
+  module Structs
+    module Shodan
+      class Location < Dry::Struct
+        attribute :country_code, Types::String
+        attribute :country_name, Types::String
+
+        def self.from_dynamic!(d)
+          d = Types::Hash[d]
+          new(
+            country_code: d.fetch("country_code"),
+            country_name: d.fetch("country_name")
+          )
+        end
+      end
+
+      class Match < Dry::Struct
+        attribute :asn, Types::String
+        attribute :hostnames, Types.Array(Types::String)
+        attribute :location, Location
+        attribute :domains, Types.Array(Types::String)
+        attribute :ip_str, Types::String
+
+        def self.from_dynamic!(d)
+          d = Types::Hash[d]
+          new(
+            asn: d.fetch("asn"),
+            hostnames: d.fetch("hostnames"),
+            location: Location.from_dynamic!(d.fetch("location")),
+            domains: d.fetch("domains"),
+            ip_str: d.fetch("ip_str")
+          )
+        end
+      end
+
+      class Result < Dry::Struct
+        attribute :matches, Types.Array(Match)
+        attribute :total, Types::Int
+
+        def self.from_dynamic!(d)
+          d = Types::Hash[d]
+          new(
+            matches: d.fetch("matches", []).map { |x| Match.from_dynamic!(x) },
+            total: d.fetch("total")
+          )
+        end
+      end
+    end
+  end
+end

data/lib/mihari/type_checker.rb

@@ -18,12 +18,12 @@ module Mihari
       raise ArgumentError if data.is_a?(Hash)
     end
 
-    # @return [true, false]
+    # @return [Boolean]
     def hash?
       md5? || sha1? || sha256? || sha512?
     end
 
-    # @return [true, false]
+    # @return [Boolean]
     def ip?
       IPAddr.new data
       true
@@ -31,7 +31,7 @@ module Mihari
       false
     end
 
-    # @return [true, false]
+    # @return [Boolean]
     def domain?
       uri = Addressable::URI.parse("http://#{data}")
       uri.host == data && PublicSuffix.valid?(uri.host)
@@ -39,7 +39,7 @@ module Mihari
       false
     end
 
-    # @return [true, false]
+    # @return [Boolean]
     def url?
       uri = Addressable::URI.parse(data)
       uri.scheme && uri.host && uri.path && PublicSuffix.valid?(uri.host)
@@ -47,7 +47,7 @@ module Mihari
       false
     end
 
-    # @return [true, false]
+    # @return [Boolean]
     def mail?
       EmailAddress.valid? data, host_validation: :syntax
     end
@@ -83,22 +83,22 @@ module Mihari
 
     private
 
-    # @return [true, false]
+    # @return [Boolean]
     def md5?
       data.match?(/^[A-Fa-f0-9]{32}$/)
     end
 
-    # @return [true, false]
+    # @return [Boolean]
     def sha1?
       data.match?(/^[A-Fa-f0-9]{40}$/)
     end
 
-    # @return [true, false]
+    # @return [Boolean]
     def sha256?
       data.match?(/^[A-Fa-f0-9]{64}$/)
     end
 
-    # @return [true, false]
+    # @return [Boolean]
     def sha512?
       data.match?(/^[A-Fa-f0-9]{128}$/)
     end

data/lib/mihari/types.rb

@@ -0,0 +1,21 @@
+require "dry/types"
+
+module Mihari
+  module Types
+    include Dry.Types()
+
+    Int = Strict::Integer
+    Nil = Strict::Nil
+    Hash = Strict::Hash
+    String = Strict::String
+    Double = Strict::Float | Strict::Integer
+
+    DataTypes = Types::String.enum(*ALLOWED_DATA_TYPES)
+
+    AnalyzerTypes = Types::String.enum(
+      "binaryedge", "censys", "circl", "dnpedia", "dnstwister",
+      "onyphe", "otx", "passivetotal", "pulsedive", "securitytrails",
+      "shodan", "virustotal"
+    )
+  end
+end

data/lib/mihari/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Mihari
-  VERSION = "3.5.0"
+  VERSION = "3.7.1"
 end

data/lib/mihari/web/controllers/artifacts_controller.rb

@@ -9,24 +9,69 @@ module Mihari
         id = params["id"].to_i
 
         begin
-          artifact = Mihari::Artifact.find(id)
-
-          # TODO: improve queries
-          alert_ids = Mihari::Artifact.where(data: artifact.data).pluck(:alert_id)
-          tag_ids = Mihari::Tagging.where(alert_id: alert_ids).pluck(:tag_id)
-          tag_names = Mihari::Tag.where(id: tag_ids).distinct.pluck(:name)
+          artifact = Mihari::Artifact.includes(
+            :autonomous_system,
+            :geolocation,
+            :whois_record,
+            :dns_records,
+            :reverse_dns_names
+          ).find(id)
         rescue ActiveRecord::RecordNotFound
           status 404
 
           return json({ message: "ID:#{id} is not found" })
         end
 
-        artifact_json = ArtifactSerializer.new(artifact).as_json
+        # TODO: improve queries
+        alert_ids = Mihari::Artifact.where(data: artifact.data).pluck(:alert_id)
+        tag_ids = Mihari::Tagging.where(alert_id: alert_ids).pluck(:tag_id)
+        tag_names = Mihari::Tag.where(id: tag_ids).distinct.pluck(:name)
+
+        artifact_json = Serializers::ArtifactSerializer.new(artifact).as_json
+
+        # convert reverse DNS names into an array of string
+        # also change it as nil if it is empty
+        reverse_dns_names = (artifact_json[:reverse_dns_names] || []).filter_map { |v| v[:name] }
+        reverse_dns_names = nil if reverse_dns_names.empty?
+        artifact_json[:reverse_dns_names] = reverse_dns_names
+
+        # change DNS records as nil if it is empty
+        dns_records = artifact_json[:dns_records] || []
+        dns_records = nil if dns_records.empty?
+        artifact_json[:dns_records] = dns_records
+
+        # set tags
         artifact_json[:tags] = tag_names
 
         json artifact_json
       end
 
+      get "/api/artifacts/:id/enrich" do
+        param :id, Integer, required: true
+
+        id = params["id"].to_i
+
+        begin
+          artifact = Mihari::Artifact.includes(
+            :autonomous_system,
+            :geolocation,
+            :whois_record,
+            :dns_records,
+            :reverse_dns_names
+          ).find(id)
+        rescue ActiveRecord::RecordNotFound
+          status 404
+
+          return json({ message: "ID:#{id} is not found" })
+        end
+
+        artifact.enrich_all
+        artifact.save
+
+        status 201
+        body ""
+      end
+
       delete "/api/artifacts/:id" do
         param :id, Integer, required: true
 
@@ -34,7 +79,7 @@ module Mihari
 
         begin
           alert = Mihari::Artifact.find(id)
-          alert.delete
+          alert.destroy
 
           status 204
           body ""