packetgen 1.3.0 → 1.4.0

data/lib/packetgen/types/tlv.rb

@@ -2,6 +2,24 @@ module PacketGen
   module Types
 
     # Class to handle Type-Length-Value attributes
+    #
+    # TLV fields handles three subfields:
+    # * a tag/type field (defaults: {Int8} type),
+    # * a length field (defaults: {Int8} type),
+    # * a value field (defaults: {String} type).
+    #
+    # {#initialize} supports options to change tag and length type. By example, to
+    # declare a TLV using {Int16}:
+    #    define_field :tlv, PacketGen::Types::TLV, builder: ->(obj) { PacketGen::Types::TLV.new(t: PacketGen::Types::Int16, l: PacketGen::Types::Int16) }
+    #
+    # == Subclasses
+    # A subclass may defined a constant hash TYPES. This hash defines human readable
+    # types versus their integer values. Hash keys are integer values, and hash values
+    # are types as strings.
+    #
+    # If TYPES is defined, a subclass may:
+    # * print human readable type using {#human_type},
+    # * set type as String with {#type=}.
     # @author Sylvain Daubert
     class TLV < Fields
       # @!attribute type
@@ -26,16 +44,75 @@ module PacketGen
       def initialize(options={})
         super
         self[:type] = options[:t].new(type) if options[:t]
-        if options[:l]
-          self[:length] = options[:l].new(length)
-          self[:value] = String.new('', length_from: self[:length])
+        self[:length] = options[:l].new(length) if options[:l]
+        self[:value] = String.new('', length_from: self[:length])
+        self.type = options[:type] if options[:type]
+        self.value = options[:value] if options[:value]
+        self.length = options[:length] if options[:length]
+      end
+
+      # @private
+      alias old_type= type=
+
+      # Set type
+      # @param [::String,Integer] val
+      # @return [Integer]
+      # @raise [TypeError] class does not define TYPES
+      # @raise [ArgumentError] unknown string type
+      def type=(val)
+        case val
+        when Integer
+          self.old_type = val
+        else
+          unless has_human_types?
+            raise TypeError, "no human types defined for #{self.class}"
+          end
+          new_val = self.class::TYPES[val.to_s]
+          raise ArgumentError, "unknown #{val.to_s} type" if new_val.nil?
+          self.old_type = new_val
         end
       end
 
-        # @return [String]
-        def to_human
-          "type=#{type},len=#{length},value=#{value.inspect}"
+      # Set +value+ and +length+ fields
+      # @param [::String] str
+      # @return [::String]
+      def value=(str)
+        self.length = str.length
+        self[:value].read str
+        str
+      end
+
+      # Return human readable type, if TYPES is defined
+      # @return [String]
+      def human_type
+        if has_human_types?
+          htype = self.class::TYPES[type]
+          htype = type if htype.nil?
+          htype.to_s
+        else
+          type.to_s
         end
+      end
+
+      # @return [String]
+      def to_human
+        name = self.class.to_s.gsub(/.*::/, '')
+        @typestr ||= if has_human_types?
+                       types = self.class::TYPES.values
+                       "%-#{types.max { |a,b| a.length <=> b.length }.size}s"
+                     else
+                       "%s"
+                     end
+        @lenstr ||= "%-#{(2**(self[:length].width*8) - 1).to_s.size}u"
+        "#{name} type:#@typestr length:#@lenstr value:#{value.inspect}" % [human_type,
+                                                                           length]
+      end
+
+      private
+
+      def has_human_types?
+        self.class.const_defined? :TYPES
+      end
     end
   end
 end

data/lib/packetgen/version.rb

@@ -8,5 +8,5 @@
 # @author Sylvain Daubert
 module PacketGen
   # PacketGen version
-  VERSION = "1.3.0"
+  VERSION = "1.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: packetgen
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Sylvain Daubert
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-27 00:00:00.000000000 Z
+date: 2017-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pcaprub
@@ -120,12 +120,21 @@ files:
 - lib/packetgen/header/dns/question.rb
 - lib/packetgen/header/dns/rr.rb
 - lib/packetgen/header/dns/rrsection.rb
+- lib/packetgen/header/dot11.rb
+- lib/packetgen/header/dot11/control.rb
+- lib/packetgen/header/dot11/data.rb
+- lib/packetgen/header/dot11/element.rb
+- lib/packetgen/header/dot11/management.rb
+- lib/packetgen/header/dot11/sub_mngt.rb
+- lib/packetgen/header/dot1q.rb
+- lib/packetgen/header/dot1x.rb
 - lib/packetgen/header/esp.rb
 - lib/packetgen/header/eth.rb
 - lib/packetgen/header/icmp.rb
 - lib/packetgen/header/icmpv6.rb
 - lib/packetgen/header/ip.rb
 - lib/packetgen/header/ipv6.rb
+- lib/packetgen/header/llc.rb
 - lib/packetgen/header/tcp.rb
 - lib/packetgen/header/tcp/option.rb
 - lib/packetgen/header/tcp/options.rb
@@ -145,6 +154,7 @@ files:
 - lib/packetgen/types/fields.rb
 - lib/packetgen/types/int.rb
 - lib/packetgen/types/int_string.rb
+- lib/packetgen/types/oui.rb
 - lib/packetgen/types/string.rb
 - lib/packetgen/types/tlv.rb
 - lib/packetgen/version.rb