packetgen 1.2.0 → 1.3.0

data/lib/packetgen/header/tcp/option.rb

@@ -4,41 +4,59 @@ module PacketGen
 
       # Base class to describe a TCP option
       # @author Sylvain Daubert
-      class Option < Struct.new(:kind, :length, :value)
-        include StructFu
+      class Option < Base
 
+        # EOL option value
         EOL_KIND       = 0
+        # NOP option value
         NOP_KIND       = 1
+        # MSS option value
         MSS_KIND       = 2
+        # WS option value
         WS_KIND        = 3
+        # SACKOK option value
         SACKOK_KIND    = 4
+        # SACK option value
         SACK_KIND      = 5
+        # ECHO option value
         ECHO_KIND      = 6
+        # ECHOREPLY option value
         ECHOREPLY_KIND = 7
+        # TS option value
         TS_KIND        = 8
 
+        # @!attribute kind
+        #  Option kind
+        #  @return [Integer] 8-bit option kind
+        define_field :kind, Types::Int8
+        # @!attribute length
+        #  Option length
+        #  @return [Integer] 8-bit option length
+        define_field :length, Types::Int8
+        # @!attribute value
+        #  @return [Integer,String] option value
+        define_field :value, Types::String
+
         # @param [hash] options
         # @option options [Integer] :kind
         # @option options [Integer] :length
         # @option options [Integer,String] :value
         def initialize(options={})
-          super Int8.new(options[:kind]),
-                Int8.new(options[:length])
-
+          super
           case options[:value]
           when Integer
             klass = case self[:length].to_i
-                    when 3; Int8
-                    when 4; Int16
-                    when 6; Int32
+                    when 3; Types::Int8
+                    when 4; Types::Int16
+                    when 6; Types::Int32
                     else
                       raise ArgumentError, 'impossible length'
                     end
             self[:value] = klass.new(options[:value])
           when NilClass
-            self[:value] = StructFu::String.new
+            self[:value] = Types::String.new
           else
-            self[:value] = StructFu::String.new.read(options[:value])
+            self[:value] = Types::String.new.read(options[:value])
             self[:length].read(self[:value].sz + 2) unless options[:length]
           end
         end
@@ -59,33 +77,6 @@ module PacketGen
           self
         end
 
-        # Getter for kind attribute
-        # @return [Integer]
-        def kind
-          self[:kind].to_i
-        end
-
-        # Setter for kind attribute
-        # @param [Integer] i
-        # @return [Integer]
-        def kind=(i)
-          self[:kind].read i
-        end
-
-        # Getter for length attribute
-        # @return [Integer]
-        def length
-          self[:length].to_i
-        end
-
-        # Setter for length attribute
-        # @param [Integer] i
-        # @return [Integer]
-        def length=(i)
-          self[:length].read i
-        end
-
-        # Say if option has a length
         # @return [Boolean]
         def has_length?
           self[:kind].value && kind >= 2
@@ -95,20 +86,13 @@ module PacketGen
         # @return [String, Integer]
         def value
           case self[:value]
-          when StructFu::Int
+          when Types::Int
             self[:value].to_i
           else
             self[:value].to_s
           end
         end
 
-        # Setter for value attribute
-        # @param [String, Integer] v
-        # @return [String, Integer]
-        def value=(v)
-          self[:value].read v
-        end
-
         # Get binary string
         # @return [String]
         def to_s
@@ -160,7 +144,7 @@ module PacketGen
         # @see Option#initialize
         def initialize(options={})
           super options.merge!(kind: MSS_KIND, length: 4)
-          self[:value] = Int16.new(options[:value])
+          self[:value] = Types::Int16.new(options[:value])
         end
 
         # @return [String]
@@ -175,7 +159,7 @@ module PacketGen
         # @see Option#initialize
         def initialize(options={})
           super options.merge!(kind: WS_KIND, length: 3)
-          self[:value] = Int8.new(options[:value])
+          self[:value] = Types::Int8.new(options[:value])
         end
 
         # @return [String]
@@ -209,7 +193,7 @@ module PacketGen
         # @see Option#initialize
         def initialize(options={})
           super options.merge!(kind: ECHO_KIND, length: 6)
-          self[:value] = Int32.new(options[:value])
+          self[:value] = Types::Int32.new(options[:value])
         end
 
         # @return [String]
@@ -224,7 +208,7 @@ module PacketGen
         # @see Option#initialize
         def initialize(options={})
           super options.merge!(kind: ECHOREPLY_KIND, length: 6)
-          self[:value] = Int32.new(options[:value])
+          self[:value] = Types::Int32.new(options[:value])
         end
 
         # @return [String]
@@ -239,7 +223,7 @@ module PacketGen
         # @see Option#initialize
         def initialize(options={})
           super options.merge!(kind: TS_KIND, length: 10)
-          self[:value] = StructFu::String.new.read(options[:value] || "\0" * 8)
+          self[:value] = Types::String.new.read(options[:value] || "\0" * 8)
         end
 
         # @return [String]

data/lib/packetgen/header/tcp/options.rb

@@ -4,7 +4,7 @@ module PacketGen
 
       # Container for TCP options in {TCP TCP header}.
       # @author Sylvain Daubert
-      class Options < Array
+      class Options < Types::Array
 
         # Get {Option} subclasses
         # @return [Array<Class>]
@@ -47,36 +47,35 @@ module PacketGen
           self
         end
 
+        # @deprecated use {#push} or {#<<}
         # Add a well-known option
         # @param [String] opt option name
         # @param [Object] value
         # @return [self]
         # @raise [ArgumentError] unknown option
         def add(opt, value=nil)
-          raise ArgumentError, "unknown option #{opt}" unless TCP.const_defined?(opt)
-          klass = TCP.const_get(opt)
-          raise ArgumentError "unknown option #{opt}" unless klass < Option
-          option = klass.new(value: value)
+          option = record_from_hash(opt: opt, value: value)
           self << option
           self
         end
 
-        # Get options binary string
-        # @return [String]
-        def to_s
-          map(&:to_s).join
-        end
-
-        # Get a human readable string
-        # @return [String]
-        def to_human
-          map(&:to_human).join(', ')
-        end
+        private
 
-        # Get options size in bytes
-        # @return [Integer]
-        def sz
-          to_s.length
+        def record_from_hash(hsh)
+          if hsh.has_key? :opt
+            klassname = hsh.delete(:opt)
+            if TCP.const_defined?(klassname)
+              klass = TCP.const_get(klassname)
+              unless klass < Option
+                raise ArgumentError, 'opt should be a TCP::Option subclass'
+              end
+              klass.new(hsh)
+            else
+              raise ArgumentError, 'opt should be a TCP::Option subclass'
+            end
+          else
+            hsh
+          end
         end
       end
     end

data/lib/packetgen/header/tcp.rb

@@ -2,9 +2,9 @@ module PacketGen
   module Header
 
     # A TCP header consists of:
-    # * a source port ({#sport}, {Int16} type),
+    # * a source port ({#sport}, {Types::Int16} type),
     # * a destination port ({#dport}, +Int16+ type),
-    # * a sequence number ({#seqnum}, {Int32} type),
+    # * a sequence number ({#seqnum}, {Types::Int32} type),
     # * an acknownledge number ({#acknum}, +Int32+ type),
     # * a 16-bit field ({#u16}, +Int16+ type) composed of:
     #   * a 4-bit {#data_offset} value,
@@ -14,7 +14,7 @@ module PacketGen
     # * a {#checksum} field (+Int16+ type),
     # * a urgent pointer ({#urg_pointer}, +Int16+ type),
     # * an optional {#options} field ({Options} type),
-    # * and a {#body} ({String} type).
+    # * and a {#body} ({Types::String} type).
     #
     # == Create a TCP header
     #  # standalone
@@ -43,14 +43,10 @@ module PacketGen
     # == Options
     # {#options} TCP attribute is a {Options}. {Option} may added to it:
     #  tcph.options << PacketGen::Header::TCP::MSS.new(1250)
-    # Another way is to use {Options#add}:
-    #  tcph.options.add 'MSS', 1250
+    # or:
+    #  tcph.options << { opt: 'MSS', value: 1250 }
     # @author Sylvain Daubert
-    class TCP < Struct.new(:sport, :dport, :seqnum, :acknum, :u16,
-                           :window, :checksum, :urg_pointer, :options, :body)
-      include StructFu
-      include HeaderMethods
-      extend HeaderClassMethods
+    class TCP < Base
     end
   end
 end
@@ -65,6 +61,61 @@ module PacketGen
       # IP protocol number for TCP
       IP_PROTOCOL = 6
 
+      # @!attribute sport
+      #  16-bit TCP source port
+      #  @return [Integer]
+      define_field :sport, Types::Int16
+      # @!attribute dport
+      #  16-bit TCP destination port
+      #  @return [Integer]
+      define_field :dport, Types::Int16
+      # @!attribute seqnum
+      #  32-bit TCP sequence number
+      #  @return [Integer]
+      define_field :seqnum, Types::Int32, default: -> { rand(2**32) }
+      # @!attribute acknum
+      #  32-bit TCP acknowledgement number
+      #  @return [Integer]
+      define_field :acknum, Types::Int32
+      # @!attribute u16
+      #  @return [Integer] 16-bit word used by flags and bit fields
+      define_field :u16, Types::Int16
+      # @!attribute window
+      #  16-bit TCP window size
+      #  @return [Integer]
+      define_field :window, Types::Int16
+      # @!attribute checksum
+      #  16-bit TCP checksum
+      #  @return [Integer]
+      define_field :checksum, Types::Int16
+      # @!attribute urg_pointer
+      #  16-bit TCP urgent data pointer
+      #  @return [Integer]
+      define_field :urg_pointer, Types::Int16
+      # @!attribute options
+      #  TCP options
+      #  @return [Options]
+      define_field :options, TCP::Options
+      # @!attribute body
+      #  @return [Types::String,Header::Base]
+      define_field :body, Types::String
+
+      alias source_port sport
+      alias source_port= sport=
+      alias destination_port dport
+      alias destination_port= dport=
+      alias sequence_number seqnum
+      alias sequence_number= seqnum=
+      alias acknowledgement_number acknum
+      alias acknowledgement_number= acknum=
+      alias wsize window
+      alias wsize= window=
+
+      # Call {Base#initialize), then handle specific options to set +u16+ by part:
+      # * +:data_offset+
+      # * +:hlen+
+      # * +:reserved+
+      # * +:flags+
       # @param [Hash] options
       # @option options [Integer] :sport
       # @option options [Integer] :dport
@@ -78,21 +129,8 @@ module PacketGen
       # @option options [Integer] :urg_pointer
       # @option options [String] :body
       def initialize(options={})
-        super Int16.new(options[:sport]),
-              Int16.new(options[:dport]),
-              Int32.new(options[:seqnum] || rand(2**32)),
-              Int32.new(options[:acknum]),
-              Int16.new,
-              Int16.new(options[:window] || options[:wsize]),
-              Int16.new(options[:checksum]),
-              Int16.new(options[:urg_pointer]),
-              Options.new,
-              StructFu::String.new.read(options[:body])
-
-        doff = options[:data_offset] || options[:hlen] || 5
-        rsv = options[:reserved] || 0
-        flgs = options[:flags] || 0
-        self.u16.read (((doff << 3) | rsv) << 9) | flgs
+        opts = { data_offset: 5 }.merge!(options)
+        super(opts)
       end
 
       # @!attribute data_offset
@@ -130,7 +168,6 @@ module PacketGen
       # @return [self]
       def read(str)
         return self if str.nil?
-        raise ParseError, 'string too short for TCP' if str.size < self.sz
         force_binary str
         self[:sport].read str[0, 2]
         self[:dport].read str[2, 2]
@@ -142,6 +179,7 @@ module PacketGen
         self[:urg_pointer].read str[18, 2]
         self[:options].read str[20, (self.data_offset - 5) * 4] if self.data_offset > 5
         self[:body].read str[self.data_offset * 4..-1]
+        self
       end
 
       # Compute checksum and set +checksum+ field
@@ -167,109 +205,8 @@ module PacketGen
         self[:data_offset] = 5 + self[:options].sz / 4
       end
 
-      # Getter for source port
-      # @return [Integer]
-      def sport
-        self[:sport].to_i
-      end
-      alias :source_port :sport
-
-      # Setter for source port
-      # @param [Integer] port
-      # @return [Integer]
-      def sport=(port)
-        self[:sport].read port
-      end
-      alias :source_port= :sport=
-
-      # Getter for destination port
-      # @return [Integer]
-      def dport
-        self[:dport].to_i
-      end
-      alias :destination_port :dport
-
-      # Setter for destination port
-      # @param [Integer] port
-      # @return [Integer]
-      def dport=(port)
-        self[:dport].read port
-      end
-      alias :destination_port= :dport=
-
-      # Getter for seqnum attribuute
-      # @return [Integer]
-      def seqnum
-        self[:seqnum].to_i
-      end
-      alias :sequence_number :seqnum
-
-      # Setter for seqnum attribuute
-      # @param [Integer] seq
-      # @return [Integer]
-      def seqnum=(seq)
-        self[:seqnum].read seq
-      end
-      alias :sequence_number= :seqnum=
-
-      # Getter for acknum attribuute
-      # @return [Integer]
-      def acknum
-        self[:acknum].to_i
-      end
-      alias :acknowledgment_number :acknum
-
-      # Setter for acknum attribuute
-      # @param [Integer] ack
-      # @return [Integer]
-      def acknum=(ack)
-        self[:acknum].read ack
-      end
-      alias :acknowledgment_number= :acknum=
-
-      alias :hlen :data_offset
-      alias :hlen= :data_offset=
-
-      # Getter for window attribuute
-      # @return [Integer]
-      def window
-        self[:window].to_i
-      end
-      alias :wsize :window
-
-      # Setter for window attribuute
-      # @param [Integer] window
-      # @return [Integer]
-      def window=(window)
-        self[:window].read window
-      end
-      alias :wsize= :window=
-
-      # Getter for checksum attribuute
-      # @return [Integer]
-      def checksum
-        self[:checksum].to_i
-      end
-
-      # Setter for checksum attribuute
-      # @param [Integer] sum
-      # @return [Integer]
-      def checksum=(sum)
-        self[:checksum].read sum
-      end
-
-      # Getter for urg_pointer attribuute
-      # @return [Integer]
-      def urg_pointer
-        self[:urg_pointer].to_i
-      end
-
-      # Setter for urg_pointer attribuute
-      # @param [Integer] urg
-      # @return [Integer]
-      def urg_pointer=(urg)
-        self[:urg_pointer].read urg
-      end
+      alias hlen data_offset
+      alias hlen= data_offset=
 
       # @return [String]
       def inspect

data/lib/packetgen/header/udp.rb

@@ -7,7 +7,7 @@ module PacketGen
   module Header
 
     # A UDP header consists of:
-    # * a source port field ({#sport}, {Int16} type),
+    # * a source port field ({#sport}, {Types::Int16} type),
     # * a destination port field ({#dport}, +Int16+ type),
     # * a UDP length field ({#length}, +Int16+ type),
     # * a {#checksum} field (+Int16+ type),
@@ -29,42 +29,41 @@ module PacketGen
     #  udp.body.read 'this is a UDP body'
     #
     # @author Sylvain Daubert
-    class UDP < Struct.new(:sport, :dport, :length, :checksum, :body)
-      include StructFu
-      include HeaderMethods
-      extend HeaderClassMethods
+    class UDP < Base
 
       # IP protocol number for UDP
       IP_PROTOCOL = 17
 
-      # @param [Hash] options
-      # @option options [Integer] :sport source port
-      # @option options [Integer] :dport destination port
-      # @option options [Integer] :length UDP length. Default: calculated
-      # @option options [Integer] :checksum. UDP checksum. Default: 0
+      # @!attribute sport
+      #  16-bit UDP source port
+      #  @return [Integer]
+      define_field :sport, Types::Int16
+      # @!attribute dport
+      #  16-bit UDP destination port
+      #  @return [Integer]
+      define_field :dport, Types::Int16
+      # @!attribute length
+      #  16-bit UDP length
+      #  @return [Integer]
+      define_field :length, Types::Int16, default: 8
+      # @!attribute checksum
+      #  16-bit UDP checksum
+      #  @return [Integer]
+      define_field :checksum, Types::Int16
+      # @!attribute body
+      #  @return [Types::String,Header::Base]
+      define_field :body, Types::String
+
+      alias source_port sport
+      alias source_port= sport=
+      alias destination_port dport
+      alias destination_port= dport=
+
+      # Call {Base#initialize), and automagically compute +length+ if +:body+
+      # option is set.
       def initialize(options={})
-        super Int16.new(options[:sport]),
-              Int16.new(options[:dport]),
-              Int16.new(options[:length]),
-              Int16.new(options[:checksum]),
-              StructFu::String.new.read(options[:body])
-        unless options[:length]
-          calc_length
-        end
-      end
-
-      # Read a IP header from a string
-      # @param [String] str binary string
-      # @return [self]
-      def read(str)
-        return self if str.nil?
-        raise ParseError, 'string too short for UDP' if str.size < self.sz
-        force_binary str
-        self[:sport].read str[0, 2]
-        self[:dport].read str[2, 2]
-        self[:length].read str[4, 2]
-        self[:checksum].read str[6, 2]
-        self[:body].read str[8..-1]
+        super
+        self.length += self[:body].sz if self[:body].sz > 0
       end
 
       # Compute checksum and set +checksum+ field
@@ -93,62 +92,6 @@ module PacketGen
       def calc_length
         self[:length].value = self.sz
       end
-
-      # Getter for source port
-      # @return [Integer]
-      def sport
-        self[:sport].to_i
-      end
-      alias :source_port :sport
-
-      # Setter for source port
-      # @param [Integer] port
-      # @return [Integer]
-      def sport=(port)
-        self[:sport].read port
-      end
-      alias :source_port= :sport=
-
-      # Getter for destination port
-      # @return [Integer]
-      def dport
-        self[:dport].to_i
-      end
-      alias :destination_port :dport
-
-      # Setter for destination port
-      # @param [Integer] port
-      # @return [Integer]
-      def dport=(port)
-        self[:dport].read port
-      end
-      alias :destination_port= :dport=
-
-      # Getter for length attribuute
-      # @return [Integer]
-      def length
-        self[:length].to_i
-      end
-
-      # Setter for length attribuute
-      # @param [Integer] len
-      # @return [Integer]
-      def length=(len)
-        self[:length].read len
-      end
-
-      # Getter for checksum attribuute
-      # @return [Integer]
-      def checksum
-        self[:checksum].to_i
-      end
-
-      # Setter for checksum attribuute
-      # @param [Integer] checksum
-      # @return [Integer]
-      def checksum=(checksum)
-        self[:checksum].read checksum
-      end
     end
 
     self.add_class UDP

data/lib/packetgen/header.rb

@@ -10,11 +10,7 @@ module PacketGen
   # Since v1.1.0, PacketGen permits adding you own header classes.
   # First, define the new header class. By example:
   #  module MyModule
-  #    class MyHeader < Struct.new(:field1, :field2)
-  #      include PacketGen::StructFu
-  #      include PacketGen::Header::HeaderMethods
-  #      extend PacketGen::Header::HeaderClassMethods
-  #      
+  #    class MyHeader < PacketGen::Header::Base
   #      def initialize(options={})
   #        super Int32.new(options[:field1]), Int32.new(options[:field2])
   #      end
@@ -47,8 +43,7 @@ module PacketGen
 
     # Add a foreign header class to known header classes. This is
     # needed by {Packet.gen} and {Packet#add}.
-    # @param [Class] klass a header class, which should include
-    #   {Header::HeaderMethods} and {Header::HeaderClassMethods}
+    # @param [Class] klass a header class
     # @return [void]
     # @since 1.1.0
     def self.add_class(klass)
@@ -57,7 +52,7 @@ module PacketGen
       @header_classes = nil
     end
 
-    # Remove a foreign header (previously added by {.add_header_class}à
+    # Remove a foreign header (previously added by {.add_header_class}
     # from known header classes.
     # @param [Class] klass
     # @return [void]
@@ -82,8 +77,7 @@ module PacketGen
   end
 end
 
-require_relative 'header/header_class_methods'
-require_relative 'header/header_methods'
+require_relative 'header/base'
 require_relative 'header/eth'
 require_relative 'header/ip'
 require_relative 'header/icmp'
@@ -93,3 +87,4 @@ require_relative 'header/icmpv6'
 require_relative 'header/udp'
 require_relative 'header/tcp'
 require_relative 'header/esp'
+require_relative 'header/dns'