redhound 0.1.0 → 1.0.0

data/lib/redhound/receiver.rb

@@ -1,3 +1,4 @@
+# rbs_inline: enabled
 # frozen_string_literal: true
 
 require 'socket'
@@ -5,21 +6,40 @@ require 'socket'
 module Redhound
   class Receiver
     class << self
-      def run(ifname:)
-        new(ifname:).run
+      # @rbs (ifname: String, filename: String) -> void
+      def run(ifname:, filename:)
+        new(ifname:, filename:).run
       end
     end
 
-    def initialize(ifname:)
+    # @rbs (ifname: String, filename: String) -> void
+    def initialize(ifname:, filename:)
       @ifname = ifname
-      @socket = SocketBuilder.build(ifname:)
+      @source = Resolver.resolve(ifname:)
+      if filename
+        @writer = Writer.new(filename:)
+        @writer.start
+      end
+      @count = 0
     end
 
+    # @rbs () -> void
     def run
       loop do
-        msg, = @socket.recvfrom(2048)
-        Analyzer.analyze(msg:)
+        msg, = @source.next_packet
+        Analyzer.analyze(msg:, count: increment)
+        @writer&.write(msg:)
+      rescue Interrupt
+        @writer&.stop
+        break
       end
     end
+
+    private
+
+    # @rbs () -> Integer
+    def increment
+      @count.tap { @count += 1 }
+    end
   end
 end

data/lib/redhound/resolver.rb

@@ -0,0 +1,22 @@
+# rbs_inline: enabled
+# frozen_string_literal: true
+
+module Redhound
+  class Resolver
+    class << self
+      # @rbs (ifname: String) -> void
+      def resolve(ifname:)
+        new.resolve(ifname:)
+      end
+    end
+
+    # @rbs (ifname: String) -> Redhound::Source::Socket
+    def resolve(ifname:)
+      if RUBY_PLATFORM =~ /darwin/
+        raise 'Not implemented yet'
+      else
+        Redhound::Builder::Socket.build(ifname:)
+      end
+    end
+  end
+end

data/lib/redhound/source/socket.rb

@@ -0,0 +1,18 @@
+# rbs_inline: enabled
+# frozen_string_literal: true
+
+module Redhound
+  module Source
+    class Socket
+      # @rbs (socket: ::Socket) -> void
+      def initialize(socket:)
+        @socket = socket
+      end
+
+      # @rbs (Integer size) -> [String, Addrinfo]
+      def next_packet(size = 2048)
+        @socket.recvfrom(size)
+      end
+    end
+  end
+end

data/lib/redhound/source.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'source/socket'

data/lib/redhound/version.rb

@@ -1,5 +1,6 @@
+# rbs_inline: enabled
 # frozen_string_literal: true
 
 module Redhound
-  VERSION = '0.1.0'
+  VERSION = '1.0.0'
 end

data/lib/redhound/writer.rb

@@ -0,0 +1,53 @@
+# rbs_inline: enabled
+# frozen_string_literal: true
+
+module Redhound
+  class Writer
+    # @rbs (filename: String) -> void
+    def initialize(filename:)
+      @filename = filename
+    end
+
+    # @rbs () -> void
+    def start
+      @file = File.open(@filename, 'wb')
+      @file.write(file_header)
+    end
+
+    # @rbs (msg: String) -> void
+    def write(msg:)
+      @file.write(packet_record(Time.now, msg.bytesize, msg.bytesize))
+      @file.write(msg)
+    end
+
+    # @rbs () -> void
+    def stop
+      @file.close
+    end
+
+    private
+
+    # @rbs () -> String
+    def file_header
+      [
+        0xa1b2c3d4, # Magic Number (little-endian)
+        2,          # Version Major
+        4,          # Version Minor
+        0,          # Timezone offset (GMT)
+        0,          # Timestamp accuracy
+        65535,      # Snapshot length
+        1           # Link-layer header type (Ethernet)
+      ].pack('VvvVVVV')
+    end
+
+    # @rbs (Time timestamp, Integer captured_length, Integer original_length) -> String
+    def packet_record(timestamp, captured_length, original_length)
+      [
+        timestamp.to_i,           # Timestamp seconds
+        timestamp.usec || 0,      # Timestamp microseconds
+        captured_length,          # Captured packet length
+        original_length           # Original packet length
+      ].pack('VVVV')
+    end
+  end
+end

data/lib/redhound.rb

@@ -1,9 +1,13 @@
 # frozen_string_literal: true
 
 require_relative 'redhound/analyzer'
+require_relative 'redhound/builder'
 require_relative 'redhound/command'
-require_relative 'redhound/header'
-require_relative 'redhound/packet_mreq'
+require_relative 'redhound/l2'
+require_relative 'redhound/l3'
+require_relative 'redhound/l4'
 require_relative 'redhound/receiver'
-require_relative 'redhound/socket_builder'
+require_relative 'redhound/resolver'
+require_relative 'redhound/source'
 require_relative 'redhound/version'
+require_relative 'redhound/writer'

data/rbs_collection.lock.yaml

@@ -0,0 +1,20 @@
+---
+path: ".gem_rbs_collection"
+gems:
+- name: fileutils
+  version: '0'
+  source:
+    type: stdlib
+- name: rake
+  version: '13.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: f83c613ed7d038c0031f25fcbcdf12603ba36e79
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: socket
+  version: '0'
+  source:
+    type: stdlib
+gemfile_lock_path: Gemfile.lock

data/rbs_collection.yaml

@@ -0,0 +1,17 @@
+# Download sources
+sources:
+  - type: git
+    name: ruby/gem_rbs_collection
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    revision: main
+    repo_dir: gems
+
+# You can specify local directories as sources also.
+# - type: local
+#   path: path/to/your/local/repository
+
+# A directory to install the downloaded RBSs
+path: .gem_rbs_collection
+
+gems:
+  - name: socket

data/sig/generated/redhound/analyzer.rbs

@@ -0,0 +1,14 @@
+# Generated from lib/redhound/analyzer.rb with RBS::Inline
+
+module Redhound
+  class Analyzer
+    # @rbs (msg: String, count: Integer) -> void
+    def self.analyze: (msg: String, count: Integer) -> void
+
+    # @rbs (msg: String, count: Integer) -> void
+    def initialize: (msg: String, count: Integer) -> void
+
+    # @rbs () -> void
+    def analyze: () -> void
+  end
+end

data/sig/generated/redhound/builder/packet_mreq.rbs

@@ -0,0 +1,39 @@
+# Generated from lib/redhound/builder/packet_mreq.rb with RBS::Inline
+
+module Redhound
+  module Builder
+    class PacketMreq
+      PACKET_MR_PROMISC: ::Integer
+
+      # @rbs (ifname: String) -> void
+      def initialize: (ifname: String) -> void
+
+      # see: https://man7.org/linux/man-pages/man7/packet.7.html
+      # struct packet_mreq {
+      #   int            mr_ifindex;    /* interface index */
+      #   unsigned short mr_type;       /* action */
+      #   unsigned short mr_alen;       /* address length */
+      #   unsigned char  mr_address[8]; /* physical-layer address */
+      # };
+      # @rbs () -> String
+      def build: () -> String
+
+      # @rbs () -> String
+      def mr_ifindex: () -> String
+
+      private
+
+      # @rbs () -> Integer?
+      def index: () -> Integer?
+
+      # @rbs () -> String
+      def mr_type: () -> String
+
+      # @rbs () -> String
+      def mr_alen: () -> String
+
+      # @rbs () -> String
+      def mr_address: () -> String
+    end
+  end
+end

data/sig/generated/redhound/builder/socket.rbs

@@ -0,0 +1,24 @@
+# Generated from lib/redhound/builder/socket.rb with RBS::Inline
+
+module Redhound
+  module Builder
+    class Socket
+      SOL_PACKET: ::Integer
+
+      PACKET_ADD_MEMBERSHIP: ::Integer
+
+      ETH_P_ALL: ::Integer
+
+      PACKED_ETH_P_ALL: untyped
+
+      # @rbs (ifname: String) -> Redhound::Source::Socket
+      def self.build: (ifname: String) -> Redhound::Source::Socket
+
+      # @rbs (ifname: String) -> void
+      def initialize: (ifname: String) -> void
+
+      # @rbs () -> Redhound::Source::Socket
+      def build: () -> Redhound::Source::Socket
+    end
+  end
+end

data/sig/generated/redhound/command.rbs

@@ -0,0 +1,19 @@
+# Generated from lib/redhound/command.rb with RBS::Inline
+
+module Redhound
+  class Command
+    # @rbs () -> void
+    def initialize: () -> void
+
+    # @rbs (Array[untyped] argv) -> void
+    def run: (Array[untyped] argv) -> void
+
+    # @rbs (Array[untyped] argv) -> void
+    def parse: (Array[untyped] argv) -> void
+
+    private
+
+    # @rbs () -> void
+    def list_interfaces: () -> void
+  end
+end

data/sig/generated/redhound/l2/ether.rbs

@@ -0,0 +1,41 @@
+# Generated from lib/redhound/l2/ether.rb with RBS::Inline
+
+module Redhound
+  class L2
+    class Ether
+      attr_reader type: Protocol
+
+      # @rbs (bytes: Array[Integer], count: Integer) -> Redhound::L2::Ether
+      def self.generate: (bytes: Array[Integer], count: Integer) -> Redhound::L2::Ether
+
+      # @rbs (bytes: Array[Integer], count: Integer) -> void
+      def initialize: (bytes: Array[Integer], count: Integer) -> void
+
+      # @rbs () -> Integer
+      def size: () -> Integer
+
+      # @rbs () -> Redhound::L2::Ether
+      def generate: () -> Redhound::L2::Ether
+
+      # @rbs () -> void
+      def dump: () -> void
+
+      # @rbs () -> String
+      def to_s: () -> String
+
+      # @rbs () -> bool
+      def supported_type?: () -> bool
+
+      private
+
+      # @rbs () -> String
+      def dhost: () -> String
+
+      # @rbs () -> String
+      def shost: () -> String
+
+      # @rbs (Array[Integer] type) -> Integer
+      def hex_type: (Array[Integer] type) -> Integer
+    end
+  end
+end

data/sig/generated/redhound/l2/protocol.rbs

@@ -0,0 +1,15 @@
+# Generated from lib/redhound/l2/protocol.rb with RBS::Inline
+
+module Redhound
+  class L2
+    class Protocol
+      PROTO_TABLE: ::Hash[untyped, untyped]
+
+      # @rbs (protocol: Integer) -> void
+      def initialize: (protocol: Integer) -> void
+
+      # @rbs () -> String
+      def to_s: () -> String
+    end
+  end
+end

data/sig/generated/redhound/l3/arp.rbs

@@ -0,0 +1,57 @@
+# Generated from lib/redhound/l3/arp.rb with RBS::Inline
+
+module Redhound
+  class L3
+    class Arp < Base
+      # @rbs (bytes: Array[Integer]) -> Redhound::L3::Arp
+      def self.generate: (bytes: Array[Integer]) -> Redhound::L3::Arp
+
+      # @rbs (bytes: Array[Integer]) -> void
+      def initialize: (bytes: Array[Integer]) -> void
+
+      # @rbs () -> Redhound::L3::Arp
+      def generate: () -> Redhound::L3::Arp
+
+      # @rbs () -> Integer
+      def arp_size: () -> Integer
+
+      # @rbs () -> Integer
+      def size: () -> Integer
+
+      # @rbs () -> String
+      def to_s: () -> String
+
+      # @rbs () -> bool
+      def supported_protocol?: () -> bool
+
+      # @rbs () -> String?
+      def protocol: () -> String?
+
+      private
+
+      # @rbs () -> Integer
+      def htype: () -> Integer
+
+      # @rbs () -> Integer
+      def ptype: () -> Integer
+
+      # @rbs () -> Integer
+      def oper: () -> Integer
+
+      # @rbs () -> String
+      def sha: () -> String
+
+      # @rbs () -> String
+      def spa: () -> String
+
+      # @rbs () -> String
+      def tha: () -> String
+
+      # @rbs () -> String
+      def tpa: () -> String
+
+      # @rbs () -> Redhound::L3::Base?
+      def generate_l3: () -> Redhound::L3::Base?
+    end
+  end
+end

data/sig/generated/redhound/l3/base.rbs

@@ -0,0 +1,28 @@
+# Generated from lib/redhound/l3/base.rb with RBS::Inline
+
+module Redhound
+  class L3
+    class Base
+      # @rbs (bytes: Array[Integer]) -> Redhound::L3::Base
+      def self.generate: (bytes: Array[Integer]) -> Redhound::L3::Base
+
+      # @rbs (bytes: Array[Integer]) -> void
+      def initialize: (bytes: Array[Integer]) -> void
+
+      # @rbs () -> Redhound::L3::Base
+      def generate: () -> Redhound::L3::Base
+
+      # @rbs () -> void
+      def dump: () -> void
+
+      # @rbs () -> Integer
+      def size: () -> Integer
+
+      # @rbs () -> bool
+      def supported_protocol?: () -> bool
+
+      # @rbs () -> Protocol
+      def protocol: () -> Protocol
+    end
+  end
+end

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

@@ -0,0 +1,53 @@
+# Generated from lib/redhound/l3/ipv4.rb with RBS::Inline
+
+module Redhound
+  class L3
+    class Ipv4 < Base
+      # @rbs (bytes: Array[Integer]) -> Redhound::L3::Ipv4
+      def self.generate: (bytes: Array[Integer]) -> Redhound::L3::Ipv4
+
+      attr_reader protocol: Protocol
+
+      # @rbs (bytes: Array[Integer]) -> void
+      def initialize: (bytes: Array[Integer]) -> void
+
+      # @rbs () -> Redhound::L3::Ipv4
+      def generate: () -> Redhound::L3::Ipv4
+
+      # @rbs () -> Integer
+      def size: () -> Integer
+
+      # @rbs () -> String
+      def to_s: () -> String
+
+      # @rbs () -> bool
+      def supported_protocol?: () -> bool
+
+      private
+
+      # @rbs () -> Integer
+      def version: () -> Integer
+
+      # @rbs () -> Integer
+      def ihl: () -> Integer
+
+      # @rbs () -> Integer
+      def tot_len: () -> Integer
+
+      # @rbs () -> Integer
+      def id: () -> Integer
+
+      # @rbs () -> Integer
+      def frag_off: () -> Integer
+
+      # @rbs () -> Integer
+      def check: () -> Integer
+
+      # @rbs () -> String
+      def saddr: () -> String
+
+      # @rbs () -> String
+      def daddr: () -> String
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# Generated from lib/redhound/l3/ipv6.rb with RBS::Inline
+
+module Redhound
+  class L3
+    class Ipv6 < Base
+      # @rbs (bytes: Array[Integer]) -> Redhound::L3::Ipv6
+      def self.generate: (bytes: Array[Integer]) -> Redhound::L3::Ipv6
+
+      attr_reader protocol: Protocol
+
+      # @rbs (bytes: Array[Integer]) -> void
+      def initialize: (bytes: Array[Integer]) -> void
+
+      # @rbs () -> Integer
+      def size: () -> Integer
+
+      # @rbs () -> Redhound::L3::Ipv6
+      def generate: () -> Redhound::L3::Ipv6
+
+      # @rbs () -> String
+      def to_s: () -> String
+
+      # @rbs () -> bool
+      def supported_protocol?: () -> bool
+
+      private
+
+      # @rbs () -> Integer
+      def payload_length: () -> Integer
+
+      # @rbs () -> Integer
+      def saddr: () -> Integer
+
+      # @rbs () -> Integer
+      def daddr: () -> Integer
+    end
+  end
+end

data/sig/generated/redhound/l3/protocol.rbs

@@ -0,0 +1,16 @@
+# Generated from lib/redhound/l3/protocol.rb with RBS::Inline
+
+module Redhound
+  class L3
+    class Protocol
+      # refs: https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml#protocol-numbers-1
+      PROTO_TABLE: untyped
+
+      # @rbs (protocol: Integer) -> void
+      def initialize: (protocol: Integer) -> void
+
+      # @rbs () -> String
+      def to_s: () -> String
+    end
+  end
+end

data/sig/generated/redhound/l3/resolver.rbs

@@ -0,0 +1,16 @@
+# Generated from lib/redhound/l3/resolver.rb with RBS::Inline
+
+module Redhound
+  class L3
+    class Resolver
+      # @rbs (bytes: Array[Integer], l2: Redhound::L2::Ether) -> Redhound::L3::Base?
+      def self.resolve: (bytes: Array[Integer], l2: Redhound::L2::Ether) -> Redhound::L3::Base?
+
+      # @rbs (bytes: Array[Integer], l2: Redhound::L2::Ether) -> void
+      def initialize: (bytes: Array[Integer], l2: Redhound::L2::Ether) -> void
+
+      # @rbs () -> Redhound::L3::Base?
+      def resolve: () -> Redhound::L3::Base?
+    end
+  end
+end

data/sig/generated/redhound/l4/base.rbs

@@ -0,0 +1,19 @@
+# Generated from lib/redhound/l4/base.rb with RBS::Inline
+
+module Redhound
+  class L4
+    class Base
+      # @rbs (bytes: Array[Integer]) -> Redhound::L4::Base
+      def self.generate: (bytes: Array[Integer]) -> Redhound::L4::Base
+
+      # @rbs (bytes: Array[Integer]) -> void
+      def initialize: (bytes: Array[Integer]) -> void
+
+      # @rbs () -> Redhound::L4::Base
+      def generate: () -> Redhound::L4::Base
+
+      # @rbs () -> void
+      def dump: () -> void
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# Generated from lib/redhound/l4/icmp.rb with RBS::Inline
+
+module Redhound
+  class L4
+    class Icmp < Base
+      # @rbs (bytes: Array[Integer]) -> void
+      def initialize: (bytes: Array[Integer]) -> void
+
+      # @rbs () -> Redhound::L4::Icmp
+      def generate: () -> Redhound::L4::Icmp
+
+      # @rbs () -> Integer
+      def size: () -> Integer
+
+      # @rbs () -> String
+      def to_s: () -> String
+
+      private
+
+      # @rbs () -> Integer
+      def check: () -> Integer
+
+      # @rbs () -> Integer
+      def id: () -> Integer
+
+      # @rbs () -> Integer
+      def seq: () -> Integer
+
+      # @rbs () -> String
+      def data: () -> String
+    end
+  end
+end

data/sig/generated/redhound/l4/resolver.rbs

@@ -0,0 +1,16 @@
+# Generated from lib/redhound/l4/resolver.rb with RBS::Inline
+
+module Redhound
+  class L4
+    class Resolver
+      # @rbs (bytes: Array[Integer], l3: Redhound::L3::Base) -> Redhound::L4::Base?
+      def self.resolve: (bytes: Array[Integer], l3: Redhound::L3::Base) -> Redhound::L4::Base?
+
+      # @rbs (bytes: Array[Integer], l3: Redhound::L3::Base) -> void
+      def initialize: (bytes: Array[Integer], l3: Redhound::L3::Base) -> void
+
+      # @rbs () -> Redhound::L4::Base?
+      def resolve: () -> Redhound::L4::Base?
+    end
+  end
+end