packetgen 2.6.0 → 2.7.0

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

@@ -8,21 +8,20 @@
 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 
+        #  @return [Integer] IP address first byte
         define_field :a1, Types::Int8
         # @!attribute a2
-        #  @return [Integer] IP address seconf byte 
+        #  @return [Integer] IP address seconf byte
         define_field :a2, Types::Int8
         # @!attribute a3
-        #  @return [Integer] IP address third byte 
+        #  @return [Integer] IP address third byte
         define_field :a3, Types::Int8
         # @!attribute a4
-        #  @return [Integer] IP address fourth byte 
+        #  @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})$/
@@ -45,7 +44,7 @@ module PacketGen
         # Addr in human readable form (dotted format)
         # @return [String]
         def to_human
-          fields.map { |f| "#{self[f].to_i}" }.join('.')
+          fields.map { |f| self[f].to_i.to_s }.join('.')
         end
 
         # Addr as an integer

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

@@ -8,12 +8,11 @@
 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]
@@ -27,7 +26,6 @@ module PacketGen
       # Base class for IP options
       # @author Sylvain Daubert
       class Option < Types::Fields
-
         # EOL option type
         EOL_TYPE = 0x00
         # NOP option type
@@ -55,7 +53,7 @@ module PacketGen
         #  option data
         # @return [String]
         define_field :data, Types::String, optional: ->(h) { h.length > 2 },
-                     builder: ->(h,t) { t.new(length_from: ->() { h.length - 2 }) }
+                     builder: ->(h, t) { t.new(length_from: -> { h.length - 2 }) }
 
         # @!attribute copied
         #  1-bit copied flag from {#type} field
@@ -94,9 +92,7 @@ module PacketGen
         # Get binary string. Set {#length} field.
         # @return [String]
         def to_s
-          if respond_to? :length
-            self.length = super.size
-          end
+          self.length = super.size if respond_to? :length
           super
         end
 
@@ -104,7 +100,7 @@ module PacketGen
         # @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
+          if respond_to?(:length) && (length > 2) && !self[:data].to_s.empty?
             str << ":#{self[:data].to_s.inspect}"
           end
           str
@@ -122,12 +118,12 @@ module PacketGen
       # 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]
@@ -136,7 +132,7 @@ module PacketGen
         #  Array of IP addresses
         #  @return [Types::Array<IP::Addr>]
         define_field :data, ArrayOfAddr,
-                     builder: ->(h,t) { t.new(length_from: ->() { h.length - 2 }) }
+                     builder: ->(h, t) { t.new(length_from: -> { h.length - 2 }) }
 
         # Populate object from a binary string
         # @param [String] str
@@ -156,7 +152,7 @@ module PacketGen
         def pointed_addr
           data[pointer / 4 - 1]
         end
-        
+
         # Get a human readable string
         # @return [String]
         def to_human
@@ -174,18 +170,18 @@ module PacketGen
       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]

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

@@ -8,12 +8,11 @@
 module PacketGen
   module Header
     class IP
-      
       # Class to handle IP options
       # @author Sylvain Daubert
       class Options < Types::Array
         set_of Option
-        
+
         HUMAN_SEPARATOR = ';'
 
         # Read IP header options from a string

data/lib/packetgen/header/ipv6.rb

@@ -5,11 +5,11 @@
 # This program is published under MIT license.
 
 # frozen_string_literal: true
+
 require 'ipaddr'
 
 module PacketGen
   module Header
-
     # A IPv6 header consists of:
     # * a first 32-bit word ({#u32}, of {Types::Int32} type) composoed of:
     #   * a 4-bit {#version} field,
@@ -45,7 +45,7 @@ module PacketGen
     #  ipv6.dst = '2001:1234:5678:abcd::123'
     #  ipv6.body.read 'this is a body'
     # @author Sylvain Daubert
-    class IPv6 < Base;end
+    class IPv6 < Base; end
 
     require_relative 'ipv6/addr'
 
@@ -103,7 +103,7 @@ module PacketGen
         self[:dst].to_a.each { |word| sum += word.to_i }
         sum
       end
-      
+
       # Send IPv6 packet on wire.
       #
       # When sending packet at IPv6 level, +version+, +flow_label+ and +length+
@@ -158,14 +158,22 @@ module PacketGen
       def parse?
         version == 6
       end
+
+      # Invert source and destination addresses
+      # @return [self]
+      # @since 2.7.0
+      def reply!
+        self[:src], self[:dst] = self[:dst], self[:src]
+        self
+      end
     end
 
     self.add_class IPv6
 
-    Eth.bind_header IPv6, ethertype: IPv6::ETHERTYPE
-    SNAP.bind_header IPv6, proto_id: IPv6::ETHERTYPE
-    Dot1q.bind_header IPv6, ethertype: IPv6::ETHERTYPE
-    IP.bind_header IPv6, protocol: 41    # 6to4
+    Eth.bind IPv6, ethertype: IPv6::ETHERTYPE
+    SNAP.bind IPv6, proto_id: IPv6::ETHERTYPE
+    Dot1q.bind IPv6, ethertype: IPv6::ETHERTYPE
+    IP.bind IPv6, protocol: 41 # 6to4
   end
 end
 
@@ -175,16 +183,23 @@ module PacketGen
   module Header
     class IPv6
       class << self
-        alias old_bind_header bind_header
+        alias old_bind bind
 
         # Bind a upper header to IPv6 and its defined extension headers.
-        # @see Base.bind_header
-        def bind_header(header_klass, args={})
-          IPv6.old_bind_header header_klass, args
+        # @see Base.bind
+        def bind(header_klass, args={})
+          IPv6.old_bind header_klass, args
           [IPv6::HopByHop].each do |klass|
-            klass.bind_header header_klass, args
+            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

@@ -5,6 +5,7 @@
 # This program is published under MIT license.
 
 # frozen_string_literal: true
+
 require 'ipaddr'
 
 module PacketGen
@@ -13,7 +14,6 @@ module PacketGen
       # IPv6 address, as a group of 8 2-byte words
       # @author Sylvain Daubert
       class Addr < Types::Fields
-
         # @!attribute a1
         #  1st 2-byte word of IPv6 address
         #  @return [Integer]
@@ -89,7 +89,7 @@ module PacketGen
       # @author Sylvain Daubert
       class ArrayOfAddr < Types::Array
         set_of IPv6::Addr
-        
+
         # Push a IPv6 address to the array
         # @param [String,Addr] addr
         # @return [self]

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

@@ -43,7 +43,7 @@ module PacketGen
         #  Specific options of extension header
         #  @return [String]
         define_field :options, Types::String,
-                     builder: ->(h, t) { t.new(length_from: ->() { h.real_length }) }
+                     builder: ->(h, t) { t.new(length_from: -> { h.real_length }) }
         # @!attribute body
         #  @return [String,Base]
         define_field :body, Types::String

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

@@ -15,7 +15,7 @@ module PacketGen
         TYPES = {
           1 => 'padn',
           5 => 'router_alert'
-        }
+        }.freeze
 
         # @return [String]
         def to_human
@@ -27,7 +27,7 @@ module PacketGen
           end
         end
       end
-      
+
       # Special option pad1, for {HopByHop} IPv6 extension header
       # @author Sylvain Daubert
       class Pad1 < Types::Fields
@@ -40,7 +40,7 @@ module PacketGen
           'pad1'
         end
       end
-      
+
       # Array of {Option}, for {HopByHop} IPv6 extension header
       # @author Sylvain Daubert
       class Options < Types::Array
@@ -54,11 +54,9 @@ module PacketGen
           return self if str.nil?
           force_binary str
           klass = self.class.class_eval { @klass }
-          while str.length > 0
+          until str.empty?
             obj = klass.new.read(str)
-            if obj.type == 0
-              obj = Pad1.new.read(str)
-            end
+            obj = Pad1.new.read(str) if obj.type.zero?
             self.push obj
             str.slice!(0, obj.sz)
           end
@@ -69,16 +67,18 @@ module PacketGen
         # @return [String]
         def to_s
           str = super
-          case str.size % 8
+          case (str.size + 2) % 8
           when 0
             return str
           when 7
             # only on byte needed: use pad1 option
+            self << Pad1.new
             str << [0].pack('C')
           else
             # use padn option
-            len = 8 - (str.size % 8) - 4
+            len = 8 - 2 - (str.size % 8) - 2
             padn = Option.new(type: 'padn', value: "\x00" * len)
+            self << padn
             str << padn.to_s
           end
           str
@@ -127,8 +127,8 @@ module PacketGen
         end
       end
     end
-    
+
     self.add_class IPv6::HopByHop
-    IPv6.bind_header IPv6::HopByHop, next: 0
+    IPv6.bind IPv6::HopByHop, next: 0
   end
 end

data/lib/packetgen/header/llc.rb

@@ -8,7 +8,6 @@
 
 module PacketGen
   module Header
-
     # Logical-Link Control header
     #
     # A LLC header consists of:
@@ -17,6 +16,7 @@ module PacketGen
     # * a {#control} ({Types::Int8}),
     # * and a {#body} (a {Types::String} or another {Base} class).
     # @author Sylvain Daubert
+    # @since 1.4.0
     class LLC < Base
       # @!attribute dsap
       #  @return [Integer] 8-bit dsap value
@@ -32,7 +32,7 @@ module PacketGen
       define_field :body, Types::String
     end
     self.add_class LLC
-    Dot11::Data.bind_header LLC, op: :and, type: 2, :wep? => false
+    Dot11::Data.bind LLC, type: 2, wep?: false
 
     # Sub-Network Access Protocol
     #
@@ -41,6 +41,7 @@ module PacketGen
     # * a {#proto_id} ({Types::Int16}),
     # * and a {#body} (a {Types::String} or another {Base} class).
     # @author Sylvain Daubert
+    # @since 1.4.0
     class SNAP < Base
       # @!attribute oui
       #  @return [Types::OUI]
@@ -53,6 +54,6 @@ module PacketGen
       define_field :body, Types::String
     end
     self.add_class SNAP
-    LLC.bind_header SNAP, op: :and, dsap: 170, ssap: 170, control: 3
+    LLC.bind SNAP, dsap: 170, ssap: 170, control: 3
   end
 end

data/lib/packetgen/header/mdns.rb

@@ -8,15 +8,15 @@
 
 module PacketGen
   module Header
-
     # Multicast DNS.
     #
     # See {DNS} for header format.
+    # @since 2.6.0
     # @author Sylvain Daubert
     class MDNS < DNS
       # Port number for mDNS over UDP
       UDP_PORT = 5353
-      
+
       # Fixup IP header according to RFC 6762:
       # * set ethernet multicast address to +01:00:5E:00:00:FB+ (for IPv4)
       #   or +33:33:00:00:00:FB+ (for IPv6),
@@ -59,17 +59,23 @@ module PacketGen
           mac.from_human('33:33:00:00:00:FB')
         end
       end
-      
+
       # @api private
       # @note This method is used internally by PacketGen and should not be
       #       directly called
+      # @since 2.7.0 Set UDP sport according to bindings, only if sport is 0.
+      #  Needed by new bind API.
       def added_to_packet(packet)
         mdns_idx = packet.headers.size
         packet.instance_eval "def mdnsize() @headers[#{mdns_idx}].mdnsize; end"
+        return unless packet.is? 'UDP'
+        return unless packet.udp.sport.zero?
+        packet.udp.sport = UDP_PORT
       end
     end
-    
+
     self.add_class MDNS
-    UDP.bind_header MDNS, dport: MDNS::UDP_PORT, sport: MDNS::UDP_PORT
+    UDP.bind MDNS, dport: MDNS::UDP_PORT
+    UDP.bind MDNS, sport: MDNS::UDP_PORT
   end
 end

data/lib/packetgen/header/mld.rb

@@ -7,7 +7,6 @@
 
 module PacketGen
   module Header
-
     # This class supports MLDv1 (RFC 2710).
     #
     # From RFC 2710, a MLD header has the following format:
@@ -44,6 +43,7 @@ module PacketGen
     #  pkt.mld.max_resp_delay = 20
     #  pkt.mld.group_addr = '::'
     # @author Sylvain Daubert
+    # @since 2.4.0
     class MLD < Base
       # @!attribute max_resp_delay
       #  16-bit MLD Max Response Delay
@@ -97,6 +97,6 @@ end
 require_relative 'mldv2'
 
 PacketGen::Header.add_class PacketGen::Header::MLD
-PacketGen::Header::ICMPv6.bind_header PacketGen::Header::MLD, type: 130
-PacketGen::Header::ICMPv6.bind_header PacketGen::Header::MLD, type: 131
-PacketGen::Header::ICMPv6.bind_header PacketGen::Header::MLD, type: 132
+PacketGen::Header::ICMPv6.bind PacketGen::Header::MLD, type: 130
+PacketGen::Header::ICMPv6.bind PacketGen::Header::MLD, type: 131
+PacketGen::Header::ICMPv6.bind PacketGen::Header::MLD, type: 132