packetgen 3.0.1 → 3.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d0ea9ae9a56d494ae6bde328655e61bdfc62c23ee413fe4d13d40e785e8dfb0
-  data.tar.gz: 2563927ccdc6961ed36d64f9e19ab52cf556cccd65bb66b391eb75510b50283f
+  metadata.gz: be94839db4cb9f9a818fdf5b948f34185198d7f8445545d13763cf57f313eb3a
+  data.tar.gz: 0cf02398bb76d3bb9083f6bbcb1e873b81c686e822ac3e63790a0b5f5d5155b7
 SHA512:
-  metadata.gz: 9c1057ab719194fef7f977b27770ea31489807bc05d20570c33746e12abdc9777e7f50c8311860152ec5c38cae30b6a6c5ef2865019e19aee8138a9c6e477db8
-  data.tar.gz: c705889994c6df09519de2b76fd5417d7cfc32b92cdf1c68d4d5efd3c3208f42c16bddbdc8256db7815ad87657d4dcf21226779281a42aa8935bb3f7a1d9aceb
+  metadata.gz: c72f91e241484140503a997aca5aa930cb8d3e357103b0af617231d7c49fa791b49537916fd68bb5c8d77b901c203500babf18cfe5c2df40900bfc2a30feb90b
+  data.tar.gz: d76180f3c3089218d67a0840d4f94c802c94bd8990cc45b91062414bba175973cc6f97287c1be99ccd87c063d7ebb17f210f15cc49fdd9eb649ec3465b29ea8e

data/lib/packetgen/header/asn1_base.rb

@@ -17,23 +17,7 @@ module PacketGen
     # @author Sylvain Daubert
     # @since 2.0.0
     class ASN1Base < RASN1::Model
-      # Reference on packet which owns this header
-      # @return [Packet,nil]
-      attr_reader :packet
-
-      # Give protocol name for this class
-      # @return [String]
-      # @since 2.0.0
-      def self.protocol_name
-        return @protocol_name if defined? @protocol_name
-
-        classname = to_s
-        @protocol_name = if classname.start_with?('PacketGen::Header')
-                           classname.sub(/.*Header::/, '')
-                         else
-                           classname.sub(/.*::/, '')
-                         end
-      end
+      include Headerable
 
       # Define some methods from given ASN.1 fields to mimic {Base} attributes
       # @param [Array<Symbol>] attributes
@@ -46,46 +30,6 @@ module PacketGen
         end
       end
 
-      # Return header protocol name
-      # @return [String]
-      def protocol_name
-        self.class.protocol_name
-      end
-
-      # return header method name
-      # @return [String]
-      # @since 2.0.0
-      def method_name
-        return @method_name if defined? @method_name
-
-        @method_name = protocol_name.downcase.sub(/::/, '_')
-      end
-
-      # Called by {Packet#parse} when guessing first header to check if header
-      # is correct
-      # @return [true]
-      def parse?
-        true
-      end
-
-      # @api private
-      # @since 2.1.4
-      # Set packet to which this header belongs
-      # @param [Packet] packet
-      # @return [Packet] packet
-      def packet=(packet)
-        @packet = packet
-        added_to_packet(packet)
-        @packet
-      end
-
-      # @abstract This method is called when a header is added to a packet.
-      #   This base method does nothing but may be overriden by subclasses.
-      # @param [Packet] packet packet to which self is added
-      # @return [void]
-      # @since 2.1.4
-      def added_to_packet(packet) end
-
       alias parse parse!
       alias to_s to_der
 

data/lib/packetgen/header/base.rb

@@ -15,6 +15,8 @@ module PacketGen
     #    * +#reply!+, which inverts needed fields to forge a response.
     # @author Sylvain Daubert
     class Base < Types::Fields
+      include Headerable
+
       # @api private
       # Simple class to handle a header association
       class Binding < Struct.new(:key, :value)
@@ -133,10 +135,6 @@ module PacketGen
         end
       end
 
-      # Reference on packet which owns this header
-      # @return [Packet,nil]
-      attr_reader :packet
-
       # @private
       # On inheritage, create +@known_header+ class variable
       # @param [Class] klass
@@ -195,19 +193,6 @@ module PacketGen
         end
       end
 
-      # Give protocol name for this class
-      # @return [String]
-      # @since 2.0.0
-      def self.protocol_name
-        return @protocol_name if defined? @protocol_name
-
-        classname = to_s
-        @protocol_name = if classname.start_with?('PacketGen::Header')
-                           classname.sub(/.*Header::/, '')
-                         else
-                           classname.sub(/.*::/, '')
-                         end
-      end
 
       # Helper method to calculate length of +hdr+ and set its +length+ field.
       # To be used by +#calc_length+ in Base subclasses.
@@ -236,47 +221,6 @@ module PacketGen
         super
       end
 
-      # Return header protocol name
-      # @return [String]
-      def protocol_name
-        self.class.protocol_name
-      end
-
-      # return header method name
-      # @return [String]
-      # @since 2.0.0
-      # @since 2.8.6 permit multiple nesting levels
-      def method_name
-        return @method_name if defined? @method_name
-
-        @method_name = protocol_name.downcase.gsub(/::/, '_')
-      end
-
-      # @abstract Should be redefined by subclasses. This method should check invariant
-      #   fields from header.
-      # Call by {Packet#parse} when guessing first header to check if header is correct
-      # @return [Boolean]
-      def parse?
-        true
-      end
-
-      # @api private
-      # Set packet to which this header belongs
-      # @param [Packet] packet
-      # @return [Packet] packet
-      # @since 2.1.4
-      def packet=(packet)
-        @packet = packet
-        added_to_packet(packet)
-        @packet
-      end
-
-      # @abstract This method is called when a header is added to a packet.
-      #   This base method does nothing but may be overriden by subclasses.
-      # @param [Packet] packet packet to which self is added
-      # @return [void]
-      # @since 2.1.4
-      def added_to_packet(packet) end
 
       # @api private
       # Get +header+ id in {Packet#headers} array

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

@@ -33,7 +33,7 @@ module PacketGen
           when 'end', 255
             End.new
           else
-            obj_klass = self.class.class_eval { @klass }
+            obj_klass = self.class.set_of_klass
             obj_klass.new(hsh)
           end
         end

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

@@ -10,7 +10,7 @@ module PacketGen
     class DNS
       # DNS Question
       # @author Sylvain Daubert
-      class Question < Base
+      class Question < Types::Fields
         # Ressource Record types
         TYPES = {
           'A'        => 1,

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

@@ -48,7 +48,7 @@ module PacketGen
 
         def real_type(opt)
           klasses = self.class.option_classes
-          klasses[opt.kind].nil? ? OPtion : klasses[opt.kind]
+          klasses[opt.kind].nil? ? Option : klasses[opt.kind]
         end
       end
     end

data/lib/packetgen/headerable.rb

@@ -0,0 +1,93 @@
+# 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.
+
+# frozen_string_literal: true
+
+module PacketGen
+  # This mixin module defines minimal API for a class to act as a header
+  # in {Packet}.
+  # @author Sylvain Daubert
+  # @since 3.0.2
+  module Headerable
+    # This modules handles class methods for {Headerable headerable classes}.
+    module ClassMethods
+      # Give protocol name for this class
+      # @return [String]
+      def protocol_name
+        return @protocol_name if defined? @protocol_name
+
+        classname = to_s
+        @protocol_name = if classname.start_with?('PacketGen::Header')
+                           classname.sub(/.*Header::/, '')
+                         else
+                           classname.sub(/.*::/, '')
+                         end
+      end
+    end
+
+    # @api private
+    # Extend +klass+ with {ClassMethods}.
+    # @param [Class] klass
+    # @return [void]
+    def self.included(klass)
+      klass.extend ClassMethods
+    end
+
+    # Return header protocol name
+    # @return [String]
+    def protocol_name
+      self.class.protocol_name
+    end
+
+    # return header method name
+    # @return [String]
+    def method_name
+      return @method_name if defined? @method_name
+
+      @method_name = protocol_name.downcase.gsub(/::/, '_')
+    end
+
+    # @abstract Should be redefined by subclasses. This method should check invariant
+    #   fields from header.
+    # Called by {Packet#parse} when guessing first header to check if header is correct
+    # @return [Boolean]
+    def parse?
+      true
+    end
+
+    # Reference on packet which owns this header
+    # @return [Packet,nil]
+    def packet
+      @packet ||= nil
+    end
+
+    # @api private
+    # Set packet to which this header belongs
+    # @param [Packet] packet
+    # @return [Packet] packet
+    def packet=(packet)
+      @packet = packet
+      added_to_packet(packet)
+      @packet
+    end
+
+    # @abstract This method is called when a header is added to a packet.
+    #   This base method does nothing but may be overriden by subclasses.
+    # @param [Packet] packet packet to which self is added
+    # @return [void]
+    def added_to_packet(packet) end
+
+    # @abstract This method MUST be redefined by subclasses.
+    # Populate headerable object from a binary string.
+    # @param [String] str
+    # @return [self]
+    # @raise [NotImplementedError]
+    def read(str)
+      super
+    rescue NoMethodError
+      raise NotImplementedError, "#{self.class} should implement #read"
+    end
+  end
+end

data/lib/packetgen/packet.rb

@@ -483,4 +483,5 @@ module PacketGen
   end
 end
 
+require_relative 'headerable'
 require_relative 'header'

data/lib/packetgen/types/array.rb

@@ -18,11 +18,11 @@ module PacketGen
     # by {.set_of}.
     #
     # == #real_type
-    # Subclasses should define private method +#real_type+ is {.set_of} type
+    # Subclasses should define private method +#real_type+ if {.set_of} type
     # may be subclassed. This method should return real class to use. It
     # takes an only argument, which is of type given by {.set_of}.
     #
-    # Default behaviour of this method is to argument's class.
+    # Default behaviour of this method is to return argument's class.
     #
     # @author Sylvain Daubert
     class Array
@@ -201,11 +201,15 @@ module PacketGen
 
       private
 
-      def record_from_hash(obj)
+      def record_from_hash(hsh)
         obj_klass = self.class.set_of_klass
-        return obj_klass.new(obj) if obj_klass
+        unless obj_klass
+          raise NotImplementedError, 'class should define #record_from_hash or declare type of elements in set with .set_of'
+        end
 
-        raise NotImplementedError, 'class should define #record_from_hash or declare type of elements in set with .set_of'
+        obj = obj_klass.new(hsh) if obj_klass
+        klass = real_type(obj)
+        klass == obj_klass ? obj : klass.new(hsh)
       end
 
       def real_type(obj)

data/lib/packetgen/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: packetgen
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.0.2
 platform: ruby
 authors:
 - Sylvain Daubert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-31 00:00:00.000000000 Z
+date: 2018-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: interfacez
@@ -234,6 +234,7 @@ files:
 - lib/packetgen/header/tcp/options.rb
 - lib/packetgen/header/tftp.rb
 - lib/packetgen/header/udp.rb
+- lib/packetgen/headerable.rb
 - lib/packetgen/inspect.rb
 - lib/packetgen/packet.rb
 - lib/packetgen/pcapng.rb