packetgen 2.8.1 → 2.8.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 37df498d94945f9c9f6388bdbdddb9e0358b28bf554605205dd9411635710325
-  data.tar.gz: 5c175ea4e4ce48c912f184375b1dfc78c86733356c0fb1207b35de53e1d757a5
+  metadata.gz: 8ed1bb8d789bf32ec06fefdb337c59a0bc798c681b109414e3c84e29d7668890
+  data.tar.gz: 938c883c20a2a5452aa4ade8d55cec86971eafc4c561c8980260c509b57312fb
 SHA512:
-  metadata.gz: fbb0342a14a3ef2add45c1957839827aad610dda2d5bda9ed3c1141a5da011ca5695615087cbe917b11397cad0df342966d912c14dee56b4f968df1c9a1855d2
-  data.tar.gz: 39998bac4ecd5d8be0e09f639159dfc257ca5fad34f546a5c7fe180607f899b1005877ed0a52ea30da916fe99c8db8ae0533c959adb7c964eb9ed8ac24f8ddc4
+  metadata.gz: 8cccb84679cdf8934e2e26b267cb4d00576201ff309311d70d7907dd3ea1ddb6ea3f61a11b2a081b4648a8e3263083ba7484961448ea60f944b6f0541e145d58
+  data.tar.gz: dfda8ea794e137b501bcbf1810f35ed637113ee33c548132d8f0f0db2cb24b6ca8603222eaf8185d02f37ca8ba2a0bd7ff60701cedd28fbaf8ccedd1c3985d35

data/README.md

@@ -157,20 +157,27 @@ classes. A special `config` object gives local network configuration:
 
 If `pry` gem is installed, it is used as backend for `pgconsole`, else IRB is used.
 
+## Plugins
+
+PacketGen provides a plugin system (see [wiki](https://github.com/sdaubert/packetgen/wiki/Create-Custom-Protocol)).
+
+For now, there is only one plugin available as a gem:
+
+* [packetgen-plugin-smb](https://github.com/sdaubert/packetgen-plugin-smb): add (limited) support for SMB protocol suite.
+
 ## See also
 
 Wiki: https://github.com/sdaubert/packetgen/wiki
 
 API documentation: http://www.rubydoc.info/gems/packetgen
 
-## Pull requests?
+## Contributing
 
-yes
+Bug reports and pull requests are welcome on GitHub at https://github.com/sdaubert/packetgen-plugin-smb.
 
 ## License
-MIT License (see [LICENSE](https://github.com/sdaubert/packetgen/blob/master/LICENSE))
 
-Copyright © 2016 Sylvain Daubert
+MIT License (see [LICENSE](https://github.com/sdaubert/packetgen/blob/master/LICENSE))
 
 ### Other sources
 All original code maintains its copyright from its original authors and licensing.

data/lib/packetgen/deprecation.rb

@@ -10,7 +10,8 @@ module PacketGen
       complete_deprecated_method_name = base_name + deprecated_method.to_s
       complete_new_method_name = base_name + new_method.to_s
 
-      warn "#{complete_deprecated_method_name} is deprecated in favor of #{complete_new_method_name}. " \
+      file, line = caller(2).first.split(':')[0, 2]
+      warn "#{file}:#{line}: #{complete_deprecated_method_name} is deprecated in favor of #{complete_new_method_name}. " \
            "It will be remove in PacketGen #{remove_version}."
     end
   end

data/lib/packetgen/header/asn1_base.rb

@@ -100,9 +100,9 @@ module PacketGen
       # Common inspect method for ASN.1 headers
       # @return [String]
       def inspect
-        str = Inspect.dashed_line(self.class, 2)
+        str = Inspect.dashed_line(self.class, 1)
         self.class.class_eval { @attributes }.each do |attr|
-          str << Inspect.inspect_asn1_attribute(attr, self[attr], 2)
+          str << Inspect.inspect_asn1_attribute(attr, self[attr], 1)
         end
         str
       end

data/lib/packetgen/header/base.rb

@@ -17,7 +17,6 @@ module PacketGen
     class Base < Types::Fields
       # @api private
       # Simple class to handle a header association
-      # @deprecated Will be remove with {Base.bind_header}
       class Binding < Struct.new(:key, :value)
         # Check +fields+ responds to binding
         # @param [Types::Fields] fields
@@ -51,7 +50,6 @@ module PacketGen
 
       # @api private
       # Class to handle a header association from procs
-      # @deprecated Will be remove with {Base.bind_header}
       class ProcBinding
         # @param [Array<Proc>] procs first proc is used to set fields, second proc is
         #  used to check binding
@@ -163,7 +161,7 @@ module PacketGen
       # @return [Packet,nil]
       attr_reader :packet
 
-      # On inheritage, create +@old_known_header+ class variable
+      # On inheritage, create +@known_header+ class variable
       # @param [Class] klass
       # @return [void]
       def self.inherited(klass)
@@ -286,6 +284,12 @@ module PacketGen
         @known_headers
       end
 
+      # @see Types::Fields#initialize
+      def initialize(options={})
+        @packet = options.delete(:packet) if options.key?(:packet)
+        super
+      end
+
       # Return header protocol name
       # @return [String]
       def protocol_name

data/lib/packetgen/header/bootp.rb

@@ -132,14 +132,15 @@ module PacketGen
 
       # @return [String]
       def inspect
-        str = Inspect.dashed_line(self.class, 2)
+        str = Inspect.dashed_line(self.class, 1)
         fields.each do |attr|
           next if attr == :body
           next unless is_present?(attr)
+
           str << if (attr == :chaddr) && (self.hlen == 6)
-                   Inspect.inspect_attribute(attr, Eth::MacAddr.new.read(self[:chaddr][0, 6]), 2)
+                   Inspect.inspect_attribute(attr, Eth::MacAddr.new.read(self[:chaddr][0, 6]), 1)
                  else
-                   Inspect.inspect_attribute(attr, self[attr], 2)
+                   Inspect.inspect_attribute(attr, self[attr], 1)
                  end
         end
         str

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

@@ -62,8 +62,6 @@ module PacketGen
       # @author Sylvain Daubert
       class DUID_LLT < DUID
         delete_field :body
-        undef body
-        undef body=
 
         # Base time for time computation
         BASE_TIME = Time.utc(2000, 1, 1)
@@ -102,8 +100,6 @@ module PacketGen
       # @author Sylvain Daubert
       class DUID_EN < DUID
         delete_field :body
-        undef body
-        undef body=
 
         # @!attribute en
         #  32-bit entreprise number
@@ -124,8 +120,6 @@ module PacketGen
       # @author Sylvain Daubert
       class DUID_LL < DUID
         delete_field :body
-        undef body
-        undef body=
 
         # @!attribute htype
         #  16-bit hardware protocol type

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

@@ -135,8 +135,6 @@ module PacketGen
         TYPE = 1
 
         delete_field :data
-        undef data
-        undef data=
 
         # @!attribute duid
         #  @return [DUID]
@@ -163,8 +161,6 @@ module PacketGen
         TYPE = 3
 
         delete_field :data
-        undef data
-        undef data=
 
         # @!attribute iaid
         #  32-bit IAID field
@@ -198,8 +194,6 @@ module PacketGen
         TYPE = 4
 
         delete_field :data
-        undef data
-        undef data=
 
         # @!attribute iaid
         #  32-bit IAID field
@@ -225,8 +219,6 @@ module PacketGen
         TYPE = 5
 
         delete_field :data
-        undef data
-        undef data=
 
         # @attribute ipv6
         #  IPv6 address
@@ -267,8 +259,6 @@ module PacketGen
         TYPE = 6
 
         delete_field :data
-        undef data
-        undef data=
 
         # @!attribute options
         #   @return [RequestedOptions]
@@ -298,8 +288,6 @@ module PacketGen
         TYPE = 7
 
         delete_field :data
-        undef data
-        undef data=
 
         # @!attribute value
         #  8-bit value
@@ -320,8 +308,6 @@ module PacketGen
         TYPE = 8
 
         delete_field :data
-        undef data
-        undef data=
 
         # @!attribute value
         #  16-bit value
@@ -349,8 +335,6 @@ module PacketGen
         TYPE = 12
 
         delete_field :data
-        undef data
-        undef data=
 
         # @!attribute addr
         #  IPv6 server address
@@ -378,8 +362,6 @@ module PacketGen
         TYPE = 14
 
         delete_field :data
-        undef data
-        undef data=
       end
     end
   end

data/lib/packetgen/header/dns.rb

@@ -250,21 +250,21 @@ module PacketGen
 
       # @return [String]
       def inspect
-        str = Inspect.dashed_line(self.class, 2)
+        str = Inspect.dashed_line(self.class, 1)
         fields.each do |attr|
           if attr == :u16
             flags = %i[qr aa tc rd ra].select! { |flag| send "#{flag}?" }
                                       .map(&:to_s).join(',')
-            str << Inspect.shift_level(2)
+            str << Inspect.shift_level(1)
             str << Inspect::FMT_ATTR % ['Flags', 'flags', flags]
-            opcode = '%-10s (%u)' % [OPCODES.key(self.opcode), self.opcode]
-            str << Inspect.shift_level(2)
+            opcode = '%-16s (%u)' % [OPCODES.key(self.opcode), self.opcode]
+            str << Inspect.shift_level(1)
             str << Inspect::FMT_ATTR % ['Integer', 'opcode', opcode]
-            rcode = '%-10s (%u)' % [RCODES.key(self.rcode), self.rcode]
-            str << Inspect.shift_level(2)
+            rcode = '%-16s (%u)' % [RCODES.key(self.rcode), self.rcode]
+            str << Inspect.shift_level(1)
             str << Inspect::FMT_ATTR % ['Integer', 'rcode', rcode]
           else
-            str << Inspect.inspect_attribute(attr, self[attr], 2)
+            str << Inspect.inspect_attribute(attr, self[attr], 1)
           end
         end
         str

data/lib/packetgen/header/dot11.rb

@@ -40,6 +40,7 @@ module PacketGen
       # @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]
@@ -102,6 +103,7 @@ module PacketGen
       # @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]
@@ -331,6 +333,7 @@ module PacketGen
 
         if self.class == Dot11
           return self if str.nil?
+
           force_binary str
           self[:frame_ctrl].read str[0, 2]
 
@@ -372,16 +375,18 @@ module PacketGen
       # @return [String]
       def inspect
         str = if self.class == Dot11
-                Inspect.dashed_line("#{self.class} #{human_type}", 2)
+                Inspect.dashed_line("#{self.class} #{human_type}", 1)
               elsif self.respond_to? :human_subtype
-                Inspect.dashed_line("#{self.class} #{human_subtype}", 2)
+                Inspect.dashed_line("#{self.class} #{human_subtype}", 1)
               else
-                Inspect.dashed_line(self.class.to_s, 2)
+                Inspect.dashed_line(self.class.to_s, 1)
               end
+
         define_applicable_fields
         @applicable_fields.each do |attr|
           next if attr == :body
-          str << Inspect.inspect_attribute(attr, @fields[attr], 2)
+
+          str << Inspect.inspect_attribute(attr, @fields[attr], 1)
         end
         str
       end
@@ -403,6 +408,7 @@ module PacketGen
       # @return [void]
       def added_to_packet(packet)
         return if packet.respond_to? :dot11
+
         packet.instance_eval("def dot11(arg=nil); header(#{self.class}, arg); end")
       end
 

data/lib/packetgen/header/dot11/sub_mngt.rb

@@ -45,9 +45,9 @@ module PacketGen
         # @return [String]
         def inspect
           str = super
-          str << Inspect.dashed_line('Dot11 Elements', 3)
+          str << Inspect.dashed_line('Dot11 Elements', 2)
           @elements.each do |el|
-            str << Inspect.shift_level(4) << el.to_human << "\n"
+            str << Inspect.shift_level(2) << el.to_human << "\n"
           end
           str
         end

data/lib/packetgen/header/eap/md5.rb

@@ -14,7 +14,6 @@ module PacketGen
       # @since 2.1.4
       class MD5 < EAP
         delete_field :body
-        undef body
 
         # @!attribute value_size
         #  @return [Integer] 8-bit value size

data/lib/packetgen/header/eap/tls.rb

@@ -51,19 +51,20 @@ module PacketGen
 
         # @return [String]
         def inspect
-          str = Inspect.dashed_line(self.class, 2)
+          str = Inspect.dashed_line(self.class, 1)
           fields.each do |attr|
             next if attr == :body
-            next unless is_present?(attr)
+            next unless present?(attr)
+
             if attr == :flags
-              shift = Inspect.shift_level(2)
+              shift = Inspect.shift_level(1)
               value = %i[l m s].map { |f| send("#{f}?") ? f.to_s : '.' }.join
-              value = '%-10s (0x%02x)' % [value, self.flags]
+              value = '%-16s (0x%02x)' % [value, self.flags]
               str << shift
               str << Inspect::FMT_ATTR % [self[attr].class.to_s.sub(/.*::/, ''),
                                           attr, value]
             else
-              str << Inspect.inspect_attribute(attr, self[attr], 2)
+              str << Inspect.inspect_attribute(attr, self[attr], 1)
             end
           end
           str

data/lib/packetgen/header/eap/ttls.rb

@@ -55,20 +55,21 @@ module PacketGen
 
         # @return [String]
         def inspect
-          str = Inspect.dashed_line(self.class, 2)
+          str = Inspect.dashed_line(self.class, 1)
           fields.each do |attr|
             next if attr == :body
             next unless is_present?(attr)
+
             if attr == :flags
-              shift = Inspect.shift_level(2)
+              shift = Inspect.shift_level(1)
               value = %i[l m s].map { |f| send("#{f}?") ? f.to_s : '.' }.join
-              value = '%-10s (0x%02x)' % [value, self.flags]
+              value = '%-16s (0x%02x)' % [value, self.flags]
               str << shift
               str << Inspect::FMT_ATTR % [self[attr].class.to_s.sub(/.*::/, ''),
                                           attr, value]
               str << Inspect::FMT_ATTR % ['', 'version', self.version]
             else
-              str << Inspect.inspect_attribute(attr, self[attr], 2)
+              str << Inspect.inspect_attribute(attr, self[attr], 1)
             end
           end
           str

data/lib/packetgen/header/ike.rb

@@ -189,9 +189,10 @@ module PacketGen
 
       # @return [String]
       def inspect
-        str = Inspect.dashed_line(self.class, 2)
+        str = Inspect.dashed_line(self.class, )
         fields.each do |attr|
           next if attr == :body
+
           case attr
           when :flags
             str_flags = ''.dup

data/lib/packetgen/header/ike/cert.rb

@@ -71,17 +71,17 @@ module PacketGen
 
         # @return [String]
         def inspect
-          str = Inspect.dashed_line(self.class, 2)
+          str = Inspect.dashed_line(self.class, 1)
           fields.each do |attr|
             case attr
             when :body
               next
             when :encoding
-              str << Inspect.shift_level(2)
+              str << Inspect.shift_level(1)
               str << Inspect::FMT_ATTR % [self[attr].class.to_s.sub(/.*::/, ''), attr,
                                           human_encoding]
             else
-              str << Inspect.inspect_attribute(attr, self[attr], 2)
+              str << Inspect.inspect_attribute(attr, self[attr], 1)
             end
           end
           str

data/lib/packetgen/header/ike/certreq.rb

@@ -52,16 +52,16 @@ module PacketGen
 
         # @return [String]
         def inspect
-          str = Inspect.dashed_line(self.class, 2)
+          str = Inspect.dashed_line(self.class, 1)
           fields.each do |attr|
             case attr
             when :body
               next
             when :content
-              str << Inspect.shift_level(2)
+              str << Inspect.shift_level(1)
               str << Inspect::FMT_ATTR % ['hashes', :content, human_content]
             else
-              str << Inspect.inspect_attribute(attr, self[attr], 2)
+              str << Inspect.inspect_attribute(attr, self[attr], 1)
             end
           end
           str

data/lib/packetgen/header/ike/notify.rb

@@ -160,15 +160,16 @@ module PacketGen
 
         # @return [String]
         def inspect
-          str = Inspect.dashed_line(self.class, 2)
+          str = Inspect.dashed_line(self.class, 1)
           fields.each do |attr|
             next if attr == :body
+
             if %i[protocol message_type].include? attr
-              str << Inspect.shift_level(2)
+              str << Inspect.shift_level(1)
               str << Inspect::FMT_ATTR % [self[attr].class.to_s.sub(/.*::/, ''), attr,
                                           send("human_#{attr}")]
             else
-              str << Inspect.inspect_attribute(attr, self[attr], 2)
+              str << Inspect.inspect_attribute(attr, self[attr], 1)
             end
           end
           str

data/lib/packetgen/header/ike/sa.rb

@@ -529,7 +529,6 @@ module PacketGen
         PAYLOAD_TYPE = 33
 
         delete_field :content
-        undef content
 
         # @!attribute proposals
         #  Set of SA proposals

data/lib/packetgen/header/ike/ts.rb

@@ -221,7 +221,6 @@ module PacketGen
         PAYLOAD_TYPE = 44
 
         delete_field :content
-        undef content
 
         # @!attribute num_ts
         #   8-bit Number of TSs

data/lib/packetgen/header/ip.rb

@@ -84,7 +84,7 @@ module PacketGen
       define_field :length, Types::Int16, default: 20
       # @!attribute id
       #   @return [Integer] 16-bit ID
-      define_field :id, Types::Int16, default: -> { rand(65_535) }
+      define_field :id, Types::Int16, default: ->(h) { rand(65_535) }
       # @!attribute frag
       #   @return [Integer] 16-bit frag word
       define_field :frag, Types::Int16, default: 0
@@ -235,11 +235,12 @@ module PacketGen
 
       # @return [String]
       def inspect
-        str = Inspect.dashed_line(self.class, 2)
-        shift = Inspect.shift_level(2)
+        str = Inspect.dashed_line(self.class, 1)
+        shift = Inspect.shift_level(1)
         fields.each do |attr|
           next if attr == :body
-          str << Inspect.inspect_attribute(attr, self[attr], 2)
+
+          str << Inspect.inspect_attribute(attr, self[attr], 1)
           if attr == :u8
             str << shift + Inspect::FMT_ATTR % ['', 'version', version]
             str << shift + Inspect::FMT_ATTR % ['', 'ihl', ihl]

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

@@ -110,9 +110,7 @@ module PacketGen
       # End-of-option-List IP option
       class EOL < Option
         delete_field :length
-        undef length
         delete_field :data
-        undef data
       end
 
       # No OPeration IP option
@@ -122,7 +120,6 @@ module PacketGen
       # Loose Source and Record Route IP option
       class LSRR < Option
         delete_field :data
-        undef data
 
         # @!attribute pointer
         #  8-bit pointer on next address
@@ -169,7 +166,6 @@ module PacketGen
       # Stream Identifier IP option
       class SI < Option
         delete_field :data
-        undef data
 
         # @!attribute id
         #  16-bit stream ID
@@ -180,7 +176,6 @@ module PacketGen
       # Router Alert IP option
       class RA < Option
         delete_field :data
-        undef data
 
         # @!attribute value
         #  16-bit value. Should be 0.

data/lib/packetgen/header/ipv6.rb

@@ -137,10 +137,11 @@ module PacketGen
 
       # @return [String]
       def inspect
-        str = Inspect.dashed_line(self.class, 2)
+        str = Inspect.dashed_line(self.class, 1)
         fields.each do |attr|
           next if attr == :body
-          str << Inspect.inspect_attribute(attr, self[attr], 2)
+
+          str << Inspect.inspect_attribute(attr, self[attr], 1)
           if attr == :u32
             shift = Inspect.shift_level(2)
             str << shift + Inspect::FMT_ATTR % ['', 'version', version]

data/lib/packetgen/header/netbios/datagram.rb

@@ -93,8 +93,8 @@ module PacketGen
         # @return [Integer] calculated length
         def calc_length
           length = self[:body].sz
-          length += self[:src_name].sz if is_present?(:src_name)
-          length += self[:dst_name].sz if is_present?(:dst_name)
+          length += self[:src_name].sz if present?(:src_name)
+          length += self[:dst_name].sz if present?(:dst_name)
           self.dgm_length = length
         end
       end

data/lib/packetgen/header/snmp.rb

@@ -280,13 +280,13 @@ module PacketGen
 
       def inspect
         str = super
-        str << Inspect.shift_level(2)
+        str << Inspect.shift_level(1)
         if self[:data].chosen.nil?
           str << Inspect::FMT_ATTR % [self[:data].type, :data, '']
         else
           data = self[:data]
           str << Inspect::FMT_ATTR % [data.type, :data, data.chosen_value.type]
-          str << Inspect.dashed_line('ASN.1 content', 2)
+          str << Inspect.dashed_line('ASN.1 content', 1)
           str << data.chosen_value.inspect(1)
           begin
             str << Inspect.inspect_body(self[:message].to_der, 'ASN.1 DER')

data/lib/packetgen/header/tcp.rb

@@ -78,7 +78,7 @@ module PacketGen
       # @!attribute seqnum
       #  32-bit TCP sequence number
       #  @return [Integer]
-      define_field :seqnum, Types::Int32, default: -> { rand(2**32) }
+      define_field :seqnum, Types::Int32, default: ->(h) { rand(2**32) }
       # @!attribute acknum
       #  32-bit TCP acknowledgement number
       #  @return [Integer]
@@ -206,11 +206,12 @@ module PacketGen
 
       # @return [String]
       def inspect
-        str = Inspect.dashed_line(self.class, 2)
-        shift = Inspect.shift_level(2)
+        str = Inspect.dashed_line(self.class, 1)
+        shift = Inspect.shift_level(1)
         fields.each do |attr|
           next if attr == :body
-          str << Inspect.inspect_attribute(attr, self[attr], 2)
+
+          str << Inspect.inspect_attribute(attr, self[attr], 1)
           if attr == :u16
             doff = Inspect.int_dec_hex(data_offset, 1)
             str << shift + Inspect::FMT_ATTR % ['', 'data_offset', doff]

data/lib/packetgen/header/tftp.rb

@@ -138,7 +138,6 @@ module PacketGen
       # TFTP Read Request header
       class RRQ < TFTP
         delete_field :body
-        undef body
 
         # @!attribute filename
         #   Filename to access
@@ -165,7 +164,6 @@ module PacketGen
       # TFTP ACK header
       class ACK < TFTP
         delete_field :body
-        undef body
 
         # @!attribute block_num
         #   16-bit block number
@@ -176,7 +174,6 @@ module PacketGen
       # TFTP ERROR header
       class ERROR < TFTP
         delete_field :body
-        undef body
 
         # @!attribute error_code
         #   16-bit error code

data/lib/packetgen/inspect.rb

@@ -14,7 +14,7 @@ module PacketGen
     MAX_WIDTH = 70
 
     # Format to inspect attribute
-    FMT_ATTR = "%12s %12s: %s\n"
+    FMT_ATTR = "%14s %16s: %s\n"
 
     # Create a dashed line with +obj+ class writing in it
     # @param [String] name
@@ -34,7 +34,7 @@ module PacketGen
     # @param [Integer] hexsize
     # @return [String]
     def self.int_dec_hex(value, hexsize)
-      "%-10s (0x%0#{hexsize}x)" % [value.to_i, value.to_i]
+      "%-16s (0x%0#{hexsize}x)" % [value.to_i, value.to_i]
     end
 
     # Format an attribute for +#inspect+.
@@ -49,16 +49,21 @@ module PacketGen
     # @return [String]
     def self.inspect_attribute(attr, value, level=1)
       str = shift_level(level)
-      val = if value.is_a?(Types::Enum)
-              "%-10s (0x%0#{value.sz * 2}x)" % [value.to_human, value.to_i]
-            elsif value.is_a?(Types::Int) || value.is_a?(Integer)
+      val = case value
+            when Types::Enum
+              "%-16s (0x%0#{value.sz * 2}x)" % [value.to_human, value.to_i]
+            when Types::Int
               int_dec_hex(value, value.sz * 2)
-            elsif value.is_a?(String)
+            when Integer
+              int_dec_hex(value, value.sz * 2)
+            when String
               value.to_s.inspect
-            elsif value.respond_to? :to_human
-              value.to_human
             else
-              value.to_s.inspect
+              if value.respond_to? :to_human
+                value.to_human
+              else
+                value.to_s.inspect
+              end
             end
       str << FMT_ATTR % [value.class.to_s.sub(/.*::/, ''), attr, val]
     end
@@ -80,7 +85,7 @@ module PacketGen
       val = case attr
             when RASN1::Types::Enumerated
               hexsize = attr.value_size * 2
-              "%-10s (0x%0#{hexsize}x)" % [attr.value, attr.to_i]
+              "%-16s (0x%0#{hexsize}x)" % [attr.value, attr.to_i]
             when RASN1::Types::Integer
               int_dec_hex(attr.value, attr.value_size * 2)
             when RASN1::Model
@@ -95,6 +100,7 @@ module PacketGen
     # @return [String]
     def self.inspect_body(body, name='Body')
       return '' if body.nil? || body.empty?
+
       str = dashed_line(name, 2)
       str << (0..15).to_a.map { |v| ' %02d' % v }.join << "\n"
       str << '-' * MAX_WIDTH << "\n"

data/lib/packetgen/packet.rb

@@ -143,7 +143,7 @@ module PacketGen
     def add(protocol, options={})
       klass = check_protocol(protocol)
 
-      header = klass.new(options)
+      header = klass.new(options.merge!(packet: self))
       add_header header
       self
     end
@@ -158,7 +158,7 @@ module PacketGen
       klass = check_protocol(protocol)
 
       nxt = prev.body
-      header = klass.new(options)
+      header = klass.new(options.merge!(packet: self))
       add_header header, previous_header: prev
       idx = @headers.index(prev) + 1
       @headers[idx, 0] = header
@@ -422,7 +422,7 @@ module PacketGen
     def guess_first_header(binary_str)
       first_header = nil
       Header.all.each do |hklass|
-        hdr = hklass.new
+        hdr = hklass.new(packet: self)
         # #read may return another object (more specific class)
         hdr = hdr.read(binary_str)
         # First header is found when:
@@ -446,7 +446,7 @@ module PacketGen
         break if last_known_hdr.body.empty?
         search_header(last_known_hdr) do |nh|
           str = last_known_hdr.body
-          nheader = nh.new
+          nheader = nh.new(packet: self)
           nheader = nheader.read(str)
           next unless nheader.parse?
           add_header nheader, parsing: true

data/lib/packetgen/types/fields.rb

@@ -99,7 +99,7 @@ module PacketGen
       # @private
       @field_defs = {}
       # @private
-      @bit_fields = []
+      @bit_fields = {}
 
       # On inheritage, create +@field_defs+ class variable
       # @param [Class] klass
@@ -132,7 +132,8 @@ module PacketGen
       # @param [Object] type class or instance
       # @param [Hash] options Unrecognized options are passed to object builder if
       #   +:builder+ option is not set.
-      # @option options [Object] :default default value
+      # @option options [Object] :default default value. May be a proc. This lambda
+      #   take one argument: the caller object.
       # @option options [Lambda] :builder lambda to construct this field.
       #   Parameters to this lambda is the caller object and the field type class.
       # @option options [Lambda] :optional define this field as optional. Given lambda
@@ -180,9 +181,11 @@ module PacketGen
       def self.define_field_before(other, name, type, options={})
         define_field name, type, options
         return if other.nil?
+
         @ordered_fields.delete name
         idx = @ordered_fields.index(other)
         raise ArgumentError, "unknown #{other} field" if idx.nil?
+
         @ordered_fields[idx, 0] = name
       end
 
@@ -197,9 +200,11 @@ module PacketGen
       def self.define_field_after(other, name, type, options={})
         define_field name, type, options
         return if other.nil?
+
         @ordered_fields.delete name
         idx = @ordered_fields.index(other)
         raise ArgumentError, "unknown #{other} field" if idx.nil?
+
         @ordered_fields[idx + 1, 0] = name
       end
 
@@ -209,6 +214,8 @@ module PacketGen
       def self.delete_field(name)
         @ordered_fields.delete name
         @field_defs.delete name
+        undef_method name
+        undef_method "#{name}="
       end
 
       # Define a bitfield on given attribute
@@ -233,16 +240,19 @@ module PacketGen
       def self.define_bit_fields_on(attr, *args)
         attr_def = @field_defs[attr]
         raise ArgumentError, "unknown #{attr} field" if attr_def.nil?
+
         type = attr_def.first
         unless type < Types::Int
           raise TypeError, "#{attr} is not a PacketGen::Types::Int"
         end
+
         total_size = type.new.width * 8
         idx = total_size - 1
 
         field = args.shift
         while field
           next unless field.is_a? Symbol
+
           size = if args.first.is_a? Integer
                    args.shift
                  else
@@ -277,7 +287,8 @@ module PacketGen
               METHODS
             end
 
-            @bit_fields << field
+            @bit_fields[attr] = {} if @bit_fields[attr].nil?
+            @bit_fields[attr][field] = size
           end
 
           idx -= size
@@ -294,7 +305,7 @@ module PacketGen
 
         self.class.class_eval { @field_defs }.each do |field, ary|
           type, default, builder, optional, enum, field_options = ary
-          default = default.call if default.is_a?(Proc)
+          default = default.to_proc.call(self) if default.is_a?(Proc)
           @fields[field] = if builder
                              builder.call(self, type)
                            elsif enum
@@ -325,8 +336,10 @@ module PacketGen
 
           @optional_fields[field] = optional if optional
         end
-        self.class.class_eval { @bit_fields }.each do |bit_field|
-          self.send "#{bit_field}=", options[bit_field] if options[bit_field]
+        self.class.class_eval { @bit_fields }.each do |_, hsh|
+          hsh.each_key do |bit_field|
+            self.send "#{bit_field}=", options[bit_field] if options[bit_field]
+          end
         end
       end
 
@@ -358,26 +371,42 @@ module PacketGen
 
       # Say if this field is optional
       # @return [Boolean]
-      def is_optional?(field)
+      def optional?(field)
         @optional_fields.key? field
       end
 
+      # @deprecated Use {#optional?} instead.
+      def is_optional?(field)
+        Deprecation.deprecated(self.class, __method__, 'optional?', klass_method: true)
+        optional? field
+      end
+
       # Say if an optional field is present
       # @return [Boolean]
-      def is_present?(field)
-        return true unless is_optional?(field)
+      def present?(field)
+        return true unless optional?(field)
+
         @optional_fields[field].call(self)
       end
 
+      # Say if an optional field is present
+      # @return [Boolean]
+      def is_present?(field)
+        Deprecation.deprecated(self.class, __method__, 'present?', klass_method: true)
+        present? field
+      end
+
       # Populate object from a binary string
       # @param [String] str
       # @return [Fields] self
       def read(str)
         return self if str.nil?
+
         force_binary str
         start = 0
         fields.each do |field|
-          next unless is_present?(field)
+          next unless present?(field)
+
           obj = nil
           if self[field].respond_to? :width
             width = self[field].width
@@ -400,11 +429,12 @@ module PacketGen
       # Common inspect method for headers
       # @return [String]
       def inspect
-        str = Inspect.dashed_line(self.class, 2)
+        str = Inspect.dashed_line(self.class, 1)
         fields.each do |attr|
           next if attr == :body
-          next unless is_present?(attr)
-          str << Inspect.inspect_attribute(attr, self[attr], 2)
+          next unless present?(attr)
+
+          str << Inspect.inspect_attribute(attr, self[attr], 1)
         end
         str
       end
@@ -412,7 +442,7 @@ module PacketGen
       # Return object as a binary string
       # @return [String]
       def to_s
-        fields.select { |f| is_present?(f) }
+        fields.select { |f| present?(f) }
               .map! { |f| force_binary @fields[f].to_s }.join
       end
 
@@ -435,6 +465,7 @@ module PacketGen
       # @raise [ArgumentError] cannot cram +body+ in +:body+ field
       def body=(value)
         raise BodyError, 'no body field' unless @fields.key? :body
+
         case body
         when ::String
           self[:body].read value
@@ -460,14 +491,24 @@ module PacketGen
       # @raise [ArgumentError] unknown field
       def offset_of(field)
         raise ArgumentError, "#{field} is an unknown field of #{self.class}" unless @fields.include?(field)
+
         offset = 0
         fields.each do |f|
           break offset if f == field
-          next unless is_present?(f)
+          next unless present?(f)
+
           offset += self[f].sz
         end
       end
 
+      # Get bit fields definition for given field.
+      # @param [Symbol] field defining bit fields
+      # @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]
+      end
+
       private
 
       # Deeply duplicate +@fields+

data/lib/packetgen/types/int.rb

@@ -56,6 +56,7 @@ module PacketGen
         unless defined? @packstr
           raise StandardError, 'PacketGen::Types::Int#to_s is an abstract method'
         end
+
         [to_i].pack(@packstr[@endian])
       end
 
@@ -79,7 +80,7 @@ module PacketGen
       end
     end
 
-    # One byte integer
+    # One byte unsigned integer
     # @author Sylvain Daubert
     class Int8 < Int
       # @param [Integer,nil] value
@@ -89,7 +90,18 @@ module PacketGen
       end
     end
 
-    # 2-byte integer
+    # One byte signed integer
+    # @author Sylvain Daubert
+    # @since 2.8.2
+    class SInt8 < Int
+      # @param [Integer,nil] value
+      def initialize(value=nil)
+        super(value, nil, 1)
+        @packstr = { nil => 'c' }
+      end
+    end
+
+    # 2-byte unsigned integer
     # @author Sylvain Daubert
     class Int16 < Int
       # @param [Integer,nil] value
@@ -100,13 +112,13 @@ module PacketGen
       end
     end
 
-    # big endian 2-byte integer
+    # big endian 2-byte unsigned integer
     # @author Sylvain Daubert
     class Int16be < Int16
       undef endian=
     end
 
-    # little endian 2-byte integer
+    # little endian 2-byte unsigned integer
     # @author Sylvain Daubert
     class Int16le < Int16
       # @param [Integer,nil] value
@@ -118,7 +130,39 @@ module PacketGen
       end
     end
 
-    # 3-byte integer
+    # 2-byte signed integer
+    # @author Sylvain Daubert
+    # @since 2.8.2
+    class SInt16 < Int16
+      # @param [Integer,nil] value
+      # @param [:big, :little] endian
+      def initialize(value=nil, endian=:big)
+        super
+        @packstr = { big: 's>', little: 's<' }
+      end
+    end
+
+    # big endian 2-byte signed integer
+    # @author Sylvain Daubert
+    # @since 2.8.2
+    class SInt16be < SInt16
+      undef endian=
+    end
+
+    # little endian 2-byte signed integer
+    # @author Sylvain Daubert
+    # @since 2.8.2
+    class SInt16le < SInt16
+      # @param [Integer,nil] value
+      undef endian=
+
+      # @param [Integer, nil] value
+      def initialize(value=nil)
+        super(value, :little)
+      end
+    end
+
+    # 3-byte unsigned integer
     # @author Sylvain Daubert
     # @since 2.1.4
     class Int24 < Int
@@ -133,6 +177,7 @@ module PacketGen
       # @return [self]
       def read(value)
         return self if value.nil?
+
         @value = if value.is_a?(Integer)
                    value.to_i
                  else
@@ -159,14 +204,14 @@ module PacketGen
       end
     end
 
-    # big endian 3-byte integer
+    # big endian 3-byte unsigned integer
     # @author Sylvain Daubert
     # @since 2.1.4
     class Int24be < Int24
       undef endian=
     end
 
-    # little endian 3-byte integer
+    # little endian 3-byte unsigned integer
     # @author Sylvain Daubert
     # @since 2.1.4
     class Int24le < Int24
@@ -179,7 +224,7 @@ module PacketGen
       end
     end
 
-    # 4-byte integer
+    # 4-byte unsigned integer
     # @author Sylvain Daubert
     class Int32 < Int
       # @param [Integer,nil] value
@@ -190,13 +235,13 @@ module PacketGen
       end
     end
 
-    # big endian 4-byte integer
+    # big endian 4-byte unsigned integer
     # @author Sylvain Daubert
     class Int32be < Int32
       undef endian=
     end
 
-    # little endian 4-byte integer
+    # little endian 4-byte unsigned integer
     # @author Sylvain Daubert
     class Int32le < Int32
       # @param [Integer,nil] value
@@ -208,7 +253,39 @@ module PacketGen
       end
     end
 
-    # 8-byte integer
+    # 4-byte unsigned integer
+    # @author Sylvain Daubert
+    # @since 2.8.2
+    class SInt32 < Int32
+      # @param [Integer,nil] value
+      # @param [:big, :little] endian
+      def initialize(value=nil, endian=:big)
+        super
+        @packstr = { big: 'l>', little: 'l<' }
+      end
+    end
+
+    # big endian 4-byte unsigned integer
+    # @author Sylvain Daubert
+    # @since 2.8.2
+    class SInt32be < SInt32
+      undef endian=
+    end
+
+    # little endian 4-byte unsigned integer
+    # @author Sylvain Daubert
+    # @since 2.8.2
+    class SInt32le < SInt32
+      # @param [Integer,nil] value
+      undef endian=
+
+      # @param [Integer, nil] value
+      def initialize(value=nil)
+        super(value, :little)
+      end
+    end
+
+    # 8-byte unsigned integer
     # @author Sylvain Daubert
     class Int64 < Int
       # @param [Integer,nil] value
@@ -219,13 +296,13 @@ module PacketGen
       end
     end
 
-    # big endian 8-byte integer
+    # big endian 8-byte unsigned integer
     # @author Sylvain Daubert
     class Int64be < Int64
       undef endian=
     end
 
-    # little endian 8-byte integer
+    # little endian 8-byte unsigned integer
     # @author Sylvain Daubert
     class Int64le < Int64
       # @param [Integer,nil] value
@@ -236,5 +313,37 @@ module PacketGen
         super(value, :little)
       end
     end
+
+    # 8-byte unsigned integer
+    # @author Sylvain Daubert
+    # @since 2.8.2
+    class SInt64 < Int64
+      # @param [Integer,nil] value
+      # @param [:big, :little] endian
+      def initialize(value=nil, endian=:big)
+        super
+        @packstr = { big: 'q>', little: 'q<' }
+      end
+    end
+
+    # big endian 8-byte unsigned integer
+    # @author Sylvain Daubert
+    # @since 2.8.2
+    class SInt64be < SInt64
+      undef endian=
+    end
+
+    # little endian 8-byte unsigned integer
+    # @author Sylvain Daubert
+    # @since 2.8.2
+    class SInt64le < SInt64
+      # @param [Integer,nil] value
+      undef endian=
+
+      # @param [Integer, nil] value
+      def initialize(value=nil)
+        super(value, :little)
+      end
+    end
   end
 end

data/lib/packetgen/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: packetgen
 version: !ruby/object:Gem::Version
-  version: 2.8.1
+  version: 2.8.3
 platform: ruby
 authors:
 - Sylvain Daubert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-16 00:00:00.000000000 Z
+date: 2018-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: interfacez