packetgen 2.3.0 → 2.4.0

data/lib/packetgen/header/igmpv3/mr.rb

@@ -0,0 +1,65 @@
+# This file is part of PacketGen
+# See https://github.com/sdaubert/packetgen for more informations
+# Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
+# This program is published under MIT license.
+require_relative 'group_record'
+
+module PacketGen
+  module Header
+    class IGMPv3
+      # IGMPv3 Membership Report.
+      #
+      # This is a subpayload for IGMPv3 packets only. This kind of payload is
+      # sent by IP systems to report (to neighboring routers) the current multicast 
+      # reception state, or changes in the multicast reception state, of their
+      # interfaces. Reports have the following format:
+      #    0                   1                   2                   3
+      #    0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+      #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+      #   |           Reserved            |  Number of Group Records (M)  |
+      #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+      #   |                                                               |
+      #   .                                                               .
+      #   .                        Group Record [1]                       .
+      #   .                                                               .
+      #   |                                                               |
+      #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+      #   |                                                               |
+      #   .                                                               .
+      #   .                        Group Record [2]                       .
+      #   .                                                               .
+      #   |                                                               |
+      #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+      #   |                               .                               |
+      #   .                               .                               .
+      #   |                               .                               |
+      #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+      #   |                                                               |
+      #   .                                                               .
+      #   .                        Group Record [M]                       .
+      #   .                                                               .
+      #   |                                                               |
+      #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+      # @author Sylvain Daubert
+      class MR < Base
+        # @!attribute reserved
+        #  16-bit reserved field
+        # @return [Integer]
+        define_field :reserved, Types::Int16, default: 0
+        # @!attribute number_of_gr
+        #  16-bit Number of group records in {#group_records}
+        #  @return [Integer]
+        define_field :number_of_gr, Types::Int16, default: 0
+        
+        # @!attribute group_records
+        #  Array of group records
+        #  @return [GroupRecords]
+        define_field :group_records, GroupRecords,
+                     builder: ->(h, t) { t.new(counter: h[:number_of_gr]) }
+      end
+    end
+
+    self.add_class IGMPv3::MR
+    IGMPv3.bind_header IGMPv3::MR, type: 0x22
+  end
+end

data/lib/packetgen/header/ip.rb

@@ -60,54 +60,13 @@ module PacketGen
     #  ip.dst = '127.0.0.2'
     #  ip.body.read 'this is a body'
     # @author Sylvain Daubert
-    class IP < Base
+    class IP < Base;end
 
-      # IP address, as a group of 4 bytes
-      # @author Sylvain Daubert
-      class Addr < Types::Fields
-        # @!attribute a1
-        #  @return [Integer] IP address first byte 
-        define_field :a1, Types::Int8
-        # @!attribute a2
-        #  @return [Integer] IP address seconf byte 
-        define_field :a2, Types::Int8
-        # @!attribute a3
-        #  @return [Integer] IP address third byte 
-        define_field :a3, Types::Int8
-        # @!attribute a4
-        #  @return [Integer] IP address fourth byte 
-        define_field :a4, Types::Int8
+require_relative 'ip/addr'
+require_relative 'ip/option'
+require_relative 'ip/options'
 
-        IPV4_ADDR_REGEX = /^(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})$/
-
-        # Read a dotted address
-        # @param [String] str
-        # @return [self]
-        def from_human(str)
-          return self if str.nil?
-          m = str.match(IPV4_ADDR_REGEX)
-          if m
-            self[:a1].read m[1].to_i
-            self[:a2].read m[2].to_i
-            self[:a3].read m[3].to_i
-            self[:a4].read m[4].to_i
-          end
-          self
-        end
-
-        # Addr in human readable form (dotted format)
-        # @return [String]
-        def to_human
-          fields.map { |f| "#{self[f].to_i}" }.join('.')
-        end
-
-        # Addr as an integer
-        # @return [Integer]
-        def to_i
-          (self.a1 << 24) | (self.a2 << 16) | (self.a3 << 8) |
-            self.a4
-        end
-      end
+    class IP
 
       # IP Ether type
       ETHERTYPE = 0x0800
@@ -146,8 +105,7 @@ module PacketGen
       # @!attribute options
       #  @since 2.2.0
       #  @return [Types::String]
-      define_field :options, Types::String, optional: ->(h) { h.ihl > 5 },
-                   builder: ->(h,t) { t.new(length_from: ->() { (h.ihl - 5) * 4 }) }
+      define_field :options, Options, optional: ->(h) { h.ihl > 5 }
       # @!attribute body
       #  @return [Types::String,Header::Base]
       define_field :body, Types::String
@@ -171,25 +129,27 @@ module PacketGen
       # Populate object from a binary string
       # @param [String] str
       # @return [Fields] self
-      #def read(str)
-      #  return self if str.nil?
-      #  force_binary str
-      #  self[:u8].read str[0, 1]
-      #  self[:tos].read str[1, 1]
-      #  self[:length].read str[2, 2]
-      #  self[:id].read str[4, 2]
-      #  self[:frag].read str[6, 2]
-      #  self[:ttl].read str[8, 1]
-      #  self[:protocol].read str[9, 1]
-      #  self[:checksum].read str[10, 2]
-      #  self[:src].read str[12, 4]
-      #  self[:dst].read str[16, 4]
-      #  if self.ihl > 5
-      #    opt_size = (self.ihl - 5) * 4
-      #    self[:options].read str[20, opt_size]
-      #  end
-      #  self
-      #end
+      def read(str)
+        return self if str.nil?
+        force_binary str
+        self[:u8].read str[0, 1]
+        self[:tos].read str[1, 1]
+        self[:length].read str[2, 2]
+        self[:id].read str[4, 2]
+        self[:frag].read str[6, 2]
+        self[:ttl].read str[8, 1]
+        self[:protocol].read str[9, 1]
+        self[:checksum].read str[10, 2]
+        self[:src].read str[12, 4]
+        self[:dst].read str[16, 4]
+        opt_size = 0
+        if self.ihl > 5
+          opt_size = (self.ihl - 5) * 4
+          self[:options].read str[20, opt_size]
+        end
+        self[:body].read str[20+opt_size..-1]
+        self
+      end
 
       # Compute checksum and set +checksum+ field
       # @return [Integer]
@@ -203,8 +163,11 @@ module PacketGen
         checksum += (self[:src].to_i & 0xffff)
         checksum += self[:dst].to_i >> 16
         checksum += self[:dst].to_i & 0xffff
-        checksum = (checksum & 0xffff) + (checksum >> 16)
-        checksum = ~(checksum % 0xffff ) & 0xffff
+        options.to_s.unpack('n*').each { |x| checksum += x }
+        while checksum > 0xffff do
+          checksum = (checksum & 0xffff) + (checksum >> 16)
+        end
+        checksum = ~checksum & 0xffff
         self[:checksum].value = (checksum == 0) ? 0xffff : checksum
       end
 
@@ -260,7 +223,14 @@ module PacketGen
       # Check version field
       # @see [Base#parse?]
       def parse?
-        version == 4
+        version == 4 and ihl >= 5
+      end
+
+      # Get binary string. Fixup IHL if needed (IP header has options, and IHL
+      # was not set by user).
+      def to_s
+        self.ihl = 5 + options.sz / 4 if self.ihl == 5
+        super
       end
     end
 

data/lib/packetgen/header/ip/addr.rb

@@ -0,0 +1,58 @@
+# This file is part of PacketGen
+# See https://github.com/sdaubert/packetgen for more informations
+# Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
+# This program is published under MIT license.
+
+module PacketGen
+  module Header
+    class IP
+
+      # IP address, as a group of 4 bytes
+      # @author Sylvain Daubert
+      class Addr < Types::Fields
+        # @!attribute a1
+        #  @return [Integer] IP address first byte 
+        define_field :a1, Types::Int8
+        # @!attribute a2
+        #  @return [Integer] IP address seconf byte 
+        define_field :a2, Types::Int8
+        # @!attribute a3
+        #  @return [Integer] IP address third byte 
+        define_field :a3, Types::Int8
+        # @!attribute a4
+        #  @return [Integer] IP address fourth byte 
+        define_field :a4, Types::Int8
+
+        IPV4_ADDR_REGEX = /^(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})$/
+
+        # Read a dotted address
+        # @param [String] str
+        # @return [self]
+        def from_human(str)
+          return self if str.nil?
+          m = str.match(IPV4_ADDR_REGEX)
+          if m
+            self[:a1].read m[1].to_i
+            self[:a2].read m[2].to_i
+            self[:a3].read m[3].to_i
+            self[:a4].read m[4].to_i
+          end
+          self
+        end
+
+        # Addr in human readable form (dotted format)
+        # @return [String]
+        def to_human
+          fields.map { |f| "#{self[f].to_i}" }.join('.')
+        end
+
+        # Addr as an integer
+        # @return [Integer]
+        def to_i
+          (self.a1 << 24) | (self.a2 << 16) | (self.a3 << 8) |
+            self.a4
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,194 @@
+# This file is part of PacketGen
+# See https://github.com/sdaubert/packetgen for more informations
+# Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
+# This program is published under MIT license.
+
+module PacketGen
+  module Header
+    class IP
+
+      # Class to handle series of IP addresses
+      # @author Sylvain Daubert
+      class ArrayOfAddr < Types::Array
+        set_of IP::Addr
+        
+        # Push a IP address to the array
+        # @param [String,Addr] addr
+        # @return [self]
+        #   array << '192.168.1.12'
+        def push(addr)
+          addr = addr.is_a?(Addr) ? addr : Addr.new.from_human(addr)
+          super(addr)
+        end
+      end
+
+      # Base class for IP options
+      # @author Sylvain Daubert
+      class Option < Types::Fields
+
+        # EOL option type
+        EOL_TYPE = 0x00
+        # NOP option type
+        NOP_TYPE = 0x01
+        # LSRR option type
+        LSRR_TYPE = 0x83
+        # SSRR option type
+        SSRR_TYPE = 0x84
+        # RR option type
+        RR_TYPE = 0x07
+        # SI option type
+        SI_TYPE = 0x88
+        # RA option type
+        RA_TYPE = 0x94
+
+        # @!attribute type
+        #  8-bit option type
+        # @return [Integer]
+        define_field :type, Types::Int8
+        # @!attribute length
+        #  8-bit option length. If 0, there is no +length+ field in option
+        # @return [Integer]
+        define_field :length, Types::Int8, default: 0, optional: ->(h) { h.type > 1 }
+        # @!attribute data
+        #  option data
+        # @return [String]
+        define_field :data, Types::String, optional: ->(h) { h.length > 2 },
+                     builder: ->(h,t) { t.new(length_from: ->() { h.length - 2 }) }
+
+        # @!attribute copied
+        #  1-bit copied flag from {#type} field
+        #  @return [Boolean]
+        # @!attribute option_class
+        #  2-bit option class (0: control, 2: debug and measurement, 1 and 3:
+        #  reserved) from {#type} field
+        #  @return [Integer]
+        # !@attribute number
+        #  5-bit option number from {#type} field
+        #  @return [Integer]
+        define_bit_fields_on :type, :copied, :option_class, 2, :number, 5
+
+        # @return [Hash]
+        def self.types
+          return @types if defined? @types
+          @types = {}
+          Option.constants.each do |cst|
+            next unless cst.to_s.end_with? '_TYPE'
+            optname = cst.to_s.sub(/_TYPE/, '')
+            @types[Option.const_get(cst)] = IP.const_get(optname)
+          end
+          @types
+        end
+
+        def initialize(options={})
+          unless options[:type]
+            opt_name = self.class.to_s.gsub(/.*::/, '')
+            if Option.const_defined? "#{opt_name}_TYPE"
+              options[:type] = Option.const_get("#{opt_name}_TYPE")
+            end
+          end
+          super
+        end
+
+        # Get binary string. Set {#length} field.
+        # @return [String]
+        def to_s
+          if respond_to? :length
+            self.length = super.size
+          end
+          super
+        end
+
+        # Get a human readable string
+        # @return [String]
+        def to_human
+          str = self.class == Option ? "unk-#{type}" : self.class.to_s.sub(/.*::/, '')
+          if respond_to?(:length) and length > 2 and self[:data].to_s.size > 0
+            str << ":#{self[:data].to_s.inspect}"
+          end
+          str
+        end
+      end
+
+      # End-of-option-List IP option
+      class EOL < Option
+        delete_field :length
+        undef length
+        delete_field :data
+        undef data
+      end
+
+      # No OPeration IP option
+      class NOP < EOL
+      end
+      
+      # Loose Source and Record Route IP option
+      class LSRR < Option
+        delete_field :data
+        undef data
+        
+        # @!attribute pointer
+        #  8-bit pointer on next address
+        #  @return [Integer]
+        define_field :pointer, Types::Int8
+        # @!attribute data
+        #  Array of IP addresses
+        #  @return [Types::Array<IP::Addr>]
+        define_field :data, ArrayOfAddr,
+                     builder: ->(h,t) { t.new(length_from: ->() { h.length - 2 }) }
+
+        # Populate object from a binary string
+        # @param [String] str
+        # @return [Fields] self
+        def read(str)
+          return self if str.nil?
+          force_binary str
+          self[:type].read str[0, 1]
+          self[:length].read str[1, 1]
+          self[:pointer].read str[2, 1]
+          self[:data].read str[3, length - 3]
+          self
+        end
+
+        # Get IP address pointer by {#pointer}
+        # @return [Addr]
+        def pointed_addr
+          data[pointer / 4 - 1]
+        end
+        
+        # Get a human readable string
+        # @return [String]
+        def to_human
+          str = self.class.to_s.sub(/.*::/, '')
+          str << ':' << self[:data].to_human
+        end
+      end
+
+      # Strict Source and Record Route IP option
+      class SSRR < LSRR; end
+      # Record Route IP option
+      class RR < LSRR; end
+
+      # Stream Identifier IP option
+      class SI < Option
+        delete_field :data
+        undef data
+        
+        # @!attribute id
+        #  16-bit stream ID
+        #  @return [Integer]
+        define_field :id, Types::Int16
+      end
+      
+      # Router Alert IP option
+      class RA < Option
+        delete_field :data
+        undef data
+        
+        # @!attribute value
+        #  16-bit value. Should be 0.
+        #  @return [Integer]
+        define_field :value, Types::Int16, default: 0
+      end
+    end
+  end
+end