mihari 4.11.0 → 5.0.0

data/sig/lib/mihari/cli/main.rbs

@@ -1,9 +0,0 @@
-module Mihari
-  module CLI
-    class Main < Base
-      include Mihari::Commands::Search
-
-      include Mihari::Commands::Web
-    end
-  end
-end

data/sig/lib/mihari/cli/validator.rbs

@@ -1,7 +0,0 @@
-module Mihari
-  module CLI
-    class Validator < Base
-      include Mihari::Commands::Validator
-    end
-  end
-end

data/sig/lib/mihari/commands/init.rbs

@@ -1,9 +0,0 @@
-module Mihari
-  module Commands
-    module Initialization
-      include Mixins::Rule
-
-      def self.included: (untyped thor) -> untyped
-    end
-  end
-end

data/sig/lib/mihari/commands/json.rbs

@@ -1,7 +0,0 @@
-module Mihari
-  module Commands
-    module JSON
-      def self.included: (untyped thor) -> untyped
-    end
-  end
-end

data/sig/lib/mihari/commands/search.rbs

@@ -1,35 +0,0 @@
-module Mihari
-  module Commands
-    module Search
-      include Mixins::Rule
-
-      def self.included: (untyped thor) -> untyped
-
-      private
-
-      #
-      # Build a rule analyzer
-      #
-      # @param [String] title
-      # @param [String] description
-      # @param [Array<Hash>] queries
-      # @param [Array<String>, nil] tags
-      # @param [Array<String>, nil] allowed_data_types
-      # @param [Array<String>, nil] disallowed_data_values
-      # @param [String, nil] source
-      #
-      # @return [Mihari::Analyzers::Rule]
-      #
-      def build_rule_analyzer: (title: String title, description: String description, queries: Array[Hash[(String | Symbol), untyped]] queries, ?tags: Array[String]? tags, ?allowed_data_types: Array[String]? allowed_data_types, ?disallowed_data_values: Array[String]? disallowed_data_values, ?source: String? source, ?id: String? id) -> Mihari::Analyzers::Rule
-
-      #
-      # Run rule analyzer
-      #
-      # @param [Mihari::Analyzer::Rule] analyzer
-      #
-      # @return [nil]
-      #
-      def run_rule_analyzer: (Mihari::Analyzers::Rule analyzer, ?ignore_old_artifacts: bool ignore_old_artifacts, ?ignore_threshold: ::Integer ignore_threshold) -> untyped
-    end
-  end
-end

data/sig/lib/mihari/commands/validator.rbs

@@ -1,9 +0,0 @@
-module Mihari
-  module Commands
-    module Validator
-      include Mixins::Rule
-
-      def self.included: (untyped thor) -> untyped
-    end
-  end
-end

data/sig/lib/mihari/commands/web.rbs

@@ -1,7 +0,0 @@
-module Mihari
-  module Commands
-    module Web
-      def self.included: (untyped thor) -> untyped
-    end
-  end
-end

data/sig/lib/mihari/constants.rbs

@@ -1,5 +0,0 @@
-module Mihari
-  ALLOWED_DATA_TYPES: Array[String]
-
-  DEFAULT_EMITTERS: Array[Hash]
-end

data/sig/lib/mihari/database.rbs

@@ -1,25 +0,0 @@
-class InitialSchema
-  def change: () -> void
-end
-
-class AddeSourceToArtifactSchema
-  def change: () -> void
-end
-
-class EnrichmentsSchema
-  def change: () -> void
-end
-
-module Mihari
-  class Database
-    def self.connect: () -> void
-
-    def self.close: () -> void
-
-    def self.destroy!: () -> void
-  end
-end
-
-class Object
-  def adapter: () -> ("postgresql" | "mysql2" | "sqlite3")
-end

data/sig/lib/mihari/emitters/base.rbs

@@ -1,18 +0,0 @@
-module Mihari
-  module Emitters
-    class Base
-      include Mixins::Configurable
-
-      include Mixins::Retriable
-
-      def self.inherited: (untyped child) -> untyped
-
-      # @return [true, false]
-      def valid?: () -> bool
-
-      def run: (**untyped params) -> void
-
-      def emit: () -> void
-    end
-  end
-end

data/sig/lib/mihari/emitters/database.rbs

@@ -1,9 +0,0 @@
-module Mihari
-  module Emitters
-    class Database < Base
-      def valid?: () -> bool
-
-      def emit: (title: String title, description: String description, artifacts: Array[Mihari::Artifact] artifacts, source: String source, ?tags: Array[String] tags) -> void
-    end
-  end
-end

data/sig/lib/mihari/emitters/http.rbs

@@ -1,35 +0,0 @@
-module Mihari
-  module Emitters
-    class PayloadTemplate < ERB
-      def self.template: () -> ::String
-
-      def initialize: (title: untyped title, description: untyped description, artifacts: untyped artifacts, source: untyped source, tags: untyped tags, ?options: ::Hash[untyped, untyped] options) -> void
-
-      def result: () -> untyped
-    end
-
-    class HTTP < Base
-      # @return [Addressable::URI, nil]
-      attr_reader uri: Addressable::URI?
-
-      # @return [Hash]
-      attr_reader http_request_headers: Hash
-
-      # @return [String]
-      attr_reader http_request_method: String
-
-      # @return [String, nil]
-      attr_reader template: String?
-
-      def initialize: (*untyped args, **untyped kwargs) -> void
-
-      def emit: (title: String title, artifacts: Array[Mihari::Artifact] artifacts, ?tags: Array[String] tags, **untyped _options) -> void
-
-      def valid?: () -> bool
-
-      private
-
-      def payload_as_string: (title: String title, description: String description, artifacts: Array[Mihari::Artifact] artifacts, source: String source, tags: Array[String] tags) -> String
-    end
-  end
-end

data/sig/lib/mihari/emitters/misp.rbs

@@ -1,34 +0,0 @@
-module Mihari
-  module Emitters
-    class MISP < Base
-
-      attr_reader url: String?
-
-      attr_reader api_key: String?
-
-
-      def initialize: () -> void
-
-      # @return [true, false]
-      def valid?: () -> bool
-
-      def emit: (title: String title, artifacts: Array[Mihari::Artifact] artifacts, ?tags: Array[String] tags, **untyped _options) -> void
-
-      private
-
-      def configuration_keys: () -> ::Array["misp_url" | "misp_api_key"]
-
-      def build_attribute: (Mihari::Artifact artifact) -> untyped
-
-      def hash_type: (String value) -> String?
-
-      def to_misp_type: (type: String `type`, value: String value) -> String?
-
-      def url?: () -> bool
-
-      def api_key?: () -> bool
-
-      def ping?: () -> bool
-    end
-  end
-end

data/sig/lib/mihari/emitters/slack.rbs

@@ -1,73 +0,0 @@
-module Mihari
-  module Emitters
-    class Attachment
-      attr_reader data: String
-      attr_reader data_type: String
-
-      # extend Dry::Initializer
-
-      def actions: () -> Array[Hash[(String | Symbol), untyped]]
-
-      def vt_link: () -> (nil | { :type => "button", text: "VirusTotal", url: String })
-
-      def urlscan_link: () -> (nil | { :type => "button", text: "urlscan.io", url: String })
-
-      def censys_link: () -> (nil | { :type => "button", text: "Censys", url: String })
-
-      def shodan_link: () -> (nil | { :type => "button", text: "Shodan", url: String })
-
-      # @return [Array]
-      def to_a: () -> ::Array[{ text: String, fallback: "VT & urlscan.io links", actions: Array[Hash[(String | Symbol), untyped]] }]
-
-      private
-
-      # @return [String]
-      def _urlscan_link: () -> String?
-
-      # @return [String]
-      def _vt_link: () -> String?
-
-      def _censys_link: () -> String?
-
-      def _shodan_link: () -> String?
-
-      # @return [String]
-      def sha256: () -> String
-
-      # @return [String]
-      def defanged_data: () -> String
-    end
-
-    class Slack < Base
-      DEFAULT_CHANNEL: String
-
-      DEFAULT_USERNAME: String
-
-      # @return [String, nil]
-      attr_reader webhook_url: String?
-
-      # @return [String]
-      attr_reader channel: String
-
-      # @return [String]
-      attr_reader username: String
-
-      #
-      # Check webhook URL is set
-      #
-      # @return [Boolean]
-      #
-      def webhook_url?: () -> bool
-
-      def notifier: () -> ::Slack::Notifier
-
-      def valid?: () -> bool
-
-      def to_attachments: (Array[Mihari::Artifact] artifacts) -> Array[Mihari::Emitters::Attachment]
-
-      def to_text: (title: String title, description: String description, ?tags: Array[String] tags) -> String
-
-      def emit: (title: String title, description: String description, artifacts: Array[Mihari::Artifact] artifacts, ?tags: Array[String] tags, **untyped _options) -> void
-    end
-  end
-end

data/sig/lib/mihari/emitters/stdout.rbs

@@ -1,9 +0,0 @@
-module Mihari
-  module Emitters
-    class StandardOutput < Base
-      def valid?: () -> ::TrueClass
-
-      def emit: (title: String title, description: String description, artifacts: Array[Mihari::Artifact] artifacts, source: String source, tags: Array[String] tags) -> void
-    end
-  end
-end

data/sig/lib/mihari/emitters/the_hive.rbs

@@ -1,32 +0,0 @@
-module Mihari
-  module Emitters
-    class TheHive < Base
-      attr_reader url: String?
-
-      attr_reader api_key: String?
-
-      attr_reader api_version: String?
-
-      # @return [true, false]
-      def valid?: () -> bool
-
-      def emit: (title: untyped title, description: untyped description, artifacts: untyped artifacts, ?tags: untyped tags, **untyped _options) -> (nil | untyped)
-
-      def normalized_api_version: () -> String?
-
-      private
-
-      def configuration_keys: () -> ::Array["thehive_url" | "thehive_api_key"]
-
-      def api: () -> untyped
-
-      # @return [true, false]
-      def url?: () -> bool
-
-      # @return [true, false]
-      def api_key?: () -> bool
-
-      def ping?: () -> bool
-    end
-  end
-end

data/sig/lib/mihari/emitters/webhook.rbs

@@ -1,20 +0,0 @@
-module Mihari
-  module Emitters
-    class Webhook < Base
-      # @return [true, false]
-      def valid?: () -> bool
-
-      def emit: (title: String title, description: String description, artifacts: Array[Mihari::Artifact] artifacts, source: String source, tags: Array[String] tags) -> void
-
-      private
-
-      def configuration_keys: () -> ::Array["webhook_url"]
-
-      def webhook_url: () -> String?
-
-      def webhook_url?: () -> bool
-
-      def use_json_body?: () -> bool?
-    end
-  end
-end

data/sig/lib/mihari/enrichers/base.rbs

@@ -1,12 +0,0 @@
-module Mihari
-  module Enrichers
-    class Base
-      include Mixins::Configurable
-
-      def self.inherited: (untyped child) -> untyped
-
-      # @return [Boolean]
-      def valid?: () -> bool
-    end
-  end
-end

data/sig/lib/mihari/enrichers/google_public_dns.rbs

@@ -1,18 +0,0 @@
-module Mihari
-  module Enrichers
-    class GooglePublicDNS < Base
-      # @return [Boolean]
-      def valid?: () -> true
-
-      #
-      # Query Google Public DNS
-      #
-      # @param [String] name
-      # @param [String] resource_type
-      #
-      # @return [Mihari::Structs::Shodan::GooglePublicDNS::Response, nil]
-      #
-      def self.query: (String name, String resource_type) -> Mihari::Structs::Shodan::GooglePublicDNS::Response?
-    end
-  end
-end

data/sig/lib/mihari/enrichers/ipinfo.rbs

@@ -1,16 +0,0 @@
-module Mihari
-  module Enrichers
-    class IPInfo
-      def valid?: () -> bool
-
-      #
-      # Query IPInfo
-      #
-      # @param [String] ip
-      #
-      # @return [Mihari::Structs::IPInfo::Response, nil]
-      #
-      def self.query: (String ip) -> Mihari::Structs::IPInfo::Response?
-    end
-  end
-end

data/sig/lib/mihari/errors.rbs

@@ -1,10 +0,0 @@
-module Mihari
-  class Error < StandardError
-  end
-
-  class InvalidInputError < Error
-  end
-
-  class RetryableError < Error
-  end
-end

data/sig/lib/mihari/feed/parser.rbs

@@ -1,11 +0,0 @@
-module Mihari
-  module Feed
-    class Parser
-      attr_reader data: Array[Hash] | Array[Array[String]]
-
-      def initialize: (Array[Hash] | Array[Array[String]] data) -> void
-
-      def parse: (String selector) -> Array[String]
-    end
-  end
-end

data/sig/lib/mihari/feed/reader.rbs

@@ -1,56 +0,0 @@
-module Mihari
-  class FeedReader
-    attr_reader uri: URI
-
-    attr_reader http_request_headers: Hash[(String | Symbol), untyped]
-
-    attr_reader http_request_method: String
-
-    attr_reader http_request_payload_type: String?
-
-    attr_reader http_request_payload: Hash[(String | Symbol), untyped]
-
-    def initialize: (
-      String uri,
-      ?http_request_headers: Hash[(String | Symbol), untyped] http_request_headers,
-      ?http_request_method: String http_request_method,
-      ?http_request_payload_type: String?  http_request_payload_type,
-      ?http_request_payload: Hash[(String | Symbol), untyped] http_request_payload
-    ) -> void
-
-    def read: () -> Array[Hash]
-
-    def get: () -> Array[Hash]
-
-    def post: () -> Array[Hash]
-
-    #
-    # Convert text as JSON
-    #
-    # @param [String] text
-    #
-    # @return [Array<Hash>]
-    #
-    def convert_as_json: (String text) -> Array[Hash]
-
-    #
-    # Convert text as CSV
-    #
-    # @param [String] text
-    #
-    # @return [Array<Hash>]
-    #
-    def convert_as_csv: (String text) -> Array[Hash]
-
-    def https_options: () -> ({ use_ssl: ::TrueClass } | ::Hash[untyped, untyped])
-
-    #
-    # Make a HTTP request
-    #
-    # @param [Net::HTTPRequest] req
-    #
-    # @return [Array<Hash>]
-    #
-    def request: (Net::HTTPRequest req) -> Array[Hash]
-  end
-end

data/sig/lib/mihari/http.rbs

@@ -1,64 +0,0 @@
-
-module Mihari
-  class HTTP
-    attr_reader uri: URI
-
-    attr_reader headers: Hash[(String | Symbol), untyped]
-
-    attr_reader payload: Hash[(String | Symbol), untyped]
-
-    def initialize: (
-      String uri,
-      ?headers: Hash[(String | Symbol), untyped] headers,
-      ?payload: Hash[(String | Symbol), untyped] payload
-    ) -> void
-
-    #
-    # Make a GET request
-    #
-    # @return [Net::HTTPResponse]
-    #
-    def get: () -> Net::HTTPResponse
-
-    #
-    # Make a POST request
-    #
-    # @return [Net::HTTPResponse]
-    #
-    def post: () -> Net::HTTPResponse
-
-    def self.get: (
-      String uri,
-      ?headers: Hash[(String | Symbol), untyped] headers,
-      ?payload_type: String? payload_type,
-      ?payload: Hash[(String | Symbol), untyped] payload
-    ) -> Net::HTTPResponse
-
-    def self.post: (
-      String uri,
-      ?headers: Hash[(String | Symbol), untyped] headers,
-      ?payload_type: String? payload_type,
-      ?payload: Hash[(String | Symbol), untyped] payload
-    ) -> Net::HTTPResponse
-
-    private
-
-    def content_type: () -> String
-
-    #
-    # Get options for HTTP request
-    #
-    # @return [Hahs]
-    #
-    def https_options: () -> ({ use_ssl: ::TrueClass } | ::Hash[untyped, untyped])
-
-    #
-    # Make a HTTP request
-    #
-    # @param [Net::HTTPRequest] req
-    #
-    # @return [Net::HTTPResponse]
-    #
-    def request: (untyped req) -> Net::HTTPResponse
-  end
-end

data/sig/lib/mihari/mixins/autonomous_system.rbs

@@ -1,14 +0,0 @@
-module Mihari
-  module Mixins
-    module AutonomousSystem
-      #
-      # Normalize ASN value
-      #
-      # @param [String, Integer] asn
-      #
-      # @return [Integer]
-      #
-      def normalize_asn: (String | Integer asn) -> Integer
-    end
-  end
-end

data/sig/lib/mihari/mixins/configurable.rbs

@@ -1,30 +0,0 @@
-module Mihari
-  module Mixins
-    module Configurable
-      #
-      # Check whether it is configured or not
-      #
-      # @return [Boolean]
-      #
-      def configured?: () -> bool
-
-      private
-
-      #
-      # Configuration values
-      #
-      # @return [Array<Hash>, nil] Configuration values as a list of hash. Returns nil if there is any keys.
-      #
-      def configuration_values: () -> untyped
-
-      #
-      # Configuration keys
-      #
-      # @return [Array<String>] A list of cofiguration keys
-      #
-      def configuration_keys: () -> Array[String]
-
-      def api_key?: () -> bool
-    end
-  end
-end

data/sig/lib/mihari/mixins/configuration.rbs

@@ -1,45 +0,0 @@
-module Mihari
-  module Mixins
-    module Configuration
-      #
-      # Load config file into hash
-      #
-      # @param [String] path Path to YAML file
-      #
-      # @return [Hash]
-      #
-      def load_config: (String path) -> Hash
-
-      #
-      # Validate config schema
-      #
-      # @param [Hash] config
-      #
-      def validate_config: (Hash config) -> void
-
-      #
-      # Returns a template for config
-      #
-      # @return [String] A template for config
-      #
-      def config_template: () -> String
-
-      #
-      # Create (blank) config file
-      #
-      # @param [String] filename
-      # @param [Dry::Files] files
-      # @param [String] template
-      #
-      # @return [nil]
-      #
-      def initialize_config_yaml: (String filename, ?untyped files, ?template: String template) -> nil
-
-      private
-
-      def show_validation_errors: (untyped errors) -> void
-
-      def _load_config: (String path) -> untyped
-    end
-  end
-end

data/sig/lib/mihari/mixins/disallowed_data_value.rbs

@@ -1,23 +0,0 @@
-module Mihari
-  module Mixins
-    module DisallowedDataValue
-      #
-      # Normalize a value as a disallowed data value
-      #
-      # @param [String] value Data value
-      #
-      # @return [String, Regexp] Normalized value
-      #
-      def normalize_disallowed_data_value: (String value) -> (String | Regexp)
-
-      #
-      # Check whetehr a value is valid format as a disallowed data value
-      #
-      # @param [String] value Data value
-      #
-      # @return [Boolean] true if it is valid, otherwise false
-      #
-      def valid_disallowed_data_value?: (String value) -> bool
-    end
-  end
-end