dnet-ffi 0.1.3 → 0.1.4

data/History.txt

@@ -0,0 +1,2 @@
+=== 0.1.4 / 2010-1-2
+  * Using ffi-packets collection for network packet structs

data/Rakefile

@@ -13,7 +13,8 @@ begin
     gem.homepage = "http://github.com/emonti/dnet-ffi"
     gem.authors = ["Eric Monti"]
     gem.files.delete_if {|f| f =~ /^mirror\//}
-#    gem.add_dependency "emonti-ffi_dry"
+    gem.add_dependency "ffi_dry"
+    gem.add_dependency "ffi-packets"
     gem.add_development_dependency "rspec"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
@@ -59,6 +60,7 @@ Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_dir = 'rdoc' 
   rdoc.title = "dnet-ffi #{version}" 
   rdoc.rdoc_files.include('README*') 
+  rdoc.rdoc_files.include('History.txt') 
   rdoc.rdoc_files.include('lib/**/*.rb') 
 end
 

data/VERSION

@@ -1 +1 @@
-0.1.3
+0.1.4

data/dnet-ffi.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{dnet-ffi}
-  s.version = "0.1.3"
+  s.version = "0.1.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Eric Monti"]
-  s.date = %q{2009-09-17}
+  s.date = %q{2010-01-02}
   s.description = %q{Ruby FFI bindings for the libdnet raw network library}
   s.email = %q{emonti@matasano.com}
   s.extra_rdoc_files = [
@@ -19,6 +19,7 @@ Gem::Specification.new do |s|
   s.files = [
     ".document",
      ".gitignore",
+     "History.txt",
      "LICENSE",
      "README.rdoc",
      "Rakefile",
@@ -65,7 +66,7 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/emonti/dnet-ffi}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.4}
+  s.rubygems_version = %q{1.3.5}
   s.summary = %q{Ruby FFI bindings for libdnet}
   s.test_files = [
     "spec/addr_spec.rb",
@@ -89,11 +90,17 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<ffi_dry>, [">= 0"])
+      s.add_runtime_dependency(%q<ffi-packets>, [">= 0"])
       s.add_development_dependency(%q<rspec>, [">= 0"])
     else
+      s.add_dependency(%q<ffi_dry>, [">= 0"])
+      s.add_dependency(%q<ffi-packets>, [">= 0"])
       s.add_dependency(%q<rspec>, [">= 0"])
     end
   else
+    s.add_dependency(%q<ffi_dry>, [">= 0"])
+    s.add_dependency(%q<ffi-packets>, [">= 0"])
     s.add_dependency(%q<rspec>, [">= 0"])
   end
 end

data/lib/dnet.rb

@@ -4,6 +4,7 @@ rescue LoadError
 end
 require 'ffi'
 require 'ffi/dry'
+require 'ffi/packets'
 
 module Dnet
   extend FFI::Library

data/lib/dnet/arp.rb

@@ -2,58 +2,7 @@
 
 module Dnet
   module Arp
-    # ARP header
-    # 
-    #   field :hrd, :uint16, :desc => 'format of hardware address'
-    #   field :pro, :uint16, :desc => 'format of protocol address'
-    #   field :hln, :uint16, :desc => 'length of hw address (ETH_ADDR_LEN)'
-    #   field :pln, :uint16, :desc => 'length of proto address (IP_ADDR_LEN)'
-    #   field :op,  :uint16, :desc => 'operation'
-    class Hdr < ::FFI::Struct
-      include ::FFI::DRY::StructHelper
-      include ::Dnet::NetEndianHelper
-      
-      dsl_layout do
-        field :hrd, :uint16, :desc => 'format of hardware address'
-        field :pro, :uint16, :desc => 'format of protocol address'
-        field :hln, :uint16, :desc => 'length of hw address (ETH_ADDR_LEN)'
-        field :pln, :uint16, :desc => 'length of proto address (IP_ADDR_LEN)'
-        field :op,  :uint16, :desc => 'operation'
-      end
-
-      # ARP operations
-      module Op
-        ::Dnet.constants.grep(/^(ARP_OP_([A-Z][A-Z0-9_]+))$/) do
-          self.const_set $2, ::Dnet.const_get($1)
-        end
-
-        module_function
-        def list
-          @@list ||= constants.inject({}){|h,c| h.merge! c => const_get(c) }
-        end
-      end # Op
-    end # Hdr
-
-    # Ethernet/IP ARP message
-    #
-    #   array :sha, [:uint8, ETH_ADDR_LEN], :desc => 'sender hardware address'
-    #   array :spa, [:uint8, IP_ADDR_LEN],  :desc => 'sender protocol address'
-    #   array :tha, [:uint8, ETH_ADDR_LEN], :desc => 'target hardware address'
-    #   array :tpa, [:uint8, IP_ADDR_LEN],  :desc => 'target protocol address'
-    #
-    class Ethip < ::FFI::Struct
-      include ::FFI::DRY::StructHelper
-      include ::Dnet::NetEndianHelper
-
-      dsl_layout do
-        array :sha, [:uint8, ETH_ADDR_LEN], :desc => 'sender hardware address'
-        array :spa, [:uint8, IP_ADDR_LEN],  :desc => 'sender protocol address'
-        array :tha, [:uint8, ETH_ADDR_LEN], :desc => 'target hardware address'
-        array :tpa, [:uint8, IP_ADDR_LEN],  :desc => 'target protocol address'
-      end
-
-    end # Ethip
-
+    include FFI::Packets::Arp
     
     # FFI mapping to libdnet's "arp_entry" struct.
     #

data/lib/dnet/eth.rb

@@ -2,77 +2,9 @@
 
 module Dnet
   
-  # FFI implementation of dnet(3)'s eth_addr struct.
-  class EthAddr < ::FFI::Struct
-    include ::FFI::DRY::StructHelper
-    
-    # struct eth_addr { ... } eth_addr_t;
-    dsl_layout{ array :data, [:uchar, ETH_ADDR_LEN] }
-
-    # Adds the ability to initialize a new EthAddr with a mac address
-    # string such as 'de:ad:be:ef:ba:be'. This argument is only parsed
-    # if it is passed as the only String argument.
-    def initialize(*args)
-      if args.size == 1 and (s=args[0]).is_a? String
-        super()
-        self.addr = s
-      else
-        super(*args)
-      end
-    end
-    
-    def addr=(val)
-      unless val.to_s =~ /^#{Dnet::Util::RX_MAC_ADDR}$/
-        raise(ArgumentError, "invalid mac address #{val.inspect}")
-      end
-      raw = ::Dnet::Util.unhexify(val, /[:-]/)
-      self[:data].to_ptr.write_string(raw, ETH_ADDR_LEN)
-    end
-
-    # Returns the MAC address as an array of unsigned char values.
-    def chars; self[:data].to_a ; end
-
-    # Returns the MAC address as a string with colon-separated hex-bytes.
-    def string; chars.map {|x| "%0.2x" % x }.join(':'); end
-  end
-
-
   module Eth
-    #
-    #   struct :dst,   EthAddr, :desc => 'destination address'
-    #   struct :src,   EthAddr, :desc => 'source address'
-    #   field  :etype, :ushort, :desc => 'ethernet payload type'
-    #
-    class Hdr < ::FFI::Struct
-      include ::FFI::DRY::StructHelper
-      include ::Dnet::NetEndianHelper
-      
-      module Etype
-        include ::FFI::DRY::ConstMap
-        slurp_constants ::Dnet, "ETH_TYPE_"
-        def list; @@list ||= super();  end
-      end
-
-      dsl_layout do
-        struct :dst,   EthAddr, :desc => 'destination address'
-        struct :src,   EthAddr, :desc => 'source address'
-        field  :etype, :ushort, :desc => 'ethernet payload type'
-      end
-
-      def lookup_etype
-        Etype[ self.etype ]
-      end
-
-      alias _divert_set_eth etype=
-
-      def etype=(val)
-        if val.kind_of? String or val.kind_of? Symbol
-          val = Etype[ val ] or raise(ArgumentError, "invalid eth type #{val}")
-        end
-        _divert_set_eth(val)
-      end
-    end
-
+    include FFI::Packets::Eth
+    
     # Obtains a new handle to transmit raw Ethernet frames via the specified
     # network device.
     #
@@ -131,6 +63,9 @@ module Dnet
     end
   end # Eth
 
+  # This is just an alias for ::Dnet::Eth::EthAddr
+  EthAddr = Eth::EthAddr
+
   # This is just an alias for ::Dnet::Eth::Handle
   EthHandle = Eth::Handle
 

data/lib/dnet/helpers.rb

@@ -2,11 +2,6 @@
 # throughout the Dnet FFI bindings.
 
 module Dnet
-  attach_function :htons, [:uint16], :uint16
-  attach_function :ntohs, [:uint16], :uint16
-  attach_function :htonl, [:uint32], :uint32
-  attach_function :ntohl, [:uint32], :uint32
-
 
   # Produces a null-terminated string from 'val', if max is supplied,
   # it is taken as a maximum length. If 'val' is longer than max, it will
@@ -99,66 +94,10 @@ module Dnet
 
   end # LoopableHandle
 
-  # A special helper for network packet structures which use big-endian or
-  # "network" byte-order. This helper generates read/write accessors that
-  # automatically call the appropriate byte conversion function, ntohs/ntohl
-  # for 'reading' a 16/32 bit field, and htons/htonl for writing to one.
-  #
-  # NOTE this helper does not currently do anything special for 64-bit values 
-  # at all.
-  #
-  # This helper relies on a included loaded FFI::DRY::StructHelper module
-  # to do its magic. Always include this module as follows:
-  #
-  #   class YourStruct < ::FFI::Struct # or ::FFI::ManagedStruct, (or Union?)
-  #     include ::FFI::DRY::StructHelper
-  #     include ::Dnet::NetEndianHelper
-  #     ...
-  #
-  module NetEndianHelper
-
-    I16_convert = [::Dnet.method(:ntohs), ::Dnet.method(:htons)]
-    U16_convert = [::Dnet.method(:ntohs), ::Dnet.method(:htons)]
-    I32_convert = [::Dnet.method(:ntohl), ::Dnet.method(:htonl)]
-    U32_convert = [::Dnet.method(:ntohl), ::Dnet.method(:htonl)]
-
-    BYTE_ORDER_METH = {
-      Dnet.find_type(:uint16) => I16_convert,
-      Dnet.find_type(:int16)  => I16_convert,
-      Dnet.find_type(:int32)  => I32_convert,
-      Dnet.find_type(:uint32) => I32_convert,
-    }
-
-    module ClassMethods
-      private
-      def _class_meths_from_dsl_metadata(meta)
-        (@dsl_metadata = meta).each do |spec|
-          name = spec[:name]
-          type = spec[:type]
-          if type.kind_of? Symbol and mp=BYTE_ORDER_METH[ Dnet.find_type(type) ]
-            unless instance_methods.include?(:"#{name}")
-              define_method(:"#{name}"){ mp[0].call(self[name]) }
-            end
-            unless instance_methods.include?(:"#{name}=")
-              define_method(:"#{name}="){|val| self[name] = mp[1].call(val) }
-            end
-          else
-            unless instance_methods.include?(:"#{name}")
-              define_method(:"#{name}"){ self[name] } 
-            end
-            unless instance_methods.include?(:"#{name}=")
-              define_method(:"#{name}="){|val| self[name]=val }
-            end 
-          end
-        end
-      end
-    end
-
-    def self.included(base)
-      base.extend(ClassMethods)
-    end
-
-  end
+  attach_function :htons, [:uint16], :uint16
+  attach_function :ntohs, [:uint16], :uint16
+  attach_function :htonl, [:uint32], :uint32
+  attach_function :ntohl, [:uint32], :uint32
 
 end
 

data/lib/dnet/icmp.rb

@@ -1,304 +1,5 @@
 
 module Dnet::Icmp
-
-  # ICMP header structure
-  #
-  #   struct icmp_hdr {
-  #     uint8_t    icmp_type;  /* type of message */
-  #     uint8_t    icmp_code;  /* type sub code */
-  #     uint16_t  icmp_cksum;  /* ones complement cksum of struct */
-  #   };
-  #
-  class Hdr < ::FFI::Struct
-    include ::FFI::DRY::StructHelper
-    include ::Dnet::NetEndianHelper
-    
-    dsl_layout do
-      field :icmp_type,    :uint8
-      field :icmp_code,    :uint8
-      field :icmp_cksum,   :uint16
-    end
-
-    module IcmpType
-      include ::FFI::DRY::ConstFlagsMap
-      slurp_constants(::Dnet, "ICMP_TYPE_")
-      def list; @@list ||= super(); end
-    end
-
-    module IcmpCode
-      module UNREACH
-        include ::FFI::DRY::ConstFlagsMap
-        slurp_constants(::Dnet, "ICMP_UNREACH_")
-        def list; @@list ||= super(); end
-      end
-
-      module REDIRECT
-        include ::FFI::DRY::ConstFlagsMap
-        slurp_constants(::Dnet, "ICMP_REDIRECT_")
-        def list; @@list ||= super(); end
-      end
-
-      module RTRADVERT
-        include ::FFI::DRY::ConstFlagsMap
-        slurp_constants(::Dnet, "ICMP_RTRADVERT_")
-        def list; @@list ||= super(); end
-      end
-
-      module TIMEEXCEED
-        include ::FFI::DRY::ConstFlagsMap
-        slurp_constants(::Dnet, "ICMP_TIMEEXCEED_")
-        def list; @@list ||= super(); end
-      end
-
-      module PARAMPROB
-        include ::FFI::DRY::ConstFlagsMap
-        slurp_constants(::Dnet, "ICMP_PARAMPROB_")
-        def list; @@list ||= super(); end
-      end
-
-      module PHOTURIS
-        include ::FFI::DRY::ConstFlagsMap
-        slurp_constants(::Dnet, "ICMP_PHOTURIS_")
-        def list; @@list ||= super(); end
-      end
-
-    end # module IcmpCode
-
-    # Various ICMP message structures
-    module Msg
-
-      # Echo message data structure
-      # 
-      #   struct icmp_msg_echo {
-      #     uint16_t  icmp_id;
-      #     uint16_t  icmp_seq;
-      #     uint8_t   icmp_data __flexarr;  /* optional data */
-      #   };
-      # 
-      class Echo < ::FFI::Struct
-        include ::FFI::DRY::StructHelper
-        include ::Dnet::NetEndianHelper
-      
-        dsl_layout do
-          field :icmp_id, :uint16
-          field :seq,     :uint16
-          field :data,    :uint8    # flexarr ... optional data
-        end
-      end
-
-      # Fragmentation-needed (unreachable) message data structure
-      # 
-      #   struct icmp_msg_needfrag {
-      #     uint16_t  icmp_void;    /* must be zero */
-      #     uint16_t  icmp_mtu;    /* MTU of next-hop network */
-      #     uint8_t   icmp_ip __flexarr;  /* IP hdr + 8 bytes of pkt */
-      #   };
-      # 
-      class NeedFrag < ::FFI::Struct
-        include ::FFI::DRY::StructHelper
-        include ::Dnet::NetEndianHelper
-      
-        dsl_layout do
-          field :icmp_void, :uint16
-          field :mtu,       :uint16
-          field :ip,        :uint8    # flexarr ... IP hdr + 8 bytes of pkt
-        end
-      end
-
-      # Unreachable, source quench, redirect, time exceeded,
-      # parameter problem message data structure
-      # 
-      #   struct icmp_msg_quote {
-      #     uint32_t  icmp_void;    /* must be zero */
-      #     uint8_t   icmp_ip __flexarr;  /* IP hdr + 8 bytes of pkt */
-      #   };
-      # 
-      class Quote < ::FFI::Struct
-        include ::FFI::DRY::StructHelper
-        include ::Dnet::NetEndianHelper
-      
-        dsl_layout do
-          field :icmp_void, :uint32 
-          field :ip,        :uint8     # flexxarr ... IP hdr + 8 bytes of pkt
-        end
-      end
-
-      # Router advertisement message data structure, RFC 1256
-      # 
-      #   struct icmp_msg_rtradvert {
-      #     uint8_t    icmp_num_addrs;    /* # of address / pref pairs */
-      #     uint8_t    icmp_wpa;    /* words / address == 2 */
-      #     uint16_t   icmp_lifetime;    /* route lifetime in seconds */
-      #     struct icmp_msg_rtr_data {
-      #       uint32_t  icmp_void;
-      #       uint32_t  icmp_pref;  /* router preference (usu 0) */
-      #     } icmp_rtr __flexarr;      /* variable # of routers */
-      #   };
-      # 
-      class RtrAdvert < ::FFI::Struct
-        include ::FFI::DRY::StructHelper
-        include ::Dnet::NetEndianHelper
-
-        class RtrData < ::FFI::Struct
-          include ::FFI::DRY::StructHelper
-          include ::Dnet::NetEndianHelper
-        
-          dsl_layout do
-            field :icmp_void, :uint32
-            field :pref,      :uint32
-          end
-        end
-
-        dsl_layout do
-          field  :num_addrs, :uint8
-          field  :wpa,       :uint8
-          field  :lifetime,  :uint16
-          struct :router,    RtrData    # flexarr ... variable # of routers
-        end
-      end
-
-      # Timestamp message data structure
-      # 
-      #   struct icmp_msg_tstamp {
-      #     uint32_t  icmp_id;    /* identifier */
-      #     uint32_t  icmp_seq;    /* sequence number */
-      #     uint32_t  icmp_ts_orig;    /* originate timestamp */
-      #     uint32_t  icmp_ts_rx;    /* receive timestamp */
-      #     uint32_t  icmp_ts_tx;    /* transmit timestamp */
-      #   };
-      # 
-      class Timestamp < ::FFI::Struct
-        include ::FFI::DRY::StructHelper
-        include ::Dnet::NetEndianHelper
-      
-        dsl_layout do
-          field :icmp_id, :uint32
-          field :seq,     :uint32
-          field :ts_orig, :uint32
-          field :ts_rx,   :uint32
-          field :ts_tx,   :uint32
-        end
-      end
-
-      # Address mask message data structure, RFC 950
-      # 
-      #   struct icmp_msg_mask {
-      #     uint32_t  icmp_id;    /* identifier */
-      #     uint32_t  icmp_seq;    /* sequence number */
-      #     uint32_t  icmp_mask;    /* address mask */
-      #   };
-      # 
-      class Mask < ::FFI::Struct
-        include ::FFI::DRY::StructHelper
-        include ::Dnet::NetEndianHelper
-
-        dsl_layout do
-          field :icmp_id, :uint32
-          field :seq,     :uint32
-          field :mask,    :uint32
-        end
-      end
-
-      # Traceroute message data structure, RFC 1393, RFC 1812
-      # 
-      #   struct icmp_msg_traceroute {
-      #     uint16_t  icmp_id;    /* identifier */
-      #     uint16_t  icmp_void;    /* unused */
-      #     uint16_t  icmp_ohc;    /* outbound hop count */
-      #     uint16_t  icmp_rhc;    /* return hop count */
-      #     uint32_t  icmp_speed;    /* link speed, bytes/sec */
-      #     uint32_t  icmp_mtu;    /* MTU in bytes */
-      #   };
-      # 
-      class Traceroute < ::FFI::Struct
-        include ::FFI::DRY::StructHelper
-        include ::Dnet::NetEndianHelper
-      
-        dsl_layout do
-          field :icmp_id,   :uint16
-          field :icmp_void, :uint16
-          field :ohc,       :uint16
-          field :rhc,       :uint16
-          field :speed,     :uint16
-          field :mtu,       :uint16
-        end
-      end
-
-      # Domain name reply message data structure, RFC 1788
-      # 
-      #   struct icmp_msg_dnsreply {
-      #     uint16_t  icmp_id;    /* identifier */
-      #     uint16_t  icmp_seq;    /* sequence number */
-      #     uint32_t  icmp_ttl;    /* time-to-live */
-      #     uint8_t    icmp_names __flexarr;  /* variable number of names */
-      #   };
-      # 
-      class DnsReply < ::FFI::Struct
-        include ::FFI::DRY::StructHelper
-        include ::Dnet::NetEndianHelper
-      
-        dsl_layout do
-          field :icmp_id, :uint16
-          field :seq,     :uint16
-          field :ttl,     :uint16
-          field :names,   :uint8    # flexarr ... variable # of names
-        end
-      end
-
-      # Generic identifier, sequence number data structure
-      # 
-      #   struct icmp_msg_idseq {
-      #     uint16_t  icmp_id;
-      #     uint16_t  icmp_seq;
-      #   };
-      # 
-      class IdSeq < ::FFI::Struct
-        include ::FFI::DRY::StructHelper
-        include ::Dnet::NetEndianHelper
-      
-        dsl_layout do
-          field :icmp_id, :uint16
-          field :seq,     :uint16
-        end
-      end
-
-    end # module Msg
-  end
-
-  # /*
-  #  * ICMP message union
-  #  */
-  # union icmp_msg {
-  #   struct icmp_msg_echo     echo;  /* ICMP_ECHO{REPLY} */
-  #   struct icmp_msg_quote     unreach;  /* ICMP_UNREACH */
-  #   struct icmp_msg_needfrag   needfrag;  /* ICMP_UNREACH_NEEDFRAG */
-  #   struct icmp_msg_quote     srcquench;  /* ICMP_SRCQUENCH */
-  #   struct icmp_msg_quote     redirect;  /* ICMP_REDIRECT (set to 0) */
-  #   uint32_t       rtrsolicit;  /* ICMP_RTRSOLICIT */
-  #   struct icmp_msg_rtradvert  rtradvert;  /* ICMP_RTRADVERT */
-  #   struct icmp_msg_quote     timexceed;  /* ICMP_TIMEXCEED */
-  #   struct icmp_msg_quote     paramprob;  /* ICMP_PARAMPROB */
-  #   struct icmp_msg_tstamp     tstamp;  /* ICMP_TSTAMP{REPLY} */
-  #   struct icmp_msg_idseq     info;  /* ICMP_INFO{REPLY} */
-  #   struct icmp_msg_mask     mask;  /* ICMP_MASK{REPLY} */
-  #   struct icmp_msg_traceroute traceroute;  /* ICMP_TRACEROUTE */
-  #   struct icmp_msg_idseq     dns;    /* ICMP_DNS */
-  #   struct icmp_msg_dnsreply   dnsreply;  /* ICMP_DNSREPLY */
-  # };
-
-  # #define icmp_pack_hdr(hdr, type, code) do {        \
-  #   struct icmp_hdr *icmp_pack_p = (struct icmp_hdr *)(hdr);  \
-  #   icmp_pack_p->icmp_type = type; icmp_pack_p->icmp_code = code;  \
-  # } while (0)
-
-  # #define icmp_pack_hdr_echo(hdr, type, code, id, seq, data, len) do {  \
-  #   struct icmp_msg_echo *echo_pack_p = (struct icmp_msg_echo *)  \
-  #     ((uint8_t *)(hdr) + ICMP_HDR_LEN);      \
-  #   icmp_pack_hdr(hdr, type, code);          \
-  #   echo_pack_p->icmp_id = htons(id);        \
-  #   echo_pack_p->icmp_seq = htons(seq);        \
-  #   memmove(echo_pack_p->icmp_data, data, len);      \
-  # } while (0)
-
-
+  include FFI::Packets::Icmp
+  
 end # module Dnet::Icmp

data/lib/dnet/ip.rb

@@ -4,228 +4,8 @@
 module Dnet
 
   module Ip
-    # Protocols (proto) - http://www.iana.org/assignments/protocol-numbers
-    #
-    # Contains mappings for all the IP_PROTO_[A-Z].* constants 
-    # (defined in constants.rb)
-    module Proto
-      include ::FFI::DRY::ConstMap
-      slurp_constants(::Dnet, "IP_PROTO_")
-      def self.list;  @@list ||= super(); end
-    end
-
-    # IP header, without options
-    #
-    #   field :v_hl,    :uint8,   :desc => 'v=vers(. & 0xf0) / '+
-    #                                      'hl=hdr len(. & 0x0f)'
-    #   field :tos,     :uint8,   :desc => 'type of service'
-    #   field :len,     :uint16,  :desc => 'total length (incl header)'
-    #   field :id,      :uint16,  :desc => 'identification'
-    #   field :off,     :uint16,  :desc => 'fragment offset and flags'
-    #   field :ttl,     :uint8,   :desc => 'time to live'
-    #   field :proto,   :uint8,   :desc => 'protocol'
-    #   field :sum,     :uint16,  :desc => 'checksum'
-    #   field :src,     :uint32,  :desc => 'source address'
-    #   field :dst,     :uint32,  :desc => 'destination address'
-    #
-    class Hdr < ::FFI::Struct
-      include ::FFI::DRY::StructHelper
-      include ::Dnet::NetEndianHelper
-    
-      dsl_layout do
-        field :v_hl,    :uint8,   :desc => 'v=vers(. & 0xf0) / '+
-                                           'hl=hdr len(. & 0x0f)'
-        field :tos,     :uint8,   :desc => 'type of service'
-        field :len,     :uint16,  :desc => 'total length (incl header)'
-        field :id,      :uint16,  :desc => 'identification'
-        field :off,     :uint16,  :desc => 'fragment offset and flags'
-        field :ttl,     :uint8,   :desc => 'time to live'
-        field :proto,   :uint8,   :desc => 'protocol'
-        field :sum,     :uint16,  :desc => 'checksum'
-        field :src,     :uint32,  :desc => 'source address'
-        field :dst,     :uint32,  :desc => 'destination address'
-      end
-
-      # Overrides set_fields to supply a default value for the 'v_hl' field.
-      #
-      #   v  = 4
-      #   hl = 5 # number of 32-bit words - 20 bytes (size of hdr without opts)
-      #
-      def set_fields(params=nil)
-        params ||= {}
-        super({:v_hl => 0x45}.merge(params))
-      end
-
-      # Sets the value of the hl field. This field is a 4-bit value occupying
-      # the lower 4 bits of the 'v_hl' field.
-      #
-      # This value is the size of the IP header (including opts if present)
-      # in 32-bit words. The byte size maximum is 15*4 - 60 bytes.
-      def hl=(val)
-        raise(ArgumentError, "value for header length too high") if val > 0xf
-        self[:v_hl] &= 0xf0
-        self[:v_hl] += val
-      end
-
-      # Returns the value of the hl field. This field is a 4-bit value occupying
-      # the lower 4 bits of the 'v_hl' field.
-      #
-      # This value is the size of the IP header (including opts if present)
-      # in 32-bit words. The byte size maximum is 15*4 - 60 bytes.
-      def hl
-        self[:v_hl] & 0x0f
-      end
-
-      # Type of service (ip_tos), RFC 1349 ("obsoleted by RFC 2474")
-      #
-      # Contains mappings for all the IP_TOS_[A-Z].* flags constants
-      module Tos
-        include ::FFI::DRY::ConstFlagsMap
-        slurp_constants(::Dnet, "IP_TOS_")
-        def self.list;  @@list ||= super(); end
-      end
-
-      def lookup_tos;  Tos[ self.tos ]; end
-
-      # Alias to ::Dnet::Ip::Proto
-      Proto = ::Dnet::Ip::Proto
-
-      def lookup_proto; Proto[ self.proto ]; end
-
-      # Sets source IP address in the header from an IPv4 address string or 
-      # 32-bit number.
-      def src=(val)
-        val = ::Dnet::Util.ipv4_atol(val) if val.kind_of? String
-        self[:src] = ::Dnet.htonl(val)
-      end
-
-      # Returns the source IP address as an IPv4 address string as an IPv4 
-      # address string.
-      def src
-        ::Dnet::Util.ipv4_ltoa( ::Dnet.ntohl( self[:src] ))
-      end
-
-      # Sets destination IP address in the header from an IPv4 address string 
-      # or 32-bit number.
-      def dst=(val)
-        val = ::Dnet::Util.ipv4_atol(val) if val.kind_of? String
-        self[:dst] = ::Dnet.htonl(val)
-      end
-
-      # Returns the destination IP address from the header as an IPv4 address 
-      # string.
-      def dst
-        ::Dnet::Util.ipv4_ltoa( ::Dnet.ntohl( self[:dst] ))
-      end
-
-    end # class Hdr
-
-
-    # IP option (following IP header)
-    #
-    #   array :otype, :uint8,            :desc => 'option type'
-    #   array :len,   :uint8,            :desc => 'option length >= IP_OPE_LEN'
-    #   array :data, [:uint8, DATA_LEN], :desc => 'option message data '
-    #
-    class Opt < ::FFI::Struct
-      include ::FFI::DRY::StructHelper
-      include ::Dnet::NetEndianHelper
-
-      DATA_LEN = IP_OPT_LEN_MAX - IP_OPT_LEN
-    
-      dsl_layout do
-        field :otype, :uint8,   :desc => 'option type'
-        field :len,   :uint8,   :desc => 'option length >= IP_OPE_LEN'
-        array :data, [:uint8, DATA_LEN], :desc => 'option message data '
-      end
-
-      # Option types (otype) - http://www.iana.org/assignments/ip-parameters
-      #
-      # Contains mappings for all the IP_OTYPE_[A-Z].* constants
-      module Otype
-        include ::FFI::DRY::ConstMap
-        slurp_constants(::Dnet, "IP_OTYPE_")
-        def self.list;  @@list ||= super(); end
-      end
-
-      # Security option data - RFC 791, 3.1
-      #
-      #   field :sec,   :uint16,     :desc => 'security'
-      #   field :cpt,   :uint16,     :desc => 'compartments'
-      #   field :hr,    :uint16,     :desc => 'handling restrictions'
-      #   array :tcc,   [:uint8, 3], :desc => 'transmission control code'
-      #
-      class DataSEC < ::FFI::Struct
-        include ::FFI::DRY::StructHelper
-        include ::Dnet::NetEndianHelper
- 
-        dsl_layout do
-          field :sec,   :uint16,     :desc => 'security'
-          field :cpt,   :uint16,     :desc => 'compartments'
-          field :hr,    :uint16,     :desc => 'handling restrictions'
-          array :tcc,   [:uint8, 3], :desc => 'transmission control code'
-        end
-
-      end
-
-      # Timestamp option data - RFC 791, 3.1
-      #
-      #   field :ptr,       :uint8,  :desc => 'from start of option'
-      #   field :oflw_flg,  :uint8,  :desc => 'oflw = number of IPs skipped /'+
-      #                                       'flg  = address/timestamp flag'
-      #   field :iptspairs, :uint32, :desc => 'IP addr/ts pairs, var-length'
-      #
-      class DataTS < ::FFI::Struct
-        include ::FFI::DRY::StructHelper
-        include ::Dnet::NetEndianHelper 
-        dsl_layout do
-          field :ptr,       :uint8,  :desc => 'from start of option'
-          field :oflw_flg,  :uint8,  :desc => 'oflw = number of IPs skipped /'+
-                                              'flg  = address/timestamp flag'
-          field :iptspairs, :uint32, :desc => 'IP addr/ts pairs, var-length'
-        end
-
-      end
-
-      # (Loose Source/Record/Strict Source) Route option data - RFC 791, 3.1
-      #
-      #   field :ptr,     :uint8,   :desc => 'from start of option'
-      #   field :iplist,  :uint32,  :desc => 'var-length list of IPs'
-      #
-      class DataRR < ::FFI::Struct
-        include ::FFI::DRY::StructHelper
-        include ::Dnet::NetEndianHelper
-      
-        dsl_layout do
-          field :ptr,     :uint8,   :desc => 'from start of option'
-          field :iplist,  :uint32,  :desc => 'var-length list of IPs'
-        end
-
-      end
-
-      #  Traceroute option data - RFC 1393, 2.2
-      #
-      #   struct ip_opt_data_tr {
-      #     uint16_t  id;     /* ID number */
-      #     uint16_t  ohc;    /* outbound hop count */
-      #     uint16_t  rhc;    /* return hop count */
-      #     uint32_t  origip; /* originator IP address */
-      #   } __attribute__((__packed__));
-      #
-      class DataTR < ::FFI::Struct
-        include ::FFI::DRY::StructHelper
-        include ::Dnet::NetEndianHelper
-      
-        dsl_layout do
-          field :id,      :uint16, :desc => 'ID number'
-          field :ohc,     :uint16, :desc => 'outbound hop count'
-          field :rhc,     :uint16, :desc => 'return hop count'
-          field :origip,  :uint32, :desc => 'originator IP address'
-        end
-      end
-
-    end # class Opt
 
+    include FFI::Packets::Ip
 
     # Abstraction around dnet(3)'s ip_t handle for transmitting raw IP packets
     # routed by the kernel.

data/lib/dnet/tcp.rb

@@ -1,103 +1,6 @@
 module Dnet
   module Tcp
-
-    # TCP header, without options
-    #
-    #   field :sport,  :uint16, :desc => 'source port'
-    #   field :dport,  :uint16, :desc => 'destination port'
-    #   field :seq,    :uint32, :desc => 'sequence number'
-    #   field :ack,    :uint32, :desc => 'acknowledgment number'
-    #   field :off_x2, :uint8,  :desc => 'data offset(& 0xf0) unused (& 0x0f)'
-    #   field :flags,  :uint8,  :desc => 'control flags'
-    #   field :win,    :uint16, :desc => 'window'
-    #   field :sum,    :uint16, :desc => 'checksum'
-    #   field :urgp,   :uint16, :desc => 'urgent pointer'
-    #
-    class Hdr < ::FFI::Struct
-      include ::FFI::DRY::StructHelper
-      include ::Dnet::NetEndianHelper
-    
-      dsl_layout do
-        field :sport,  :uint16, :desc => 'source port'
-        field :dport,  :uint16, :desc => 'destination port'
-        field :seq,    :uint32, :desc => 'sequence number'
-        field :ack,    :uint32, :desc => 'acknowledgment number'
-        field :off_x2, :uint8,  :desc => 'data offset(& 0xf0) unused (& 0x0f)'
-        field :flags,  :uint8,  :desc => 'control flags'
-        field :win,    :uint16, :desc => 'window'
-        field :sum,    :uint16, :desc => 'checksum'
-        field :urgp,   :uint16, :desc => 'urgent pointer'
-      end
-
-      # TCP control flags (flags)
-      module Flags
-        include ::FFI::DRY::ConstFlagsMap
-        slurp_constants(::Dnet, "TH_")
-        def self.list; @@list ||= super() ; end
-      end
-
-      #  #define \
-      #    tcp_pack_hdr(hdr, sport, dport, seq, ack, flags, win, urp) do { \
-      #      struct tcp_hdr *tcp_pack_p = (struct tcp_hdr *)(hdr);    \
-      #      tcp_pack_p->th_sport = htons(sport);                     \
-      #      tcp_pack_p->th_dport = htons(dport);                     \
-      #      tcp_pack_p->th_seq = htonl(seq);                         \
-      #      tcp_pack_p->th_ack = htonl(ack);                         \
-      #      tcp_pack_p->th_x2 = 0; tcp_pack_p->th_off = 5;           \
-      #      tcp_pack_p->th_flags = flags;                            \
-      #      tcp_pack_p->th_win = htons(win);                         \
-      #      tcp_pack_p->th_urp = htons(urp);                         \
-      #  } while (0)
-
-    end
-
-    #
-    # TCP option (following TCP header)
-    #
-    #   struct tcp_opt {
-    #      uint8_t        opt_type;  /* option type */
-    #      uint8_t        opt_len;   /* option length >= TCP_OPT_LEN */
-    #      union tcp_opt_data {
-    #        uint16_t    mss;           /* TCP_OPT_MSS */
-    #        uint8_t        wscale;     /* TCP_OPT_WSCALE */
-    #        uint16_t    sack[19];      /* TCP_OPT_SACK */
-    #        uint32_t    echo;          /* TCP_OPT_ECHO{REPLY} */
-    #        uint32_t    timestamp[2];  /* TCP_OPT_TIMESTAMP */
-    #        uint32_t    cc;            /* TCP_OPT_CC{NEW,ECHO} */
-    #        uint8_t        cksum;      /* TCP_OPT_ALTSUM */
-    #        uint8_t        md5[16];    /* TCP_OPT_MD5 */
-    #        uint8_t        data8[TCP_OPT_LEN_MAX - TCP_OPT_LEN];
-    #      } opt_data;
-    #   } __attribute__((__packed__));
-    #
-    class Opt < ::FFI::Struct
-      include ::FFI::DRY::StructHelper
-      include ::Dnet::NetEndianHelper
-
-      DATA_LEN = TCP_OPT_LEN_MAX - TCP_OPT_LEN
-    
-      dsl_layout do
-        field :otype,  :uint8
-        field :len,    :uint8
-        array :data8,  [:uint8, DATA_LEN]
-      end
-
-      # Options (otype) - http://www.iana.org/assignments/tcp-parameters
-      module Otype
-        include ::FFI::DRY::ConstMap
-        slurp_constants(::Dnet, "TCP_OTYPE_")
-        def self.list; @@list ||= super() ; end
-      end
-
-    end # class Opt
-
-    # TCP FSM states
-    module State
-      include ::FFI::DRY::ConstMap
-      slurp_constants(::Dnet, "TCP_STATE_")
-      def self.list; @@list ||= super() ; end
-    end
-
+    include FFI::Packets::Tcp
   end # module Tcp
 end # module Dnet
 

data/lib/dnet/udp.rb

@@ -1,24 +1,6 @@
 module Dnet
 
-  class Udp
-    class Hdr < ::FFI::Struct
-      include ::FFI::DRY::StructHelper 
-      include ::Dnet::NetEndianHelper
-
-      # struct udp_hdr {
-      #   uint16_t	uh_sport;	/* source port */
-      #  	uint16_t	uh_dport;	/* destination port */
-      #  	uint16_t	uh_ulen;	/* udp length (including header) */
-      #  	uint16_t	uh_sum;		/* udp checksum */
-      # };
-      dsl_layout do
-        field :sport,   :uint16
-        field :dport,   :uint16
-        field :len,     :uint16
-        field :sum,     :uint16
-      end
-    end
-  end
+  Udp = FFI::Packets::Udp
 
 
   #  #define udp_pack_hdr(hdr, sport, dport, ulen) do {		\

data/lib/dnet/util.rb

@@ -8,10 +8,6 @@ module Dnet
     # or module
     module Helpers
 
-      def unhexify(str, d=/\s*/)
-        str.to_s.strip.gsub(/([A-Fa-f0-9]{1,2})#{d}?/) { $1.hex.chr }
-      end
-
       # Attempts to derive a memory pointer and length from an "anonymous" object.
       # Returns an an array object containing [len, pointer]
       #
@@ -38,30 +34,6 @@ module Dnet
         return [pbuf, bsz]
       end
       
-      # takes a IPv4 number and returns it as a 32-bit number
-      def ipv4_atol(str)
-        unless str =~ /^#{::Dnet::Util::RX_IP4_ADDR}$/
-          raise(::ArgumentError, "invalid IP address #{str.inspect}")
-        else
-          u32=0
-          str.split('.',4).each {|o| u32 = ((u32 << 8) | o.to_i) }
-          return u32
-        end
-      end
-
-      # takes a 32-bit number and returns it as an IPv4 address string.
-      def ipv4_ltoa(int)
-        unless(int.is_a? Numeric and int <= 0xffffffff)
-          raise(::ArgumentError, "not a long integer: #{int.inspect}")
-        end
-        ret = []
-        4.times do 
-          ret.unshift(int & 0xff)
-          int >>= 8
-        end
-        ret.join('.')
-      end
-
     end # module Helpers
 
     extend(::Dnet::Util::Helpers)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: dnet-ffi
 version: !ruby/object:Gem::Version 
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors: 
 - Eric Monti
@@ -9,9 +9,29 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-17 00:00:00 -04:00
+date: 2010-01-02 00:00:00 -06:00
 default_executable: 
 dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ffi_dry
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: ffi-packets
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
 - !ruby/object:Gem::Dependency 
   name: rspec
   type: :development
@@ -34,6 +54,7 @@ extra_rdoc_files:
 files: 
 - .document
 - .gitignore
+- History.txt
 - LICENSE
 - README.rdoc
 - Rakefile
@@ -100,7 +121,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.4
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: Ruby FFI bindings for libdnet