mihari 3.10.0 → 4.0.0

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

@@ -4,20 +4,11 @@ module Mihari
       #
       # Load rule into hash
       #
-      # @param [String] path Path to YAML file or YAML string
+      # @param [String] path_or_id
       #
-      # @return [Hash]
+      # @return [Mihari::Structs::Rule::Rule]
       #
-      def load_rule: (String path) -> Hash
-
-      #
-      # Validate rule schema and return a normalized rule
-      #
-      # @param [Hash] rule
-      #
-      # @return [Hash]
-      #
-      def validate_rule: (Hash rule) -> Hash
+      def load_rule: (String path_or_id) -> Mihari::Structs::Rule::Rule
 
       #
       # Returns a template for rule
@@ -26,6 +17,8 @@ module Mihari
       #
       def rule_template: () -> String
 
+      def validate_rule!: (Mihari::Structs::Rule::Rule rule) -> nil
+
       #
       # Create (blank) rule file
       #

data/sig/lib/mihari/models/alert.rbs

@@ -7,7 +7,7 @@ module Mihari
     attr_accessor artifacts(): Array[Mihari::Artifact]
     attr_accessor Tags(): Array[Mihari::Tag]
 
-    def self.search: (Mihari::Structs::Alert::SearchFilterWithPagination filter) -> Array[Hash[(String | Symbol), untyped]]
+    def self.search: (Mihari::Structs::Alert::SearchFilterWithPagination filter) -> Array[Mihari::Alert]
 
     def self.count: (Mihari::Structs::Alert::SearchFilter filter) -> Integer
 

data/sig/lib/mihari/models/artifact.rbs

@@ -7,6 +7,8 @@ module Mihari
     attr_accessor data (): String
     attr_accessor data_type (): String
 
+    attr_accessor metadata(): Hash?
+
     attr_accessor autonomous_system(): Mihari::AutonomousSystem
     attr_accessor geolocation (): Mihari::Geolocation
     attr_accessor whois_record(): Mihari::WhoisRecord

data/sig/lib/mihari/models/rule.rbs

@@ -0,0 +1,14 @@
+module Mihari
+  class Rule < ActiveRecord::Base
+    attr_accessor id(): String
+    attr_accessor title(): String
+    attr_accessor description(): String
+    attr_accessor data(): Hash
+
+    def to_h: () -> Hash
+
+    def self.search: (Mihari::Structs::Rule::SearchFilterWithPagination filter) -> Array[Mihari::Rule]
+
+    def self.count: (Mihari::Structs::Rule::SearchFilter filter) -> Integer
+  end
+end

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

@@ -13,7 +13,7 @@ module Mihari
         attr_reader dns_record: String?
         attr_reader reverse_dns_name: String?
 
-        def has_valid_artifact_filters: () -> bool
+        def valid_artifact_filters?: () -> bool
       end
 
       class SearchFilterWithPagination

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

@@ -6,14 +6,14 @@ module Mihari
         attr_reader country_code: String
         attr_reader asn: String
 
-        def self.from_dynamic!: (Hash[(String | Symbol), untyped] d) -> untyped
+        def self.from_dynamic!: (Hash[(String | Symbol), untyped] d) ->  Mihari::Structs::GreyNoise::Metadata
       end
 
       class Datum < Dry::Struct
         attr_reader ip: String
         attr_reader metadata: Mihari::Structs::GreyNoise::Metadata
 
-        def self.from_dynamic!: (Hash[(String | Symbol), untyped] d) -> untyped
+        def self.from_dynamic!: (Hash[(String | Symbol), untyped] d) -> Mihari::Structs::GreyNoise::Datum
       end
 
       class Response < Dry::Struct
@@ -23,7 +23,7 @@ module Mihari
         attr_reader message: String
         attr_reader query: String
 
-        def self.from_dynamic!: (Hash[(String | Symbol), untyped] d) -> untyped
+        def self.from_dynamic!: (Hash[(String | Symbol), untyped] d) -> Mihari::Structs::GreyNoise::Response
       end
     end
   end

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

@@ -0,0 +1,56 @@
+module Mihari
+  module Structs
+    module Rule
+      class SearchFilter < Dry::Struct
+      end
+
+      class SearchFilterWithPagination < SearchFilter
+        def without_pagination: () -> SearchFilter
+      end
+
+      class Rule
+        attr_reader data: Hash
+
+        attr_reader errors: Array[untypes]
+
+        def initialize: (Hash data) -> void
+
+        #
+        # @return [Boolean]
+        #
+        def errors?: () -> (bool)
+
+        #
+        # @return [Array[String]]
+        #
+        def error_messages: () -> (Array[String])
+
+        def validate: () -> void
+
+        def validate!: () -> void
+
+        def []: (untyped key) -> untyped
+
+        #
+        # @return [String]
+        #
+        def id: () -> String
+
+        #
+        # @return [String]
+        #
+        def title: () -> String
+
+        #
+        # @return [String]
+        #
+        def description: () -> String
+
+        #
+        # @return [Mihari::Rule]
+        #
+        def to_model: () -> Mihari::Rule
+      end
+    end
+  end
+end

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

@@ -2,8 +2,8 @@ module Mihari
   module Structs
     module Shodan
       class Location
-        attr_reader country_code: String
-        attr_reader country_name: String
+        attr_reader country_code: String?
+        attr_reader country_name: String?
 
         def self.from_dynamic!: (Hash[(String | Symbol), untyped] d) -> Mihari::Structs::Shodan::Location
       end

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

@@ -0,0 +1,28 @@
+module Mihari
+  module Structs
+    module Urlscan
+      class Page < Dry::Struct
+        attr_reader domain: String?
+        attr_reader ip: String?
+        attr_reader url: String
+
+        def self.from_dynamic!: (Hash[(String | Symbol), untyped] d) -> Mihari::Structs::Urlscan::Page
+      end
+
+      class Result < Dry::Struct
+        attr_reader page: Mihari::Structs::Urlscan::Page
+        attr_reader id: String
+        attr_reader sort: Array[Integer | String]
+
+        def self.from_dynamic!: (Hash[(String | Symbol), untyped] d) -> Mihari::Structs::Urlscan::Result
+      end
+
+      class Response < Dry::Struct
+        attr_reader results: Array[Mihari::Structs::Urlscan::Result]
+        attr_reader has_more: Boolean
+
+        def self.from_dynamic!: (Hash[(String | Symbol), untyped] d) -> Mihari::Structs::Urlscan::Response
+      end
+    end
+  end
+end

data/sig/lib/mihari/types.rbs

@@ -13,5 +13,9 @@ module Mihari
     DataTypes: Array[String]
 
     AnalyzerTypes: Array[String]
+
+    FeedHttpRequestMethods: Array[String]
+
+    FeedHttpRequestPayloadTypes: Array[String]
   end
 end

data/sig/lib/mihari.rbs

@@ -36,8 +36,6 @@ module Mihari
 
   extend Mixins::Configuration
 
-  # include Mem
-
   def self.emitters: () -> ::Array[singleton(Mihari::Emitters::Base)]
 
   def self.analyzers: () -> ::Array[singleton(Mihari::Analyzers::Base)]