packetgen 3.3.2 → 4.0.0

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

@@ -27,26 +27,26 @@ module PacketGen
       # * a 32-bit {#link_state_id} field,
       # * and a 32-bit {#advertising_router} field.
       # @author Sylvain Daubert
-      class LSR < Types::Fields
-        include Types::Fieldable
+      class LSR < BinStruct::Struct
+        include BinStruct::Structable
 
         # @!attribute reserved
         #  reserved field.
         #  @return [Integer]
-        define_field :reserved, Types::Int16, default: 0
+        define_attr :reserved, BinStruct::Int16, default: 0
         # @!attribute type
         #  The type of the LSA to request.
         #  @return [Integer]
-        define_field :type, Types::Int16Enum, enum: LSAHeader::TYPES
+        define_attr :type, BinStruct::Int16Enum, enum: LSAHeader::TYPES
         # @!attribute link_state_id
         #  This field identifies the portion of the internet environment
         #  that is being described by the LSA to request.
         #  @return [String]
-        define_field :link_state_id, IP::Addr
+        define_attr :link_state_id, IP::Addr
         # @!attribute advertising_router
         #  The Router ID of the requested LSA.
         #  @return [String]
-        define_field :advertising_router, IP::Addr
+        define_attr :advertising_router, IP::Addr
 
         # Get human-readable type
         # @return [String]
@@ -60,10 +60,10 @@ module PacketGen
         end
       end
 
-      # This class defines a specialized {Types::Array array} to handle series
+      # This class defines a specialized {BinStruct::Array array} to handle series
       # of {LSR LSRs}.
       # @author Sylvain Daubert
-      class ArrayOfLSR < Types::Array
+      class ArrayOfLSR < BinStruct::Array
         set_of LSR
       end
 
@@ -100,7 +100,7 @@ module PacketGen
         # @!attribute lsrs
         #  Array of {LSR}
         #  @return [ArrayOfLSR]
-        define_field :lsrs, ArrayOfLSR
+        define_attr :lsrs, ArrayOfLSR
       end
     end
 

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

@@ -23,7 +23,7 @@ module PacketGen
       #   |                              ...                              |
       #
       # This paylod is implemented with two fields:
-      # * {#lsas_count}, a {Types::Int32} field,
+      # * {#lsas_count}, a {BinStruct::Int32} field,
       # * and {#lsas}, an {ArrayOfLSA} object.
       #
       # == Create a LSUpdate payload
@@ -48,12 +48,12 @@ module PacketGen
         # @!attribute lsas_count
         #  Count of LSAs included in this update
         #  @return [Integer]
-        define_field :lsas_count, Types::Int32
+        define_attr :lsas_count, BinStruct::Int32
         # @!attribute lsas
         #  Array of {LSA LSAs}
         #  @return [ArrayOfLSA]
-        define_field :lsas, ArrayOfLSA,
-                     builder: ->(h, t) { t.new(counter: h[:lsas_count]) }
+        define_attr :lsas, ArrayOfLSA,
+                    builder: ->(h, t) { t.new(counter: h[:lsas_count]) }
 
         # Calculate checksums of all LSAs
         # @return [void]

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

@@ -11,27 +11,27 @@ module PacketGen
     class OSPFv3
       # This class handles links in a {LSARouter OSPFv3 LSA router payload}.
       # @author Sylvain Daubert
-      class Link < Types::Fields
-        include Types::Fieldable
+      class Link < BinStruct::Struct
+        include BinStruct::Structable
 
         # @!attribute type
         #  @return [Integer]
-        define_field :type, Types::Int8
+        define_attr :type, BinStruct::Int8
         # @!attribute reserved
         #  @return [Integer]
-        define_field :reserved, Types::Int8, default: 0
+        define_attr :reserved, BinStruct::Int8, default: 0
         # @!attribute metric
         #  @return [Integer]
-        define_field :metric, Types::Int16
+        define_attr :metric, BinStruct::Int16
         # @!attribute interface_id
         #  @return [Integer]
-        define_field :interface_id, Types::Int32
+        define_attr :interface_id, BinStruct::Int32
         # @!attribute neighbor_interface_id
         #  @return [Integer]
-        define_field :neighbor_interface_id, Types::Int32
+        define_attr :neighbor_interface_id, BinStruct::Int32
         # @!attribute neighbor_router_id
         #  @return [String]
-        define_field :neighbor_router_id, IP::Addr
+        define_attr :neighbor_router_id, IP::Addr
 
         # @return [String]
         def to_human
@@ -40,10 +40,10 @@ module PacketGen
         end
       end
 
-      # This class defines a specialized {Types::Array array} to handle series
+      # This class defines a specialized {BinStruct::Array array} to handle series
       # of {Link Links}.
       # @author Sylvain Daubert
-      class ArrayOfLink < Types::Array
+      class ArrayOfLink < BinStruct::Array
         set_of Link
       end
 
@@ -54,39 +54,36 @@ module PacketGen
         # @!attribute body
         #  LSA body
         #  @return [String]
-        define_field :body, Types::String,
-                     builder: ->(h, t) { t.new(length_from: -> { h.length - 20 }) }
+        define_attr :body, BinStruct::String,
+                    builder: ->(h, t) { t.new(length_from: -> { h.length - 20 }) }
       end
 
       # This class handles OSPFv3 LSA Router payloads.
       #
       # A LSA router payload is composed of:
       # * a header (see methods inherited from {LSAHeader}),
-      # * a 8-bit flag word {#flags} ({Types::Int8}),
-      # * a 24-bit {#options} field ({Types::Int24}),
+      # * a 8-bit flag word {#flags} ({BinStruct::Int8}),
+      # * a 24-bit {#options} field ({BinStruct::Int24}),
       # * and an array of {#links} ({ArrayOfLink}).
       # @author Sylvain Daubert
       class LSARouter < LSAHeader
         # @attribute flags
         #  8-bit flag word
         #  @return [Integer]
-        define_field :flags, Types::Int8
-        # @!macro define_ospfv3_options
-        OSPFv3.define_options(self)
-        # @attribute links
-        #  @return [ArrayOfLink]
-        define_field :links, ArrayOfLink, builder: ->(h, t) { t.new(length_from: -> { h.length - h.offset_of(:links) }) }
-
         # @!attribute nt_flag
-        #  @return [Boolean]
+        #  @return [Integer]
         # @!attribute v_flag
-        #  @return [Boolean]
+        #  @return [Integer]
         # @!attribute e_flag
-        #  @return [Boolean]
+        #  @return [Integer]
         # @!attribute b_flag
-        #  @return [Boolean]
-        define_bit_fields_on :flags, :zz, 3, :nt_flag, :x_flag, :v_flag, :e_flag,
-                             :b_flag
+        #  @return [Integer]
+        define_bit_attr :flags, zz: 3, nt_flag: 1, x_flag: 1, v_flag: 1, e_flag: 1, b_flag: 1
+        # @!macro define_ospfv3_options
+        OSPFv3.define_options(self)
+        # @attribute links
+        #  @return [ArrayOfLink]
+        define_attr :links, ArrayOfLink, builder: ->(h, t) { t.new(length_from: -> { h.length - h.offset_of(:links) }) }
       end
 
       # This class handles OSPFv3 LSA Network payloads.
@@ -100,20 +97,20 @@ module PacketGen
       class LSANetwork < LSAHeader
         # @!attribute reserved
         #  @return [Integer]
-        define_field :reserved, Types::Int8
+        define_attr :reserved, BinStruct::Int8
         # @!macro define_ospfv3_options
         OSPFv3.define_options(self)
         # @!attribute routers
         #  List of routers attached to the link.
         #  @return [IP::ArrayOfAddr]
-        define_field :routers, IP::ArrayOfAddr, builder: ->(h, t) { t.new(length_from: -> { h.length - h.offset_of(:routers) }) }
+        define_attr :routers, IP::ArrayOfAddr, builder: ->(h, t) { t.new(length_from: -> { h.length - h.offset_of(:routers) }) }
       end
 
       # This class handles OSPFv3 LSA Intra-Area-Prefix payloads.
       #
       # An Intra-Area-Prefix payloads is composed of:
-      # * a 16-bit {#prefix_count} field ({Types::Int16}),
-      # * a 16-bit {#ref_ls_type} field ({Types::Int16Enum}),
+      # * a 16-bit {#prefix_count} field ({BinStruct::Int16}),
+      # * a 16-bit {#ref_ls_type} field ({BinStruct::Int16Enum}),
       # * a 32-bit {#ref_link_state_id} ({IP::Addr}),
       # * a 32-bit {#ref_advertising_router} ({IP::Addr}),
       # * and an array of {IPv6Prefix} ({#prefixes}, {ArrayOfIPv6Prefix}). In
@@ -123,40 +120,40 @@ module PacketGen
         # @!attribute prefix_count
         #  The number of IPv6 address prefixes contained in the LSA.
         #  @return [Integer]
-        define_field :prefix_count, Types::Int16
+        define_attr :prefix_count, BinStruct::Int16
         # @!attribute ref_ls_type
         #  Used to identify  the router-LSA or network-LSA with which the IPv6
         #  address prefixes should be associated, in association with
         #  {#ref_link_state_id} and {#ref_advertising_router}.
         #  @return [Integer]
-        define_field :ref_ls_type, Types::Int16Enum, enum: TYPES
+        define_attr :ref_ls_type, BinStruct::Int16Enum, enum: TYPES
         # @!attribute ref_link_state_id
         #  Used to identify  the router-LSA or network-LSA with which the IPv6
         #  address prefixes should be associated, in association with
         #  {#ref_ls_type} and {#ref_advertising_router}.
         #  @return [String]
-        define_field :ref_link_state_id, IP::Addr
+        define_attr :ref_link_state_id, IP::Addr
         # @!attribute ref_advertising_router
         #  Used to identify  the router-LSA or network-LSA with which the IPv6
         #  address prefixes should be associated, in association with
         #  {#ref_link_state_id} and {#ref_ls_type}.
         #  @return [String]
-        define_field :ref_advertising_router, IP::Addr
+        define_attr :ref_advertising_router, IP::Addr
         # @!attribute prefixes
         #  Array of {IPv6Prefix}. Note for this LSA, {IPv6Prefix#reserved} is
         #  used as +metric+ value.
         #  @return [ArrayOfIPv6Prefix]
-        define_field :prefixes, ArrayOfIPv6Prefix,
-                     builder: ->(h, t) { t.new(counter: h[:prefix_count]) }
+        define_attr :prefixes, ArrayOfIPv6Prefix,
+                    builder: ->(h, t) { t.new(counter: h[:prefix_count]) }
       end
 
       # This class handles OSPFv3 LSA Link payloads.
       #
       # A Link payloads is composed of:
-      # * a 8-bit {#router_priority} field ({Types::Int8}),
-      # * a 24-bit {#options} field ({Types::Int24}),
+      # * a 8-bit {#router_priority} field ({BinStruct::Int8}),
+      # * a 24-bit {#options} field ({BinStruct::Int24}),
       # * a 128-bit IPv6 {#interface_addr} ({IPv6::Addr}),
-      # * a 32-bit {#prefix_count} field ({Types::Int32}),
+      # * a 32-bit {#prefix_count} field ({BinStruct::Int32}),
       # * and an array of {IPv6Prefix} ({#prefixes}, {ArrayOfIPv6Prefix}).
       # @author Sylvain Daubert
       class LSALink < LSAHeader
@@ -164,33 +161,33 @@ module PacketGen
         #  The Router Priority of the interface attaching the originating
         #  router to the link.
         #  @return [Integer]
-        define_field :router_priority, Types::Int8
+        define_attr :router_priority, BinStruct::Int8
         # @!macro define_ospfv3_options
         OSPFv3.define_options(self)
         # @!attribute interface_addr
         #  The originating router's link-local interface address on the link.
         #  @return [String]
-        define_field :interface_addr, IPv6::Addr
+        define_attr :interface_addr, IPv6::Addr
         # @!attribute prefix_count
         #  The number of IPv6 address prefixes contained in the LSA.
         #  @return [Integer]
-        define_field :prefix_count, Types::Int32
+        define_attr :prefix_count, BinStruct::Int32
         # @!attribute prefixes
         #  List of IPv6 prefixes to be associated with the link.
         #  @return [ArrayOfIPv6Prefix]
-        define_field :prefixes, ArrayOfIPv6Prefix, builder: ->(h, t) { t.new(counter: h[:prefix_count]) }
+        define_attr :prefixes, ArrayOfIPv6Prefix, builder: ->(h, t) { t.new(counter: h[:prefix_count]) }
       end
 
-      # This class defines a specialized {Types::Array array} to handle series
+      # This class defines a specialized {BinStruct::Array array} to handle series
       # of {LSA LSAs} or {LSAHeader LSAHeaders}. It recognizes known LSA types
       # and infers correct type.
       # @author Sylvain Daubert
-      class ArrayOfLSA < Types::Array
+      class ArrayOfLSA < BinStruct::Array
         set_of LSAHeader
 
         # @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}
+        # @option options [BinStruct::Int] counter Int object used as a counter for this set
+        # @option options [Integer] only_headers if +true+, only {LSAHeader LSAHeaders}
         #  will be added to this array.
         def initialize(options={})
           super
@@ -200,7 +197,7 @@ module PacketGen
         private
 
         def record_from_hash(hsh)
-          raise ArgumentError, 'hash should have :type key' unless hsh.key? :type
+          raise ArgumentError, 'hash should have :type key' unless hsh.key?(:type)
 
           klass = if @only_headers
                     LSAHeader
@@ -220,8 +217,8 @@ module PacketGen
         def get_lsa_class_by_human_type(htype)
           klassname = "LSA#{htype.to_s.delete('-')}"
           begin
-            if OSPFv3.const_defined? klassname
-              OSPFv3.const_get klassname
+            if OSPFv3.const_defined?(klassname)
+              OSPFv3.const_get(klassname)
             else
               LSA
             end

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

@@ -29,8 +29,8 @@ module PacketGen
       # LSA headers are used as-is in {DbDescription} and {LSAck} payloads.
       # But this class is also a base class for different LSA class, as {LSARouter}.
       # @author Sylvain Daubert
-      class LSAHeader < Types::Fields
-        include Types::Fieldable
+      class LSAHeader < BinStruct::Struct
+        include BinStruct::Structable
 
         # LSA known types
         TYPES = {
@@ -47,34 +47,34 @@ module PacketGen
         # @!attribute age
         #  The time in seconds since the LSA was originated.
         #  @return [Integer]
-        define_field :age, Types::Int16
+        define_attr :age, BinStruct::Int16
         # @!attribute type
         #  The type of the LSA.
         #  @return [Integer]
-        define_field :type, Types::Int16Enum, enum: TYPES
+        define_attr :type, BinStruct::Int16Enum, enum: TYPES
         # @!attribute link_state_id
         #  This field identifies the portion of the internet environment
         #  that is being described by the LSA.
         #  @return [String]
-        define_field :link_state_id, IP::Addr
+        define_attr :link_state_id, IP::Addr
         # @!attribute advertising_router
         #  The Router ID of the router that originated the LSA.
         #  @return [String]
-        define_field :advertising_router, IP::Addr
+        define_attr :advertising_router, IP::Addr
         # @!attribute sequence_number
         #  @return [Integer]
-        define_field :sequence_number, Types::Int32
+        define_attr :sequence_number, BinStruct::Int32
         alias seqnum sequence_number
         alias seqnum= sequence_number=
         # @!attribute checksum
         #  The Fletcher checksum of the complete contents of the LSA,
         #  including the LSA header but excluding the LS age field.
         #  @return [Integer]
-        define_field :checksum, Types::Int16
+        define_attr :checksum, BinStruct::Int16
         # @!attribute length
         #  Length of the LSA, including the header.
         #  @return [Integer]
-        define_field :length, Types::Int16
+        define_attr :length, BinStruct::Int16
 
         # Compute and set Fletcher-16 checksum on LSA
         # @return [Integer]

data/lib/packetgen/header/ospfv3.rb

@@ -24,15 +24,15 @@ module PacketGen
     #  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
     #
     # An OSPFv3 header consists of:
-    # * a {#version} field ({Types::Int8}),
-    # * a {#type} field ({Types::Int8Enum}),
-    # * a {#length} field ({Types::Int16}). The length includes the header,
-    # * a {#router_id} field ({Types::Int32}),
-    # * an {#area_id} field ({Types::Int32}),
-    # * a {#checksum} field ({Types::Int16}),
-    # * an {#instance_id} field ({Types::Int8}),
-    # * a {#reserved} field ({Types::Int8}),
-    # * and a {#body} ({Types::String}).
+    # * a {#version} field ({BinStruct::Int8}),
+    # * a {#type} field ({BinStruct::Int8Enum}),
+    # * a {#length} field ({BinStruct::Int16}). The length includes the header,
+    # * a {#router_id} field ({BinStruct::Int32}),
+    # * an {#area_id} field ({BinStruct::Int32}),
+    # * a {#checksum} field ({BinStruct::Int16}),
+    # * an {#instance_id} field ({BinStruct::Int8}),
+    # * a {#reserved} field ({BinStruct::Int8}),
+    # * and a {#body} ({BinStruct::String}).
     #
     # == Create an OSPFv3 header
     #   # standalone
@@ -74,38 +74,38 @@ module PacketGen
       # @!attribute version
       #  8-bit OSPF version
       #  @return [Integer]
-      define_field :version, Types::Int8, default: 3
+      define_attr :version, BinStruct::Int8, default: 3
       # @!attribute type
       #  8-bit OSPF packet type. Types are defined in {TYPES}.
       #  @return [Integer]
-      define_field :type, Types::Int8Enum, enum: TYPES
+      define_attr :type, BinStruct::Int8Enum, enum: TYPES
       # @!attribute length
       #  16-bit OSPF packet length
       #  @return [Integer]
-      define_field :length, Types::Int16
+      define_attr :length, BinStruct::Int16
       # @!attribute router_id
       #  32-bit router ID
       #  @return [Integer]
-      define_field :router_id, Types::Int32
+      define_attr :router_id, BinStruct::Int32
       # @!attribute area_id
       #  32-bit area ID
       #  @return [Integer]
-      define_field :area_id, Types::Int32
+      define_attr :area_id, BinStruct::Int32
       # @!attribute checksum
       #  16-bit OSPF packet checksum
       #  @return [Integer]
-      define_field :checksum, Types::Int16
+      define_attr :checksum, BinStruct::Int16
       # @!attribute instance_id
       #  8-bit instance ID.
       #  @return [Integer]
-      define_field :instance_id, Types::Int8
+      define_attr :instance_id, BinStruct::Int8
       # @!attribute reserved
       #  8-bit reserved field.
       #  @return [Integer]
-      define_field :reserved, Types::Int8, default: 0
+      define_attr :reserved, BinStruct::Int8, default: 0
       # @!attribute body
       #  @return [String,Base]
-      define_field :body, Types::String
+      define_attr :body, BinStruct::String
 
       # @api private
       # Helper class method to define an OSPFv3 options field.
@@ -118,27 +118,25 @@ module PacketGen
       #    @return [Integer]
       #  @!attribute dc_opt
       #    This bit describes the router's handling of demand circuits.
-      #    @return [Boolean]
+      #    @return [Integer]
       #  @!attribute r_opt
       #    This bit indicates whether the originator is an active router.
-      #    @return [Boolean]
+      #    @return [Integer]
       #  @!attribute n_opt
       #    This bit indicates whether or not the router is attached to an NSSA.
-      #    @return [Boolean]
+      #    @return [Integer]
       #  @!attribute x_opt
       #    This bit should be set to 0, and ignored when received.
-      #    @return [Boolean]
+      #    @return [Integer]
       #  @!attribute e_opt
       #    This bit describes the way AS-external-LSAs are flooded.
-      #    @return [Boolean]
+      #    @return [Integer]
       #  @!attribute v6_opt
       #    If this bit is clear, the router/link should be excluded from IPv6
       #    routing calculations.
-      #    @return [Boolean]
+      #    @return [Integer]
       def self.define_options(hdr)
-        hdr.define_field :options, Types::Int24
-        hdr.define_bit_fields_on :options, :z, 18, :dc_opt, :r_opt,
-                                 :n_opt, :x_opt, :e_opt, :v6_opt
+        hdr.define_bit_attr :options, z: 18, dc_opt: 1, r_opt: 1, n_opt: 1, x_opt: 1, e_opt: 1, v6_opt: 1
       end
 
       # @api private