ffi-packets 0.1.0

data/lib/ffi/packets/tcp.rb

@@ -0,0 +1,104 @@
+module FFI::Packets
+  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::NetStructHelper
+    
+      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(Constants, "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::NetStructHelper
+
+      TCP_OPT_LEN = Constants::TCP_OPT_LEN
+      TCP_OPT_LEN_MAX = Constants::TCP_OPT_LEN_MAX
+
+      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(Constants, "TCP_OTYPE_")
+        def self.list; @@list ||= super() ; end
+      end
+
+    end # class Opt
+
+    # TCP FSM states
+    module State
+      include ::FFI::DRY::ConstMap
+      slurp_constants(Constants, "TCP_STATE_")
+      def self.list; @@list ||= super() ; end
+    end
+
+  end # module Tcp
+end 
+

data/lib/ffi/packets/udp.rb

@@ -0,0 +1,30 @@
+module FFI::Packets
+
+  class Udp
+    class Hdr < ::FFI::Struct
+      include ::FFI::DRY::NetStructHelper 
+
+      # 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
+
+
+  #  #define udp_pack_hdr(hdr, sport, dport, ulen) do {		\
+  #  	struct udp_hdr *udp_pack_p = (struct udp_hdr *)(hdr);	\
+  #  	udp_pack_p->uh_sport = htons(sport);			\
+  #  	udp_pack_p->uh_dport = htons(dport);			\
+  #  	udp_pack_p->uh_ulen = htons(ulen);			\
+  #  } while (0)
+
+end

data/lib/ffi/packets/util.rb

@@ -0,0 +1,54 @@
+
+module FFI::Packets
+  module Util
+
+    RX_IP4_ADDR = /(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)/
+    RX_MAC_ADDR = /(?:(?:[a-f0-9]{1,2}[:-])?{5}[a-f0-9]{1,2})/i
+
+    # takes a IPv4 number and returns it as a 32-bit number
+    def Util.ipv4_atol(str)
+      unless str =~ /^#{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 Util.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
+
+    def Util.unhexify(str, d=/\s*/)
+      str.to_s.strip.gsub(/([A-Fa-f0-9]{1,2})#{d}?/) { $1.hex.chr }
+    end
+
+    def Util.htonl(*args)
+      FFI::DRY::NetEndian.htonl(*args)
+    end
+
+    def Util.htons(*args)
+      FFI::DRY::NetEndian.htons(*args)
+    end
+
+    def Util.ntohl(*args)
+      FFI::DRY::NetEndian.ntohl(*args)
+    end
+
+    def Util.ntohs(*args)
+      FFI::DRY::NetEndian.ntohs(*args)
+    end
+
+  end # module Util
+
+end

data/spec/ffi-packets_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "FfiPackets" do
+  it "fails" do
+    fail "hey buddy, you should probably rename this file and start specing for real"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'ffi/packets'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification 
+name: ffi-packets
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Eric Monti
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-02 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ffi
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !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: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: A collection of common network packets structures in FFI::Struct form for use with bindings to raw network libraries such as libdnet, libnet, or libpcap.
+email: emonti@matasano.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- ffi-packets.gemspec
+- lib/ffi/packets.rb
+- lib/ffi/packets/arp.rb
+- lib/ffi/packets/constants.rb
+- lib/ffi/packets/eth.rb
+- lib/ffi/packets/icmp.rb
+- lib/ffi/packets/ip.rb
+- lib/ffi/packets/tcp.rb
+- lib/ffi/packets/udp.rb
+- lib/ffi/packets/util.rb
+- spec/ffi-packets_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/emonti/ffi-packets
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A collection of common network packets structures
+test_files: 
+- spec/ffi-packets_spec.rb
+- spec/spec_helper.rb