packetgen 2.6.0 → 2.7.0

data/lib/packetgen/header/ospfv3.rb

@@ -7,7 +7,6 @@
 
 module PacketGen
   module Header
-    
     # This class supports OSPFv3 (RFC 5340).
     # A OSPFv3 header has the following format:
     #
@@ -63,11 +62,11 @@ module PacketGen
     # * {OSPFv3::LSUpdate},
     # * or {OSPFv3::LSAck}.
     # @author Sylvain Daubert
+    # @since 2.5.0
     class OSPFv3 < Base
-      
       # IP protocol number for OSPF
       IP_PROTOCOL = OSPFv2::IP_PROTOCOL
-      
+
       # OSPF packet types
       TYPES = OSPFv2::TYPES
 
@@ -202,7 +201,7 @@ module PacketGen
     end
 
     self.add_class OSPFv3
-    IPv6.bind_header OSPFv3, next: OSPFv3::IP_PROTOCOL
+    IPv6.bind OSPFv3, next: OSPFv3::IP_PROTOCOL
   end
 end
 

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

@@ -8,7 +8,6 @@
 module PacketGen
   module Header
     class OSPFv3
-
       # This class handles {OSPFv3 OSPFv3} DB description packets payload.
       # The DB description payload has the following format:
       #    0                   1                   2                   3
@@ -65,7 +64,6 @@ module PacketGen
       #   dbd.lsas << existing_lsa.to_lsa_header
       # @author Sylvain Daubert
       class DbDescription < Base
-
         # @!attribute reserved
         #  8-bit zero field before {#options} one
         #  @return [Integer]
@@ -100,15 +98,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 OSPFv3::DbDescription
-    OSPFv3.bind_header OSPFv3::DbDescription, type: OSPFv3::TYPES['DB_DESCRIPTION']
+    OSPFv3.bind OSPFv3::DbDescription, type: OSPFv3::TYPES['DB_DESCRIPTION']
   end
 end

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

@@ -8,7 +8,6 @@
 module PacketGen
   module Header
     class OSPFv3
-
       # This class handles {OSPFv3 OSPFv3} 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 OSPFv3::Hello
-    OSPFv3.bind_header OSPFv3::Hello, type: OSPFv3::TYPES['HELLO']
+    OSPFv3.bind OSPFv3::Hello, type: OSPFv3::TYPES['HELLO']
   end
 end

data/lib/packetgen/header/ospfv3/ipv6_prefix.rb

@@ -8,7 +8,6 @@
 module PacketGen
   module Header
     class OSPFv3
-
       # Array of 32-bit words.
       # @author Sylvain Daubert
       class ArrayOfInt32 < Types::Array
@@ -64,13 +63,13 @@ module PacketGen
         # @return [String]
         def to_human
           ary = prefix.map(&:to_i).map do |v|
-            "#{((v>>16) & 0xffff).to_s(16)}:#{(v & 0xffff).to_s(16)}"
+            "#{((v >> 16) & 0xffff).to_s(16)}:#{(v & 0xffff).to_s(16)}"
           end
           pfx = ary.join(':')
-          pfx += '::' if prefix.size < (128/32)
-          "#{IPAddr.new(pfx).to_s}/#{length}"
+          pfx += '::' if prefix.size < (128 / 32)
+          "#{IPAddr.new(pfx)}/#{length}"
         end
-        
+
         # Set prefix from a human-readable string. This method cannot set
         # {#options} field.
         # @param [String] str
@@ -80,10 +79,10 @@ module PacketGen
           len = (len || 128).to_i
           addr = IPv6::Addr.new.from_human(pfx)
           ary_size = (len + 31) / 32
-          ary = addr.to_a[0...ary_size*2]
+          ary = addr.to_a[0...ary_size * 2]
           self.prefix.clear
           ary.each_with_index do |v, i|
-            if i % 2 == 0
+            if i.even?
               self.prefix << v
             else
               self.prefix.last.value = (self.prefix.last.to_i << 16) | v.to_i
@@ -92,7 +91,7 @@ module PacketGen
           self.length = len
         end
       end
-      
+
       # Array of {IPv6Prefix}
       # @author Sylvain Daubert
       class ArrayOfIPv6Prefix < Types::Array

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

@@ -8,7 +8,6 @@
 module PacketGen
   module Header
     class OSPFv3
-
       # This class handles {OSPFv3 OSPFv3} Link State Acknownledgment packets
       # payload. The LSAck payload has the following format:
       #    0                   1                   2                   3
@@ -41,11 +40,11 @@ module PacketGen
         #  Array of {LSA LSAs}
         #  @return [ArrayOfLSA]
         define_field :lsas, ArrayOfLSA,
-                     builder: ->(h, t) { t.new(only_headers: true) }
+                     builder: ->(_h, t) { t.new(only_headers: true) }
       end
     end
 
     self.add_class OSPFv3::LSAck
-    OSPFv3.bind_header OSPFv3::LSAck, type: OSPFv3::TYPES['LS_ACK']
+    OSPFv3.bind OSPFv3::LSAck, type: OSPFv3::TYPES['LS_ACK']
   end
 end

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

@@ -8,7 +8,6 @@
 module PacketGen
   module Header
     class OSPFv3
-
       # This class handle LSA requests, as used in {LSRequest} payloads.
       # The LSA request payload has the following format:
       #   0                   1                   2                   3
@@ -57,7 +56,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
@@ -103,6 +102,6 @@ module PacketGen
     end
 
     self.add_class OSPFv3::LSRequest
-    OSPFv3.bind_header OSPFv3::LSRequest, type: OSPFv3::TYPES['LS_REQUEST']
+    OSPFv3.bind OSPFv3::LSRequest, type: OSPFv3::TYPES['LS_REQUEST']
   end
 end

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

@@ -8,7 +8,6 @@
 module PacketGen
   module Header
     class OSPFv3
-
       # This class handles {OSPFv3 OSPFv3} Link State Update packets
       # payload. The LSU payload has the following format:
       #    0                   1                   2                   3
@@ -54,21 +53,21 @@ module PacketGen
         #  @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 OSPFv3::LSUpdate
-    OSPFv3.bind_header OSPFv3::LSUpdate, type: OSPFv3::TYPES['LS_UPDATE']
+    OSPFv3.bind OSPFv3::LSUpdate, type: OSPFv3::TYPES['LS_UPDATE']
   end
 end

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

@@ -8,7 +8,6 @@
 module PacketGen
   module Header
     class OSPFv3
-
       # This class handles links in a {LSARouter OSPFv3 LSA router payload}.
       # @author Sylvain Daubert
       class Link < Types::Fields
@@ -53,7 +52,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 OSPFv3 LSA Router payloads.
@@ -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 OSPFv3.const_defined? klassname
             OSPFv3.const_get klassname
           else

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

@@ -8,7 +8,6 @@
 module PacketGen
   module Header
     class OSPFv3
-
       # This class handles {OSPFv3 OSPFv3} LSA header. A LSA header has the
       # following format:
       #   0                   1                   2                   3
@@ -40,7 +39,7 @@ module PacketGen
           'NSSA'              => 0x2007,
           'Link'              => 0x0008,
           'Intra-Area-Prefix' => 0x2009
-        }
+        }.freeze
 
         # @!attribute age
         #  The time in seconds since the LSA was originated.
@@ -73,7 +72,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
@@ -87,7 +86,7 @@ module PacketGen
           end
           c0 %= 255
           c1 %= 255
-          
+
           x = ((sz - 16 - 1) * c0 - c1) % 255
           x += 255 if x <= 0
           y = 255 * 2 - c0 - x

data/lib/packetgen/header/snmp.rb

@@ -8,7 +8,6 @@
 
 module PacketGen
   module Header
-
     # Dissect error
     class DissectError < ParseError; end
 
@@ -18,7 +17,6 @@ module PacketGen
     # @author Sylvain Daubert
     # @since 2.0.0
     class SNMP < ASN1Base
-
       # Agents listen to this port
       UDP_PORT1 = 161
       # Configuration sinks listen to this port
@@ -34,26 +32,27 @@ module PacketGen
       PDU_TRAPv2   = 7
       PDU_REPORT   = 8
 
-      ERRORS = { 'no_error'              => 0,
-                 'too_big'               => 1,
-                 'no_such_name'          => 2,
-                 'bad_value'             => 3,
-                 'read_only'             => 4,
-                 'generic_error'         => 5,
-                 'no_access'             => 6,
-                 'wrong_type'            => 7,
-                 'wrong_length'          => 8,
-                 'wrong_encoding'        => 9,
-                 'wrong_value'           => 10,
-                 'no_creation'           => 11,
-                 'inconsistent_value'    => 12,
-                 'ressource_unavailable' => 13,
-                 'commit_failed'         => 14,
-                 'undo_failed'           => 15,
-                 'authorization_error'   => 16,
-                 'not_writable'          => 17,
-                 'inconsistent_name'     => 18
-               }
+      ERRORS = {
+        'no_error'              => 0,
+        'too_big'               => 1,
+        'no_such_name'          => 2,
+        'bad_value'             => 3,
+        'read_only'             => 4,
+        'generic_error'         => 5,
+        'no_access'             => 6,
+        'wrong_type'            => 7,
+        'wrong_length'          => 8,
+        'wrong_encoding'        => 9,
+        'wrong_value'           => 10,
+        'no_creation'           => 11,
+        'inconsistent_value'    => 12,
+        'ressource_unavailable' => 13,
+        'commit_failed'         => 14,
+        'undo_failed'           => 15,
+        'authorization_error'   => 16,
+        'not_writable'          => 17,
+        'inconsistent_name'     => 18
+      }.freeze
 
       # Class to handle SNMP VarBind
       #  VarBind ::= SEQUENCE {
@@ -76,10 +75,10 @@ module PacketGen
 
       # Class to handle GetRequest PDU
       #  GetRequest-PDU ::= [0] IMPLICIT PDU
-      #  
+      #
       #  PDU ::= SEQUENCE {
       #              request-id INTEGER (-214783648..214783647),
-      #  
+      #
       #              error-status                -- sometimes ignored
       #                  INTEGER {
       #                      noError(0),
@@ -102,10 +101,10 @@ module PacketGen
       #                      notWritable(17),
       #                      inconsistentName(18)
       #                  },
-      #          
+      #
       #              error-index                 -- sometimes ignored
       #                  INTEGER (0..max-bindings),
-      #          
+      #
       #              variable-bindings           -- values are sometimes ignored
       #                  VarBindList
       #          }
@@ -177,7 +176,7 @@ module PacketGen
 
       # Class to handle Bulk PDU
       #  GetBulkRequest-PDU ::= [5] IMPLICIT BulkPDU
-      #  
+      #
       #  BulkPDU ::=                         -- must be identical in
       #        SEQUENCE {                    -- structure to PDU
       #            request-id      INTEGER (-214783648..214783647),
@@ -259,9 +258,8 @@ module PacketGen
       def initialize(options={})
         super
         data.chosen = options[:chosen_pdu] if options[:chosen_pdu]
-        if options[:pdu]
-          data.root.value[data.chosen] = data.root.chosen_value.class.new(options[:pdu])
-        end
+        return unless options[:pdu]
+        data.root.value[data.chosen] = data.root.chosen_value.class.new(options[:pdu])
       end
 
       # accessor to data payload
@@ -298,10 +296,25 @@ module PacketGen
           str
         end
       end
+
+      # @api private
+      # @note This method is used internally by PacketGen and should not be
+      #       directly called
+      # @param [Packet] packet
+      # @return [void]
+      # @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)
+        return unless packet.is? 'UDP'
+        return unless packet.udp.sport.zero?
+        packet.udp.sport = packet.udp.dport
+      end
     end
 
     self.add_class SNMP
-    UDP.bind_header SNMP, dport: SNMP::UDP_PORT1, sport: SNMP::UDP_PORT1
-    UDP.bind_header SNMP, dport: SNMP::UDP_PORT2, sport: SNMP::UDP_PORT2
+    UDP.bind SNMP, dport: SNMP::UDP_PORT1
+    UDP.bind SNMP, sport: SNMP::UDP_PORT1
+    UDP.bind SNMP, dport: SNMP::UDP_PORT2
+    UDP.bind SNMP, sport: SNMP::UDP_PORT2
   end
 end