libnet4r 0.1 → 0.2

data/CHANGELOG

@@ -1,5 +1,12 @@
 = Libnet Changelog
 
+== Version 0.2
+
+=== November 19, 2007
+
+* Added support for TCP.
+* Fixed a bug that prevented assigning nil to fields.
+
 == Version 0.1
 
 === November 18, 2007

data/Rakefile

@@ -6,7 +6,7 @@ require 'rake/clean'
 require 'rake/rdoctask'
 
 NAME     = 'libnet4r'
-VERS     = '0.1'
+VERS     = '0.2'
 GEM_NAME = "#{NAME}-#{VERS}.gem"
 
 RDOC_MAIN = "README"

data/ext/libnet.c

@@ -9,6 +9,7 @@ VALUE cLibnet;
 extern void define_ipv4_methods(void);
 extern void define_ipv6_methods(void);
 extern void define_udp_methods(void);
+extern void define_tcp_methods(void);
 extern void define_ipv4_methods(void);
 extern void define_ethernet_methods(void);
 extern void define_vlan_methods(void);
@@ -696,6 +697,7 @@ void Init_libnet4r()
 
     /* define the individual protocol methods */
     define_udp_methods();
+    define_tcp_methods();
     define_ipv4_methods();
     define_ipv6_methods();
     define_ethernet_methods();

data/ext/libnet_tcp.c

@@ -0,0 +1,138 @@
+#include <ruby.h>
+#include <libnet.h>
+
+extern VALUE cLibnet;
+
+static VALUE net_s_decode_tcp(VALUE self, VALUE bytes) 
+{
+    VALUE                  tcp_obj;
+    VALUE                  str;
+    VALUE                  payload;
+    struct libnet_tcp_hdr *tcp;
+    u_int16_t              th_sport, th_dport;
+    u_int32_t              th_seq, th_ack;
+    u_int8_t               th_off, th_x2, th_flags;
+    u_int16_t              th_win, th_sum, th_urp;
+
+    tcp_obj = rb_funcall(self, rb_intern("new"), 0);
+
+    str = StringValue(bytes);
+
+    if (RSTRING(str)->len < LIBNET_TCP_H) {
+        rb_raise(rb_eArgError, "string is too small to contain a TCP header");
+    }
+
+    tcp = (struct libnet_tcp_hdr *)RSTRING(str)->ptr;
+
+    th_sport = ntohs(tcp->th_sport); 
+    th_dport = ntohs(tcp->th_dport); 
+    th_seq   = ntohl(tcp->th_seq);
+    th_ack   = ntohl(tcp->th_ack);
+    th_off   = tcp->th_off;
+    th_x2    = tcp->th_x2 << 3;
+    th_x2   |= (tcp->th_flags & 0xe0) >> 5;
+    th_flags = tcp->th_flags & 0x1f;
+    th_win   = ntohs(tcp->th_win);
+    th_sum   = ntohs(tcp->th_sum);
+    th_urp   = ntohs(tcp->th_urp);
+
+    rb_iv_set(tcp_obj, "@src_port",    UINT2NUM(th_sport));
+    rb_iv_set(tcp_obj, "@dst_port",    UINT2NUM(th_dport));
+    rb_iv_set(tcp_obj, "@seq",         ULONG2NUM(th_seq));
+    rb_iv_set(tcp_obj, "@ack",         ULONG2NUM(th_ack));
+    rb_iv_set(tcp_obj, "@data_offset", UINT2NUM(th_off));
+    rb_iv_set(tcp_obj, "@reserved",    UINT2NUM(th_x2));
+    rb_iv_set(tcp_obj, "@control",     UINT2NUM(th_flags));
+    rb_iv_set(tcp_obj, "@window",      UINT2NUM(th_win));
+    rb_iv_set(tcp_obj, "@checksum",    UINT2NUM(th_sum));
+    rb_iv_set(tcp_obj, "@urgent",      UINT2NUM(th_urp));
+
+    if (RSTRING(str)->len > LIBNET_TCP_H) {
+        payload = rb_str_new(RSTRING(str)->ptr + LIBNET_TCP_H,
+                RSTRING(str)->len - LIBNET_TCP_H);
+    }
+    else {
+        payload = Qnil;
+    }
+
+    rb_iv_set(tcp_obj, "@payload", payload);
+
+    return tcp_obj;
+}
+
+static VALUE net_build_tcp(int argc, VALUE *argv, VALUE self)
+{
+    libnet_t      *l;
+    VALUE          tcp, v;
+    u_int16_t      sp, dp;
+    u_int32_t      seq, ack;
+    u_int8_t       control;
+    u_int16_t      win, sum, urg;
+    char          *payload   = NULL;
+    u_int32_t      payload_s = 0;
+    VALUE          ptag_obj;
+    libnet_ptag_t  ptag = 0;
+
+    rb_scan_args(argc, argv, "01", &tcp);
+
+    Data_Get_Struct(self, libnet_t, l);
+
+    if (NIL_P(tcp)) {
+        tcp = rb_class_new_instance(0, NULL, rb_const_get(cLibnet, rb_intern("TCP")));
+        rb_yield(tcp);
+    }
+
+    /* check that all required fields are set */
+    rb_funcall(tcp, rb_intern("check_packable"), 0);
+
+    v       = rb_funcall(tcp, rb_intern("src_port"), 0);
+    sp      = NUM2UINT(v);
+    v       = rb_funcall(tcp, rb_intern("dst_port"), 0);
+    dp      = NUM2UINT(v);
+    v       = rb_funcall(tcp, rb_intern("seq"), 0);
+    seq     = NUM2ULONG(v);
+    v       = rb_funcall(tcp, rb_intern("ack"), 0);
+    ack     = NUM2ULONG(v);
+    v       = rb_funcall(tcp, rb_intern("control"), 0);
+    control = NUM2UINT(v);
+    v       = rb_funcall(tcp, rb_intern("window"), 0);
+    win     = NUM2UINT(v);
+    v       = rb_funcall(tcp, rb_intern("checksum"), 0);
+    sum     = NUM2UINT(v);
+    v       = rb_funcall(tcp, rb_intern("urgent"), 0);
+    urg     = NUM2UINT(v);
+
+    /* get the payload */
+    if ((v = rb_funcall(tcp, rb_intern("payload"), 0)) != Qnil) {
+        v         = StringValue(v);
+        payload   = RSTRING(v)->ptr;
+        payload_s = RSTRING(v)->len;
+    }
+
+    ptag_obj = rb_iv_get(tcp, "@ptag");
+
+    if (!NIL_P(ptag_obj)) {
+        ptag = NUM2LONG(ptag_obj);
+    }
+
+    ptag = libnet_build_tcp(sp, dp, seq, ack, control, win, sum, urg,
+        LIBNET_TCP_H + payload_s, (u_int8_t *)payload, payload_s, l, ptag);
+
+    if (ptag == -1) {
+        rb_raise(rb_eRuntimeError, libnet_geterror(l));
+    }
+
+    rb_iv_set(tcp, "@ptag", LONG2NUM(ptag));
+
+    return tcp;
+}
+
+void define_tcp_methods()
+{
+    VALUE cTCP = rb_const_get(cLibnet, rb_intern("TCP"));
+
+    rb_define_singleton_method(cTCP, "decode", net_s_decode_tcp, 1);
+
+    rb_define_method(cLibnet, "build_tcp", net_build_tcp, -1);
+}
+

data/lib/libnet4r/header.rb

@@ -40,14 +40,17 @@ class Libnet
         unless opts[:read_only]
           self.class_eval do
             define_method("#{name}=") do |v|
-              if self.assignment_filters.has_key? name
-                v = self.assignment_filters[name].call(v)
-              end
+              # allow for setting to nil
+              if v
+                if self.assignment_filters.has_key? name
+                  v = self.assignment_filters[name].call(v)
+                end
 
-              check_integer(v)
+                check_integer(v)
 
-              unless range.include? v
-                raise ArgumentError, "value #{v} is out of range for field '#{name}'"
+                unless range.include? v
+                  raise ArgumentError, "value #{v} is out of range for field '#{name}'"
+                end
               end
 
               instance_variable_set(ivar, v)
@@ -67,15 +70,20 @@ class Libnet
         unless opts[:read_only]
           self.class_eval do
             define_method("#{name}=") do |v|
-              value = v.dup
-              if self.assignment_filters.has_key? name
-                value = self.assignment_filters[name].call(v)
-              end
-
-              check_string(value)
-
-              if size && value.length != size
-                raise ArgumentError, "value must be #{size} bytes long for field '#{name}'"
+              if v
+                value = v.dup
+                if self.assignment_filters.has_key? name
+                  value = self.assignment_filters[name].call(v)
+                end
+
+                check_string(value)
+
+                if size && value.length != size
+                  raise ArgumentError, "value must be #{size} bytes long for field '#{name}'"
+                end
+              else
+                # allow for setting to nil
+                value = v
               end
 
               instance_variable_set(ivar, value)
@@ -515,6 +523,82 @@ class Libnet
     octets_field   :payload, nil, :optional => true
   end
 
+  # = TCP
+  #
+  # Class to represent an RFC 793 Transmission Control Protocol (TCP) header.
+  #
+  # === Example
+  #
+  #   t = Libnet::TCP.new
+  #
+  #   t.src_port = 0x4321
+  #   t.dst_port = 0xabcd
+  #   t.seq      = 32
+  #   t.ack      = 0
+  #   t.control  = 0x0b
+  #   t.window   = 0x1122
+  #   t.checksum = 0x1111
+  #   t.urgent   = 0
+  #   t.payload  = payload
+  #
+  # == Public Class Methods
+  #
+  # === decode(string) -> new TCP object
+  #
+  # Decode a packed TCP packet.
+  #
+  # == Public Instance Methods
+  #
+  # === src_port, src_port=, src_port?
+  # Get/set/query the source port.
+  #
+  # === dst_port, dst_port=, dst_port?
+  # Get/set/query the destination port.
+  #
+  # === seq, seq=, seq?
+  # Get/set/query the sequence number.
+  #
+  # === ack, ack=, ack?
+  # Get/set/query the acknowledgement number.
+  #
+  # === data_offset, data_offset?
+  # Get/query the data offset.
+  #
+  # === reserved, reserved?
+  # Get/query the reserved field.
+  #
+  # === control, control=, control?
+  # Get/set/query the control flags.
+  #
+  # === window, window=, window?
+  # Get/set/query the window size.
+  #
+  # === checksum, checksum=, checksum?
+  # Get/set/query the checksum.
+  #
+  # === urgent, urgent=, urgent?
+  # Get/set/query the urgent pointer.
+  #
+  # === payload, payload=, payload?
+  # Get/set/query the payload.
+  #
+  # === ptag
+  # Get the ptag value for this header object.  Set by the Libnet builder method.
+  #
+  class TCP < Header
+    unsigned_field :src_port,    2
+    unsigned_field :dst_port,    2
+    unsigned_field :seq,         4
+    unsigned_field :ack,         4
+    unsigned_field :data_offset, 4, :units => :bits, :read_only => true
+    unsigned_field :reserved,    6, :units => :bits, :read_only => true
+    unsigned_field :control,     6, :units => :bits
+    unsigned_field :window,      2
+    unsigned_field :checksum,    2
+    unsigned_field :urgent,      2
+    octets_field   :payload, nil, :optional => true
+  end
+
   # = ARP
   #
   # Class to represent an Address Resolution Protocol (ARP) header.  Depending

data/test/tc_header.rb

@@ -52,6 +52,12 @@ class TC_Libnet_Header < Test::Unit::TestCase
     assert_raise NoMethodError do
       p.baz = 1
     end
+
+    # allow for setting fields to nil
+    assert_nothing_raised do
+      p.foo = nil
+      p.qux = nil
+    end
   end
 
   def test_read_query

data/test/tc_tcp.rb

@@ -0,0 +1,198 @@
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+
+require 'test/unit'
+require 'libnet4r'
+
+class TC_Libnet_TCP < Test::Unit::TestCase
+  def test_unpack
+    bytes = [
+      0x43, 0x21, 0xab, 0xcd,
+      0x00, 0x00, 0x00, 0x20, 0x00, 0x00, 0x00, 0x00, 0x50, 0x0b, 0x11, 0x22,
+      0x57, 0x9c, 0x00, 0x00, 0x74, 0x68, 0x65, 0x20, 0x71, 0x75, 0x69, 0x63,
+      0x6b, 0x20, 0x62, 0x72, 0x6f, 0x77, 0x6e, 0x20, 0x66, 0x6f, 0x78, 0x20,
+      0x6a, 0x75, 0x6d, 0x70, 0x65, 0x64, 0x20, 0x6f, 0x76, 0x65, 0x72, 0x20,
+      0x74, 0x68, 0x65, 0x20, 0x6c, 0x61, 0x7a, 0x79, 0x20, 0x64, 0x6f, 0x67
+    ].pack("C*")
+    payload = "the quick brown fox jumped over the lazy dog"
+
+    t = Libnet::TCP.decode(bytes)
+
+    assert_equal(0x4321,  t.src_port)
+    assert_equal(0xabcd,  t.dst_port)
+    assert_equal(32,      t.seq)
+    assert_equal(0,       t.ack)
+    assert_equal(5,       t.data_offset)
+    assert_equal(0,       t.reserved)
+    assert_equal(0x0b,    t.control)
+    assert_equal(0x1122,  t.window)
+    assert_equal(0x579c,  t.checksum)
+    assert_equal(0,       t.urgent)
+    assert_equal(payload, t.payload)
+
+    assert_raise ArgumentError do
+      Libnet::TCP.decode("foobar")
+    end
+  end
+
+  def test_pack
+    bytes = [
+      0x43, 0x21, 0xab, 0xcd,
+      0x00, 0x00, 0x00, 0x20, 0x00, 0x00, 0x00, 0x00, 0x50, 0x0b, 0x11, 0x22,
+      0x11, 0x11, 0x00, 0x00, 0x74, 0x68, 0x65, 0x20, 0x71, 0x75, 0x69, 0x63,
+      0x6b, 0x20, 0x62, 0x72, 0x6f, 0x77, 0x6e, 0x20, 0x66, 0x6f, 0x78, 0x20,
+      0x6a, 0x75, 0x6d, 0x70, 0x65, 0x64, 0x20, 0x6f, 0x76, 0x65, 0x72, 0x20,
+      0x74, 0x68, 0x65, 0x20, 0x6c, 0x61, 0x7a, 0x79, 0x20, 0x64, 0x6f, 0x67
+    ].pack("C*")
+    payload = "the quick brown fox jumped over the lazy dog"
+
+    t = Libnet::TCP.new
+
+    t.src_port = 0x4321
+    t.dst_port = 0xabcd
+    t.seq      = 32
+    t.ack      = 0
+    t.control  = 0x0b
+    t.window   = 0x1122
+    t.checksum = 0x1111
+    t.urgent   = 0
+    t.payload  = payload
+
+    assert_nil(t.ptag)
+
+    l = Libnet.new
+
+    l.build_tcp(t)
+
+    assert(t.ptag > 0)
+
+    assert_equal(bytes, l.pack)
+
+    l = Libnet.new
+
+    t = nil
+    l.build_tcp do |t|
+      t.src_port = 0x4321
+      t.dst_port = 0xabcd
+      t.seq      = 32
+      t.ack      = 0
+      t.control  = 0x0b
+      t.window   = 0x1122
+      t.checksum = 0x1111
+      t.urgent   = 0
+      t.payload  = payload
+    end
+
+    assert(t.ptag > 0)
+    assert_equal(bytes, l.pack)
+  end
+
+  def test_modify_ptag
+    bytes1 = [
+      0x43, 0x21, 0xab, 0xcd,
+      0x00, 0x00, 0x00, 0x20, 0x00, 0x00, 0x00, 0x00, 0x50, 0x0b, 0x11, 0x22,
+      0x11, 0x11, 0x00, 0x00, 0x74, 0x68, 0x65, 0x20, 0x71, 0x75, 0x69, 0x63,
+      0x6b, 0x20, 0x62, 0x72, 0x6f, 0x77, 0x6e, 0x20, 0x66, 0x6f, 0x78, 0x20,
+      0x6a, 0x75, 0x6d, 0x70, 0x65, 0x64, 0x20, 0x6f, 0x76, 0x65, 0x72, 0x20,
+      0x74, 0x68, 0x65, 0x20, 0x6c, 0x61, 0x7a, 0x79, 0x20, 0x64, 0x6f, 0x67
+    ].pack("C*")
+    bytes2 = [
+      0xfe, 0xed, 0xfa, 0xce,
+      0x00, 0x00, 0x00, 0x20, 0x00, 0x00, 0x00, 0x00, 0x50, 0x0b, 0x11, 0x22,
+      0x11, 0x11, 0x00, 0x00, 0x74, 0x68, 0x65, 0x20, 0x71, 0x75, 0x69, 0x63,
+      0x6b, 0x20, 0x62, 0x72, 0x6f, 0x77, 0x6e, 0x20, 0x66, 0x6f, 0x78, 0x20,
+      0x6a, 0x75, 0x6d, 0x70, 0x65, 0x64, 0x20, 0x6f, 0x76, 0x65, 0x72, 0x20,
+      0x74, 0x68, 0x65, 0x20, 0x6c, 0x61, 0x7a, 0x79, 0x20, 0x64, 0x6f, 0x67
+    ].pack("C*")
+    payload = "the quick brown fox jumped over the lazy dog"
+
+    l = Libnet.new
+
+    t = l.build_tcp do |t|
+      t.src_port = 0x4321
+      t.dst_port = 0xabcd
+      t.seq      = 32
+      t.ack      = 0
+      t.control  = 0x0b
+      t.window   = 0x1122
+      t.checksum = 0x1111
+      t.urgent   = 0
+      t.payload  = payload
+    end
+
+    assert(t.ptag > 0)
+    ptag = t.ptag
+
+    assert_equal(bytes1, l.pack)
+
+    t.src_port = 0xfeed
+    t.dst_port = 0xface
+
+    l.build_tcp(t)
+
+    assert_equal(ptag, t.ptag)
+    assert_equal(bytes2, l.pack)
+  end
+
+  def test_ether_ipv4_tcp
+    bytes = [
+      # ethernet
+      0xaa, 0xbb, 0xcc, 0xdd, 0xee, 0xff, 0x11, 0x22, 0x33, 0x44, 0x55, 0x66,
+      0x08, 0x00,
+      # ipv4
+      0x45, 0x12, 0x00, 0x54, 0x43, 0x21, 0x00, 0x00, 0x48, 0x06, 0xac, 0x1b,
+      0xc0, 0xa8, 0x01, 0x02, 0xc0, 0xa8, 0x01, 0x03,
+      # tcp
+      0x43, 0x21, 0xab, 0xcd,
+      0x00, 0x00, 0x00, 0x20, 0x00, 0x00, 0x00, 0x00, 0x50, 0x0b, 0x11, 0x22,
+      0x57, 0x9c, 0x00, 0x00, 0x74, 0x68, 0x65, 0x20, 0x71, 0x75, 0x69, 0x63,
+      0x6b, 0x20, 0x62, 0x72, 0x6f, 0x77, 0x6e, 0x20, 0x66, 0x6f, 0x78, 0x20,
+      0x6a, 0x75, 0x6d, 0x70, 0x65, 0x64, 0x20, 0x6f, 0x76, 0x65, 0x72, 0x20,
+      0x74, 0x68, 0x65, 0x20, 0x6c, 0x61, 0x7a, 0x79, 0x20, 0x64, 0x6f, 0x67
+    ].pack("C*")
+    payload = "the quick brown fox jumped over the lazy dog"
+
+    l = Libnet.new(:link)
+
+    t = l.build_tcp do |t|
+      t.src_port = 0x4321
+      t.dst_port = 0xabcd
+      t.seq      = 32
+      t.ack      = 0
+      t.control  = 0x0b
+      t.window   = 0x1122
+      t.checksum = 0
+      t.urgent   = 0
+      t.payload  = payload
+    end
+
+    l.build_ipv4 do |i|
+      i.tos      = 0x12
+      i.length   = Libnet::HL_IPV4 + Libnet::HL_TCP + payload.length
+      i.id       = 0x4321
+      i.frag_off = 0
+      i.ttl      = 72
+      i.protocol = Libnet::IPPROTO_TCP
+      i.checksum = 0
+      i.src_ip   = '192.168.1.2'
+      i.dst_ip   = 0xc0a80103
+    end
+
+    l.build_ethernet do |e|
+      e.dst = 'aa:bb:cc:dd:ee:ff'
+      e.src = '11:22:33:44:55:66'
+      e.type = 0x0800
+    end
+
+    assert_equal(bytes, l.pack)
+
+    if Process.uid > 0 && Process.euid > 0
+      # user is not root, so we should get an exception here
+      assert_raise RuntimeError do
+        l.write
+      end
+    else
+      # user is root, so this should work
+      assert_equal(bytes.length, l.write)
+    end
+  end
+end

data/test/ts_all.rb

@@ -13,3 +13,4 @@ require 'tc_arp'
 require 'tc_ipv4'
 require 'tc_ipv6'
 require 'tc_udp'
+require 'tc_tcp'

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: libnet4r
 version: !ruby/object:Gem::Version 
-  version: "0.1"
-date: 2007-11-18 00:00:00 -06:00
+  version: "0.2"
+date: 2007-11-19 00:00:00 -06:00
 summary: Packet builder and injection library.
 require_paths: 
 - lib
@@ -38,6 +38,7 @@ files:
 - ext/libnet_ethernet.c
 - ext/libnet_ipv4.c
 - ext/libnet_ipv6.c
+- ext/libnet_tcp.c
 - ext/libnet_udp.c
 - ext/libnet_vlan.c
 - lib/libnet4r/header.rb
@@ -50,6 +51,7 @@ files:
 - test/tc_init.rb
 - test/tc_ipv4.rb
 - test/tc_ipv6.rb
+- test/tc_tcp.rb
 - test/tc_udp.rb
 - test/tc_vlan.rb
 - test/ts_all.rb