packetgen 3.1.4 → 3.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2adf2b07c2d2d334e4f0ae6e4e7b49571d4d436788bef51df6cf7c1a5aaba9c8
-  data.tar.gz: 8997321a31379ea6952ab42a4642d98a717587ed777652ebdb9e25b5928cc8d4
+  metadata.gz: 476cbc2bd2b9fb254ea40fe0a07a4d703a0fc36e4accc823de7e83b640d95a2d
+  data.tar.gz: 375f31ea90589b2b0c0b257b8a3efaa66715e8b369c542124fe3dcac283d9221
 SHA512:
-  metadata.gz: b5af6e0d04f8bb03af01d63cde3879a6a13c8a78477811be2b95fee5c597820f4714f8ac8b69f4aa8f04d3d5b81c5e25b5787815ee2237a8c3329721b5dc7895
-  data.tar.gz: 6eebb203f8dfde49505987d16778c1ecbc81c463d6ac8b5f005e2c6f486166ba0cceabd848d3b3aeebe867b138993171026e8dcacfb04c84a126bc149ff5c616
+  metadata.gz: c518ff72cf70227c8f9ef38cce97ba5036eb3229051d38172ba947898b9051f508670d1e0106bac0f5edf577fe1450d5f71db557aa6968b7e3998945a87177d7
+  data.tar.gz: 9382d6f8a7542c8988dec0aaf92940f1518885133bf9e7c835478e787546309410c7e7bcfb4525c13fb7479a9cad9a7ece3e30a3d3c6bbb4f081c1cc48b7f02e

data/lib/packetgen.rb

@@ -97,6 +97,12 @@ module PacketGen
     Interfacez.default
   end
 
+  # Get loopback network interface
+  # @return [String]
+  def self.loopback_iface
+    Interfacez.loopback
+  end
+
   # Shortcut to get a header class
   # @example builtin class
   #   # same as PacketGen::Header::Dot11:Data.new(id: 0xfedc)
@@ -114,8 +120,9 @@ module PacketGen
 end
 
 require 'packetgen/deprecation'
-require 'packetgen/types'
 require 'packetgen/inspect'
+require 'packetgen/inspectable'
+require 'packetgen/types'
 require 'packetgen/pcapng'
 require 'packetgen/pcap'
 require 'packetgen/packet'

data/lib/packetgen/capture.rb

@@ -13,7 +13,7 @@ module PacketGen
   class Capture
     private
 
-    attr_reader :filter, :cap_thread, :snaplen, :promisc
+    attr_reader :filter, :cap_thread, :snaplen, :promisc, :monitor
 
     public
 
@@ -41,14 +41,18 @@ module PacketGen
     #    yielding.  Default: +true+
     # @param [Integer] snaplen maximum number of bytes to capture for
     #    each packet.
+    # @param [Boolean] monitor enable or disable monitor mode on interface (if supported by +iface+).
     # @since 2.0.0 remove old 1.x API
     # @since 3.0.0 arguments are kwargs and no more a hash
-    def initialize(iface: nil, max: nil, timeout: nil, filter: nil, promisc: false, parse: true, snaplen: nil)
-      @iface = iface || Interfacez.default || Interfacez.loopback
+    # @since 3.1.5 add monitor argument
+    # @author Sylvain Daubert
+    # @author optix2000 - add monitor argument
+    def initialize(iface: nil, max: nil, timeout: nil, filter: nil, promisc: false, parse: true, snaplen: nil, monitor: nil)
+      @iface = iface || PacketGen.default_iface || PacketGen.loopback_iface
 
       @packets     = []
       @raw_packets = []
-      set_options iface, max, timeout, filter, promisc, parse, snaplen
+      set_options iface, max, timeout, filter, promisc, parse, snaplen, monitor
     end
 
     # Start capture
@@ -56,8 +60,11 @@ module PacketGen
     # @yieldparam [Packet,String] packet if a block is given, yield each
     #    captured packet (Packet or raw data String, depending on +:parse+ option)
     # @since 3.0.0 arguments are kwargs and no more a hash
-    def start(iface: nil, max: nil, timeout: nil, filter: nil, promisc: false, parse: true, snaplen: nil, &block)
-      set_options iface, max, timeout, filter, promisc, parse, snaplen
+    # @since 3.1.5 add monitor argument
+    # @author Sylvain Daubert
+    # @author optix2000 - add monitor argument
+    def start(iface: nil, max: nil, timeout: nil, filter: nil, promisc: false, parse: true, snaplen: nil, monitor: nil, &block)
+      set_options iface, max, timeout, filter, promisc, parse, snaplen, monitor
 
       @cap_thread = Thread.new do
         PCAPRUBWrapper.capture(**capture_args) do |packet_data|
@@ -79,7 +86,7 @@ module PacketGen
 
     private
 
-    def set_options(iface, max, timeout, filter, promisc, parse, snaplen)
+    def set_options(iface, max, timeout, filter, promisc, parse, snaplen, monitor)
       @max = max if max
       @filter = filter unless filter.nil?
       @timeout = timeout unless timeout.nil?
@@ -87,10 +94,11 @@ module PacketGen
       @snaplen = snaplen unless snaplen.nil?
       @parse = parse unless parse.nil?
       @iface = iface unless iface.nil?
+      @monitor = monitor unless monitor.nil?
     end
 
     def capture_args
-      h = { iface: iface, filter: filter }
+      h = { iface: iface, filter: filter, monitor: monitor }
       h[:snaplen] = snaplen unless snaplen.nil?
       h[:promisc] = promisc unless promisc.nil?
       h

data/lib/packetgen/config.rb

@@ -22,37 +22,43 @@ module PacketGen
     attr_reader :default_iface
 
     def initialize
-      @default_iface = Interfacez.default || Interfacez.loopback
+      @default_iface = PacketGen.default_iface || PacketGen.loopback_iface
       @hwaddr = {}
       @ipaddr = {}
       @ip6addr = {}
 
-      Interfacez.all do |iface_name|
-        @hwaddr[iface_name] = Interfacez.mac_address_of(iface_name)
-        @ipaddr[iface_name] = Interfacez.ipv4_address_of(iface_name)
-        @ip6addr[iface_name] = Interfacez.ipv6_addresses_of(iface_name)
-      end
+      initialize_local_addresses
     end
 
     # Get MAC address for given network interface
     # @param [String,nil] iface network interface. If +nil+, use default one.
     # @return [String]
     def hwaddr(iface=nil)
-      @hwaddr[iface || @default_iface]
+      @hwaddr[iface || default_iface]
     end
 
     # Get IP address for given network interface
     # @param [String,nil] iface network interface. If +nil+, use default one.
     # @return [String]
     def ipaddr(iface=nil)
-      @ipaddr[iface || @default_iface]
+      @ipaddr[iface || default_iface]
     end
 
     # Get IPv6 addresses for given network interface
     # @param [String,nil] iface network interface. If +nil+, use default one.
     # @return [Array<String>]
     def ip6addr(iface=nil)
-      @ip6addr[iface || @default_iface]
+      @ip6addr[iface || default_iface]
+    end
+
+    private
+
+    def initialize_local_addresses
+      Interfacez.all do |iface_name|
+        @hwaddr[iface_name] = Interfacez.mac_address_of(iface_name)
+        @ipaddr[iface_name] = Interfacez.ipv4_address_of(iface_name)
+        @ip6addr[iface_name] = Interfacez.ipv6_addresses_of(iface_name)
+      end
     end
   end
 end

data/lib/packetgen/deprecation.rb

@@ -31,7 +31,7 @@ module PacketGen
       complete_deprecated_method_name = "#{base_name}#{deprecated_method}"
       complete_new_method_name = "#{base_name}#{new_method}" unless new_method.nil?
 
-      file, line = caller(2..2).split(':')[0, 2]
+      file, line = caller(2..2).first.split(':')[0, 2]
       message = +"#{file}:#{line}: #{complete_deprecated_method_name} is deprecated"
       message << " in favor of #{complete_new_method_name}" unless new_method.nil?
       message << '. ' << self.removed(remove_version)

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

@@ -230,17 +230,7 @@ module PacketGen
 
         # @!attribute options
         #   @return [RequestedOptions]
-        define_field :options, RequestedOptions
-
-        # Populate object from +str+
-        # @param [String] str
-        # @return [self]
-        def read(str)
-          self[:type].read str[0, 2]
-          self[:length].read str[2, 2]
-          self[:options].read str[4, self.length]
-          self
-        end
+        define_field :options, RequestedOptions, builder: ->(h, t) { t.new(length_from: h[:length]) }
 
         # Get human-readable data
         # @return [String]

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

@@ -35,7 +35,7 @@ module PacketGen
           while !str.empty? && (self.size < @counter.to_i)
             question = Question.new(@dns).read(str)
             str.slice!(0, question.sz)
-            self.push question
+            push question
           end
           self
         end

data/lib/packetgen/header/dot11.rb

@@ -28,7 +28,7 @@ module PacketGen
       define_field :dlt, Types::Int32le
       # @!attribute ppi_fields
       #  @return [Type::String] concatenation of PPI fields
-      define_field :ppi_fields, Types::String
+      define_field :ppi_fields, Types::String, builder: ->(h, t) { t.new(length_from: -> { h.length - 8 }) }
       # @!attribute body
       #  @return [Type::String]
       define_field :body, Types::String
@@ -36,21 +36,6 @@ module PacketGen
       #  @return [Boolean] align flag from {#flags} attribute
       define_bit_fields_on :flags, :reserved, 7, :align
 
-      # @param [String] str
-      # @return [PPI] self
-      def read(str)
-        return self if str.nil?
-
-        force_binary str
-        self[:version].read str[0, 1]
-        self[:flags].read str[1, 1]
-        self[:length].read str[2, 2]
-        self[:dlt].read str[4, 4]
-        self[:ppi_fields].read str[8, length - 8]
-        self[:body].read str[length, str.size]
-        self
-      end
-
       # Check version field
       # @see [Base#parse?]
       def parse?
@@ -91,26 +76,11 @@ module PacketGen
       define_field :present_flags, Types::Int32le
       # @!attribute radio_fields
       #  @return [Type::String] concatenation of RadioTap fields
-      define_field :radio_fields, Types::String
+      define_field :radio_fields, Types::String, builder: ->(h, t) { t.new(length_from: -> { h.length - 8 }) }
       # @!attribute body
       #  @return [Type::String]
       define_field :body, Types::String
 
-      # @param [String] str
-      # @return [RadioTap] self
-      def read(str)
-        return self if str.nil?
-
-        force_binary str
-        self[:version].read str[0, 1]
-        self[:pad].read str[1, 1]
-        self[:length].read str[2, 2]
-        self[:present_flags].read str[4, 4]
-        self[:radio_fields].read str[8, length - 8]
-        self[:body].read str[length, str.size]
-        self
-      end
-
       # Check version field
       # @see [Base#parse?]
       def parse?

data/lib/packetgen/header/dot1x.rb

@@ -45,20 +45,7 @@ module PacketGen
       define_field :length, Types::Int16
       # @!attribute body
       #  @return [Types::String,Header::Base]
-      define_field :body, Types::String
-
-      # Populate object from string
-      # @param [String] str
-      # @return [self]
-      def read(str)
-        return self if str.nil?
-
-        self[:version].read(str[0, 1])
-        self[:type].read(str[1, 1])
-        self[:length].read(str[2, 2])
-        self[:body].read(str[4, self.length])
-        self
-      end
+      define_field :body, Types::String, builder: ->(h, t) { t.new(length_from: h[:length]) }
 
       # Get human readable type
       # @return [String]

data/lib/packetgen/header/eap.rb

@@ -132,21 +132,17 @@ module PacketGen
       def read(str)
         super str
         return self unless self.class == EAP
-
-        if type?
-          obj = case self.type
-                when 4
-                  EAP::MD5.new.read(str)
-                when 13
-                  EAP::TLS.new.read(str)
-                when 21
-                  EAP::TTLS.new.read(str)
-                when 43
-                  EAP::FAST.new.read(str)
-                else
-                  self
-                end
-          obj
+        return self unless type?
+
+        case self.type
+        when 4
+          EAP::MD5.new.read(str)
+        when 13
+          EAP::TLS.new.read(str)
+        when 21
+          EAP::TTLS.new.read(str)
+        when 43
+          EAP::FAST.new.read(str)
         else
           self
         end

data/lib/packetgen/header/eth.rb

@@ -33,6 +33,8 @@ module PacketGen
       # Ethernet MAC address, as a group of 6 bytes
       # @author Sylvain Daubert
       class MacAddr < Types::Fields
+        include Inspectable
+
         # @!attribute a0
         #  @return [Integer] first byte from MacAddr
         define_field :a0, Types::Int8
@@ -75,6 +77,7 @@ module PacketGen
         def to_human
           fields.map { |m| '%02x' % self[m] }.join(':')
         end
+        alias format_inspect to_human
 
         def ==(other)
           other.is_a?(self.class) &&

data/lib/packetgen/header/http/headers.rb

@@ -12,6 +12,8 @@ module PacketGen
       # @abstract Base class for HTTP headers.
       # @author Kent 'picat' Gruber
       class Headers
+        include Inspectable
+
         # Underlying Headers data (or nil).
         # @return [Hash, nil]
         attr_reader :data
@@ -56,6 +58,7 @@ module PacketGen
         def to_human
           @data
         end
+        alias format_inspect to_human
 
         # Read human-readable data to populate header data.
         # @param [String, Hash] data

data/lib/packetgen/header/ip/addr.rb

@@ -11,6 +11,8 @@ module PacketGen
       # IP address, as a group of 4 bytes
       # @author Sylvain Daubert
       class Addr < Types::Fields
+        include Inspectable
+
         # @!attribute a1
         #  @return [Integer] IP address first byte
         define_field :a1, Types::Int8
@@ -47,6 +49,7 @@ module PacketGen
         def to_human
           fields.map { |f| self[f].to_i.to_s }.join('.')
         end
+        alias format_inspect to_human
 
         # Addr as an integer
         # @return [Integer]

data/lib/packetgen/header/ipv6/addr.rb

@@ -14,6 +14,8 @@ module PacketGen
       # IPv6 address, as a group of 8 2-byte words
       # @author Sylvain Daubert
       class Addr < Types::Fields
+        include Inspectable
+
         # @!attribute a1
         #  1st 2-byte word of IPv6 address
         #  @return [Integer]
@@ -73,6 +75,7 @@ module PacketGen
         def to_human
           IPAddr.new(to_a.map { |a| a.to_i.to_s(16) }.join(':')).to_s
         end
+        alias format_inspect to_human
 
         # Return an array of address 16-bit words
         # @return [Array<Integer>]

data/lib/packetgen/header/tcp.rb

@@ -121,7 +121,7 @@ module PacketGen
       # @!attribute options
       #  TCP options
       #  @return [Options]
-      define_field :options, TCP::Options
+      define_field :options, TCP::Options, builder: ->(h, t) { t.new(length_from: -> { h.data_offset > 5 ? (h.data_offset - 5) * 4 : 0 }) }
       # @!attribute body
       #  @return [Types::String,Header::Base]
       define_field :body, Types::String
@@ -189,25 +189,6 @@ module PacketGen
       #  @return [Boolean] 1-bit FIN flag
       define_bit_fields_on :u16, :_, 7, :flag_ns, :flag_cwr, :flag_ece, :flag_urg,
                            :flag_ack, :flag_psh, :flag_rst, :flag_syn, :flag_fin
-      # Read a TCP header from a string
-      # @param [String] str binary string
-      # @return [self]
-      def read(str)
-        return self if str.nil?
-
-        force_binary str
-        self[:sport].read str[0, 2]
-        self[:dport].read str[2, 2]
-        self[:seqnum].read str[4, 4]
-        self[:acknum].read str[8, 4]
-        self[:u16].read str[12, 2]
-        self[:window].read str[14, 2]
-        self[:checksum].read str[16, 2]
-        self[:urg_pointer].read str[18, 2]
-        self[:options].read str[20, (self.data_offset - 5) * 4] if self.data_offset > 5
-        self[:body].read str[self.data_offset * 4..-1]
-        self
-      end
 
       # Compute checksum and set +checksum+ field
       # @return [Integer]

data/lib/packetgen/inspect.rb

@@ -68,23 +68,7 @@ module PacketGen
     # @return [String]
     def self.inspect_attribute(attr, value, level=1)
       type = value.class.to_s.sub(/.*::/, '')
-      val = case value
-            when Types::Enum
-              enum_human_hex(value.to_human, value.to_i, value.sz * 2)
-            when Types::Int
-              int_dec_hex(value, value.sz * 2)
-            when Integer
-              int_dec_hex(value, value.sz * 2)
-            when String
-              value.to_s.inspect
-            else
-              if value.respond_to? :to_human
-                value.to_human
-              else
-                value.to_s.inspect
-              end
-            end
-      self.format(type, attr, val, level)
+      self.format(type, attr, value.format_inspect, level)
     end
 
     # Format a ASN.1 attribute for +#inspect+.

data/lib/packetgen/inspectable.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# This file is part of PacketGen
+# See https://github.com/sdaubert/packetgen for more informations
+# Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
+# This program is published under MIT license.
+
+module PacketGen
+  # Module to add common methods to format types when inspecting packets/headers.
+  # @author Sylvain Daubert
+  # @since 3.1.5
+  module Inspectable
+    # Format attribute for inspecting
+    # @abstract should be overriden by types.
+    # @return [String]
+    def format_inspect
+      to_s.inspect
+    end
+  end
+end

data/lib/packetgen/pcaprub_wrapper.rb

@@ -23,9 +23,19 @@ module PacketGen
     # @param [String] iface interface name
     # @param [Integer] snaplen
     # @param [Boolean] promisc
+    # @param [Boolean] monitor
     # @return [PCAPRUB::Pcap]
-    def self.open_iface(iface:, snaplen: DEFAULT_SNAPLEN, promisc: DEFAULT_PROMISC)
-      PCAPRUB::Pcap.open_live(iface, snaplen, promisc, TIMEOUT)
+    # @author Sylvain Daubert
+    # @author optix2000 - add support for setting monitor mode
+    # @since 3.1.5 add monitor argument
+    def self.open_iface(iface:, snaplen: DEFAULT_SNAPLEN, promisc: DEFAULT_PROMISC, monitor: nil)
+      pcap = PCAPRUB::Pcap.create(iface)
+      pcap.setsnaplen(snaplen)
+      pcap.setpromisc(promisc)
+      pcap.settimeout(TIMEOUT)
+      # Monitor MUST be set before pcap is activated
+      pcap.setmonitor monitor unless monitor.nil?
+      pcap.activate
     end
 
     # Capture packets from a network interface
@@ -33,10 +43,14 @@ module PacketGen
     # @param [Integer] snaplen
     # @param [Boolean] promisc
     # @param [String] filter BPF filter
+    # @param [Boolean] monitor
     # @yieldparam [String] packet_data binary packet data
     # @return [void]
-    def self.capture(iface:, snaplen: DEFAULT_SNAPLEN, promisc: DEFAULT_PROMISC, filter: nil)
-      pcap = self.open_iface(iface: iface, snaplen: snaplen, promisc: promisc)
+    # @author Sylvain Daubert
+    # @author optix2000 - add support for setting monitor mode
+    # @since 3.1.5 add monitor argument
+    def self.capture(iface:, snaplen: DEFAULT_SNAPLEN, promisc: DEFAULT_PROMISC, filter: nil, monitor: nil)
+      pcap = self.open_iface(iface: iface, snaplen: snaplen, promisc: promisc, monitor: monitor)
       pcap.setfilter filter unless filter.nil?
       pcap.each do |packet_data|
         yield packet_data

data/lib/packetgen/types/abstract_tlv.rb

@@ -58,6 +58,8 @@ module PacketGen
     # @since 3.1.0
     # @since 3.1.1 add +:aliases+ keyword to {#initialize}
     class AbstractTLV < Types::Fields
+      include Inspectable
+
       class <<self
         # @return [Hash]
         attr_accessor :aliases
@@ -169,8 +171,9 @@ module PacketGen
       # @return [String]
       def to_human
         my_value = self[:value].is_a?(String) ? self[:value].inspect : self[:value].to_human
-        "type:%s,length:%u,value:#{my_value}" % [human_type, length]
+        "type:%s,length:%u,value:%s" % [human_type, length, my_value]
       end
+      alias format_inspect to_human
 
       private
 

data/lib/packetgen/types/array.rb

@@ -27,6 +27,9 @@ module PacketGen
     # @author Sylvain Daubert
     class Array
       extend Forwardable
+      include Inspectable
+      include Enumerable
+      include LengthFrom
 
       # @!method [](index)
       #   Return the element at +index+.
@@ -54,9 +57,6 @@ module PacketGen
       def_delegators :@array, :[], :clear, :each, :empty?, :first, :last, :size
       alias length size
 
-      include Enumerable
-      include LengthFrom
-
       # Separator used in {#to_human}.
       # May be ovverriden by subclasses
       HUMAN_SEPARATOR = ','
@@ -198,6 +198,7 @@ module PacketGen
       def to_human
         @array.map(&:to_human).join(self.class::HUMAN_SEPARATOR)
       end
+      alias format_inspect to_human
 
       private
 

data/lib/packetgen/types/cstring.rb

@@ -11,6 +11,8 @@ module PacketGen
     # This class handles null-terminated strings (aka C strings).
     # @author Sylvain Daubert
     class CString < ::String
+      include Inspectable
+
       # @param [Hash] options
       # @option options [Integer] :static_length set a static length for this string
       def initialize(options={})
@@ -66,6 +68,7 @@ module PacketGen
         idx = self.index(+"\x00".encode(self.encoding)) || self.sz
         self[0, idx]
       end
+      alias format_inspect to_human
     end
   end
 end

data/lib/packetgen/types/enum.rb

@@ -71,6 +71,10 @@ module PacketGen
       def to_human
         @enum.key(to_i) || "<unknown:#{@value}>"
       end
+
+      def format_inspect
+        format_str % [to_human, to_i]
+      end
     end
 
     # Enumeration on one byte. See {Enum}.

data/lib/packetgen/types/fields.rb

@@ -119,6 +119,10 @@ module PacketGen
         # @return [Hash]
         # @since 3.1.0
         attr_reader :field_defs
+        # Get bit fields defintions for this class
+        # @return [Hash]
+        # @since 3.1.5
+        attr_reader :bit_fields
 
         # On inheritage, create +@field_defs+ class variable
         # @param [Class] klass
@@ -129,7 +133,7 @@ module PacketGen
             field_defs[k] = v.clone
           end
           ordered = @ordered_fields.clone
-          bf = @bit_fields.clone
+          bf = bit_fields.clone
 
           klass.class_eval do
             @ordered_fields = ordered
@@ -172,37 +176,15 @@ module PacketGen
         #   Define enumeration: hash's keys are +String+, and values are +Integer+.
         # @return [void]
         def define_field(name, type, options={})
-          define = []
-          if type < Types::Enum
-            define << "def #{name}; self[:#{name}].to_i; end"
-            define << "def #{name}=(val) self[:#{name}].value = val; end"
-          else
-            define << "def #{name}\n" \
-                      "  if self[:#{name}].respond_to?(:to_human) && self[:#{name}].respond_to?(:from_human)\n" \
-                      "    self[:#{name}].to_human\n" \
-                      "  else\n" \
-                      "    self[:#{name}]\n" \
-                      "  end\n" \
-                      'end'
-            define << "def #{name}=(val)\n" \
-                      "  if self[:#{name}].respond_to?(:to_human) && self[:#{name}].respond_to?(:from_human)\n" \
-                      "    self[:#{name}].from_human val\n" \
-                      "  else\n" \
-                      "    self[:#{name}].read val\n" \
-                      "  end\n" \
-                      'end'
-          end
-
-          define.delete_at(1) if instance_methods.include? "#{name}=".to_sym
-          define.delete_at(0) if instance_methods.include? name
-          class_eval define.join("\n")
+          fields << name
           field_defs[name] = FieldDef.new(type,
                                           options.delete(:default),
                                           options.delete(:builder),
                                           options.delete(:optional),
                                           options.delete(:enum),
                                           options)
-          fields << name
+
+          add_methods(name, type)
         end
 
         # Define a field, before another one
@@ -300,8 +282,8 @@ module PacketGen
           total_size = type.new.width * 8
           idx = total_size - 1
 
-          field = args.shift
-          while field
+          until args.empty?
+            field = args.shift
             next unless field.is_a? Symbol
 
             size = if args.first.is_a? Integer
@@ -309,41 +291,13 @@ module PacketGen
                    else
                      1
                    end
+
             unless field == :_
-              shift = idx - (size - 1)
-              field_mask = (2**size - 1) << shift
-              clear_mask = (2**total_size - 1) & (~field_mask & (2**total_size - 1))
-
-              if size == 1
-                class_eval <<-METHODS
-                def #{field}?
-                  val = (self[:#{attr}].to_i & #{field_mask}) >> #{shift}
-                  val != 0
-                end
-                def #{field}=(v)
-                  val = v ? 1 : 0
-                  self[:#{attr}].value = self[:#{attr}].to_i & #{clear_mask}
-                  self[:#{attr}].value |= val << #{shift}
-                end
-                METHODS
-              else
-                class_eval <<-METHODS
-                def #{field}
-                  (self[:#{attr}].to_i & #{field_mask}) >> #{shift}
-                end
-                def #{field}=(v)
-                  self[:#{attr}].value = self[:#{attr}].to_i & #{clear_mask}
-                  self[:#{attr}].value |= (v & #{2**size - 1}) << #{shift}
-                end
-                METHODS
-              end
-
-              @bit_fields[attr] = {} if @bit_fields[attr].nil?
-              @bit_fields[attr][field] = size
+              add_bit_methods(attr, field, size, total_size, idx)
+              register_bit_field_size(attr, field, size)
             end
 
             idx -= size
-            field = args.shift
           end
         end
 
@@ -352,7 +306,7 @@ module PacketGen
         # @return [void]
         # @since 2.8.4
         def remove_bit_fields_on(attr)
-          fields = @bit_fields.delete(attr)
+          fields = bit_fields.delete(attr)
           return if fields.nil?
 
           fields.each do |field, size|
@@ -360,6 +314,62 @@ module PacketGen
             undef_method(size == 1 ? "#{field}?" : field)
           end
         end
+
+        private
+
+        def add_methods(name, type)
+          define = []
+          if type < Types::Enum
+            define << "def #{name}; self[:#{name}].to_i; end"
+            define << "def #{name}=(val) self[:#{name}].value = val; end"
+          else
+            define << "def #{name}\n" \
+                      "  to_and_from_human?(:#{name}) ? self[:#{name}].to_human : self[:#{name}]\n" \
+                      'end'
+            define << "def #{name}=(val)\n" \
+                      "  to_and_from_human?(:#{name}) ? self[:#{name}].from_human(val) : self[:#{name}].read(val)\n" \
+                      'end'
+          end
+
+          define.delete_at(1) if instance_methods.include? "#{name}=".to_sym
+          define.delete_at(0) if instance_methods.include? name
+          class_eval define.join("\n")
+        end
+
+        def add_bit_methods(attr, name, size, total_size, idx)
+          shift = idx - (size - 1)
+          field_mask = (2**size - 1) << shift
+          clear_mask = (2**total_size - 1) & (~field_mask & (2**total_size - 1))
+
+          if size == 1
+            class_eval <<-METHODS
+            def #{name}?
+              val = (self[:#{attr}].to_i & #{field_mask}) >> #{shift}
+              val != 0
+            end
+            def #{name}=(v)
+              val = v ? 1 : 0
+              self[:#{attr}].value = self[:#{attr}].to_i & #{clear_mask}
+              self[:#{attr}].value |= val << #{shift}
+            end
+            METHODS
+          else
+            class_eval <<-METHODS
+            def #{name}
+              (self[:#{attr}].to_i & #{field_mask}) >> #{shift}
+            end
+            def #{name}=(v)
+              self[:#{attr}].value = self[:#{attr}].to_i & #{clear_mask}
+              self[:#{attr}].value |= (v & #{2**size - 1}) << #{shift}
+            end
+            METHODS
+          end
+        end
+
+        def register_bit_field_size(attr, field, size)
+          bit_fields[attr] = {} if bit_fields[attr].nil?
+          bit_fields[attr][field] = size
+        end
       end
 
       # Create a new fields object
@@ -369,36 +379,13 @@ module PacketGen
         @fields = {}
         @optional_fields = {}
 
-        field_defs = self.class.field_defs
         self.class.fields.each do |field|
-          type = field_defs[field].type
-          default = field_defs[field].default
-          default = default.to_proc.call(self) if default.is_a?(Proc)
-          builder = field_defs[field].builder
-          optional = field_defs[field].optional
-          enum = field_defs[field].enum
-          field_options = field_defs[field].options
-
-          @fields[field] = if builder
-                             builder.call(self, type)
-                           elsif enum
-                             type.new(enum)
-                           elsif !field_options.empty?
-                             type.new(field_options)
-                           else
-                             type.new
-                           end
-
-          value = options[field] || default
-          if value.class <= type
-            @fields[field] = value
-          elsif @fields[field].respond_to? :from_human
-            @fields[field].from_human(value)
-          end
-
-          @optional_fields[field] = optional if optional
+          build_field field
+          initialize_value field, options[field]
+          initialize_optional field
         end
-        self.class.class_eval { @bit_fields }.each do |_, hsh|
+
+        self.class.bit_fields.each do |_, hsh|
           hsh.each_key do |bit_field|
             self.send "#{bit_field}=", options[bit_field] if options[bit_field]
           end
@@ -528,7 +515,7 @@ module PacketGen
       # @return [Hash,nil] keys: bit fields, values: their size in bits
       # @since 2.8.3
       def bits_on(field)
-        self.class.class_eval { @bit_fields }[field]
+        self.class.bit_fields[field]
       end
 
       private
@@ -547,6 +534,51 @@ module PacketGen
       def force_binary(str)
         PacketGen.force_binary(str)
       end
+
+      # @param [Symbol] attr attribute
+      # @return [Boolean] +tru+e if #from_human and #to_human are both defined for given attribute
+      def to_and_from_human?(attr)
+        self[attr].respond_to?(:to_human) && self[attr].respond_to?(:from_human)
+      end
+
+      def field_defs
+        self.class.field_defs
+      end
+
+      def build_field(field)
+        type = field_defs[field].type
+        builder = field_defs[field].builder
+        enum = field_defs[field].enum
+        field_options = field_defs[field].options
+
+        @fields[field] = if builder
+                           builder.call(self, type)
+                         elsif enum
+                           type.new(enum)
+                         elsif !field_options.empty?
+                           type.new(field_options)
+                         else
+                           type.new
+                         end
+      end
+
+      def initialize_value(field, val)
+        type = field_defs[field].type
+        default = field_defs[field].default
+        default = default.to_proc.call(self) if default.is_a?(Proc)
+
+        value = val || default
+        if value.class <= type
+          @fields[field] = value
+        elsif @fields[field].respond_to? :from_human
+          @fields[field].from_human(value)
+        end
+      end
+
+      def initialize_optional(field)
+        optional = field_defs[field].optional
+        @optional_fields[field] = optional if optional
+      end
     end
   end
 end

data/lib/packetgen/types/int.rb

@@ -12,6 +12,8 @@ module PacketGen
     # @abstract
     # @author Sylvain Daubert
     class Int
+      include Inspectable
+
       # Integer value
       # @return [Integer]
       attr_accessor :value
@@ -80,6 +82,18 @@ module PacketGen
       def sz
         width
       end
+
+      # Format Int type when inspecting header or packet
+      # @return [String]
+      def format_inspect
+        format_str % [to_i.to_s, to_i]
+      end
+
+      private
+
+      def format_str
+        "%-16s (0x%0#{width * 2}x)"
+      end
     end
 
     # One byte unsigned integer

data/lib/packetgen/types/int_string.rb

@@ -12,6 +12,8 @@ module PacketGen
     # By default, a null string will have one byte length (length byte set to 0).
     # @author Sylvain Daubert
     class IntString
+      include Inspectable
+
       # internal string
       # @return [String]
       attr_reader :string
@@ -76,6 +78,7 @@ module PacketGen
       def to_human
         @string
       end
+      alias format_inspect to_human
 
       # Set length from internal string length
       # @return [Integer]

data/lib/packetgen/types/oui.rb

@@ -14,6 +14,8 @@ module PacketGen
     #  oui.to_human   # => "00:01:02"
     # @author Sylvain Daubert
     class OUI < Types::Fields
+      include Inspectable
+
       # @attribute b2
       #  @return [Integer] left-most byte
       define_field :b2, Types::Int8
@@ -44,6 +46,7 @@ module PacketGen
       def to_human
         fields.map { |m| '%02x' % self[m] }.join(':')
       end
+      alias format_inspect to_human
     end
   end
 end

data/lib/packetgen/types/string.rb

@@ -14,6 +14,7 @@ module PacketGen
     # @author Sylvain Daubert
     class String < ::String
       include LengthFrom
+      include Inspectable
 
       # @return [Integer]
       attr_reader :static_length

data/lib/packetgen/types/tlv.rb

@@ -31,6 +31,8 @@ module PacketGen
     # @deprecated Use {AbstractTLV} instead.
     # @since 3.1.0 deprecated
     class TLV < Fields
+      include Inspectable
+
       # @!attribute type
       #  @return [Integer]
       define_field :type, Int8
@@ -139,6 +141,7 @@ module PacketGen
         "#{name} type:#{@typestr} length:#{@lenstr} value:#{value.inspect}" % [human_type,
                                                                                length]
       end
+      alias format_inspect to_human
 
       private
 

data/lib/packetgen/utils.rb

@@ -53,7 +53,7 @@ module PacketGen
       timeout = options[:timeout] || 1
       my_hwaddr = Config.instance.hwaddr(iface)
       arp_pkt = Packet.gen('Eth', dst: 'ff:ff:ff:ff:ff:ff', src: my_hwaddr)
-      arp_pkt.add('ARP', sha: Config.instance.hwaddr, spa: Config.instance.ipaddr,
+      arp_pkt.add('ARP', sha: Config.instance.hwaddr(iface), spa: Config.instance.ipaddr(iface),
                          tpa: ipaddr)
 
       capture = Capture.new(iface: iface, timeout: timeout, max: 1,

data/lib/packetgen/version.rb

@@ -10,5 +10,5 @@
 # @author Sylvain Daubert
 module PacketGen
   # PacketGen version
-  VERSION = '3.1.4'
+  VERSION = '3.1.5'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: packetgen
 version: !ruby/object:Gem::Version
-  version: 3.1.4
+  version: 3.1.5
 platform: ruby
 authors:
 - Sylvain Daubert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-22 00:00:00.000000000 Z
+date: 2020-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: interfacez
@@ -208,6 +208,7 @@ files:
 - lib/packetgen/headerable.rb
 - lib/packetgen/inject.rb
 - lib/packetgen/inspect.rb
+- lib/packetgen/inspectable.rb
 - lib/packetgen/packet.rb
 - lib/packetgen/pcap.rb
 - lib/packetgen/pcapng.rb
@@ -235,10 +236,11 @@ files:
 - lib/packetgen/utils.rb
 - lib/packetgen/utils/arp_spoofer.rb
 - lib/packetgen/version.rb
-homepage: https://github.com/sdaubert/packetgen
+homepage: 
 licenses:
 - MIT
 metadata:
+  homepage_uri: https://github.com/sdaubert/packetgen
   bug_tracker_uri: https://github.com/sdaubert/packetgen/issues
   documentation_uri: https://www.rubydoc.info/gems/packetgen
   source_code_uri: https://github.com/sdaubert/packetgen