redhound 0.1.0 → 1.0.0

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

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

data/sig/generated/redhound/receiver.rbs

@@ -0,0 +1,19 @@
+# Generated from lib/redhound/receiver.rb with RBS::Inline
+
+module Redhound
+  class Receiver
+    # @rbs (ifname: String, filename: String) -> void
+    def self.run: (ifname: String, filename: String) -> void
+
+    # @rbs (ifname: String, filename: String) -> void
+    def initialize: (ifname: String, filename: String) -> void
+
+    # @rbs () -> void
+    def run: () -> void
+
+    private
+
+    # @rbs () -> Integer
+    def increment: () -> Integer
+  end
+end

data/sig/generated/redhound/resolver.rbs

@@ -0,0 +1,11 @@
+# Generated from lib/redhound/resolver.rb with RBS::Inline
+
+module Redhound
+  class Resolver
+    # @rbs (ifname: String) -> void
+    def self.resolve: (ifname: String) -> void
+
+    # @rbs (ifname: String) -> Redhound::Source::Socket
+    def resolve: (ifname: String) -> Redhound::Source::Socket
+  end
+end

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

@@ -0,0 +1,13 @@
+# Generated from lib/redhound/source/socket.rb with RBS::Inline
+
+module Redhound
+  module Source
+    class Socket
+      # @rbs (socket: ::Socket) -> void
+      def initialize: (socket: ::Socket) -> void
+
+      # @rbs (Integer size) -> [String, Addrinfo]
+      def next_packet: (Integer size) -> [ String, Addrinfo ]
+    end
+  end
+end

data/sig/generated/redhound/version.rbs

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

data/sig/generated/redhound/writer.rbs

@@ -0,0 +1,25 @@
+# Generated from lib/redhound/writer.rb with RBS::Inline
+
+module Redhound
+  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
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: redhound
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Yudai Takada
 bindir: exe
 cert_chain: []
-date: 2024-11-05 00:00:00.000000000 Z
+date: 2025-01-17 00:00:00.000000000 Z
 dependencies: []
 description: Redhound is a pure Ruby packet analyzer that can be used to capture and
   analyze network packets.
@@ -24,21 +24,59 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- Steepfile
 - docker-compose.yml
 - exe/redhound
 - lib/redhound.rb
 - lib/redhound/analyzer.rb
+- lib/redhound/builder.rb
+- lib/redhound/builder/packet_mreq.rb
+- lib/redhound/builder/socket.rb
 - lib/redhound/command.rb
-- lib/redhound/header.rb
-- lib/redhound/header/ether.rb
-- lib/redhound/header/icmp.rb
-- lib/redhound/header/ipv4.rb
-- lib/redhound/header/udp.rb
-- lib/redhound/packet_mreq.rb
+- lib/redhound/l2.rb
+- lib/redhound/l2/ether.rb
+- lib/redhound/l2/protocol.rb
+- lib/redhound/l3.rb
+- lib/redhound/l3/arp.rb
+- lib/redhound/l3/base.rb
+- lib/redhound/l3/ipv4.rb
+- lib/redhound/l3/ipv6.rb
+- lib/redhound/l3/protocol.rb
+- lib/redhound/l3/resolver.rb
+- lib/redhound/l4.rb
+- lib/redhound/l4/base.rb
+- lib/redhound/l4/icmp.rb
+- lib/redhound/l4/resolver.rb
+- lib/redhound/l4/udp.rb
 - lib/redhound/receiver.rb
-- lib/redhound/socket_builder.rb
+- lib/redhound/resolver.rb
+- lib/redhound/source.rb
+- lib/redhound/source/socket.rb
 - lib/redhound/version.rb
-- sig/redhound.rbs
+- lib/redhound/writer.rb
+- rbs_collection.lock.yaml
+- rbs_collection.yaml
+- sig/generated/redhound/analyzer.rbs
+- sig/generated/redhound/builder/packet_mreq.rbs
+- sig/generated/redhound/builder/socket.rbs
+- sig/generated/redhound/command.rbs
+- sig/generated/redhound/l2/ether.rbs
+- sig/generated/redhound/l2/protocol.rbs
+- sig/generated/redhound/l3/arp.rbs
+- sig/generated/redhound/l3/base.rbs
+- sig/generated/redhound/l3/ipv4.rbs
+- sig/generated/redhound/l3/ipv6.rbs
+- sig/generated/redhound/l3/protocol.rbs
+- sig/generated/redhound/l3/resolver.rbs
+- sig/generated/redhound/l4/base.rbs
+- sig/generated/redhound/l4/icmp.rbs
+- sig/generated/redhound/l4/resolver.rbs
+- sig/generated/redhound/l4/udp.rbs
+- sig/generated/redhound/receiver.rbs
+- sig/generated/redhound/resolver.rbs
+- sig/generated/redhound/source/socket.rbs
+- sig/generated/redhound/version.rbs
+- sig/generated/redhound/writer.rbs
 homepage: https://github.com/ydah/redhound
 licenses:
 - MIT
@@ -63,7 +101,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.0.dev
+rubygems_version: 3.7.0.dev
 specification_version: 4
 summary: Pure Ruby packet analyzer
 test_files: []

data/lib/redhound/header/ether.rb

@@ -1,68 +0,0 @@
-# frozen_string_literal: true
-
-module Redhound
-  class Header
-    class Ether
-      ETH_P_IP = 0x0800
-
-      class << self
-        def generate(bytes:)
-          new(bytes:).generate
-        end
-      end
-
-      def initialize(bytes:)
-        raise ArgumentError, 'bytes must be 14 bytes' unless bytes.size == 14
-
-        @bytes = bytes
-      end
-
-      def generate
-        pp @bytes[0..5]
-        @dhost = @bytes[0..5]
-        @shost = @bytes[6..11]
-        @type = @bytes[12..13]
-        self
-      end
-
-      def ipv4?
-        hex_type == ETH_P_IP
-      end
-
-      def dump
-        puts 'ETHERNET HEADER----------------'
-        puts self
-      end
-
-      def to_s
-        <<~ETHER
-          Destination MAC: #{dhost}
-          Source MAC: #{shost}
-          Type: #{type}
-        ETHER
-      end
-
-      def dhost
-        @dhost.map { |b| b.to_s(16).rjust(2, '0') }.join(':')
-      end
-
-      def shost
-        @shost.map { |b| b.to_s(16).rjust(2, '0') }.join(':')
-      end
-
-      def type
-        if ipv4?
-          'IPv4'
-        else
-          'Unknown'
-        end
-      end
-
-      private
-
-      def hex_type
-        @hex_type ||= @type.map { |b| b.to_s(16).rjust(2, '0') }.join.to_i(16)
-      end
-    end
-  end
-end

data/lib/redhound/header.rb

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'header/ether'
-require_relative 'header/icmp'
-require_relative 'header/ipv4'
-require_relative 'header/udp'

data/lib/redhound/packet_mreq.rb

@@ -1,46 +0,0 @@
-# frozen_string_literal: true
-
-require 'socket'
-
-module Redhound
-  class PacketMreq
-    PACKET_MR_PROMISC = 0x0001 # NOTE: netpacket/packet.h
-
-    def initialize(ifname:)
-      @ifname = ifname
-    end
-
-    # 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 */
-    # };
-    def generate
-      mr_ifindex + mr_type + mr_alen + mr_address
-    end
-
-    def mr_ifindex
-      @mr_ifindex ||= [[index].pack('c')].pack('a4')
-    end
-
-    private
-
-    def index
-      ::Socket.getifaddrs.find { |ifaddr| ifaddr.name == @ifname }&.ifindex
-    end
-
-    def mr_type
-      @mr_type ||= [PACKET_MR_PROMISC].pack('S')
-    end
-
-    def mr_alen
-      @mr_alen ||= [0].pack('S')
-    end
-
-    def mr_address
-      @mr_address ||= [0].pack('C') * 8
-    end
-  end
-end

data/lib/redhound/socket_builder.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-require 'socket'
-
-module Redhound
-  class SocketBuilder
-    class << self
-      def build(ifname:)
-        new(ifname:).build
-      end
-    end
-
-    SOL_PACKET            = 0x0107 # bits/socket.h
-    PACKET_ADD_MEMBERSHIP = 0x0001 # NOTE: netpacket/packet.h
-    ETH_P_ALL             = 768    # NOTE: htons(ETH_P_ALL) => linux/if_ether.h
-    PACKED_ETH_P_ALL = [ETH_P_ALL].pack('S').unpack1('S>')
-
-    def initialize(ifname:)
-      @ifname = ifname
-      @mq_req = PacketMreq.new(ifname: @ifname)
-    end
-
-    def build
-      socket = Socket.new(Socket::AF_PACKET, Socket::SOCK_RAW, ETH_P_ALL)
-      socket.bind([Socket::AF_PACKET, PACKED_ETH_P_ALL, @mq_req.mr_ifindex].pack('SS>a16'))
-      socket.setsockopt(SOL_PACKET, PACKET_ADD_MEMBERSHIP, @mq_req.generate)
-      socket
-    end
-  end
-end

data/sig/redhound.rbs

@@ -1,4 +0,0 @@
-module Redhound
-  VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
-end