packetgen 2.8.7 → 3.0.0

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

@@ -74,6 +74,8 @@ module PacketGen
         #  @return [Integer]
         define_bit_fields_on :u8, :resv, 4, :flag_s, :qrv, 3
 
+        undef qqic, qqic=
+
         # Get QQIC value
         # @note May return a different value from value previously set, as a
         #   float encoding is used to encode big values. See {IGMPv3.decode}.

data/lib/packetgen/header/ip.rb

@@ -9,6 +9,22 @@ require 'socket'
 
 module PacketGen
   module Header
+    # IP protocol ({https://tools.ietf.org/html/rfc791 RFC 791})
+    #    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
+    #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    #   |Version|  IHL  |Type of Service|          Total Length         |
+    #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    #   |         Identification        |Flags|      Fragment Offset    |
+    #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    #   |  Time to Live |    Protocol   |         Header Checksum       |
+    #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    #   |                       Source Address                          |
+    #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    #   |                    Destination Address                        |
+    #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    #   |                    Options                    |    Padding    |
+    #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
     # A IP header consists of:
     # * a first byte ({#u8} of {Types::Int8} type) composed of:
     #   * a 4-bit {#version} field,
@@ -24,7 +40,7 @@ module PacketGen
     # * a {#checksum} field (+Int16+),
     # * a source IP address ({#src}, {Addr} type),
     # * a destination IP address ({#dst}, +Addr+ type),
-    # * an optional {#options} field ({Types::String} type),
+    # * an optional {#options} field ({Options} type),
     # * and a {#body} ({Types::String} type).
     #
     # == Create a IP header
@@ -61,6 +77,14 @@ module PacketGen
     #  ip[:src]              # => PacketGen::Header::IP::Addr
     #  ip.dst = '127.0.0.2'
     #  ip.body.read 'this is a body'
+    #
+    # == Add IP options
+    # IP has an {#options} attribute used to store datagram options.
+    #  pkt = PacketGen.gen('IP')
+    #  # add option from class
+    #  pkt.ip.options << PacketGen::Header::IP::RA.new
+    #  # or use a hash
+    #  pkt.ip.options << { type: 'RR', data: ['192.168.16.4']}
     # @author Sylvain Daubert
     class IP < Base; end
 
@@ -84,7 +108,7 @@ module PacketGen
       define_field :length, Types::Int16, default: 20
       # @!attribute id
       #   @return [Integer] 16-bit ID
-      define_field :id, Types::Int16, default: ->(h) { rand(65_535) }
+      define_field :id, Types::Int16, default: ->(_) { rand(65_535) }
       # @!attribute frag
       #   @return [Integer] 16-bit frag word
       define_field :frag, Types::Int16, default: 0
@@ -106,7 +130,8 @@ module PacketGen
       # @!attribute options
       #  @since 2.2.0
       #  @return [Types::String]
-      define_field :options, Options, optional: ->(h) { h.ihl > 5 }
+      define_field :options, Options, optional: ->(h) { h.ihl > 5 },
+                  builder: ->(h, t) { t.new(length_from: -> { (h.ihl - 5) * 4 }) }
       # @!attribute body
       #  @return [Types::String,Header::Base]
       define_field :body, Types::String
@@ -164,31 +189,6 @@ module PacketGen
         checksum.zero? ? 0xffff : checksum
       end
 
-      # 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]
-        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]
       def calc_checksum
@@ -207,10 +207,12 @@ module PacketGen
         self[:checksum].value = IP.reduce_checksum(checksum)
       end
 
-      # Compute length and set +length+ field
+      # Compute and set +length+ and +ihl+ field
       # @return [Integer]
+      # @since 3.0.0 add +ihl+ calculation
       def calc_length
         Base.calculate_and_set_length self
+        self.ihl = 5 + self[:options].sz / 4
       end
 
       # Get IP part of pseudo header checksum.
@@ -265,7 +267,7 @@ module PacketGen
       # 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
+        self.ihl = 5 + self[:options].sz / 4 if self.ihl == 5
         super
       end
 

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

@@ -31,6 +31,7 @@ module PacketGen
         # @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

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

@@ -70,15 +70,32 @@ module PacketGen
         # @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)
+            @types[optname] = Option.const_get(cst)
           end
           @types
         end
 
+        # Factory to build an option from its type
+        # @return [Option]
+        def Option.build(options={})
+          type = options.delete(:type)
+          klass = case type
+                  when String
+                    types.key?(type) ? IP.const_get(type) : self
+                  when Integer
+                    types.value?(type) ? IP.const_get(types.key(type)) : self
+                  else
+                    self
+                  end
+          klass.new(options)
+        end
+
         def initialize(options={})
           unless options[:type]
             opt_name = self.class.to_s.gsub(/.*::/, '')
@@ -87,6 +104,7 @@ module PacketGen
             end
           end
           super
+          self.length = sz if respond_to?(:length) && options[:length].nil?
         end
 
         # Get binary string. Set {#length} field.
@@ -99,7 +117,7 @@ module PacketGen
         # Get a human readable string
         # @return [String]
         def to_human
-          str = self.class == Option ? "unk-#{type}" : self.class.to_s.sub(/.*::/, '')
+          str = self.class == Option ? +"unk-#{type}" : self.class.to_s.sub(/.*::/, '')
           if respond_to?(:length) && (length > 2) && !self[:data].to_s.empty?
             str << ":#{self[:data].to_s.inspect}"
           end
@@ -114,8 +132,7 @@ module PacketGen
       end
 
       # No OPeration IP option
-      class NOP < EOL
-      end
+      class NOP < EOL; end
 
       # Loose Source and Record Route IP option
       class LSRR < Option
@@ -124,25 +141,11 @@ module PacketGen
         # @!attribute pointer
         #  8-bit pointer on next address
         #  @return [Integer]
-        define_field :pointer, Types::Int8
+        define_field :pointer, Types::Int8, default: 4
         # @!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
+        define_field :data, ArrayOfAddr, builder: ->(h, t) { t.new(length_from: -> { h.length - 3 }) }
 
         # Get IP address pointer by {#pointer}
         # @return [Addr]

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

@@ -15,30 +15,6 @@ module PacketGen
 
         HUMAN_SEPARATOR = ';'
 
-        # Read IP header options from a string
-        # @param [String] str binary string
-        # @return [self]
-        def read(str)
-          clear
-          return self if str.nil?
-          PacketGen.force_binary str
-
-          i = 0
-          types = Option.types
-          while i < str.to_s.length
-            type = str[i, 1].unpack('C').first
-            this_option = if types[type].nil?
-                            Option.new
-                          else
-                            types[type].new
-                          end
-            this_option.read str[i, str.size]
-            self << this_option
-            i += this_option.sz
-          end
-          self
-        end
-
         # Get binary string
         # @return [String]
         def to_s
@@ -48,6 +24,17 @@ module PacketGen
           end
           str
         end
+
+        private
+
+        def record_from_hash(hsh)
+          Option.build(hsh)
+        end
+
+        def real_type(opt)
+          types = Option.types
+          types.value?(opt.type) ? IP.const_get(types.key(opt.type)) : opt.class
+        end
       end
     end
   end

data/lib/packetgen/header/ipv6.rb

@@ -10,8 +10,33 @@ require 'ipaddr'
 
 module PacketGen
   module Header
+    # IPv6 ({https://tools.ietf.org/html/rfc8200 RFC 8200})
+    #    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
+    #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    #   |Version| Traffic Class |           Flow Label                  |
+    #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    #   |         Payload Length        |  Next Header  |   Hop Limit   |
+    #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    #   |                                                               |
+    #   +                                                               +
+    #   |                                                               |
+    #   +                         Source Address                        +
+    #   |                                                               |
+    #   +                                                               +
+    #   |                                                               |
+    #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    #   |                                                               |
+    #   +                                                               +
+    #   |                                                               |
+    #   +                      Destination Address                      +
+    #   |                                                               |
+    #   +                                                               +
+    #   |                                                               |
+    #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    #
     # A IPv6 header consists of:
-    # * a first 32-bit word ({#u32}, of {Types::Int32} type) composoed of:
+    # * a first 32-bit word ({#u32}, of {Types::Int32} type) composed of:
     #   * a 4-bit {#version} field,
     #   * a 8-bit {#traffic_class} field,
     #   * a 20-bit {#flow_label} field,
@@ -20,6 +45,7 @@ module PacketGen
     # * a hop-limit field ({#hop}, +Int8+ type),
     # * a source address field ({#src}, {IPv6::Addr} type),
     # * a destination address field ({#dst}, +IPv6::Addr+ type),
+    # * and a {#body} ({Types::String} type).
     #
     # == Create a IPv6 header
     #  # standalone
@@ -44,6 +70,18 @@ module PacketGen
     #  ipv6[:src]              # => PacketGen::Header::IPv6::Addr
     #  ipv6.dst = '2001:1234:5678:abcd::123'
     #  ipv6.body.read 'this is a body'
+    #
+    # == Add IPv6 extensions
+    # In IPv6, optional extensions are encoded in separate headers that
+    # may be placed between the IPv6 header and the upper-layer header.
+    #
+    # In PacketGen, a IPv6 extension is processedf as a classical header:
+    #  pkt = PacketGen.gen('IPv6')
+    #  # Add a HopByHop extension
+    #  pkt.add('IPv6::HopByHop')
+    #  pkt.ipv6_hopbyhop.options << { type: 'router_alert', value: [0].pack('n') }
+    #  # Add another header
+    #  pkt.add('UDP')
     # @author Sylvain Daubert
     class IPv6 < Base; end
 
@@ -104,34 +142,14 @@ module PacketGen
         sum
       end
 
-      # Send IPv6 packet on wire.
-      #
-      # When sending packet at IPv6 level, +version+, +flow_label+ and +length+
-      # fields are set by kernel. Source address should be a unicast address
-      # assigned to the host. To set any of this fields, use {Eth#to_w}.
-      # @param [String] iface interface name
+      # Send IPv6 packet on wire. All fields may be set (even {#version}).
+      # @param [String] _iface interface name (not used)
       # @return [void]
-      def to_w(iface=nil)
-        sock = Socket.new(Socket::AF_INET6, Socket::SOCK_RAW, self.next)
+      # @since 3.0.0 no more limitations on +flow_label+, +length+ and +src+ fields.
+      def to_w(_iface=nil)
+        sock = Socket.new(Socket::AF_INET6, Socket::SOCK_RAW, Socket::IPPROTO_RAW)
         sockaddrin = Socket.sockaddr_in(0, dst)
-
-        # IPv6 RAW sockets don't have IPHDRINCL option to send IPv6 header.
-        # So, header must be built using ancillary data.
-        # Only src address, traffic_class and hop_limit can be set this way.
-        hop_limit = Socket::AncillaryData.int(Socket::AF_INET6,
-                                              Socket::IPPROTO_IPV6,
-                                              Socket::IPV6_HOPLIMIT, hop)
-        tc = Socket::AncillaryData.int(Socket::AF_INET6,
-                                       Socket::IPPROTO_IPV6,
-                                       Socket::IPV6_TCLASS,
-                                       traffic_class)
-
-        # src address is set through PKT_INFO, which needs interface index.
-        ifaddr = Socket.getifaddrs.find { |ia| ia.name == iface }
-        raise WireError, "unknown #{iface} interface" if ifaddr.nil?
-        pkt_info = Socket::AncillaryData.ipv6_pktinfo(Addrinfo.ip(src), ifaddr.ifindex)
-
-        sock.sendmsg body.to_s, 0, sockaddrin, hop_limit, tc, pkt_info
+        sock.send to_s, 0, sockaddrin
         sock.close
       end
 
@@ -190,13 +208,6 @@ module PacketGen
             klass.bind header_klass, args
           end
         end
-        # Bind a upper header to IPv6 and its defined extension headers.
-        # @see Base.bind_header
-        # @deprecated USe {bind}.
-        def bind_header(header_klass, args={})
-          Deprecation.deprecated(self, __method__, 'bind', klass_method: true)
-          bind header_klass, args
-        end
       end
     end
   end

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

@@ -52,8 +52,10 @@ module PacketGen
         # @return [self]
         def from_human(str)
           return self if str.nil?
+
           addr = IPAddr.new(str)
           raise ArgumentError, 'string is not a IPv6 address' unless addr.ipv6?
+
           addri = addr.to_i
           self.a1 = addri >> 112
           self.a2 = addri >> 96 & 0xffff

data/lib/packetgen/header/ipv6/hop_by_hop.rb

@@ -46,23 +46,6 @@ module PacketGen
       class Options < Types::Array
         set_of Option
 
-        # Populate object from a binary string
-        # @param [String] str
-        # @return [self]
-        def read(str)
-          clear
-          return self if str.nil?
-          force_binary str
-          klass = self.class.class_eval { @klass }
-          until str.empty?
-            obj = klass.new.read(str)
-            obj = Pad1.new.read(str) if obj.type.zero?
-            self.push obj
-            str.slice!(0, obj.sz)
-          end
-          self
-        end
-
         # Get options as a binary string. Add padding if needed.
         # @return [String]
         def to_s
@@ -83,6 +66,12 @@ module PacketGen
           end
           str
         end
+
+        private
+
+        def real_type(opt)
+          opt.type.zero? ? Pad1 : opt.class
+        end
       end
 
       # Hop-by-hop IPv6 extension
@@ -111,20 +100,7 @@ module PacketGen
         # @!attribute options
         #  Specific options of extension header
         #  @return [Options]
-        define_field_before :body, :options, Options
-
-        # Populate object from a binary string
-        # @param [String] str
-        # @return [self]
-        def read(str)
-          return self if str.nil?
-          force_binary str
-          self[:next].read str[0, 1]
-          self[:length].read str[1, 1]
-          self[:options].read str[2, real_length - 2]
-          self[:body].read str[real_length..-1]
-          self
-        end
+        define_field_before :body, :options, Options, builder: ->(h, t) { t.new(length_from: -> { h.real_length - 2} ) }
       end
     end