packetgen 3.3.3 → 4.1.0

data/lib/packetgen/header/bootp.rb

@@ -12,31 +12,31 @@ module PacketGen
     # RFC 951}
     #
     # A BOOTP header consists of:
-    # * an operation code field ({#op} of type {Types::Int8Enum}),
-    # * a hardware address type ({#htype} of type {Types::Int8}),
-    # * a hardware address length ({#hlen} of type {Types::Int8}),
-    # * a {#hops} field ({Types::Int8}),
-    # * a transaction ID ({#xid} of type {Types::Int32}),
-    # * a {#secs} field (){Types::Int16}),
-    # * a {#flags} field (){Types::Int16}):
+    # * an operation code field ({#op} of type +BinStruct::Int8Enum+),
+    # * a hardware address type ({#htype} of type +BinStruct::Int8+),
+    # * a hardware address length ({#hlen} of type +BinStruct::Int8+),
+    # * a {#hops} field (+BinStruct::Int8+),
+    # * a transaction ID ({#xid} of type +BinStruct::Int32+),
+    # * a {#secs} field (+BinStruct::Int16+),
+    # * a {#flags} field (+BinStruct::Int16+):
     #   * a 1-bit broadcast flag ({#b}),
     #   * a 15-bit Must Be Zero field ({#mbz}),
     # * a {#ciaddr} field ({IP::Addr}),
     # * a {#yiaddr} field ({IP::Addr}),
     # * a {#siaddr} field ({IP::Addr}),
     # * a {#giaddr} field ({IP::Addr}),
-    # * a {#chaddr} field (16-byte {Types::String}),
-    # * a {#sname} field (64-byte {Types::CString}),
-    # * a {#file} field (128-byte {Types::CString}),
-    # * and a body ({Types::String}).
+    # * a {#chaddr} field (16-byte +BinStruct::String+),
+    # * a {#sname} field (64-byte +BinStruct::CString+),
+    # * a {#file} field (128-byte +BinStruct::CString+),
+    # * and a body (+BinStruct::String+).
     #
-    # == Create a BOOTP header
+    # @example Create a BOOTP header
     #   # standalone
     #   bootp = PacketGen::Header::BOOTP.new
     #   # in a packet
-    #   pkt = PacketGen.gen('IP').add('BOOTP')
+    #   pkt = PacketGen.gen('IP').add('UDP').add('BOOTP')
     #   # access to BOOTP header
-    #   pkt.bootp      # => PacketGen::Header::BOOTP
+    #   pkt.bootp.protocol_name      # => "BOOTP"
     # @author Sylvain Daubert
     # @since 2.2.0
     class BOOTP < Base
@@ -52,84 +52,82 @@ module PacketGen
       # @!attribute op
       #   8-bit opcode
       #   @return [Integer]
-      define_field :op, Types::Int8Enum, enum: OPCODES
+      define_attr :op, BinStruct::Int8Enum, enum: OPCODES
 
       # @!attribute htype
       #  8-bit hardware address type
       #  @return [Integer]
-      define_field :htype, Types::Int8, default: 1
+      define_attr :htype, BinStruct::Int8, default: 1
 
       # @!attribute hlen
       #  8-bit hardware address length
       #  @return [Integer]
-      define_field :hlen, Types::Int8, default: 6
+      define_attr :hlen, BinStruct::Int8, default: 6
 
       # @!attribute hops
       #  @return [Integer]
-      define_field :hops, Types::Int8
+      define_attr :hops, BinStruct::Int8
 
       # @!attribute xid
       #  32-bit Transaction ID
       #  @return [Integer]
-      define_field :xid, Types::Int32
+      define_attr :xid, BinStruct::Int32
 
       # @!attribute secs
       #  16-bit integer: number of seconds elapsed since client began address
       #  acquisition or renewal process
       #  @return [Integer]
-      define_field :secs, Types::Int16
+      define_attr :secs, BinStruct::Int16
 
       # @!attribute flags
       #  16-bit flag field
       #  @return [Integer]
-      define_field :flags, Types::Int16
+      # @!attribute b
+      #  Broadcast flag, from {#flags}
+      # @return [Boolean]
+      # @!attribute mbz
+      #  15-bit Must Be Zero bits, from {#flags}
+      # @return [Boolean]
+      define_bit_attr :flags, b: 1, mbz: 15
 
       # @!attribute ciaddr
       #  client IP address
       #  @return [String]
-      define_field :ciaddr, IP::Addr
+      define_attr :ciaddr, IP::Addr
 
       # @!attribute yiaddr
       #  'your' (client) IP address
       #  @return [String]
-      define_field :yiaddr, IP::Addr
+      define_attr :yiaddr, IP::Addr
 
       # @!attribute siaddr
       #  IP address of next server to use in bootstrap
       #  @return [String]
-      define_field :siaddr, IP::Addr
+      define_attr :siaddr, IP::Addr
 
       # @!attribute giaddr
       #  Relay agent IP address, used in booting via a relay agent
       #  @return [String]
-      define_field :giaddr, IP::Addr
+      define_attr :giaddr, IP::Addr
 
       # @!attribute chaddr
       #   client hardware address
       #   @return [String]
-      define_field :chaddr, Types::String, static_length: 16
+      define_attr :chaddr, BinStruct::String, static_length: 16
 
       # @!attribute sname
       #   optional server hostname, null-terminated string
       #   @return [String]
-      define_field :sname, Types::CString, static_length: 64
+      define_attr :sname, BinStruct::CString, static_length: 64
 
       # @!attribute file
       #   Boot file name, null terminated string
       #   @return [String]
-      define_field :file, Types::CString, static_length: 128
+      define_attr :file, BinStruct::CString, static_length: 128
 
       # @!attribute body
       #   @return [String]
-      define_field :body, Types::String
-
-      # @!attribute b
-      #  Broadcast flag, from {#flags}
-      # @return [Boolean]
-      # @!attribute mbz
-      #  15-bit Must Be Zero bits, from {#flags}
-      # @return [Boolean]
-      define_bit_fields_on :flags, :b, :mbz, 15
+      define_attr :body, BinStruct::String
 
       # @return [String]
       def inspect

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

@@ -58,52 +58,52 @@ module PacketGen
       }.freeze
 
       # @!parse
-      #  # Option class with string value. {#type #type} and {#length #length} are
-      #  # {Types::Int8}.
+      #  # Option class with string value. +#type+ and +#length+ are
+      #  # +BinStruct::Int8+.
       #  #
-      #  # See also {IPAddrOption}, {Int8Option}, {Int16Option} and {Int32Option}.
+      #  # See also specialized {IPAddrOption}, {Int8Option}, {Int16Option} and {Int32Option}.
       #  # @since 2.2.0
-      #  # @since 3.1.0 subclass of {Types::AbstractTLV}
-      #  class Option < Types::AbstractTLV; end
+      #  # @since 3.1.0 subclass of +BinStruct::AbstractTLV+
+      #  class Option < BinStruct::AbstractTLV; end
       # @private
-      Option = Types::AbstractTLV.create
+      Option = BinStruct::AbstractTLV.create
       Option.define_type_enum DHCP_OPTIONS
       # @!parse
       #  # {Option} class with IP address value
       #  # @since 2.2.0
-      #  # @since 3.1.0 subclass of {Types::AbstractTLV}
-      #  class IPAddrOption < Types::AbstractTLV; end
+      #  # @since 3.1.0 subclass of +BinStruct::AbstractTLV+
+      #  class IPAddrOption < BinStruct::AbstractTLV; end
       # @private
-      IPAddrOption = Types::AbstractTLV.create(value_class: IP::Addr)
+      IPAddrOption = BinStruct::AbstractTLV.create(value_class: IP::Addr)
       IPAddrOption.define_type_enum DHCP_OPTIONS
       # @!parse
       #  # {Option} class with int8 value
       #  # @since 2.2.0
-      #  # @since 3.1.0 subclass of {Types::AbstractTLV}
-      #  class Int8Option < Types::AbstractTLV; end
+      #  # @since 3.1.0 subclass of +BinStruct::AbstractTLV+
+      #  class Int8Option < BinStruct::AbstractTLV; end
       # @private
-      Int8Option = Types::AbstractTLV.create(value_class: Types::Int8)
+      Int8Option = BinStruct::AbstractTLV.create(value_class: BinStruct::Int8)
       Int8Option.define_type_enum DHCP_OPTIONS
       # @!parse
       #  # {Option} class with int16 value
       #  # @since 2.2.0
-      #  # @since 3.1.0 subclass of {Types::AbstractTLV}
-      #  class Int16Option < Types::AbstractTLV; end
+      #  # @since 3.1.0 subclass of {+inStruct::AbstractTLV+
+      #  class Int16Option < BinStruct::AbstractTLV; end
       # @private
-      Int16Option = Types::AbstractTLV.create(value_class: Types::Int16)
+      Int16Option = BinStruct::AbstractTLV.create(value_class: BinStruct::Int16)
       Int16Option.define_type_enum DHCP_OPTIONS
       # @!parse
       #  # {Option} class with int32 value
       #  # @since 2.2.0
-      #  # @since 3.1.0 subclass of {Types::AbstractTLV}
-      #  class Int32Option < Types::AbstractTLV; end
+      #  # @since 3.1.0 subclass of +BinStruct::AbstractTLV+
+      #  class Int32Option < BinStruct::AbstractTLV; end
       # @private
-      Int32Option = Types::AbstractTLV.create(value_class: Types::Int32)
+      Int32Option = BinStruct::AbstractTLV.create(value_class: BinStruct::Int32)
       Int32Option.define_type_enum DHCP_OPTIONS
 
       # Class to indicate DHCP options end
-      class End < Types::Int8
-        def initialize(value=255)
+      class End < BinStruct::Int8
+        def initialize(options={ value: 255 })
           super
         end
 
@@ -115,7 +115,7 @@ module PacketGen
 
       # Class to indicate padding after DHCP options
       class Pad < End
-        def initialize(value=0)
+        def initialize(options={ value: 0 })
           super
         end
       end

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

@@ -9,9 +9,9 @@
 module PacketGen
   module Header
     class DHCP
-      # Container class for {Option DHCP Options}.
+      # Container class for {Option DHCP Options}. Accepted options are listed on {DHCP::DHCP_OPTIONS}.
       #
-      # == Add DHCP options to an +Options+ instance
+      # @example Add DHCP options to an +Options+ instance
       #   options = PacketGen::Header::DHCP::Options.new
       #   # Add a lease_time option
       #   options << { type: 'lease_time', value: 3600 }
@@ -22,7 +22,7 @@ module PacketGen
       #   # And finish with padding
       #   options << { type: 'pad' }
       # @author Sylvain Daubert
-      class Options < Types::Array
+      class Options < BinStruct::Array
         set_of Option
 
         private

data/lib/packetgen/header/dhcp.rb

@@ -12,22 +12,21 @@ module PacketGen
     # RFC 2131}
     #
     # A DHCP header is quite simple. It is composed of:
-    # * a {#magic} field ({Types::Int32}) to retrieve it in a BOOTP header,
-    # * a, {#options} field ({Options} type, which is a collection of DHCP
+    # * a {#magic} field (+BinStruct::Int32+) to retrieve it in a BOOTP header,
+    # * a {#options} field ({Options} type, which is a collection of DHCP
     #   options).
     #
     # In PacketGen, a DHCP header is always a secondary header after {BOOTP} one.
     #
-    # == Create a DHCP header
+    # @example Create a DHCP header
     #   # standalone
     #   dhcp = PacketGen::Header::DHCP.new
     #   # in a packet
-    #   pkt = PacketGen.gen('IP').add('BOOTP').add('DHCP')
+    #   pkt = PacketGen.gen('IP').add('UDP').add('BOOTP').add('DHCP')
     #   # access to DHCP header
-    #   pkt.dhcp      # => PacketGen::Header::DHCP
+    #   pkt.dhcp.class      # => PacketGen::Header::DHCP
     #
-    # == Add options
-    # Options may be added these ways:
+    # @example Add options to a DHCP header
     #   dhcp = PacketGen::Header::DHCP.new
     #   # Add a lease_time option
     #   dhcp.options << { type: 'lease_time', value: 3600 }
@@ -50,10 +49,10 @@ module PacketGen
 
       # @!attribute magic
       #   @return [Integer]
-      define_field :magic, Types::Int32, default: 0x63825563
+      define_attr :magic, BinStruct::Int32, default: 0x63825563
       # @!attribute options
       #   @return [DHCP::Options]
-      define_field :options, DHCP::Options
+      define_attr :options, DHCP::Options
 
       # differentiate from BOOTP by checking presence of DHCP magic
       # @return [Boolean]

data/lib/packetgen/header/dhcpv6/duid.rb

@@ -11,8 +11,8 @@ module PacketGen
     class DHCPv6
       # @abstract Base class for DUID (DHCP Unique ID)
       # @author Sylvain Daubert
-      class DUID < Types::Fields
-        include Types::Fieldable
+      class DUID < BinStruct::Struct
+        include BinStruct::Structable
 
         TYPES = {
           'DUID-LLT' => 1,
@@ -23,12 +23,12 @@ module PacketGen
         # @!attribute type
         #  16-bit DUID type
         #  @return [Integer]
-        define_field :type, Types::Int16Enum, enum: TYPES
+        define_attr :type, BinStruct::Int16Enum, enum: TYPES
         # @!attribute body
-        #  @abstract replaced by specific fields in subclasses
+        #  @abstract replaced by specific attributes in subclasses
         #  DUID data.
         #  @return [String]
-        define_field :body, Types::String
+        define_attr :body, BinStruct::String
 
         alias private_read read
         private :private_read
@@ -50,7 +50,7 @@ module PacketGen
               self
             end
           else
-            private_read str
+            private_read(str)
           end
         end
 
@@ -72,7 +72,7 @@ module PacketGen
       # DUID Based on Link-layer Address Plus Time
       # @author Sylvain Daubert
       class DUID_LLT < DUID
-        remove_field :body
+        remove_attr :body
 
         # Base time for time computation
         BASE_TIME = Time.utc(2000, 1, 1)
@@ -80,14 +80,14 @@ module PacketGen
         # @!attribute htype
         #  16-bit hardware protocol type
         #  @return [Integer]
-        define_field :htype, Types::Int16, default: 1
+        define_attr :htype, BinStruct::Int16, default: 1
         # @!attribute time
         #  32-bit time information
         #  @return [Time]
-        define_field :time, Types::Int32, default: (Time.now - BASE_TIME).to_i
+        define_attr :time, BinStruct::Int32, default: (Time.now - BASE_TIME).to_i
         # @!attribute link_addr
         #  @return [Eth::MacAddr]
-        define_field :link_addr, Eth::MacAddr
+        define_attr :link_addr, Eth::MacAddr
 
         undef time, time=
 
@@ -112,15 +112,15 @@ module PacketGen
       # DUID Based on Enterprise Number
       # @author Sylvain Daubert
       class DUID_EN < DUID
-        remove_field :body
+        remove_attr :body
 
         # @!attribute en
         #  32-bit entreprise number
         #  @return [Integer]
-        define_field :en, Types::Int32
+        define_attr :en, BinStruct::Int32
         # @!attribute identifier
         #  @return [String]
-        define_field :identifier, Types::String
+        define_attr :identifier, BinStruct::String
 
         # Get human-readable DUID description
         # @return [String]
@@ -132,15 +132,15 @@ module PacketGen
       # DUID Based on Link-layer
       # @author Sylvain Daubert
       class DUID_LL < DUID
-        remove_field :body
+        remove_attr :body
 
         # @!attribute htype
         #  16-bit hardware protocol type
         #  @return [Integer]
-        define_field :htype, Types::Int16, default: 1
+        define_attr :htype, BinStruct::Int16, default: 1
         # @!attribute link_addr
         #  @return [Eth::MacAddr]
-        define_field :link_addr, Eth::MacAddr
+        define_attr :link_addr, Eth::MacAddr
 
         # Get human-readable DUID description
         # @return [String]