mihari 3.7.2 → 3.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4ce5b3ce24278b8141bf2078dce45d572846a4838a0dc00c34e695201c36d77
-  data.tar.gz: '0992223bccd1d9732e0cc9cb6063f822efef8f0db34a27a45ad829efc930a60f'
+  metadata.gz: d2e67ff3e1ae2bf328a9a77ef7c9a88dce779749c422490a97106d3529a9a3b1
+  data.tar.gz: a71ee49c8fcb0b06e180739a588930783dabbc40078d234f791314dd3f8af9b4
 SHA512:
-  metadata.gz: 26aa441c9e982df2a84e5d3f8cc5bc261b49b9dae618fc73384a116927481125b4a87dac8317a6fb319caf5523398020ebcf8973eee6229d128a377f1054c4db
-  data.tar.gz: bfee6864b187018a6a9f9b5f4c68cfdea496b36ebad0b796425642ed9b80b2f7c70c4d74ef16964838e16b2985acddb11d4b0c0a6c4cca73dfb93d7a1ff83875
+  metadata.gz: 41c30a97d80e6d96f425230401b7f0ee947979dff6b2a8c458bb72c38ed34c2577bed1b007f25e2607cacc1c70f6d7de183722bac0b604f0c54f582758db1e53
+  data.tar.gz: 6cb1d47e4efec3fb54bd93ddacf5e8f55e423d3b28c1e3c6ae2ea852898b88d3995d8eb767e89535ba50bfffb6b533ce946068eb348cfbd33afe41ace587a5df

data/.github/workflows/test.yml

@@ -43,17 +43,16 @@ jobs:
 
     steps:
       - uses: actions/checkout@v2
-      - name: Set up Ruby 2.7
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-          bundler-cache: true
 
       - name: Install dependencies
         run: |
           sudo apt-get -yqq install libpq-dev libmysqlclient-dev
-          gem install bundler
-          bundle install
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
 
       - name: Test with PostgreSQL
         env:

data/README.md

@@ -46,7 +46,7 @@ Mihari supports the following services by default.
 - [Shodan](https://shodan.io)
 - [Spyse](https://spyse.com)
 - [urlscan.io](https://urlscan.io)
-- [VirusTotal](http://virustotal.com)
+- [VirusTotal](http://virustotal.com) & [VirusTotal Intelligence](https://www.virustotal.com/gui/intelligence-overview)
 - [ZoomEye](https://zoomeye.org)
 
 ## Docs

data/config.ru

@@ -4,4 +4,4 @@ require "./lib/mihari"
 # set rack env as development
 ENV["RACK_ENV"] ||= "development"
 
-run Mihari::App
+run Mihari::App.instance

data/lib/mihari/analyzers/rule.rb

@@ -4,6 +4,30 @@ require "uuidtools"
 
 module Mihari
   module Analyzers
+    ANALYZER_TO_CLASS = {
+      "binaryedge" => BinaryEdge,
+      "censys" => Censys,
+      "circl" => CIRCL,
+      "crtsh" => Crtsh,
+      "dnpedia" => DNPedia,
+      "dnstwister" => DNSTwister,
+      "onyphe" => Onyphe,
+      "otx" => OTX,
+      "passivetotal" => PassiveTotal,
+      "pt" => PassiveTotal,
+      "pulsedive" => Pulsedive,
+      "securitytrails" => SecurityTrails,
+      "shodan" => Shodan,
+      "spyse" => Spyse,
+      "st" => SecurityTrails,
+      "urlscan" => Urlscan,
+      "virustotal_intelligence" => VirusTotalIntelligence,
+      "virustotal" => VirusTotal,
+      "vt_intel" => VirusTotalIntelligence,
+      "vt" => VirusTotal,
+      "zoomeye" => ZoomEye
+    }.freeze
+
     class Rule < Base
       include Mihari::Mixins::DisallowedDataValue
 
@@ -26,25 +50,6 @@ module Mihari
         validate_analyzer_configurations
       end
 
-      ANALYZER_TO_CLASS = {
-        "binaryedge" => BinaryEdge,
-        "censys" => Censys,
-        "circl" => CIRCL,
-        "crtsh" => Crtsh,
-        "dnpedia" => DNPedia,
-        "dnstwister" => DNSTwister,
-        "onyphe" => Onyphe,
-        "otx" => OTX,
-        "passivetotal" => PassiveTotal,
-        "pulsedive" => Pulsedive,
-        "securitytrails" => SecurityTrails,
-        "shodan" => Shodan,
-        "spyse" => Spyse,
-        "urlscan" => Urlscan,
-        "virustotal" => VirusTotal,
-        "zoomeye" => ZoomEye
-      }.freeze
-
       #
       # Returns a list of artifacts matched with queries
       #

data/lib/mihari/analyzers/virustotal_intelligence.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require "virustotal"
+
+module Mihari
+  module Analyzers
+    class VirusTotalIntelligence < Base
+      param :query
+      option :title, default: proc { "VirusTotal Intelligence search" }
+      option :description, default: proc { "query = #{query}" }
+      option :tags, default: proc { [] }
+
+      def initialize(*args, **kwargs)
+        super
+
+        @query = query
+      end
+
+      def artifacts
+        responses = search_witgh_cursor
+        responses.map do |response|
+          response.data.map(&:value)
+        end.flatten.compact.uniq
+      end
+
+      private
+
+      def configuration_keys
+        %w[virustotal_api_key]
+      end
+
+      #
+      # VT API
+      #
+      # @return [::VirusTotal::API]
+      #
+      def api
+        @api = ::VirusTotal::API.new(key: Mihari.config.virustotal_api_key)
+      end
+
+      #
+      # Search with cursor
+      #
+      # @return [Array<Structs::VirusTotalIntelligence::Response>]
+      #
+      def search_witgh_cursor
+        cursor = nil
+        responses = []
+
+        loop do
+          response = Structs::VirusTotalIntelligence::Response.from_dynamic!(api.intelligence.search(query, cursor: cursor))
+          responses << response
+
+          break if response.meta.cursor.nil?
+
+          cursor = response.meta.cursor
+        end
+
+        responses
+      end
+    end
+  end
+end

data/lib/mihari/cli/analyzer.rb

@@ -14,6 +14,7 @@ require "mihari/commands/securitytrails"
 require "mihari/commands/shodan"
 require "mihari/commands/spyse"
 require "mihari/commands/urlscan"
+require "mihari/commands/virustotal_intelligence"
 require "mihari/commands/virustotal"
 require "mihari/commands/zoomeye"
 
@@ -42,6 +43,7 @@ module Mihari
       include Mihari::Commands::Spyse
       include Mihari::Commands::Urlscan
       include Mihari::Commands::VirusTotal
+      include Mihari::Commands::VirusTotalIntelligence
       include Mihari::Commands::ZoomEye
     end
   end

data/lib/mihari/commands/passivetotal.rb

@@ -14,6 +14,7 @@ module Mihari
               run_analyzer Analyzers::PassiveTotal, query: indicator, options: options
             end
           end
+          map "pt" => :passivetotal
         end
       end
     end

data/lib/mihari/commands/virustotal.rb

@@ -14,6 +14,7 @@ module Mihari
               run_analyzer Analyzers::VirusTotal, query: indiactor, options: options
             end
           end
+          map "vt" => :virustotal
         end
       end
     end

data/lib/mihari/commands/virustotal_intelligence.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Mihari
+  module Commands
+    module VirusTotalIntelligence
+      def self.included(thor)
+        thor.class_eval do
+          desc "virustotal_intelligence [QUERY]", "VirusTotal Intelligence search"
+          method_option :title, type: :string, desc: "title"
+          method_option :description, type: :string, desc: "description"
+          method_option :tags, type: :array, desc: "tags"
+          def virustotal_intelligence(query)
+            with_error_handling do
+              run_analyzer Analyzers::VirusTotalIntelligence, query: query, options: options
+            end
+          end
+          map "vt_intel" => :virustotal_intelligence
+        end
+      end
+    end
+  end
+end

data/lib/mihari/commands/web.rb

@@ -6,19 +6,23 @@ module Mihari
       def self.included(thor)
         thor.class_eval do
           desc "web", "Launch the web app"
-          method_option :port, type: :numeric, default: 9292
-          method_option :host, type: :string, default: "localhost"
+          method_option :port, type: :numeric, default: 9292, desc: "Hostname to listen on"
+          method_option :host, type: :string, default: "localhost", desc: "Port to listen on"
+          method_option :threads, type: :string, default: "0:16", desc: "min:max threads to use"
+          method_option :verbose, type: :boolean, default: true, desc: "Report each request"
           method_option :config, type: :string, desc: "Path to the config file"
           def web
-            port = options["port"].to_i || 9292
-            host = options["host"] || "localhost"
+            port = options["port"]
+            host = options["host"]
+            threads = options["threads"]
+            verbose = options["verbose"]
 
             load_configuration
 
             # set rack env as production
             ENV["RACK_ENV"] ||= "production"
 
-            Mihari::App.run!(port: port, host: host)
+            Mihari::App.run!(port: port, host: host, threads: threads, verbose: verbose)
           end
         end
       end

data/lib/mihari/database.rb

@@ -106,7 +106,7 @@ module Mihari
           )
         end
 
-        # ActiveRecord::Base.logger = Logger.new STDOUT
+        ActiveRecord::Base.logger = Logger.new($stdout) if ENV["RACK_ENV"] == "development"
         ActiveRecord::Migration.verbose = false
 
         InitialSchema.migrate(:up)

data/lib/mihari/errors.rb

@@ -6,4 +6,6 @@ module Mihari
   class InvalidInputError < Error; end
 
   class RetryableError < Error; end
+
+  class FileNotFoundError < Error; end
 end

data/lib/mihari/mixins/configuration.rb

@@ -80,10 +80,20 @@ module Mihari
         end
       end
 
+      #
+      # Load configuration file
+      #
+      # @param [String] path
+      #
+      # @return [Hash]
+      #
       def _load_config(path)
-        return YAML.safe_load(File.read(path), symbolize_names: true) if Pathname(path).exist?
+        unless Pathname(path).exist?
+          puts "#{path} does not exist".colorize(:red)
+          raise FileNotFoundError
+        end
 
-        YAML.safe_load(path, symbolize_names: true)
+        YAML.safe_load(File.read(path), symbolize_names: true)
       end
     end
   end

data/lib/mihari/models/alert.rb

@@ -13,92 +13,67 @@ module Mihari
       #
       # Search alerts
       #
-      # @param [String, nil] artifact_data
-      # @param [String, nil] description
-      # @param [String, nil] source
-      # @param [String, nil] tag_name
-      # @param [String, nil] title
-      # @param [DateTime, nil] from_at
-      # @param [DateTime, nil] to_at
-      # @param [Integer, nil] limit
-      # @param [Integer, nil] page
+      # @param [Structs::Alert::SearchFilterWithPagination] filter
       #
       # @return [Array<Hash>]
       #
-      def search(artifact_data: nil, description: nil, source: nil, tag_name: nil, title: nil, from_at: nil, to_at: nil, limit: 10, page: 1)
-        limit = limit.to_i
+      def search(filter)
+        limit = filter.limit.to_i
         raise ArgumentError, "limit should be bigger than zero" unless limit.positive?
 
-        page = page.to_i
+        page = filter.page.to_i
         raise ArgumentError, "page should be bigger than zero" unless page.positive?
 
         offset = (page - 1) * limit
 
-        relation = build_relation(
-          artifact_data: artifact_data,
-          title: title,
-          description: description,
-          source: source,
-          tag_name: tag_name,
-          from_at: from_at,
-          to_at: to_at
-        )
+        relation = build_relation(filter.without_pagination)
 
         # TODO: improve queires
         alert_ids = relation.limit(limit).offset(offset).order(id: :desc).pluck(:id).uniq
-        alerts = includes(:artifacts, :tags).where(id: [alert_ids]).order(id: :desc)
-
-        alerts.map do |alert|
-          json = Serializers::AlertSerializer.new(alert).as_json
-          json[:artifacts] = json[:artifacts] || []
-          json[:tags] = json[:tags] || []
-          json
-        end
+        includes(:artifacts, :tags).where(id: [alert_ids]).order(id: :desc)
       end
 
       #
       # Count alerts
       #
       # @param [String, nil] artifact_data
-      # @param [String, nil] description
-      # @param [String, nil] source
-      # @param [String, nil] tag_name
-      # @param [String, nil] title
-      # @param [DateTime, nil] from_at
-      # @param [DateTime, nil] to_at
       #
       # @return [Integer]
       #
-      def count(artifact_data: nil, description: nil, source: nil, tag_name: nil, title: nil, from_at: nil, to_at: nil)
-        relation = build_relation(
-          artifact_data: artifact_data,
-          title: title,
-          description: description,
-          source: source,
-          tag_name: tag_name,
-          from_at: from_at,
-          to_at: to_at
-        )
+      def count(filter)
+        relation = build_relation(filter)
         relation.distinct("alerts.id").count
       end
 
       private
 
-      def build_relation(artifact_data: nil, title: nil, description: nil, source: nil, tag_name: nil, from_at: nil, to_at: nil)
-        relation = self
+      def build_relation(filter)
+        artifact_ids = []
+        artifact = Artifact.includes(:autonomous_system, :dns_records, :reverse_dns_names)
+        artifact = artifact.where(data: filter.artifact_data) if filter.artifact_data
+        artifact = artifact.where(autonomous_system: { asn: filter.asn }) if filter.asn
+        artifact = artifact.where(dns_records: { value: filter.dns_record }) if filter.dns_record
+        artifact = artifact.where(reverse_dns_names: { name: filter.reverse_dns_name }) if filter.reverse_dns_name
+        # get artifact ids if there is any valid filter for artifact
+        if filter.has_valid_artifact_filters
+          artifact_ids = artifact.pluck(:id)
+          # set invalid ID if nothing is matched with the filters
+          artifact_ids = [-1] if artifact_ids.empty?
+        end
 
+        relation = self
         relation = relation.includes(:artifacts, :tags)
 
-        relation = relation.where(artifacts: { data: artifact_data }) if artifact_data
-        relation = relation.where(tags: { name: tag_name }) if tag_name
+        relation = relation.where(artifacts: { id: artifact_ids }) unless artifact_ids.empty?
+        relation = relation.where(tags: { name: filter.tag_name }) if filter.tag_name
 
-        relation = relation.where(source: source) if source
-        relation = relation.where(title: title) if title
+        relation = relation.where(source: filter.source) if filter.source
+        relation = relation.where(title: filter.title) if filter.title
 
-        relation = relation.filter(description: { like: "%#{description}%" }) if description
+        relation = relation.filter(description: { like: "%#{filter.description}%" }) if filter.description
 
-        relation = relation.filter(created_at: { gte: from_at }) if from_at
-        relation = relation.filter(created_at: { lte: to_at }) if to_at
+        relation = relation.filter(created_at: { gte: filter.from_at }) if filter.from_at
+        relation = relation.filter(created_at: { lte: filter.to_at }) if filter.to_at
 
         relation
       end

data/lib/mihari/models/artifact.rb

@@ -29,10 +29,13 @@ module Mihari
 
     validates_with ArtifactValidator
 
+    attr_accessor :tags
+
     def initialize(attributes)
       super
 
       self.data_type = TypeChecker.type(data)
+      self.tags = []
     end
 
     #

data/lib/mihari/structs/alert.rb

@@ -0,0 +1,45 @@
+require "json"
+require "dry/struct"
+
+module Mihari
+  module Structs
+    module Alert
+      class SearchFilter < Dry::Struct
+        attribute? :artifact_data, Types::String.optional
+        attribute? :description, Types::String.optional
+        attribute? :source, Types::String.optional
+        attribute? :tag_name, Types::String.optional
+        attribute? :title, Types::String.optional
+        attribute? :from_at, Types::DateTime.optional
+        attribute? :to_at, Types::DateTime.optional
+        attribute? :asn, Types::Int.optional
+        attribute? :dns_record, Types::String.optional
+        attribute? :reverse_dns_name, Types::String.optional
+
+        def has_valid_artifact_filters
+          !(artifact_data || asn || dns_record || reverse_dns_name).nil?
+        end
+      end
+
+      class SearchFilterWithPagination < SearchFilter
+        attribute? :page, Types::Int.default(1)
+        attribute? :limit, Types::Int.default(10)
+
+        def without_pagination
+          SearchFilter.new(
+            artifact_data: artifact_data,
+            description: description,
+            from_at: from_at,
+            source: source,
+            tag_name: tag_name,
+            title: title,
+            to_at: to_at,
+            asn: asn,
+            dns_record: dns_record,
+            reverse_dns_name: reverse_dns_name
+          )
+        end
+      end
+    end
+  end
+end

data/lib/mihari/structs/ipinfo.rb

@@ -18,10 +18,9 @@ module Mihari
             d = Types::Hash[d]
 
             asn = nil
-            org = d["org"]
-            unless org.nil?
-              asn = org.split.first
-              asn = normalize_asn(asn)
+            asn_ = d.dig("asn", "asn")
+            unless asn_.nil?
+              asn = normalize_asn(asn_)
             end
 
             new(

data/lib/mihari/structs/virustotal_intelligence.rb

@@ -0,0 +1,75 @@
+require "json"
+require "dry/struct"
+
+module Mihari
+  module Structs
+    module VirusTotalIntelligence
+      class ContextAttributes < Dry::Struct
+        attribute :url, Types.Array(Types::String).optional
+
+        def self.from_dynamic!(d)
+          d = Types::Hash[d]
+          new(
+            url: d["url"]
+          )
+        end
+      end
+
+      class Datum < Dry::Struct
+        attribute :type, Types::String
+        attribute :id, Types::String
+        attribute :context_attributes, ContextAttributes.optional
+
+        def value
+          case type
+          when "file"
+            id
+          when "url"
+            (context_attributes.url || []).first
+          when "domain"
+            id
+          when "ip_address"
+            id
+          end
+        end
+
+        def self.from_dynamic!(d)
+          d = Types::Hash[d]
+
+          context_attributes = nil
+          context_attributes = ContextAttributes.from_dynamic!(d.fetch("context_attributes")) if d.key?("context_attributes")
+
+          new(
+            type: d.fetch("type"),
+            id: d.fetch("id"),
+            context_attributes: context_attributes
+          )
+        end
+      end
+
+      class Meta < Dry::Struct
+        attribute :cursor, Types::String.optional
+
+        def self.from_dynamic!(d)
+          d = Types::Hash[d]
+          new(
+            cursor: d["cursor"]
+          )
+        end
+      end
+
+      class Response < Dry::Struct
+        attribute :meta, Meta
+        attribute :data, Types.Array(Datum)
+
+        def self.from_dynamic!(d)
+          d = Types::Hash[d]
+          new(
+            meta: Meta.from_dynamic!(d.fetch("meta")),
+            data: d.fetch("data").map { |x| Datum.from_dynamic!(x) }
+          )
+        end
+      end
+    end
+  end
+end

data/lib/mihari/types.rb

@@ -9,13 +9,28 @@ module Mihari
     Hash = Strict::Hash
     String = Strict::String
     Double = Strict::Float | Strict::Integer
+    DateTime = Strict::DateTime
 
     DataTypes = Types::String.enum(*ALLOWED_DATA_TYPES)
 
     AnalyzerTypes = Types::String.enum(
-      "binaryedge", "censys", "circl", "dnpedia", "dnstwister",
-      "onyphe", "otx", "passivetotal", "pulsedive", "securitytrails",
-      "shodan", "virustotal"
+      "binaryedge",
+      "censys",
+      "circl",
+      "dnpedia",
+      "dnstwister",
+      "onyphe",
+      "otx",
+      "passivetotal",
+      "pt",
+      "pulsedive",
+      "securitytrails",
+      "shodan",
+      "st",
+      "virustotal_intelligence",
+      "virustotal",
+      "vt_intel",
+      "vt"
     )
   end
 end

data/lib/mihari/version.rb

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

data/lib/mihari/web/api.rb

@@ -0,0 +1,43 @@
+# Entities
+require "mihari/web/entities/message"
+
+require "mihari/web/entities/autonomous_system"
+require "mihari/web/entities/command"
+require "mihari/web/entities/config"
+require "mihari/web/entities/dns"
+require "mihari/web/entities/geolocation"
+require "mihari/web/entities/ip_address"
+require "mihari/web/entities/reverse_dns"
+require "mihari/web/entities/source"
+require "mihari/web/entities/tag"
+require "mihari/web/entities/whois"
+
+require "mihari/web/entities/artifact"
+
+require "mihari/web/entities/alert"
+
+# Endpoints
+require "mihari/web/endpoints/alerts"
+require "mihari/web/endpoints/artifacts"
+require "mihari/web/endpoints/command"
+require "mihari/web/endpoints/configs"
+require "mihari/web/endpoints/ip_addresses"
+require "mihari/web/endpoints/sources"
+require "mihari/web/endpoints/tags"
+
+module Mihari
+  class API < Grape::API
+    prefix "api"
+    format :json
+
+    mount Endpoints::Alerts
+    mount Endpoints::Artifacts
+    mount Endpoints::Command
+    mount Endpoints::Configs
+    mount Endpoints::IPAddresses
+    mount Endpoints::Sources
+    mount Endpoints::Tags
+
+    add_swagger_documentation(api_version: "v1", info: { title: "Mihari API" })
+  end
+end