packetgen 3.3.3 → 4.1.0

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

@@ -9,30 +9,31 @@
 module PacketGen
   module Header
     class DHCPv6
-      # A DHCPv6 consists of:
-      # * a {#type} ({Types::Int16}),
-      # * a {#length} ({Types::Int16}),
-      # * and a {#data} ({Types::String}).
+      # A DHCPv6 option consists of:
+      # * a {#type} (+BinStruct::Int16+),
+      # * a {#length} (+BinStruct::Int16+),
+      # * and a {#data} (+BinStruct::String+).
       #
       # Subclasses handles known options. These subclasses may remove {#data}
       # field to replace it by specific option field(s).
       # @author Sylvain Daubert
-      class Option < Types::Fields
-        include Types::Fieldable
+      class Option < BinStruct::Struct
+        include BinStruct::Structable
 
         # @!attribute type
         #  16-bit option type
         #  @return [Integer]
-        define_field :type, Types::Int16
+        define_attr :type, BinStruct::Int16
         # @!attribute length
-        #  16-bit option length
+        #  16-bit option length. Length of data part.
         #  @return [Integer]
-        define_field :length, Types::Int16
+        define_attr :length, BinStruct::Int16
+        # @!scope class
         # @!attribute data
         #  variable length option data.
         #  @return [String]
-        define_field :data, Types::String,
-                     builder: ->(h, t) { t.new(length_from: h[:length]) }
+        define_attr :data, BinStruct::String,
+                    builder: ->(h, t) { t.new(length_from: h[:length]) }
 
         class << self
           # Get Option subclasses
@@ -63,7 +64,7 @@ module PacketGen
             when String
               if DHCPv6.const_defined?(options[:type])
                 klass = DHCPv6.const_get(options[:type])
-                options.delete :type
+                options.delete(:type)
                 klass.new(options) if klass < Option
               end
             else
@@ -96,7 +97,7 @@ module PacketGen
         # Get a human-readable string for this option
         # @return [String]
         def to_human
-          str = +"#{human_type}:"
+          str = "#{human_type}:"
           if respond_to?(:human_data) && !human_data.empty?
             str << human_data
           elsif !self[:data].nil?
@@ -111,12 +112,12 @@ module PacketGen
       # DHCPv6 Client ID option
       # @author Sylvain Daubert
       class ClientID < Option
-        update_field :type, default: 1
-        remove_field :data
+        update_attr :type, default: 1
+        remove_attr :data
 
         # @!attribute duid
         #  @return [DUID]
-        define_field :duid, DUID
+        define_attr :duid, DUID
 
         # Get human-readable data (DUID)
         # @return [String]
@@ -128,32 +129,32 @@ module PacketGen
       # DHCPv6 Server ID option
       # @author Sylvain Daubert
       class ServerID < ClientID
-        update_field :type, default: 2
+        update_attr :type, default: 2
       end
 
       # DHCPv6 Identity Association for Non-temporary Addresses Option
       # @author Sylvain Daubert
       class IANA < Option
-        update_field :type, default: 3
-        remove_field :data
+        update_attr :type, default: 3
+        remove_attr :data
 
         # @!attribute iaid
         #  32-bit IAID field
         #  @return [Integer]
-        define_field :iaid, Types::Int32
+        define_attr :iaid, BinStruct::Int32
         # @!attribute t1
         #  32-bit T1 field
         #  @return [Integer]
-        define_field :t1, Types::Int32
+        define_attr :t1, BinStruct::Int32
         # @!attribute t2
         #  32-bit T2 field
         #  @return [Integer]
-        define_field :t2, Types::Int32
+        define_attr :t2, BinStruct::Int32
         # @!attribute options
         #  options field
         #  @return [String]
-        define_field :options, Types::String,
-                     builder: ->(h, t) { t.new length_from: -> { h[:length].to_i - 12 } }
+        define_attr :options, BinStruct::String,
+                    builder: ->(h, t) { t.new length_from: -> { h[:length].to_i - 12 } }
 
         # Get human-readable data (IAID, T1 and T2)
         # @return [String]
@@ -165,18 +166,18 @@ module PacketGen
       # DHCPv6 Identity Association for Temporary Addresses Option
       # @author Sylvain Daubert
       class IATA < Option
-        update_field :type, default: 4
-        remove_field :data
+        update_attr :type, default: 4
+        remove_attr :data
 
         # @!attribute iaid
         #  32-bit IAID field
         #  @return [Integer]
-        define_field :iaid, Types::Int32
+        define_attr :iaid, BinStruct::Int32
         # @!attribute options
         #  options field
         #  @return [String]
-        define_field :options, Types::String,
-                     builder: ->(h, t) { t.new length_from: -> { h[:length].to_i - 4 } }
+        define_attr :options, BinStruct::String,
+                    builder: ->(h, t) { t.new length_from: -> { h[:length].to_i - 4 } }
 
         # Get human-readable data (IAID)
         # @return [String]
@@ -188,26 +189,26 @@ module PacketGen
       # DHCPv6 IA Address option
       # @author Sylvain Daubert
       class IAAddr < Option
-        update_field :type, default: 5
-        remove_field :data
+        update_attr :type, default: 5
+        remove_attr :data
 
         # @attribute ipv6
         #  IPv6 address
         # @return [IPv6::Addr]
-        define_field :ipv6, IPv6::Addr
+        define_attr :ipv6, IPv6::Addr
         # @attribute preferred_lifetime
         #  32-bit preferred lifetime
         #  @return [Integer]
-        define_field :preferred_lifetime, Types::Int32
+        define_attr :preferred_lifetime, BinStruct::Int32
         # @attribute valid_lifetime
         #  32-bit valid lifetime
         #  @return [Integer]
-        define_field :valid_lifetime, Types::Int32
+        define_attr :valid_lifetime, BinStruct::Int32
         # @!attribute options
         #  options field
         #  @return [String]
-        define_field :options, Types::String,
-                     builder: ->(h, t) { t.new length_from: -> { h[:length].to_i - 24 } }
+        define_attr :options, BinStruct::String,
+                    builder: ->(h, t) { t.new length_from: -> { h[:length].to_i - 24 } }
 
         # Get human-readable data (ipv6, preferred lifetime and valid lifetime)
         # @return [String]
@@ -216,22 +217,17 @@ module PacketGen
         end
       end
 
-      # List of requested options for {ORO} option.
-      # Set of {Types::Int16}
-      # @author Sylvain Daubert
-      class RequestedOptions < Types::Array
-        set_of Types::Int16
-      end
-
       # DHCPv6 Option Request Option
       # @author Sylvain Daubert
       class ORO < Option
-        update_field :type, default: 6
-        remove_field :data
+        update_attr :type, default: 6
+        remove_attr :data
 
         # @!attribute options
-        #   @return [RequestedOptions]
-        define_field :options, RequestedOptions, builder: ->(h, t) { t.new(length_from: h[:length]) }
+        #   @return [BinStruct::ArrayOfInt16]
+        #   @since 2.5.0
+        #   @since 4.1.0 Type +BinStruct::ArrayOfInt16+ instead of custom +RequestedOptions+ (deleted)
+        define_attr :options, BinStruct::ArrayOfInt16, builder: ->(h, t) { t.new(length_from: h[:length]) }
 
         # Get human-readable data
         # @return [String]
@@ -243,13 +239,13 @@ module PacketGen
       # DHCPv6 Preference option
       # @author Sylvain Daubert
       class Preference < Option
-        update_field :type, default: 7
-        remove_field :data
+        update_attr :type, default: 7
+        remove_attr :data
 
         # @!attribute value
         #  8-bit value
         #  @return [Integer]
-        define_field :value, Types::Int8
+        define_attr :value, BinStruct::Int8
 
         # Get human-readable data (value)
         # @return [String]
@@ -261,13 +257,13 @@ module PacketGen
       # DHCPv6 Elapsed Time option
       # @author Sylvain Daubert
       class ElapsedTime < Option
-        update_field :type, default: 8
-        remove_field :data
+        update_attr :type, default: 8
+        remove_attr :data
 
         # @!attribute value
         #  16-bit value
         #  @return [Integer]
-        define_field :value, Types::Int16
+        define_attr :value, BinStruct::Int16
 
         # Get human-readable data (value)
         # @return [String]
@@ -279,19 +275,22 @@ module PacketGen
       # DHCPv6 Relay Message option
       # @author Sylvain Daubert
       class RelayMessage < Option
-        update_field :type, default: 9
+        update_attr :type, default: 9
+        # @!attribute data
+        #  variable length option data.
+        #  @return [String]
       end
 
       # DHCPv6 Server Unicast option
       # @author Sylvain Daubert
       class ServerUnicast < Option
-        update_field :type, default: 12
-        remove_field :data
+        update_attr :type, default: 12
+        remove_attr :data
 
         # @!attribute addr
         #  IPv6 server address
         # @return [IPv6::Addr]
-        define_field :addr, IPv6::Addr
+        define_attr :addr, IPv6::Addr
 
         # Get human-readable data (addr)
         # @return [String]
@@ -302,15 +301,38 @@ module PacketGen
 
       # DHCPv6 Status Code option
       # @author Sylvain Daubert
-      class StatusCode < ElapsedTime
-        update_field :type, default: 13
+      class StatusCode < Option
+        update_attr :type, default: 13
+        remove_attr :data
+
+        # @!attribute status_code
+        #  16-bit status code
+        #  @return [Integer]
+        define_attr :status_code, BinStruct::Int16
+        # @!attribute status_message
+        #  UTF-8 encoded text string suitable for display to an end user
+        #  @return [::String]
+        define_attr :status_message, BinStruct::String
+
+        # @param [Hash] options
+        def initialize(options={})
+          options[:length] = options[:status_message].to_s.size + 2 if options[:status_message]
+          super
+          self.length = self.sz - 4 if options[:status_message].nil?
+        end
+
+        # Get human-readable data (status code)
+        # @return [String]
+        def human_data
+          status_code.to_s
+        end
       end
 
       # DHCPv6 Rapid Commit option
       # @author Sylvain Daubert
       class RapidCommit < Option
-        update_field :type, default: 14
-        remove_field :data
+        update_attr :type, default: 14
+        remove_attr :data
       end
     end
   end

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

@@ -11,18 +11,18 @@ module PacketGen
     class DHCPv6
       # Container class for DHCPv6 {Option options}.
       #
-      # == Add DHCPv6 options to an +Options+ instance
-      #   options = PacketGen::Header::DHCP::Options.new
+      # @example Add DHCPv6 options to an +Options+ instance
+      #   options = PacketGen::Header::DHCPv6::Options.new
       #   # Add an ElapsedTime option
       #   options << { type: 'ElapsedTime', value: 3600 }
       #   # Add a ClientID. Here, use integer type
       #   duid = PacketGen::Header::DHCPv6::DUID_LL.new(link_addr: '08:00:27:fe:8f:95')
       #   options << { type: 1, duid: duid }
       # @author Sylvain Daubert
-      class Options < Types::Array
+      class Options < BinStruct::Array
         set_of DHCPv6::Option
 
-        # Separator used in {#to_human}.
+        # Separator used in +#to_human+.
         HUMAN_SEPARATOR = ';'
 
         private

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

@@ -21,25 +21,26 @@ module PacketGen
         # @!attribute msg_type
         #   8-bit message type
         #   @return [Integer]
-        define_field :msg_type, Types::Int8Enum, enum: MESSAGE_TYPES
+        define_attr :msg_type, BinStruct::Int8Enum, enum: MESSAGE_TYPES
         # @!attribute hop_count
         #   8-bit hop count (number of relay agents that have relayed
         #   this message)
         #   @return [Integer]
-        define_field :hop_count, Types::Int8
+        define_attr :hop_count, BinStruct::Int8
         # @!attribute link
         #   Link address: address that will be used by the server to identify
         #   the link on which the client is located
         #   @return [IPv6::Addr]
-        define_field :link, IPv6::Addr
+        define_attr :link, IPv6::Addr
         # @!attribute peer
         #   Peer address: the address of the client or relay agent from which
         #   the message to be relayed was received
         #   @return [IPv6::Addr]
-        define_field :peer, IPv6::Addr
+        define_attr :peer, IPv6::Addr
         # @!attribute options
+        #   Set of {Option}s
         #   @return [DHCPv6::Options]
-        define_field :options, DHCPv6::Options
+        define_attr :options, DHCPv6::Options
       end
     end
 

data/lib/packetgen/header/dhcpv6.rb

@@ -22,22 +22,20 @@ module PacketGen
     #   |                                                               |
     #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
     # A DHCPv6 header is made of:
-    # * a {#msg_type} field ({Types::Int8Enum}),
-    # * a {#transaction_id} field ({Types::Int24}),
-    # * and an {#options} field ({DHCPv6::Options}).
+    # * a {#msg_type} field (+BinStruct::Int8Enum+),
+    # * a {#transaction_id} field (+BinStruct::Int24+),
+    # * and an {#options} field ({DHCPv6::Options}). This field is a container for {DHCPv6::Option} objects.
     #
-    # == Create a DHCPv6 header
+    # @example Create a DHCPv6 header
     #   # standalone
-    #  dhcpv6 = PacketGen::Header::DHCPv6.new(msg_type: 'SOLLICIT')
-    #  # in a packet
-    #  pkt = PacketGen.gen('IPv6').add('DHCPv6', msg_type: 'SOLLICIT')
-    #  # access to DHCPv6 header from packet
-    #  pkt.dhcpv6    #=> PacketGen::Header::DHCPv6
-    #
-    # == Add options
-    # DHCPv6 options are defined by subclasses of {DHCPv6::Option}.
+    #   dhcpv6 = PacketGen::Header::DHCPv6.new(msg_type: 'SOLLICIT')
+    #   # in a packet
+    #   pkt = PacketGen.gen('IPv6').add('UDP').add('DHCPv6', msg_type: 'SOLLICIT')
+    #   # access to DHCPv6 header from packet
+    #   pkt.dhcpv6.class    #=> PacketGen::Header::DHCPv6
     #
-    # Options may be added by pushing a hash to {#options}:
+    # @example Add options
+    #   # Options may be added by pushing a hash to #options:
     #   dhcpv6 = PacketGen::Header::DHCPv6.new(msg_type: 'SOLLICIT')
     #   dhcpv6.options << { type: 'Preference', value: 1 }
     # @author Sylvain Daubert
@@ -72,20 +70,21 @@ module PacketGen
       # @!attribute msg_type
       #   8-bit message type
       #   @return [Integer]
-      define_field :msg_type, Types::Int8Enum, enum: MESSAGE_TYPES
+      define_attr :msg_type, BinStruct::Int8Enum, enum: MESSAGE_TYPES
       # @!attribute transaction_id
       #   24-bit transaction ID
-      # @return [Integer]
-      define_field :transaction_id, Types::Int24
+      #   @return [Integer]
+      define_attr :transaction_id, BinStruct::Int24
       # @!attribute options
+      #   Set of {Option}s
       #   @return [DHCPv6::Options]
-      define_field :options, DHCPv6::Options
+      define_attr :options, DHCPv6::Options
 
       # Populate object from string
       # @param [String] str
       # @return [DHCPv6,DHCPv6::Relay]
       def read(str)
-        msg_type = Types::Int8.new.read(str)
+        msg_type = BinStruct::Int8.new.read(str)
 
         case msg_type
         when 12, 13

data/lib/packetgen/header/dns/name.rb

@@ -9,26 +9,31 @@
 module PacketGen
   module Header
     class DNS
-      # DNS Name, defined as a suite of labels. A label is of type {Types::IntString}.
+      # DNS Name, defined as a suite of labels. A label is of type +BinStruct::IntString+.
       # @author Sylvain Daubert
-      class Name < Types::Array
+      # @author LemonTree55
+      class Name < BinStruct::Array
         # Mask to decode a pointer on another label
         POINTER_MASK = 0xc000
 
+        # DNS message to which this name is attached. Used to decode compressed names
         # @return [DNS]
         attr_accessor :dns
 
-        def initialize
+        # @param [Hash] options
+        # @option options [DNS] :dns
+        def initialize(options={})
+          @dns = options.delete(:dns)
           super
           @pointer = nil
           @pointer_name = nil
         end
 
         # @!method push(label)
-        #  @param [Types::IntString] label
+        #  @param [BinStruct::IntString] label
         #  @return [Name] self
         # @!method <<(label)
-        #  @param [Types::IntString] label
+        #  @param [BinStruct::IntString] label
         #  @return [Name] self
 
         # Read a set of labels form a dotted string
@@ -39,38 +44,38 @@ module PacketGen
           return self if str.nil?
 
           str.split('.').each do |label|
-            self << Types::IntString.new(string: label)
+            self << BinStruct::IntString.new(value: label)
           end
-          self << Types::IntString.new
+          self << BinStruct::IntString.new
         end
 
         # Clear name
-        #   @return [void]
+        # @return [void]
         def clear
           super
           @pointer = nil
           @pointer_name = nil
         end
 
-        # Read a sequence of label from a string
+        # Read a sequence of label from a binary string
         # @param [String] str binary string
         # @return [Name] self
         def read(str)
           clear
           return self if str.nil?
 
-          PacketGen.force_binary str
+          strb = str.to_s.b
           start = 0
           loop do
-            index = str[start, 2].unpack1('n')
-            if pointer? index
+            index = strb[start, 2].unpack1('n')
+            if pointer?(index)
               # Pointer on another label
-              @pointer = str[start, 2]
+              @pointer = strb[start, 2]
               break
             else
-              label = add_label_from(str[start..])
+              label = add_label_from(strb[start..])
               start += label.sz
-              break if label.empty? || str[start..].empty?
+              break if label.empty? || strb[start..].empty?
             end
           end
           # force resolution of compressed names
@@ -119,7 +124,7 @@ module PacketGen
         end
 
         def add_label_from(str)
-          label = Types::IntString.new
+          label = BinStruct::IntString.new
           label.read(str)
           self << label
           label

data/lib/packetgen/header/dns/opt.rb

@@ -15,12 +15,13 @@ module PacketGen
       #
       # a OPT record may contain zero or more {Option options} in its {#rdata}.
       # @author Sylvain Daubert
+      # @author LemonTree55
       # @since 1.3.0
       # @since 3.1.1 {#options} is a {ArrayOfOptions}
       class OPT < RR
         # @!attribute options
         #   @return [ArrayOfOptions]
-        define_field_after :rdata, :options, ArrayOfOptions
+        define_attr_after :rdata, :options, ArrayOfOptions
 
         # @param [DNS] dns
         # @param [Hash] options
@@ -94,7 +95,7 @@ module PacketGen
             self[:ttl].value = self[:ttl].to_i & (0xffffffff & ~(1 << 15))
             self[:ttl].value |= (b & 1) << 15
           end
-          ((self[:ttl].to_i >> 15) & 1) == 1
+          self[:ttl].to_i.anybits?(0x8000)
         end
         alias do? do=
 
@@ -118,11 +119,13 @@ module PacketGen
         alias udp_size rrclass
         alias udp_size= rrclass=
 
+        # Get human-readable string for flags
         # @return [String]
         def human_flags
           do? ? 'do' : 'none'
         end
 
+        # Get human-readable string for this OPT
         # @return [String]
         def to_human
           "#{name} #{human_type} UDPsize:#{udp_size} " \

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

@@ -11,28 +11,28 @@ module PacketGen
     class DNS
       # @!parse
       #  # DNS option is a TLV object:
-      #  # * {#code} is a {Types::Int16},
-      #  # * {#length} is a {Types::Int16},
-      #  # * {#data} is a {Types::String}.
+      #  # * {#code} is a BinStruct::Int16,
+      #  # * +#length+ is a BinStruct::Int16,
+      #  # * {#data} is a BinStruct::String.
       #  #
       #  # @since 1.3.0
-      #  # @since 3.1.0 defined with {Types::AbstractTLV}
-      #  # @!parse class Option < Types::AbstractTLV; end
+      #  # @since 3.1.0 defined with BinStruct::AbstractTLV
+      #  # @!parse class Option < BinStruct::AbstractTLV; end
       #  # @!attribute code
-      #  #   Alias for {#type}
+      #  #   Alias for +#type+
       #  #   @return [Integer]
       #  # @!attribute data
-      #  #   Alias for {#value}
-      #  #   @return [Types::String]
-      #  class Option < Types::AbstractTLV; end
+      #  #   Alias for +#value+
+      #  #   @return [BinStruct::String]
+      #  class Option < BinStruct::AbstractTLV; end
       # @private
-      Option = Types::AbstractTLV.create(type_class: Types::Int16,
-                                         length_class: Types::Int16,
-                                         aliases: { code: :type, data: :value })
+      Option = BinStruct::AbstractTLV.create(type_class: BinStruct::Int16,
+                                             length_class: BinStruct::Int16,
+                                             aliases: { code: :type, data: :value })
 
-      # Array of {Option}.
+      # Array of {Option}s.
       # @since 3.1.1
-      class ArrayOfOptions < Types::Array
+      class ArrayOfOptions < BinStruct::Array
         set_of Option
       end
     end

data/lib/packetgen/header/dns/qdsection.rb

@@ -25,18 +25,18 @@ module PacketGen
         #  @param [Question] q
         #  @return [Question]
 
-        # Read Question section from a string
+        # Read Question section from a binary string
         # @param [String] str binary string
         # @return [QDSection] self
         def read(str)
           clear
           return self if str.nil?
 
-          PacketGen.force_binary str
+          str = str.b unless str.encoding == Encoding::ASCII_8BIT
           while !str.empty? && (self.size < @counter.to_i)
             question = Question.new(@dns).read(str)
             str.slice!(0, question.sz)
-            push question
+            push(question)
           end
           self
         end

data/lib/packetgen/header/dns/question.rb

@@ -11,8 +11,8 @@ module PacketGen
     class DNS
       # DNS Question
       # @author Sylvain Daubert
-      class Question < Types::Fields
-        include Types::Fieldable
+      class Question < BinStruct::Struct
+        include BinStruct::Structable
 
         # Ressource Record types
         TYPES = {
@@ -59,15 +59,15 @@ module PacketGen
         # @!attribute name
         #  Question domain name
         #  @return [String]
-        define_field :name, Name, default: '.'
+        define_attr :name, Name, default: '.'
         # @!attribute type
         #  16-bit question type
         #  @return [Integer]
-        define_field :type, Types::Int16Enum, default: 1, enum: TYPES
+        define_attr :type, BinStruct::Int16Enum, default: 1, enum: TYPES
         # @!attribute rrclass
         #  16-bit question class
         #  @return [Integer]
-        define_field :rrclass, Types::Int16Enum, default: 1, enum: CLASSES
+        define_attr :rrclass, BinStruct::Int16Enum, default: 1, enum: CLASSES
 
         # @param [DNS] dns
         # @param [Hash] options
@@ -77,8 +77,6 @@ module PacketGen
         def initialize(dns, options={})
           super(options)
           self[:name].dns = dns
-          self.type = options[:type] if options[:type]
-          self.rrclass = options[:rrclass] if options[:rrclass]
         end
 
         undef rrclass=
@@ -95,7 +93,7 @@ module PacketGen
               end
           raise ArgumentError, "unknown class #{val.inspect}" unless v
 
-          self[:rrclass].read v
+          self[:rrclass].from_human(v)
         end
 
         # Check type
@@ -122,6 +120,7 @@ module PacketGen
           end
         end
 
+        # Human-readable string for this question
         # @return [String]
         def to_human
           if self[:name].dns.is_a? MDNS