mihari 3.8.1 → 3.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a3dcac61a2835aa2f940ab90edf363b10293d0537baf8b1748212686770495f
-  data.tar.gz: 1f1bb0515227d8cb842e511b3045298bec2b981706ddacd0750b9a6a11aa2625
+  metadata.gz: c4d53239fe8be60cdc674dc22c14f801147a71144649cec83f4fd3caaf2c99fa
+  data.tar.gz: 71b9b3746164b1f3eec9b98a807a6940e85a9184991efd7dd9abe5bd9b3f3578
 SHA512:
-  metadata.gz: ce4ad498c64026a3b349c927dcd5f98bb59415a232acaaf279cde6f45d8f4af18bb62776568c092e261c936e5574f487a02f1fc4089f8af05a367578f06864b5
-  data.tar.gz: a5223e8a9f2060374df5cb21f6dbcfd475ce66408a04356131471fbb0321ac4622fec0df7ebf354ae2b46c537460a8738beb3dda5ac35c3a11588a4a97642712
+  metadata.gz: 6bee10443bd55e0ac483e8495c508bcce95dc56073aeb99f6c1566f38fb73707140baa838c07212c39795017d109aef8e9478f560bc3d04a21cbb949a48c9b61
+  data.tar.gz: c35f757168a737c37dcbf9a54d0408eabdfbf807a7a57db77c59c10f9a5b803d6731c615f3360db93b05647ee5e6cdcd35518baf4a7a7efe8d73e198d7f2664e

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/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/greynoise.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require "greynoise"
+
+module Mihari
+  module Analyzers
+    class GreyNoise < Base
+      param :query
+      option :title, default: proc { "GreyNoise search" }
+      option :description, default: proc { "query = #{query}" }
+      option :tags, default: proc { [] }
+
+      def artifacts
+        res = Structs::GreyNoise::Response.from_dynamic!(search)
+        res.data.map do |datum|
+          build_artifact datum
+        end
+      end
+
+      private
+
+      PAGE_SIZE = 10_000
+
+      def configuration_keys
+        %w[greynoise_api_key]
+      end
+
+      def api
+        @api ||= ::GreyNoise::API.new(key: Mihari.config.greynoise_api_key)
+      end
+
+      #
+      # Search
+      #
+      # @return [Hash]
+      #
+      def search
+        api.experimental.gnql(query, size: PAGE_SIZE)
+      end
+
+      #
+      # Build an artifact from a GreyNoise search API response
+      #
+      # @param [Structs::GreyNoise::Datum] datum
+      #
+      # @return [Artifact]
+      #
+      def build_artifact(datum)
+        as = AutonomousSystem.new(asn: normalize_asn(datum.metadata.asn))
+
+        geolocation = Geolocation.new(
+          country: datum.metadata.country,
+          country_code: datum.metadata.country_code
+        )
+
+        Artifact.new(
+          data: datum.ip,
+          source: source,
+          autonomous_system: as,
+          geolocation: geolocation
+        )
+      end
+    end
+  end
+end

data/lib/mihari/analyzers/rule.rb

@@ -11,6 +11,7 @@ module Mihari
       "crtsh" => Crtsh,
       "dnpedia" => DNPedia,
       "dnstwister" => DNSTwister,
+      "greynoise" => GreyNoise,
       "onyphe" => Onyphe,
       "otx" => OTX,
       "passivetotal" => PassiveTotal,

data/lib/mihari/analyzers/shodan.rb

@@ -78,7 +78,9 @@ module Mihari
       # @return [Artifact]
       #
       def build_artifact(match)
-        as = AutonomousSystem.new(asn: normalize_asn(match.asn))
+        as = nil
+        as = AutonomousSystem.new(asn: normalize_asn(match.asn)) unless match.asn.nil?
+
         geolocation = Geolocation.new(
           country: match.location.country_name,
           country_code: match.location.country_code

data/lib/mihari/cli/analyzer.rb

@@ -6,6 +6,7 @@ require "mihari/commands/circl"
 require "mihari/commands/crtsh"
 require "mihari/commands/dnpedia"
 require "mihari/commands/dnstwister"
+require "mihari/commands/greynoise"
 require "mihari/commands/onyphe"
 require "mihari/commands/otx"
 require "mihari/commands/passivetotal"
@@ -33,6 +34,7 @@ module Mihari
       include Mihari::Commands::Crtsh
       include Mihari::Commands::DNPedia
       include Mihari::Commands::DNSTwister
+      include Mihari::Commands::GreyNoise
       include Mihari::Commands::JSON
       include Mihari::Commands::Onyphe
       include Mihari::Commands::OTX

data/lib/mihari/commands/greynoise.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Mihari
+  module Commands
+    module GreyNoise
+      def self.included(thor)
+        thor.class_eval do
+          desc "greynoise [QUERY]", "GreyNoise search"
+          method_option :title, type: :string, desc: "title"
+          method_option :description, type: :string, desc: "description"
+          method_option :tags, type: :array, desc: "tags"
+          def greynoise(query)
+            with_error_handling do
+              run_analyzer Analyzers::GreyNoise, query: query, options: options
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mihari/commands/search.rb

@@ -10,6 +10,9 @@ module Mihari
           desc "search [RULE]", "Search by a rule"
           method_option :config, type: :string, desc: "Path to the config file"
           def search_by_rule(rule)
+            # load configuration
+            load_configuration
+
             # convert str(YAML) to hash or str(path/YAML file) to hash
             rule = load_rule(rule)
 
@@ -77,8 +80,6 @@ module Mihari
       # @return [nil]
       #
       def run_rule_analyzer(analyzer, ignore_old_artifacts: false, ignore_threshold: 0)
-        load_configuration
-
         analyzer.ignore_old_artifacts = ignore_old_artifacts
         analyzer.ignore_threshold = ignore_threshold
 

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/schemas/configuration.rb

@@ -13,6 +13,8 @@ module Mihari
       optional(:censys_secret).value(:string)
       optional(:circl_passive_password).value(:string)
       optional(:circl_passive_username).value(:string)
+      optional(:database).value(:string)
+      optional(:greynoise_api_key).value(:string)
       optional(:ipinfo_api_key).value(:string)
       optional(:misp_api_endpoint).value(:string)
       optional(:misp_api_key).value(:string)
@@ -30,10 +32,9 @@ module Mihari
       optional(:thehive_api_key).value(:string)
       optional(:urlscan_api_key).value(:string)
       optional(:virustotal_api_key).value(:string)
-      optional(:zoomeye_api_key).value(:string)
       optional(:webhook_url).value(:string)
       optional(:webhook_use_json_body).value(:bool)
-      optional(:database).value(:string)
+      optional(:zoomeye_api_key).value(:string)
     end
 
     class ConfigurationContract < Dry::Validation::Contract

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/greynoise.rb

@@ -0,0 +1,55 @@
+require "json"
+require "dry/struct"
+
+module Mihari
+  module Structs
+    module GreyNoise
+      class Metadata < Dry::Struct
+        attribute :country, Types::String
+        attribute :country_code, Types::String
+        attribute :asn, Types::String
+
+        def self.from_dynamic!(d)
+          d = Types::Hash[d]
+          new(
+            country: d.fetch("country"),
+            country_code: d.fetch("country_code"),
+            asn: d.fetch("asn")
+          )
+        end
+      end
+
+      class Datum < Dry::Struct
+        attribute :ip, Types::String
+        attribute :metadata, Metadata
+
+        def self.from_dynamic!(d)
+          d = Types::Hash[d]
+          new(
+            ip: d.fetch("ip"),
+            metadata: Metadata.from_dynamic!(d.fetch("metadata"))
+          )
+        end
+      end
+
+      class Response < Dry::Struct
+        attribute :complete, Types::Bool
+        attribute :count, Types::Int
+        attribute :data, Types.Array(Datum)
+        attribute :message, Types::String
+        attribute :query, Types::String
+
+        def self.from_dynamic!(d)
+          d = Types::Hash[d]
+          new(
+            complete: d.fetch("complete"),
+            count: d.fetch("count"),
+            data: d.fetch("data").map { |x| Datum.from_dynamic!(x) },
+            message: d.fetch("message"),
+            query: d.fetch("query")
+          )
+        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/shodan.rb

@@ -18,7 +18,7 @@ module Mihari
       end
 
       class Match < Dry::Struct
-        attribute :asn, Types::String
+        attribute :asn, Types::String.optional
         attribute :hostnames, Types.Array(Types::String)
         attribute :location, Location
         attribute :domains, Types.Array(Types::String)
@@ -27,7 +27,7 @@ module Mihari
         def self.from_dynamic!(d)
           d = Types::Hash[d]
           new(
-            asn: d.fetch("asn"),
+            asn: d["asn"],
             hostnames: d.fetch("hostnames"),
             location: Location.from_dynamic!(d.fetch("location")),
             domains: d.fetch("domains"),

data/lib/mihari/types.rb

@@ -9,6 +9,7 @@ module Mihari
     Hash = Strict::Hash
     String = Strict::String
     Double = Strict::Float | Strict::Integer
+    DateTime = Strict::DateTime
 
     DataTypes = Types::String.enum(*ALLOWED_DATA_TYPES)
 
@@ -18,6 +19,7 @@ module Mihari
       "circl",
       "dnpedia",
       "dnstwister",
+      "greynoise",
       "onyphe",
       "otx",
       "passivetotal",

data/lib/mihari/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Mihari
-  VERSION = "3.8.1"
+  VERSION = "3.10.0"
 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