mihari 3.6.0 → 3.6.1

data/sig/lib/mihari/notifiers/exception_notifier.rbs

@@ -0,0 +1,75 @@
+module Mihari
+  module Notifiers
+    class ExceptionNotifier
+      def initialize: () -> void
+
+      def valid?: () -> bool
+
+      def notify: (Exception exception) -> void
+
+      #
+      # Send notification to Slack
+      #
+      # @param [String] text
+      # @param [Array<Hash>] attachments
+      #
+      # @return [nil]
+      #
+      def notify_to_slack: (text: String text, attachments: Array[Hash[(String | Symbol), untyped]] attachments) -> void
+
+      #
+      # Send notification to STDOUT
+      #
+      # @param [Exception] exception
+      #
+      # @return [nil]
+      #
+      def notify_to_stdout: (Exception exception) -> void
+
+      #
+      # Convert exception to attachments (for Slack)
+      #
+      # @param [Exception] exception
+      # @param [String] clean_message
+      #
+      # @return [Array<Hash>]
+      #
+      def to_attachments: (Exception exception, String clean_message) -> ::Array[{ color: untyped, text: untyped, fields: untyped, :mrkdwn_in => ::Array["text" | "fields"] }]
+
+      #
+      # Convert exception class to text
+      #
+      # @param [Class<Exception>] exception_class
+      #
+      # @return [String]
+      #
+      def to_text: (singleton(Exception) exception_class) -> ::String
+
+      #
+      # Convert clean_message and backtrace into fields (for Slack)
+      #
+      # @param [String] clean_message
+      # @param [Array] backtrace
+      #
+      # @return [Array<Hash>]
+      #
+      def to_fields: (String clean_message, untyped backtrace) -> Array[Hash[(String | Symbol), untyped]]
+
+      #
+      # Hostname of runnning instance
+      #
+      # @return [String]
+      #
+      def hostname: () -> String
+
+      #
+      # Format backtrace in string
+      #
+      # @param [Array] backtrace
+      #
+      # @return [String]
+      #
+      def format_backtrace: (untyped backtrace) -> (nil | ::String)
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+module Mihari
+  module Notifiers
+    class Slack < Base
+      SLACK_WEBHOOK_URL_KEY: ::String
+
+      SLACK_CHANNEL_KEY: ::String
+
+      DEFAULT_USERNAME: ::String
+
+      #
+      # Slack channel to post
+      #
+      # @return [String]
+      #
+      def slack_channel: () -> String
+
+      #
+      # Slack webhook URL
+      #
+      # @return [String]
+      #
+      def slack_webhook_url: () -> String
+
+      #
+      # Check Slack webhook URL is set
+      #
+      # @return [Boolean]
+      #
+      def slack_webhook_url?: () -> bool
+
+      #
+      # Check Slack webhook URL is set. Alias of #slack_webhook_url?.
+      #
+      # @return [Boolean]
+      #
+      def valid?: () -> bool
+
+      #
+      # Send notification to Slack
+      #
+      # @param [String] text
+      # @param [Array<Hash>] attachments
+      # @param [Boolean] mrkdwn
+      #
+      # @return [nil]
+      #
+      def notify: (text: String text, ?attachments: Array[Hash[(String | Symbol), untyped]] attachments, ?mrkdwn: bool mrkdwn) -> untyped
+    end
+  end
+end

data/sig/lib/mihari/status.rbs

@@ -0,0 +1,25 @@
+module Mihari
+  class Status
+    def check: () -> Array[Hash[(String | Symbol), untyped]]
+
+    def self.check: () -> Array[Hash[(String | Symbol), untyped]]
+
+    private
+
+    #
+    # Statuses of analyzers and emitters
+    #
+    # @return [Array<Hash>]
+    #
+    def statuses: () -> Array[Hash[(String | Symbol), untyped]]
+
+    #
+    # Build a status of a class
+    #
+    # @param [Class<Mihari::Analyzers::Base>, Class<Mihari::Emitters::Base>] klass
+    #
+    # @return [Hash, nil]
+    #
+    def build_status: (singleton(Mihari::Analyzers::Base) | singleton(Mihari::Emitters::Base)) -> Hash[(String|Symbol), untyped]?
+  end
+end

data/sig/lib/mihari/structs/censys.rbs

@@ -0,0 +1,50 @@
+module Mihari
+  module Structs
+    module Censys
+      class AutonomousSystem
+        attr_reader asn: Integer
+
+        def self.from_dynamic!: (Hash[(String | Symbol), untyped] d) -> Mihari::Structs::Censys::AutonomousSystem
+      end
+
+      class Location
+        attr_reader country: String
+        attr_reader country_code: String
+
+        def self.from_dynamic!: (Hash[(String | Symbol), untyped] d) -> Mihari::Structs::Censys::Location
+      end
+
+      class Hit
+        attr_reader ip: String
+        attr_reader location: Mihari::Structs::Censys::Location
+        attr_reader autonomous_system: Mihari::Structs::Censys::AutonomousSystem
+
+        def self.from_dynamic!: (Hash[(String | Symbol), untyped] d) -> Mihari::Structs::Censys::Hit
+      end
+
+      class Links
+        attr_reader next: String
+        attr_reader prev: String
+
+        def self.from_dynamic!: (Hash[(String | Symbol), untyped] d) -> Mihari::Structs::Censys::Links
+      end
+
+      class Result
+        attr_reader query: String
+        attr_reader total: Integer
+        attr_reader hits: Array[Mihari::Structs::Censys::Hit]
+        attr_reader links: Mihari::Structs::Censys::Links
+
+        def self.from_dynamic!: (Hash[(String | Symbol), untyped] d) -> Mihari::Structs::Censys::Result
+      end
+
+      class Response
+        attr_reader code: Integer
+        attr_reader status: String
+        attr_reader result: Mihari::Structs::Censys::Result
+
+        def self.from_dynamic!: (Hash[(String | Symbol), untyped] d) -> Mihari::Structs::Censys::Response
+      end
+    end
+  end
+end

data/sig/lib/mihari/structs/onyphe.rbs

@@ -0,0 +1,25 @@
+module Mihari
+  module Structs
+    module Onyphe
+      class Result
+        attr_reader asn: String
+        attr_reader country_code: String?
+        attr_reader ip: String
+
+        def self.from_dynamic!: (Hash[(String | Symbol), untyped] d) -> Mihari::Structs::Onyphe::Result
+      end
+
+      class Response
+        attr_reader count: Integer
+        attr_reader error: Integer
+        attr_reader max_page: Integer
+        attr_reader page: String
+        attr_reader results: Array[Mihari::Structs::Onyphe::Result]
+        attr_reader status: String
+        attr_reader total: Integer
+
+        def self.from_dynamic!: (Hash[(String | Symbol), untyped] d) -> Mihari::Structs::Onyphe::Response
+      end
+    end
+  end
+end

data/sig/lib/mihari/structs/shodan.rbs

@@ -0,0 +1,28 @@
+module Mihari
+  module Structs
+    module Shodan
+      class Location
+        attr_reader country_code: String
+        attr_reader country_name: String
+
+        def self.from_dynamic!: (Hash[(String | Symbol), untyped] d) -> Mihari::Structs::Shodan::Location
+      end
+
+      class Match
+        attr_reader asn: String
+        attr_reader hostnames: Array[String]
+        attr_reader location: Mihari::Structs::Shodan::Location
+        attr_reader domains: Array[String]
+        attr_reader ip_str: String
+        def self.from_dynamic!: (Hash[(String | Symbol), untyped] d) -> Mihari::Structs::Shodan::Match
+      end
+
+      class Result
+        attr_reader matches: Array[Mihari::Structs::Shodan::Match]
+        attr_reader total: Integer
+
+        def self.from_dynamic!: (Hash[(String | Symbol), untyped] d) -> Mihari::Structs::Shodan::Result
+      end
+    end
+  end
+end

data/sig/lib/mihari/type_checker.rbs

@@ -0,0 +1,48 @@
+module Mihari
+  class TypeChecker
+    # extend Dry::Initializer
+
+    def initialize: (*untyped args, **untyped kwargs) -> void
+
+    # @return [true, false]
+    def hash?: () -> bool
+
+    # @return [true, false]
+    def ip?: () -> bool
+
+    # @return [true, false]
+    def domain?: () -> bool
+
+    # @return [true, false]
+    def url?: () -> bool
+
+    # @return [true, false]
+    def mail?: () -> bool
+
+    # @return [String, nil]
+    def type: () -> ("hash" | "ip" | "domain" | "url" | nil)
+
+    # @return [String, nil]
+    def detailed_type: () -> ("md5" | "sha1" | "sha256" | "sha512" | nil)
+
+    # @return [String, nil]
+    def self.type: (untyped data) -> String?
+
+    # @return [String, nil]
+    def self.detailed_type: (untyped data) -> String?
+
+    private
+
+    # @return [true, false]
+    def md5?: () -> bool
+
+    # @return [true, false]
+    def sha1?: () -> bool
+
+    # @return [true, false]
+    def sha256?: () -> bool
+
+    # @return [true, false]
+    def sha512?: () -> bool
+  end
+end

data/sig/lib/mihari/types.rbs

@@ -0,0 +1,17 @@
+module Mihari
+  module Types
+    Int: ::Integer
+
+    Nil: nil
+
+    Hash: Hash[(String | Symbol), untyped]
+
+    String: ::String
+
+    Double: (::Float | ::Integer)
+
+    DataTypes: Array[String]
+
+    AnalyzerTypes: Array[String]
+  end
+end

data/sig/lib/mihari/version.rbs

@@ -0,0 +1,3 @@
+module Mihari
+  VERSION: ::String
+end

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

@@ -0,0 +1,5 @@
+module Mihari
+  class App # < Sinatra::Base
+    def self.run!: (?port: ::Integer port, ?host: ::String host) -> void
+  end
+end

data/sig/lib/mihari.rbs

@@ -0,0 +1,57 @@
+class Configuration
+  attr_accessor binaryedge_api_key (): String?
+  attr_accessor censys_id (): String?
+  attr_accessor censys_secret (): String?
+  attr_accessor circl_passive_password (): String?
+  attr_accessor circl_passive_username (): String?
+  attr_accessor ipinfo_api_key (): String?
+  attr_accessor misp_api_endpoint (): String?
+  attr_accessor misp_api_key (): String?
+  attr_accessor onyphe_api_key (): String?
+  attr_accessor otx_api_key (): String?
+  attr_accessor passivetotal_api_key (): String?
+  attr_accessor passivetotal_username (): String?
+  attr_accessor pulsedive_api_key (): String?
+  attr_accessor securitytrails_api_key (): String?
+  attr_accessor shodan_api_key (): String?
+  attr_accessor slack_channel (): String?
+  attr_accessor slack_webhook_url (): String?
+  attr_accessor spyse_api_key (): String?
+  attr_accessor thehive_api_endpoint (): String?
+  attr_accessor thehive_api_key (): String?
+  attr_accessor urlscan_api_key (): String?
+  attr_accessor virustotal_api_key (): String?
+  attr_accessor zoomeye_api_key (): String?
+  attr_accessor webhook_url (): String?
+  attr_accessor webhook_use_json_body (): (bool | nil)
+  attr_accessor database (): String?
+
+  attr_reader values: Hash[(String | Symbol), String?]
+end
+
+module Mihari
+  def self.config: () -> Configuration
+
+  # extend Dry::Configurable
+
+  extend Mixins::Configuration
+
+  # include Mem
+
+  def self.emitters: () -> ::Array[singleton(Mihari::Emitters::Base)]
+
+  def self.analyzers: () -> ::Array[singleton(Mihari::Analyzers::Base)]
+
+  #
+  # Load configuration from YAML file
+  #
+  # @param [String] path Path to YAML file
+  #
+  # @return [nil]
+  #
+  def self.load_config_from_yaml: (String path) -> void
+end
+
+class Object
+  def truthy?: (untyped value) -> bool
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mihari
 version: !ruby/object:Gem::Version
-  version: 3.6.0
+  version: 3.6.1
 platform: ruby
 authors:
 - Manabu Niseki
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-08-24 00:00:00.000000000 Z
+date: 2021-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -178,6 +178,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: steep
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.45'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.45'
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
@@ -960,6 +974,7 @@ files:
 - ".github/ISSUE_TEMPLATE/feature_request.md"
 - ".github/workflows/test.yml"
 - ".gitignore"
+- ".gitmodules"
 - ".overcommit.yml"
 - ".rspec"
 - ".standard.yml"
@@ -967,6 +982,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- Steepfile
 - bin/console
 - bin/setup
 - build_frontend.sh
@@ -1135,6 +1151,90 @@ files:
 - lib/mihari/web/public/static/js/app.cccddb2b.js.map
 - mihari.gemspec
 - renovate.json
+- sig/lib/mihari.rbs
+- sig/lib/mihari/analyzers/base.rbs
+- sig/lib/mihari/analyzers/basic.rbs
+- sig/lib/mihari/analyzers/binaryedge.rbs
+- sig/lib/mihari/analyzers/censys.rbs
+- sig/lib/mihari/analyzers/circl.rbs
+- sig/lib/mihari/analyzers/crtsh.rbs
+- sig/lib/mihari/analyzers/dnpedia.rbs
+- sig/lib/mihari/analyzers/dnstwister.rbs
+- sig/lib/mihari/analyzers/onyphe.rbs
+- sig/lib/mihari/analyzers/otx.rbs
+- sig/lib/mihari/analyzers/passivetotal.rbs
+- sig/lib/mihari/analyzers/pulsedive.rbs
+- sig/lib/mihari/analyzers/rule.rbs
+- sig/lib/mihari/analyzers/securitytrails.rbs
+- sig/lib/mihari/analyzers/shodan.rbs
+- sig/lib/mihari/analyzers/spyse.rbs
+- sig/lib/mihari/analyzers/urlscan.rbs
+- sig/lib/mihari/analyzers/virustotal.rbs
+- sig/lib/mihari/analyzers/zoomeye.rbs
+- sig/lib/mihari/cli/analyzer.rbs
+- sig/lib/mihari/cli/base.rbs
+- sig/lib/mihari/cli/init.rbs
+- sig/lib/mihari/cli/main.rbs
+- sig/lib/mihari/cli/mixins/utils.rbs
+- sig/lib/mihari/cli/validator.rbs
+- sig/lib/mihari/commands/binaryedge.rbs
+- sig/lib/mihari/commands/censys.rbs
+- sig/lib/mihari/commands/circl.rbs
+- sig/lib/mihari/commands/crtsh.rbs
+- sig/lib/mihari/commands/dnpedia.rbs
+- sig/lib/mihari/commands/dnstwister.rbs
+- sig/lib/mihari/commands/init.rbs
+- sig/lib/mihari/commands/json.rbs
+- sig/lib/mihari/commands/onyphe.rbs
+- sig/lib/mihari/commands/otx.rbs
+- sig/lib/mihari/commands/passivetotal.rbs
+- sig/lib/mihari/commands/pulsedive.rbs
+- sig/lib/mihari/commands/search.rbs
+- sig/lib/mihari/commands/securitytrails.rbs
+- sig/lib/mihari/commands/shodan.rbs
+- sig/lib/mihari/commands/spyse.rbs
+- sig/lib/mihari/commands/urlscan.rbs
+- sig/lib/mihari/commands/validator.rbs
+- sig/lib/mihari/commands/virustotal.rbs
+- sig/lib/mihari/commands/web.rbs
+- sig/lib/mihari/commands/zoomeye.rbs
+- sig/lib/mihari/constants.rbs
+- sig/lib/mihari/database.rbs
+- sig/lib/mihari/emitters/base.rbs
+- sig/lib/mihari/emitters/database.rbs
+- sig/lib/mihari/emitters/misp.rbs
+- sig/lib/mihari/emitters/slack.rbs
+- sig/lib/mihari/emitters/stdout.rbs
+- sig/lib/mihari/emitters/the_hive.rbs
+- sig/lib/mihari/emitters/webhook.rbs
+- sig/lib/mihari/errors.rbs
+- sig/lib/mihari/mixins/configurable.rbs
+- sig/lib/mihari/mixins/configuration.rbs
+- sig/lib/mihari/mixins/disallowed_data_value.rbs
+- sig/lib/mihari/mixins/hash.rbs
+- sig/lib/mihari/mixins/refang.rbs
+- sig/lib/mihari/mixins/retriable.rbs
+- sig/lib/mihari/mixins/rule.rbs
+- sig/lib/mihari/models/alert.rbs
+- sig/lib/mihari/models/artifact.rbs
+- sig/lib/mihari/models/autonomous_system.rbs
+- sig/lib/mihari/models/dns.rbs
+- sig/lib/mihari/models/geolocation.rbs
+- sig/lib/mihari/models/reverse_dns.rbs
+- sig/lib/mihari/models/tag.rbs
+- sig/lib/mihari/models/tagging.rbs
+- sig/lib/mihari/models/whois.rbs
+- sig/lib/mihari/notifiers/base.rbs
+- sig/lib/mihari/notifiers/exception_notifier.rbs
+- sig/lib/mihari/notifiers/slack.rbs
+- sig/lib/mihari/status.rbs
+- sig/lib/mihari/structs/censys.rbs
+- sig/lib/mihari/structs/onyphe.rbs
+- sig/lib/mihari/structs/shodan.rbs
+- sig/lib/mihari/type_checker.rbs
+- sig/lib/mihari/types.rbs
+- sig/lib/mihari/version.rbs
+- sig/lib/mihari/web/app.rbs
 homepage: https://github.com/ninoseki/mihari
 licenses:
 - MIT