mihari 3.9.0 → 3.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47f7a6231abe8eee1a1a4e4bc6f905d5f08fba2b68b1435d1621ab85e9e583c0
-  data.tar.gz: 591a8c71130095d6ac963fb333179d087f00727f45ab545e4a674a3c42a2af46
+  metadata.gz: d2e67ff3e1ae2bf328a9a77ef7c9a88dce779749c422490a97106d3529a9a3b1
+  data.tar.gz: a71ee49c8fcb0b06e180739a588930783dabbc40078d234f791314dd3f8af9b4
 SHA512:
-  metadata.gz: da1c99c406086a9d8d029f8421a3316a5a6976c5b8fbc839a910bd0d61f04a3297614582974dbda925722308d206db9d2889fe44ae213df2650f1482cc15e918
-  data.tar.gz: edf130cb5027bbb6abfea72b150266b8768494b627162da814c93b38d54fe2597a870d78cd9f8f33238512e5a3205cb84a67b9da0589b71393b67fef062ad9b1
+  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/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/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

@@ -30,14 +30,7 @@ module Mihari
 
         # 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
 
       #

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

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

data/lib/mihari/web/app.rb

@@ -2,46 +2,47 @@
 
 require "launchy"
 require "rack"
+require "rack/contrib"
 require "rack/handler/puma"
-require "sinatra"
+require "rack/cors"
 
-require "mihari/web/helpers/json"
+require "grape"
+require "grape-entity"
+require "grape-swagger"
+require "grape-swagger-entity"
 
-require "mihari/web/controllers/base_controller"
-
-require "mihari/web/controllers/alerts_controller"
-require "mihari/web/controllers/analyzers_controller"
-require "mihari/web/controllers/artifacts_controller"
-require "mihari/web/controllers/command_controller"
-require "mihari/web/controllers/config_controller"
-require "mihari/web/controllers/ip_address_controller"
-require "mihari/web/controllers/sources_controller"
-require "mihari/web/controllers/tags_controller"
+require "mihari/web/api"
 
 module Mihari
-  class App < Sinatra::Base
-    set :root, File.dirname(__FILE__)
-    set :public_folder, File.join(root, "public")
-
-    get "/" do
-      send_file File.join(settings.public_folder, "index.html")
+  class App
+    def initialize
+      @filenames = ["", ".html", "index.html", "/index.html"]
+      @rack_static = ::Rack::Static.new(
+        -> { [404, {}, []] },
+        root: File.expand_path("./public", __dir__),
+        urls: ["/"]
+      )
     end
 
-    use Mihari::Controllers::AlertsController
-    use Mihari::Controllers::AnalyzersController
-    use Mihari::Controllers::ArtifactsController
-    use Mihari::Controllers::CommandController
-    use Mihari::Controllers::ConfigController
-    use Mihari::Controllers::IPAddressController
-    use Mihari::Controllers::SourcesController
-    use Mihari::Controllers::TagsController
-
     class << self
+      def instance
+        @instance ||= Rack::Builder.new do
+          use Rack::Cors do
+            allow do
+              origins "*"
+              resource "*", headers: :any, methods: [:get, :post, :put, :delete, :options]
+            end
+          end
+
+          run App.new
+        end.to_app
+      end
+
       def run!(port: 9292, host: "localhost", threads: "0:16", verbose: false)
         url = "http://#{host}:#{port}"
 
-        Rack::Handler::Puma.run(self, Port: port, Host: host, Threads: threads, Verbose: verbose) do |server|
-          Launchy.open url
+        Rack::Handler::Puma.run(instance, Port: port, Host: host, Threads: threads, Verbose: verbose) do |server|
+          Launchy.open(url) if ENV["RACK_ENV"] != "development"
 
           [:INT, :TERM].each do |sig|
             trap(sig) do
@@ -51,5 +52,22 @@ module Mihari
         end
       end
     end
+
+    def call(env)
+      # api
+      api_response = API.call(env)
+
+      # Check if the App wants us to pass the response along to others
+      if api_response[1]["X-Cascade"] == "pass"
+        # static files
+        request_path = env["PATH_INFO"]
+        @filenames.each do |path|
+          response = @rack_static.call(env.merge("PATH_INFO" => request_path + path))
+          return response if response[0] != 404
+        end
+      end
+
+      api_response
+    end
   end
 end

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

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Mihari
+  module Endpoints
+    class Alerts < Grape::API
+      namespace :alerts do
+        desc "Search alerts", {
+          is_array: true,
+          success: Entities::Alert,
+          failure: [{ code: 404, message: "Not found", model: Entities::Message }]
+        }
+        params do
+          optional :page, type: Integer
+          optional :artifact, type: String
+          optional :description, type: String
+          optional :source, type: String
+          optional :tag, type: String
+
+          optional :fromAt, type: DateTime
+          optional :toAt, type: DateTime
+
+          optional :asn, type: Integer
+          optional :dnsRecord, type: String
+          optional :reverseDnsName, type: String
+        end
+        get "/" do
+          filter = params.to_h.to_snake_keys
+
+          # set page & limit
+          page = filter["page"] || 1
+          filter["page"] = page.to_i
+
+          limit = 10
+          filter["limit"] = 10
+
+          # normalize keys
+          filter["artifact_data"] = filter["artifact"]
+          filter["tag_name"] = filter["tag"]
+
+          # symbolize hash keys
+          filter = filter.to_h.transform_keys(&:to_sym)
+
+          search_filter_with_pagenation = Structs::Alert::SearchFilterWithPagination.new(**filter)
+          alerts = Mihari::Alert.search(search_filter_with_pagenation)
+          total = Mihari::Alert.count(search_filter_with_pagenation.without_pagination)
+
+          present({ alerts: alerts, total: total, current_page: page, page_size: limit }, with: Entities::AlertsWithPagination)
+        end
+
+        desc "Delete an alert", {
+          success: Entities::Message,
+          failure: [{ code: 404, message: "Not found", model: Entities::Message }]
+        }
+        params do
+          requires :id, type: Integer
+        end
+        delete "/:id" do
+          id = params["id"].to_i
+
+          begin
+            alert = Mihari::Alert.find(id)
+          rescue ActiveRecord::RecordNotFound
+            error!({ message: "ID:#{id} is not found" }, 404)
+          end
+
+          alert.destroy
+
+          status 204
+          present({ message: "" }, with: Entities::Message)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module Mihari
+  module Endpoints
+    class Artifacts < Grape::API
+      namespace :artifacts do
+        desc "Get an artifact", {
+          success: Entities::Artifact,
+          failure: [{ code: 404, message: "Not found", model: Entities::Message }]
+        }
+        params do
+          requires :id, type: Integer
+        end
+        get "/:id" do
+          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
+            error!({ message: "ID:#{id} is not found" }, 404)
+          end
+
+          # 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.tags = tag_names
+
+          present artifact, with: Entities::Artifact
+        end
+
+        desc "Enrich an artifact", {
+          success: Entities::Message,
+          failure: [{ code: 404, message: "Not found", model: Entities::Message }]
+        }
+        params do
+          requires :id, type: Integer
+        end
+        get "/:id/enrich" do
+          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
+            error!({ message: "ID:#{id} is not found" }, 404)
+          end
+
+          artifact.enrich_all
+          artifact.save
+
+          status 201
+          present({ message: "" }, with: Entities::Message)
+        end
+
+        desc "Delete an artifact", {
+          success: Entities::Message,
+          failure: [{ code: 404, message: "Not found", model: Entities::Message }]
+        }
+        params do
+          requires :id, type: Integer
+        end
+        delete "/:id" do
+          id = params["id"].to_i
+
+          begin
+            alert = Mihari::Artifact.find(id)
+          rescue ActiveRecord::RecordNotFound
+            error!({ message: "ID:#{id} is not found" }, 404)
+          end
+
+          alert.destroy
+
+          status 204
+          present({ message: "" }, with: Entities::Message)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "safe_shell"
+
+module Mihari
+  module Endpoints
+    class Command < Grape::API
+      namespace :command do
+        desc "Run a command", {
+          success: Entities::CommandResult,
+          failure: [{ code: 400, message: "Bad request", model: Entities::Message }]
+        }
+        params do
+          requires :command, type: String, documentation: { param_type: "body" }
+        end
+        post "/" do
+          command = params[:command]
+          if command.nil?
+            error!({ message: "command is required" }, 400)
+          end
+
+          command = command.split
+
+          output = SafeShell.execute("mihari", *command)
+          success = $?.success?
+
+          present({ output: output, success: success }, with: Entities::CommandResult)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Mihari
+  module Endpoints
+    class Configs < Grape::API
+      namespace :configs do
+        desc "Get configs", {
+          is_array: true,
+          success: Entities::Config
+        }
+        get "/" do
+          statuses = Status.check
+
+          configs = statuses.map do |key, value|
+            { name: key, status: value }
+          end
+          present(configs, with: Entities::Config)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Mihari
+  module Endpoints
+    class IPAddresses < Grape::API
+      namespace :ip_addresses do
+        desc "Get an IP address", {
+          success: Entities::IPAddress,
+          failure: [{ code: 404, message: "Not found", model: Entities::Message }]
+        }
+        params do
+          requires :ip, type: String, regexp: /\A[0-9.]+\z/
+        end
+        get "/:ip", requirements: { ip: %r{[^/]+} } do
+          ip = params[:ip].to_s
+
+          data = Enrichers::IPInfo.query(ip)
+          if data.nil?
+            error!({ message: "IP:#{ip} is not found" }, 404)
+          else
+            present data, with: Entities::IPAddress
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Mihari
+  module Endpoints
+    class Sources < Grape::API
+      namespace :sources do
+        desc "Get sources", {
+          is_array: true,
+          success: Entities::Sources
+        }
+        get "/" do
+          sources = Mihari::Alert.distinct.pluck(:source)
+          present({ sources: sources }, with: Entities::Sources)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Mihari
+  module Endpoints
+    class Tags < Grape::API
+      namespace :tags do
+        desc "Get tags", {
+          is_array: true,
+          success: Entities::Tags
+        }
+        get "/" do
+          tags = Mihari::Tag.distinct.pluck(:name)
+          present({ tags: tags }, with: Entities::Tags)
+        end
+
+        desc "Delete a tag", {
+          success: Entities::Message,
+          failure: [{ code: 404, message: "Not found", model: Entities::Message }]
+        }
+        params do
+          requires :name, type: String
+        end
+        delete "/:name" do
+          name = params[:name].to_s
+
+          begin
+            Mihari::Tag.where(name: name).destroy_all
+          rescue ActiveRecord::RecordNotFound
+            error!({ message: "Name:#{name} is not found" }, 404)
+          end
+
+          status 204
+          present({ message: "" }, with: Entities::Message)
+        end
+      end
+    end
+  end
+end

data/lib/mihari/web/entities/alert.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Mihari
+  module Entities
+    class Alert < Grape::Entity
+      expose :id, documentation: { type: Integer, required: true }
+      expose :title, documentation: { type: String, required: true }
+      expose :description, documentation: { type: String, required: true }
+      expose :source, documentation: { type: String, required: true }
+      expose :created_at, documentation: { type: DateTime, required: true }, as: :createdAt
+
+      expose :artifacts, using: Entities::Artifact, documentation: { type: Entities::Artifact, is_array: true }
+      expose :tags, using: Entities::Tag, documentation: { type: Entities::Tag, is_array: true, required: true }
+    end
+
+    class AlertsWithPagination < Grape::Entity
+      expose :alerts, using: Entities::Alert, documentation: { type: Entities::Alert, is_array: true, required: true }
+      expose :total, documentation: { type: Integer, required: true }
+      expose :current_page, documentation: { type: Integer, required: true }, as: :currentPage
+      expose :page_size, documentation: { type: Integer, required: true }, as: :pageSize
+    end
+  end
+end

data/lib/mihari/web/entities/artifact.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Mihari
+  module Entities
+    class Artifact < Grape::Entity
+      expose :id, documentation: { type: Integer, required: true }
+      expose :data, documentation: { type: String, required: true }
+      expose :data_type, documentation: { type: String, required: true }, as: :dataType
+      expose :source, documentation: { type: String, required: true }
+      expose :tags, documentation: { type: String, is_array: true }
+
+      expose :autonomous_system, using: Entities::AutonomousSystem, documentation: { type: Entities::AutonomousSystem, required: false }, as: :autonomousSystem
+      expose :geolocation, using: Entities::Geolocation, documentation: { type: Entities::Geolocation, required: false }
+      expose :whois_record, using: Entities::WhoisRecord, documentation: { type: Entities::WhoisRecord, required: false }, as: :whoisRecord
+
+      expose :reverse_dns_names, using: Entities::ReverseDnsName, documentation: { type: Entities::ReverseDnsName, is_array: true, required: false }, as: :reverseDnsNames do |status, _options|
+        status.reverse_dns_names.length > 0 ? status.reverse_dns_names : nil
+      end
+      expose :dns_records, using: Entities::DnsRecord, documentation: { type: Entities::DnsRecord, is_array: true, required: false }, as: :dnsRecords do |status, _options|
+        status.dns_records.length > 0 ? status.dns_records : nil
+      end
+    end
+  end
+end

data/lib/mihari/web/entities/autonomous_system.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Mihari
+  module Entities
+    class AutonomousSystem < Grape::Entity
+      expose :asn, documentation: { type: Integer, required: true }
+    end
+  end
+end

data/lib/mihari/web/entities/command.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Mihari
+  module Entities
+    class CommandInput < Grape::Entity
+      expose :command, documentation: { type: String, required: true }
+    end
+
+    class CommandResult < Grape::Entity
+      expose :output, documentation: { type: String, required: true }
+      expose :success, documentation: { type: Grape::API::Boolean, required: true }
+    end
+  end
+end

data/lib/mihari/web/entities/config.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Mihari
+  module Entities
+    class ConfigStatus < Grape::Entity
+      expose :type, documentation: { type: String, required: true }
+      expose :values, documentation: { type: String, is_array: true, required: true }
+      expose :is_configured, documentation: { type: Grape::API::Boolean, required: true }, as: :isConfigured
+    end
+
+    class Config < Grape::Entity
+      expose :name, documentation: { type: String, required: true }
+      expose :status, using: Entities::ConfigStatus, documentation: { type: ConfigStatus, required: true }
+    end
+  end
+end