packetgen 2.6.0 → 2.7.0

data/lib/packetgen/header/mldv2.rb

@@ -9,6 +9,7 @@ module PacketGen
   module Header
     # This module contains all MLDv2 specific classes.
     # @author Sylvain Daubert
+    # @since 2.4.0
     module MLDv2
       # Encode value for MLDv2 Max Resp Code.
       # Value may be encoded as a float, so some error may occur.
@@ -16,14 +17,14 @@ module PacketGen
       # @param [Integer] value value to encode
       # @return [Integer]
       def self.encode(value)
-        if value < 32768
+        if value < 32_768
           value
         elsif value > 8_387_583
           0xffff
         else
           exp = 0
           value >>= 3
-          while value > 8191 do
+          while value > 8_191
             exp += 1
             value >>= 1
           end
@@ -36,7 +37,7 @@ module PacketGen
       # @param [Integer] value value to decode
       # @return [Integer]
       def self.decode(value)
-        if value < 32768
+        if value < 32_768
           value
         else
           mant = value & 0xfff

data/lib/packetgen/header/mldv2/mcast_address_record.rb

@@ -52,7 +52,6 @@ module PacketGen
       #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
       # @author Sylvain Daubert
       class McastAddressRecord < Types::Fields
-
         # Known record types
         RECORD_TYPES = IGMPv3::GroupRecord::RECORD_TYPES
 
@@ -81,7 +80,7 @@ module PacketGen
         # @!attribute aux_data
         #  @return [String]
         define_field :aux_data, Types::String,
-                     builder: ->(h, t) { t.new(length_from: ->() { h[:aux_data_len].to_i * 4 }) }
+                     builder: ->(h, t) { t.new(length_from: -> { h[:aux_data_len].to_i * 4 }) }
 
         def human_type
           self[:type].to_human
@@ -91,12 +90,12 @@ module PacketGen
           "#{human_type}(ma:#{multicast_addr}|src:#{source_addr.to_human})"
         end
       end
-      
+
       # Class to handle series of {McastAddressRecord}.
       # @author Sylvain Daubert
       class McastAddressRecords < Types::Array
         set_of McastAddressRecord
-        
+
         # Separator used in {#to_human}.
         HUMAN_SEPARATOR = ';'
       end

data/lib/packetgen/header/mldv2/mlq.rb

@@ -92,7 +92,7 @@ module PacketGen
         #  Array of IPv6 source addresses
         #  @return [IPv6::ArrayOfAddr]
         define_field_before :body, :source_addr, IPv6::ArrayOfAddr,
-                            builder: ->(h,t) { t.new(counter: h[:number_of_sources]) }
+                            builder: ->(h, t) { t.new(counter: h[:number_of_sources]) }
 
         # @!attribute flag_resv
         #   4-bit reserved field in {#flags}
@@ -138,9 +138,8 @@ module PacketGen
         end
       end
     end
-    
-    self.add_class MLDv2::MLQ
-    ICMPv6.bind_header MLDv2::MLQ, op: :and, type: 130, body: ->(b) { b.nil? ? '' : b.length > 23 }
 
+    self.add_class MLDv2::MLQ
+    ICMPv6.bind MLDv2::MLQ, type: 130, body: ->(b) { b.nil? ? '' : b.length > 23 }
   end
 end

data/lib/packetgen/header/mldv2/mlr.rb

@@ -4,6 +4,7 @@
 # This program is published under MIT license.
 
 # frozen_string_literal: true
+
 require_relative 'mcast_address_record'
 
 module PacketGen
@@ -52,7 +53,7 @@ module PacketGen
         #  16-bit Number of group records in {#records}
         #  @return [Integer]
         define_field :number_of_mar, Types::Int16, default: 0
-        
+
         # @!attribute records
         #  Array of Mcast Address Records
         #  @return [McastAddressRecords]
@@ -60,8 +61,8 @@ module PacketGen
                      builder: ->(h, t) { t.new(counter: h[:number_of_mar]) }
       end
     end
-    
+
     self.add_class MLDv2::MLR
-    ICMPv6.bind_header MLDv2::MLR, type: 143
+    ICMPv6.bind MLDv2::MLR, type: 143
   end
 end

data/lib/packetgen/header/netbios.rb

@@ -9,13 +9,14 @@ module PacketGen
   module Header
     # Module to group all NetBIOS headers
     # @author Sylvain Daubert
+    # @since 2.5.1
     module NetBIOS
       # NetBIOS Session Service messages.
       # @author Sylvain Daubert
       class Session < Base
         # Port number for NetBIOS Session Service over TCP
         TCP_PORT = 139
-        
+
         # Session packet types
         TYPES = {
           'message'           => 0,
@@ -24,8 +25,8 @@ module PacketGen
           'negative_response' => 0x83,
           'retarget_response' => 0x84,
           'keep_alive'        => 0x85,
-        }
-        
+        }.freeze
+
         # @!attribute type
         #  8-bit session packet type
         #  @return [Integer]
@@ -37,15 +38,27 @@ module PacketGen
         # @!attribute body
         #  @return [String]
         define_field :body, Types::String
-        
+
         # Compute and set {#length} field
         # @return [Integer] calculated length
         def calc_length
           Base.calculate_and_set_length(self, header_in_size: false)
         end
+
+        # @api private
+        # @note This method is used internally by PacketGen and should not be
+        #       directly called
+        # @since 2.7.0 Set TCP sport according to bindings, only if sport is 0.
+        #  Needed by new bind API.
+        def added_to_packet(packet)
+          return unless packet.is? 'TCP'
+          return unless packet.tcp.sport.zero?
+          packet.tcp.sport = TCP_PORT
+        end
       end
     end
     self.add_class NetBIOS::Session
-    TCP.bind_header NetBIOS::Session, sport: NetBIOS::Session::TCP_PORT, dport: NetBIOS::Session::TCP_PORT
+    TCP.bind NetBIOS::Session, dport: NetBIOS::Session::TCP_PORT
+    TCP.bind NetBIOS::Session, sport: NetBIOS::Session::TCP_PORT
   end
 end

data/lib/packetgen/header/ospfv2.rb

@@ -7,7 +7,6 @@
 
 module PacketGen
   module Header
-    
     # This class supports OSPFv2 (RFC 2328).
     # A OSPFv2 header has the following format:
     #
@@ -69,19 +68,19 @@ module PacketGen
     # * or {OSPFv2::LSAck}.
     #
     # @author Sylvain Daubert
+    # @since 2.5.0
     class OSPFv2 < Base
-      
       # IP protocol number for OSPF
       IP_PROTOCOL = 89
-      
+
       # OSPF packet types
-      TYPES    = {
+      TYPES = {
         'HELLO'          => 1,
         'DB_DESCRIPTION' => 2,
         'LS_REQUEST'     => 3,
         'LS_UPDATE'      => 4,
         'LS_ACK'         => 5
-      }
+      }.freeze
 
       # Authentication types
       AU_TYPES = {
@@ -89,7 +88,7 @@ module PacketGen
         'PASSWORD'        => 1,
         'CRYPTO'          => 2,
         'CRYPTO_WITH_ESN' => 3
-      }
+      }.freeze
 
       # @!attribute version
       #  8-bit OSPF version
@@ -236,7 +235,7 @@ module PacketGen
     end
 
     self.add_class OSPFv2
-    IP.bind_header OSPFv2, protocol: OSPFv2::IP_PROTOCOL
+    IP.bind OSPFv2, protocol: OSPFv2::IP_PROTOCOL
   end
 end
 

data/lib/packetgen/header/ospfv2/db_description.rb

@@ -8,7 +8,6 @@
 module PacketGen
   module Header
     class OSPFv2
-
       # This class handles {OSPFv2 OSPFv2} DB description packets payload.
       # The DB description payload has the following format:
       #    0                   1                   2                   3
@@ -91,15 +90,15 @@ module PacketGen
         define_field :sequence_number, Types::Int32
         alias seqnum sequence_number
         alias seqnum= sequence_number=
-        
+
         # @!attribute lsas
         #  Array of LSA headers
         #  @return [ArrayOfLSAHeader]
-        define_field :lsas, ArrayOfLSA, builder: ->(h, t) { t.new(only_headers: true) }
+        define_field :lsas, ArrayOfLSA, builder: ->(_h, t) { t.new(only_headers: true) }
       end
     end
 
     self.add_class OSPFv2::DbDescription
-    OSPFv2.bind_header OSPFv2::DbDescription, type: OSPFv2::TYPES['DB_DESCRIPTION']
+    OSPFv2.bind OSPFv2::DbDescription, type: OSPFv2::TYPES['DB_DESCRIPTION']
   end
 end

data/lib/packetgen/header/ospfv2/hello.rb

@@ -8,7 +8,6 @@
 module PacketGen
   module Header
     class OSPFv2
-
       # This class handles {OSPFv2 OSPFv2} HELLO packets payload. The HELLO
       # payload has the following format:
       #    0                   1                   2                   3
@@ -97,8 +96,8 @@ module PacketGen
         define_field :neighbors, IP::ArrayOfAddr
       end
     end
-    
+
     self.add_class OSPFv2::Hello
-    OSPFv2.bind_header OSPFv2::Hello, type: OSPFv2::TYPES['HELLO']
+    OSPFv2.bind OSPFv2::Hello, type: OSPFv2::TYPES['HELLO']
   end
 end

data/lib/packetgen/header/ospfv2/ls_ack.rb

@@ -8,7 +8,6 @@
 module PacketGen
   module Header
     class OSPFv2
-
       # This class handles {OSPFv2 OSPFv2} LS Acknowledgment packets payload.
       # The LS Acknowledgment payload has the following format:
       #    0                   1                   2                   3
@@ -45,11 +44,11 @@ module PacketGen
         # @!attribute lsas
         #  Array of LSA headers
         #  @return [ArrayOfLSAHeader]
-        define_field :lsas, ArrayOfLSA, builder: ->(h, t) { t.new(only_headers: true) }
+        define_field :lsas, ArrayOfLSA, builder: ->(_h, t) { t.new(only_headers: true) }
       end
     end
 
     self.add_class OSPFv2::LSAck
-    OSPFv2.bind_header OSPFv2::LSAck, type: OSPFv2::TYPES['LS_ACK']
+    OSPFv2.bind OSPFv2::LSAck, type: OSPFv2::TYPES['LS_ACK']
   end
 end

data/lib/packetgen/header/ospfv2/ls_request.rb

@@ -8,7 +8,6 @@
 module PacketGen
   module Header
     class OSPFv2
-
       # This class handle a LS request, which is composed 3 {Types::Int32} fields:
       # * {#type},
       # * {#link_state_id},
@@ -40,7 +39,7 @@ module PacketGen
           "LSR<#{human_type},#{link_state_id},#{advertising_router}>"
         end
       end
-      
+
       # This class defines a specialized {Types::Array array} to handle series
       # of {LSR LSRs}.
       # @author Sylvain Daubert
@@ -85,6 +84,6 @@ module PacketGen
     end
 
     self.add_class OSPFv2::LSRequest
-    OSPFv2.bind_header OSPFv2::LSRequest, type: OSPFv2::TYPES['LS_REQUEST']
+    OSPFv2.bind OSPFv2::LSRequest, type: OSPFv2::TYPES['LS_REQUEST']
   end
 end

data/lib/packetgen/header/ospfv2/ls_update.rb

@@ -8,7 +8,6 @@
 module PacketGen
   module Header
     class OSPFv2
-
       # This class handles {OSPFv2 OSPFv2} Link State Update packets
       # payload. The LSU payload has the following format:
       #    0                   1                   2                   3
@@ -52,21 +51,21 @@ module PacketGen
         #  Array of {LSA LSAs}
         #  @return [ArrayOfLSA]
         define_field :lsas, ArrayOfLSA, builder: ->(h, t) { t.new(counter: h[:lsas_count]) }
-        
+
         # Calculate checksums of all LSAs
         # @return [void]
         def calc_checksum
-          lsas.each { |lsa| lsa.calc_checksum }
+          lsas.each(&:calc_checksum)
         end
-        
+
         # Calculate length of all LSAs
         def calc_length
-          lsas.each { |lsa| lsa.calc_length }
+          lsas.each(&:calc_length)
         end
       end
     end
 
     self.add_class OSPFv2::LSUpdate
-    OSPFv2.bind_header OSPFv2::LSUpdate, type: OSPFv2::TYPES['LS_UPDATE']
+    OSPFv2.bind OSPFv2::LSUpdate, type: OSPFv2::TYPES['LS_UPDATE']
   end
 end

data/lib/packetgen/header/ospfv2/lsa.rb

@@ -8,7 +8,6 @@
 module PacketGen
   module Header
     class OSPFv2
-
       # This class handles unsupported {OSPFv2 OSPFv2} LSA payloads.
       # A LSA payload is a {LSAHeader} with a {#body} field.
       # @author Sylvain Daubert
@@ -17,7 +16,7 @@ module PacketGen
         #  LSA body
         #  @return [String]
         define_field :body, Types::String,
-                     builder: ->(h,t) { t.new(length_from: ->() { h.length - 20 }) }
+                     builder: ->(h, t) { t.new(length_from: -> { h.length - 20 }) }
       end
 
       # This class handles TOS metrics for {Link links} in a {LSARouter
@@ -71,7 +70,7 @@ module PacketGen
         # @!attribute tos
         #  Additionnal TOS metrics
         #  @return [ArrayOfTosMetric]
-        define_field :tos, ArrayOfTosMetric, builder: ->(h,t) { t.new(counter: h[:tos_count]) }
+        define_field :tos, ArrayOfTosMetric, builder: ->(h, t) { t.new(counter: h[:tos_count]) }
 
         # @return [String]
         def to_human
@@ -106,7 +105,7 @@ module PacketGen
         # @attribute links
         #  @return [ArrayOfLink]
         define_field :links, ArrayOfLink, builder: ->(h, t) { t.new(counter: h[:link_count]) }
-        
+
         # @attribute v_flag
         #  @return [Boolean]
         # @attribute e_flag
@@ -148,7 +147,7 @@ module PacketGen
         # @!attribute ext_route_tag
         #  @return [Integer]
         define_field :ext_route_tag, Types::Int32
-        
+
         # @!attribute e_flag
         #  @return [Boolean]
         # @!attribute tos
@@ -185,7 +184,7 @@ module PacketGen
       # @author Sylvain Daubert
       class ArrayOfLSA < Types::Array
         set_of LSA
-        
+
         # @param [Hash] options
         # @option options [Types::Int] counter Int object used as a counter for this set
         # @option options [Boolean] only_headers if +true+, only {LSAHeader LSAHeaders}
@@ -201,17 +200,17 @@ module PacketGen
         def read(str)
           clear
           return self if str.nil?
-          return self if @counter and @counter.to_i == 0
+          return self if @counter && @counter.to_i.zero?
           force_binary str
-          while str.length > 0
+          until str.empty?
             lsa = LSAHeader.new.read(str)
-            if !@only_headers
+            unless @only_headers
               klass = get_lsa_class_by_human_type(lsa.human_type)
               lsa = klass.new.read(str[0...lsa.length])
             end
             self.push lsa
             str.slice!(0, lsa.sz)
-            break if @counter and self.size == @counter.to_i
+            break if @counter && (self.size == @counter.to_i)
           end
           self
         end
@@ -219,10 +218,10 @@ module PacketGen
         private
 
         def record_from_hash(hsh)
-          unless hsh.has_key? :type
-            raise ArgumentError, "hash should have :type key"
+          unless hsh.key? :type
+            raise ArgumentError, 'hash should have :type key'
           end
-          
+
           klass = if @only_headers
                     LSAHeader
                   else
@@ -239,7 +238,7 @@ module PacketGen
         end
 
         def get_lsa_class_by_human_type(htype)
-          klassname = "LSA#{htype.to_s.gsub(/-/, '')}"
+          klassname = "LSA#{htype.to_s.delete('-')}"
           if OSPFv2.const_defined? klassname
             OSPFv2.const_get klassname
           else

data/lib/packetgen/header/ospfv2/lsa_header.rb

@@ -8,7 +8,6 @@
 module PacketGen
   module Header
     class OSPFv2
-
       # This class handles {OSPFv2 OSPFv2} LSA header. A LSA header has the
       # following format:
       #   0                   1                   2                   3
@@ -37,7 +36,7 @@ module PacketGen
           'Summary-IP'   => 3,
           'Summary-ABSR' => 4,
           'AS-External'  => 5
-        }
+        }.freeze
 
         # @!attribute age
         #  The time in seconds since the LSA was originated.
@@ -72,7 +71,7 @@ module PacketGen
         #  Length of the LSA, including the header.
         #  @return [Integer]
         define_field :length, Types::Int16
-        
+
         # Compute and set Fletcher-16 checksum on LSA
         # @return [Integer]
         def calc_checksum
@@ -86,10 +85,10 @@ module PacketGen
           end
           c0 %= 255
           c1 %= 255
-          
+
           x = ((sz - 16 - 1) * c0 - c1) % 255
           x += 255 if x <= 0
-          y = 255*2 - c0 - x
+          y = 255 * 2 - c0 - x
           y -= 255 if y > 255
           self.checksum = (x << 8) | y
         end