redhound 1.0.1 → 2.0.0.rc2

data/sig/generated/redhound/protocols/ethernet.rbs

@@ -0,0 +1,15 @@
+# Generated from lib/redhound/protocols/ethernet.rb with RBS::Inline
+
+module Redhound
+  # @api private
+  module Protocols
+    # @api private
+    class Ethernet < Dissector
+      # @rbs (Context ctx, Layer layer) -> void
+      def dissect: (Context ctx, Layer layer) -> void
+
+      # @rbs (Context ctx, Layer layer) -> untyped
+      def next_dissector: (Context ctx, Layer layer) -> untyped
+    end
+  end
+end

data/sig/generated/redhound/protocols/http.rbs

@@ -0,0 +1,36 @@
+# Generated from lib/redhound/protocols/http.rb with RBS::Inline
+
+module Redhound
+  # @api private
+  module Protocols
+    # @api private
+    class Http < StreamDissector
+      HEADER_LIMIT: ::Integer
+
+      TOKEN: ::Regexp
+
+      HEADERS: untyped
+
+      # @rbs (Context ctx, Cursor cursor) -> bool
+      def self.heuristic?: (Context ctx, Cursor cursor) -> bool
+
+      # @rbs (Context ctx, Layer layer) -> void
+      def dissect: (Context ctx, Layer layer) -> void
+
+      # @rbs (Layer layer, String line, Integer offset, bool response) -> Integer
+      def start_line: (Layer layer, String line, Integer offset, bool response) -> Integer
+
+      # @rbs (Layer layer, String bytes, Integer pos, Integer ending) -> Hash[String, Array[String]]
+      def parse_headers: (Layer layer, String bytes, Integer pos, Integer ending) -> Hash[String, Array[String]]
+
+      # @rbs (Layer layer, String bytes, Integer pos) -> [String, Integer]
+      def chunked: (Layer layer, String bytes, Integer pos) -> [ String, Integer ]
+
+      # @rbs (Layer layer, String name, untyped value, Symbol type, Integer offset, Integer length) -> void
+      def put: (Layer layer, String name, untyped value, Symbol type, Integer offset, Integer length) -> void
+
+      # @rbs (Layer layer) -> String
+      def summary: (Layer layer) -> String
+    end
+  end
+end

data/sig/generated/redhound/protocols/icmp.rbs

@@ -0,0 +1,41 @@
+# Generated from lib/redhound/protocols/icmp.rb with RBS::Inline
+
+module Redhound
+  # @api private
+  module Protocols
+    # @api private
+    class Icmp < Dissector
+      TYPES: untyped
+
+      CODES: untyped
+
+      # @rbs (Context ctx, Layer layer) -> void
+      def dissect: (Context ctx, Layer layer) -> void
+
+      # @rbs (Context ctx, Layer layer) -> untyped
+      def next_dissector: (Context ctx, Layer layer) -> untyped
+
+      # @rbs (Layer layer) -> String
+      def summary: (Layer layer) -> String
+    end
+
+    # @api private
+    class Icmpv6 < Dissector
+      TYPES: untyped
+
+      CODES: untyped
+
+      # @rbs (Context ctx, Layer layer) -> void
+      def dissect: (Context ctx, Layer layer) -> void
+
+      # @rbs (Context ctx, Layer layer) -> untyped
+      def next_dissector: (Context ctx, Layer layer) -> untyped
+    end
+
+    # @api private
+    class Igmp < Dissector
+      # @rbs (Context ctx, Layer layer) -> void
+      def dissect: (Context ctx, Layer layer) -> void
+    end
+  end
+end

data/sig/generated/redhound/protocols/ipv4.rbs

@@ -0,0 +1,15 @@
+# Generated from lib/redhound/protocols/ipv4.rb with RBS::Inline
+
+module Redhound
+  # @api private
+  module Protocols
+    # @api private
+    class Ipv4 < Dissector
+      # @rbs (Context ctx, Layer layer) -> void
+      def dissect: (Context ctx, Layer layer) -> void
+
+      # @rbs (Context ctx, Layer layer) -> untyped
+      def next_dissector: (Context ctx, Layer layer) -> untyped
+    end
+  end
+end

data/sig/generated/redhound/protocols/ipv6.rbs

@@ -0,0 +1,24 @@
+# Generated from lib/redhound/protocols/ipv6.rb with RBS::Inline
+
+module Redhound
+  # @api private
+  module Protocols
+    # @api private
+    class Ipv6 < Dissector
+      # @rbs (Context ctx, Layer layer) -> void
+      def dissect: (Context ctx, Layer layer) -> void
+
+      # @rbs (Context ctx, Layer layer) -> untyped
+      def next_dissector: (Context ctx, Layer layer) -> untyped
+    end
+
+    # @api private
+    class Ipv6Ext < Dissector
+      # @rbs (Context ctx, Layer layer) -> void
+      def dissect: (Context ctx, Layer layer) -> void
+
+      # @rbs (Context ctx, Layer layer) -> untyped
+      def next_dissector: (Context ctx, Layer layer) -> untyped
+    end
+  end
+end

data/sig/generated/redhound/protocols/link.rbs

@@ -0,0 +1,33 @@
+# Generated from lib/redhound/protocols/link.rb with RBS::Inline
+
+module Redhound
+  # @api private
+  module Protocols
+    # @api private
+    class Sll < Dissector
+      # @rbs (Context ctx, Layer layer) -> untyped
+      def next_dissector: (Context ctx, Layer layer) -> untyped
+    end
+
+    # @api private
+    class Sll2 < Dissector
+      # @rbs (Context ctx, Layer layer) -> untyped
+      def next_dissector: (Context ctx, Layer layer) -> untyped
+    end
+
+    # @api private
+    class Null < Dissector
+      # @rbs (Context ctx, Layer layer) -> void
+      def dissect: (Context ctx, Layer layer) -> void
+
+      # @rbs (Context ctx, Layer layer) -> untyped
+      def next_dissector: (Context ctx, Layer layer) -> untyped
+    end
+
+    # @api private
+    class Raw < Dissector
+      # @rbs (Context ctx, Layer layer) -> untyped
+      def next_dissector: (Context ctx, Layer layer) -> untyped
+    end
+  end
+end

data/sig/generated/redhound/protocols/llc.rbs

@@ -0,0 +1,15 @@
+# Generated from lib/redhound/protocols/llc.rb with RBS::Inline
+
+module Redhound
+  # @api private
+  module Protocols
+    # @api private
+    class Llc < Dissector
+      # @rbs (Context ctx, Layer layer) -> void
+      def dissect: (Context ctx, Layer layer) -> void
+
+      # @rbs (Context ctx, Layer layer) -> untyped
+      def next_dissector: (Context ctx, Layer layer) -> untyped
+    end
+  end
+end

data/sig/generated/redhound/protocols/ntp.rbs

@@ -0,0 +1,17 @@
+# Generated from lib/redhound/protocols/ntp.rb with RBS::Inline
+
+module Redhound
+  # @api private
+  module Protocols
+    # @api private
+    class Ntp < Dissector
+      MODES: untyped
+
+      # @rbs (Context ctx, Layer layer) -> void
+      def dissect: (Context ctx, Layer layer) -> void
+
+      # @rbs (Layer layer) -> String
+      def summary: (Layer layer) -> String
+    end
+  end
+end

data/sig/generated/redhound/protocols/tcp.rbs

@@ -0,0 +1,25 @@
+# Generated from lib/redhound/protocols/tcp.rb with RBS::Inline
+
+module Redhound
+  # @api private
+  module Protocols
+    # @api private
+    class Tcp < Dissector
+      FLAGS: untyped
+
+      FLAG_FIELDS: untyped
+
+      # @rbs (Context ctx, Layer layer) -> void
+      def dissect: (Context ctx, Layer layer) -> void
+
+      # @rbs (Cursor cursor, Layer layer, Integer hlen) -> void
+      def options: (Cursor cursor, Layer layer, Integer hlen) -> void
+
+      # @rbs (Context ctx, Layer layer) -> untyped
+      def next_dissector: (Context ctx, Layer layer) -> untyped
+
+      # @rbs (Layer layer) -> String
+      def summary: (Layer layer) -> String
+    end
+  end
+end

data/sig/generated/redhound/protocols/tls.rbs

@@ -0,0 +1,51 @@
+# Generated from lib/redhound/protocols/tls.rb with RBS::Inline
+
+module Redhound
+  # @api private
+  module Protocols
+    # @api private
+    class Tls < StreamDissector
+      # @type ivar @ranges: Array[untyped]
+      # @api private
+      class BadLength < StandardError
+      end
+
+      CONTENT_TYPES: untyped
+
+      HANDSHAKES: untyped
+
+      # @rbs (Context ctx, Cursor cursor) -> bool
+      def self.heuristic?: (Context ctx, Cursor cursor) -> bool
+
+      # @rbs (Context ctx, Layer layer) -> void
+      def dissect: (Context ctx, Layer layer) -> void
+
+      # @rbs (Layer layer, Cursor cursor) -> void
+      def handshakes: (Layer layer, Cursor cursor) -> void
+
+      # @rbs (Layer layer, Cursor cursor, Integer type) -> void
+      def hello: (Layer layer, Cursor cursor, Integer type) -> void
+
+      # @rbs (Layer layer, Cursor cursor, Integer pos, bool client) -> void
+      def extensions: (Layer layer, Cursor cursor, Integer pos, bool client) -> void
+
+      # @rbs (Layer layer, Cursor cursor) -> void
+      def server_names: (Layer layer, Cursor cursor) -> void
+
+      # @rbs (Layer layer, Cursor cursor) -> void
+      def alpn: (Layer layer, Cursor cursor) -> void
+
+      # @rbs (Layer layer, Cursor cursor, bool client) -> void
+      def versions: (Layer layer, Cursor cursor, bool client) -> void
+
+      # @rbs (Integer logical) -> Integer
+      def wire_offset: (Integer logical) -> Integer
+
+      # @rbs (Layer layer, String name, untyped value, Symbol type, Integer offset, Integer length, ?bool handshake) -> void
+      def put: (Layer layer, String name, untyped value, Symbol type, Integer offset, Integer length, ?bool handshake) -> void
+
+      # @rbs (Layer layer) -> String
+      def summary: (Layer layer) -> String
+    end
+  end
+end

data/sig/generated/redhound/protocols/tunnel.rbs

@@ -0,0 +1,24 @@
+# Generated from lib/redhound/protocols/tunnel.rb with RBS::Inline
+
+module Redhound
+  # @api private
+  module Protocols
+    # @api private
+    class Gre < Dissector
+      # @rbs (Context ctx, Layer layer) -> void
+      def dissect: (Context ctx, Layer layer) -> void
+
+      # @rbs (Context ctx, Layer layer) -> untyped
+      def next_dissector: (Context ctx, Layer layer) -> untyped
+    end
+
+    # @api private
+    class Vxlan < Dissector
+      # @rbs (Context ctx, Layer layer) -> void
+      def dissect: (Context ctx, Layer layer) -> void
+
+      # @rbs (Context ctx, Layer layer) -> untyped
+      def next_dissector: (Context ctx, Layer layer) -> untyped
+    end
+  end
+end

data/sig/generated/redhound/protocols/udp.rbs

@@ -0,0 +1,18 @@
+# Generated from lib/redhound/protocols/udp.rb with RBS::Inline
+
+module Redhound
+  # @api private
+  module Protocols
+    # @api private
+    class Udp < Dissector
+      # @rbs (Context ctx, Layer layer) -> void
+      def dissect: (Context ctx, Layer layer) -> void
+
+      # @rbs (Context ctx, Layer layer) -> untyped
+      def next_dissector: (Context ctx, Layer layer) -> untyped
+
+      # @rbs (Layer layer) -> String
+      def summary: (Layer layer) -> String
+    end
+  end
+end

data/sig/generated/redhound/protocols/vlan.rbs

@@ -0,0 +1,12 @@
+# Generated from lib/redhound/protocols/vlan.rb with RBS::Inline
+
+module Redhound
+  # @api private
+  module Protocols
+    # @api private
+    class Vlan < Dissector
+      # @rbs (Context ctx, Layer layer) -> untyped
+      def next_dissector: (Context ctx, Layer layer) -> untyped
+    end
+  end
+end

data/sig/generated/redhound/reader.rbs

@@ -0,0 +1,7 @@
+# Generated from lib/redhound/reader.rb with RBS::Inline
+
+module Redhound
+  # Enumerable pcap/pcapng reader; inherited capture-source methods include stop and close.
+  class Reader < Capture::FileSource
+  end
+end

data/sig/generated/redhound/registry.rbs

@@ -0,0 +1,45 @@
+# Generated from lib/redhound/registry.rb with RBS::Inline
+
+module Redhound
+  # Protocol dispatch and per-session decode-as rules.
+  class Registry
+    # @rbs () -> Registry
+    # Shared registry populated by built-in and custom dissectors.
+    def self.default: () -> Registry
+
+    # Registered protocol identities and dispatch tables.
+    attr_reader protocols: untyped
+
+    # @rbs () -> void
+    # Create empty protocol dispatch tables.
+    def initialize: () -> void
+
+    # @rbs (String key, Integer value, untyped klass) -> void
+    # Register a class under a dispatch key and value.
+    def register: (String key, Integer value, untyped klass) -> void
+
+    # @rbs (untyped klass) -> void
+    # Register a protocol class by its declared identity.
+    def register_protocol: (untyped klass) -> void
+
+    # @rbs (String key, Integer value) -> untyped
+    # Look up a protocol class for a dispatch key and value.
+    def lookup: (String key, Integer value) -> untyped
+
+    # @rbs (String key, Integer src, Integer dst) -> untyped
+    # Resolve decode-as rules before registered low/high port dispatch.
+    def by_port: (String key, Integer src, Integer dst) -> untyped
+
+    # @rbs (Symbol parent, Context ctx, Cursor cursor) -> untyped
+    # Run registered transport heuristics on the bounded payload.
+    def heuristic: (Symbol parent, Context ctx, Cursor cursor) -> untyped
+
+    # @rbs (String rule) -> void
+    # Apply a transport-port override such as udp.port==8443,dns.
+    def decode_as: (String rule) -> void
+
+    # @rbs () -> Registry
+    # Copy tables and overrides for an independent analysis session.
+    def copy: () -> Registry
+  end
+end

data/sig/generated/redhound/stream_dissector.rbs

@@ -0,0 +1,44 @@
+# Generated from lib/redhound/stream_dissector.rb with RBS::Inline
+
+module Redhound
+  # A stateful TCP dissector. Instances belong to one bidirectional flow.
+  # Override on_data/on_gap for custom stream protocols; built-in framing is
+  # shared with the packet dissectors so validation has one implementation.
+  class StreamDissector < Dissector
+    # @rbs (?registry: Registry, ?max_bytes: Integer) -> void
+    def initialize: (?registry: Registry, ?max_bytes: Integer) -> void
+
+    # @rbs (untyped stream, Integer direction, String data, Integer frame) -> Array[Layer]
+    def on_data: (untyped stream, Integer direction, String data, Integer frame) -> Array[Layer]
+
+    # @rbs (untyped stream, Integer direction, Integer length) -> Array[Layer]
+    def on_gap: (untyped stream, Integer direction, Integer length) -> Array[Layer]
+
+    # @rbs (untyped stream, Integer direction) -> Array[Layer]
+    def on_close: (untyped stream, Integer direction) -> Array[Layer]
+
+    # @rbs () -> Integer
+    def bytesize: () -> Integer
+
+    # @rbs (Integer direction, Integer length) -> Array[Integer]
+    def consume_origins: (Integer direction, Integer length) -> Array[Integer]
+
+    # @rbs (String bytes, ?tls_encrypted: bool, ?head_response: bool) -> Layer
+    def parse_pdu: (String bytes, ?tls_encrypted: bool, ?head_response: bool) -> Layer
+
+    # @rbs (String buffer, ?Integer direction, ?head_response: bool) -> Integer?
+    def pdu_length: (String buffer, ?Integer direction, ?head_response: bool) -> Integer?
+
+    # @rbs (String buffer, ?head_response: bool) -> Integer?
+    def http_length: (String buffer, ?head_response: bool) -> Integer?
+
+    # @rbs (untyped stream, Integer direction, String buffer) -> bool
+    def head_response?: (untyped stream, Integer direction, String buffer) -> bool
+
+    # @rbs (untyped stream, Integer direction, Layer layer) -> void
+    def record_http: (untyped stream, Integer direction, Layer layer) -> void
+
+    # @rbs (String buffer, Integer direction) -> Integer?
+    def tls_length: (String buffer, Integer direction) -> Integer?
+  end
+end

data/sig/generated/redhound/util/seq.rbs

@@ -0,0 +1,20 @@
+# Generated from lib/redhound/util/seq.rb with RBS::Inline
+
+module Redhound
+  # @api private
+  module Util
+    # @api private
+    module Seq
+      MOD: ::Integer
+
+      # @rbs (Integer a, Integer b) -> Integer
+      def self.diff: (Integer a, Integer b) -> Integer
+
+      # @rbs (Integer a, Integer b) -> bool
+      def self.lt: (Integer a, Integer b) -> bool
+
+      # @rbs (Integer a, Integer b) -> Integer
+      def self.signed_diff: (Integer a, Integer b) -> Integer
+    end
+  end
+end

data/sig/generated/redhound/version.rbs

@@ -1,5 +1,6 @@
 # Generated from lib/redhound/version.rb with RBS::Inline
 
 module Redhound
+  # Published gem version.
   VERSION: ::String
 end

data/sig/generated/redhound/writer.rbs

@@ -1,25 +1,12 @@
 # Generated from lib/redhound/writer.rb with RBS::Inline
 
 module Redhound
+  # Open pcap/pcapng outputs, optionally with bounded rotation.
   class Writer
-    # @rbs (filename: String) -> void
-    def initialize: (filename: String) -> void
-
-    # @rbs () -> void
-    def start: () -> void
-
-    # @rbs (msg: String) -> void
-    def write: (msg: String) -> void
-
-    # @rbs () -> void
-    def stop: () -> void
-
-    private
-
-    # @rbs () -> String
-    def file_header: () -> String
-
-    # @rbs (Time timestamp, Integer captured_length, Integer original_length) -> String
-    def packet_record: (Time timestamp, Integer captured_length, Integer original_length) -> String
+    # @rbs (untyped output, ?linktype: Integer | Symbol | String, ?format: Symbol | String | nil, ?snaplen: Integer, ?precision: Symbol, ?packet_buffered: bool, ?forbidden_input: String?, **untyped options) -> untyped
+    # @rbs [T] (untyped output, ?linktype: Integer | Symbol | String, ?format: Symbol | String | nil, ?snaplen: Integer, ?precision: Symbol, ?packet_buffered: bool, ?forbidden_input: String?, **untyped options) { (untyped) -> T } -> T
+    # Open a path or binary IO; close automatically with a block. See docs/API.md for options.
+    def self.open: (untyped output, ?linktype: Integer | Symbol | String, ?format: Symbol | String | nil, ?snaplen: Integer, ?precision: Symbol, ?packet_buffered: bool, ?forbidden_input: String?, **untyped options) -> untyped
+                 | [T] (untyped output, ?linktype: Integer | Symbol | String, ?format: Symbol | String | nil, ?snaplen: Integer, ?precision: Symbol, ?packet_buffered: bool, ?forbidden_input: String?, **untyped options) { (untyped) -> T } -> T
   end
 end

data/sig/generated/redhound.rbs

@@ -0,0 +1,18 @@
+# Generated from lib/redhound.rb with RBS::Inline
+
+# Capture, inspect and save network packets using Ruby standard libraries.
+module Redhound
+  # @rbs (String bytes, ?linktype: (Integer | Symbol), **untyped metadata) -> Packet
+  # Create a packet with lazy, bounded protocol dissection. See docs/API.md.
+  def self.dissect: (String bytes, ?linktype: Integer | Symbol, **untyped metadata) -> Packet
+
+  # @rbs (untyped input, ?filter: String?) -> Reader
+  # @rbs [T] (untyped input, ?filter: String?) { (Reader) -> T } -> T
+  # Read a pcap/pcapng path or binary IO; a block closes the reader automatically.
+  def self.open: (untyped input, ?filter: String?) -> Reader
+               | [T] (untyped input, ?filter: String?) { (Reader) -> T } -> T
+
+  # @rbs (interface: String | Integer, ?count: Integer?, **untyped options) { (Packet) -> void } -> void
+  # Yield live packets until count is reached or capture stops; always close the source.
+  def self.capture: (interface: String | Integer, ?count: Integer?, **untyped options) { (Packet) -> void } -> void
+end

data/sig/shims/io.rbs

@@ -0,0 +1,7 @@
+class IO
+  def self.select: (Array[IO]?, ?Array[IO]?, ?Array[IO]?, ?Numeric?) -> [Array[IO], Array[IO], Array[IO]]?
+end
+
+module Shellwords
+  def self.split: (String) -> Array[String]
+end

data/sig/shims/process.rbs

@@ -0,0 +1,3 @@
+module Process
+  def self.spawn: (*untyped, **untyped) -> Integer
+end