packetgen 1.2.0 → 1.3.0

data/lib/packetgen/types/int.rb

@@ -0,0 +1,164 @@
+# coding: utf-8
+# 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 Types
+
+    # Base integer class to handle binary integers
+    # @abstract
+    # @author Sylvain Daubert
+    class Int
+
+      # Integer value
+      # @return [Integer]
+      attr_accessor :value
+      # Integer endianness
+      # @return [:little,:big]
+      attr_accessor :endian
+      # Integer size, in bytes
+      # @return [Integer]
+      attr_accessor :width
+      # Integer default value
+      # @return [Integer]
+      attr_accessor :default
+
+      # @param [Integer,nil] value
+      # @param [:little,:big,nil] endian
+      # @param [Integer,nil] width
+      # @param [Integer] default
+      def initialize(value=nil, endian=nil, width=nil, default=0)
+        @value = value
+        @endian = endian
+        @width = width
+        @default = default
+      end
+
+      def read(value)
+        @value = if value.is_a?(Integer)
+                   value.to_i
+                 else
+                   value.to_s.unpack(@packstr[@endian]).first
+                 end
+        self
+      end
+
+      # @abstract
+      # @return [::String]
+      # @raise [StandardError] This is an abstrat method and must be redefined
+      def to_s
+        unless defined? @packstr
+          raise StandardError, 'PacketGen::Types::Int#to_s is an abstract method'
+        end
+        [to_i].pack(@packstr[@endian])
+      end
+
+      def to_i
+        @value || @default
+      end
+
+      def to_f
+        to_i.to_f
+      end
+    end
+
+    # One byte integer
+    # @author Sylvain Daubert
+    class Int8 < Int
+      # @param [Integer,nil] value
+      def initialize(value=nil)
+        super(value, nil, 1)
+        @packstr = { nil => 'C' }
+      end
+    end
+
+    # 2-byte integer
+    # @author Sylvain Daubert
+    class Int16 < Int
+      # @param [Integer,nil] value
+      # @param [:big, :little] endian
+      def initialize(value=nil, endian=:big)
+        super(value, endian, 2)
+        @packstr = { big: 'n', little: 'v' }
+      end
+    end
+
+    # big endian 2-byte integer
+    # @author Sylvain Daubert
+    class Int16be < Int16
+      undef endian=
+    end
+
+    # little endian 2-byte integer
+    # @author Sylvain Daubert
+    class Int16le < Int16
+      # @param [Integer,nil] value
+      undef endian=
+
+      # @param [Integer, nil] value
+      def initialize(value=nil)
+        super(value, :little)
+      end
+    end
+
+    # 4-byte integer
+    # @author Sylvain Daubert
+    class Int32 < Int
+      # @param [Integer,nil] value
+      # @param [:big, :little] endian
+      def initialize(value=nil, endian=:big)
+        super(value, endian, 4)
+        @packstr = { big: 'N', little: 'V' }
+      end
+    end
+
+    # big endian 4-byte integer
+    # @author Sylvain Daubert
+    class Int32be < Int32
+      undef endian=
+    end
+
+    # little endian 4-byte integer
+    # @author Sylvain Daubert
+    class Int32le < Int32
+      # @param [Integer,nil] value
+      undef endian=
+
+      # @param [Integer, nil] value
+      def initialize(value=nil)
+        super(value, :little)
+      end
+    end
+
+    # 8-byte integer
+    # @author Sylvain Daubert
+    class Int64 < Int
+      # @param [Integer,nil] value
+      # @param [:big, :little] endian
+      def initialize(value=nil, endian=:big)
+        super(value, endian, 8)
+        @packstr = { big: 'Q>', little: 'Q<' }
+      end
+    end
+
+    # big endian 8-byte integer
+    # @author Sylvain Daubert
+    class Int64be < Int64
+      undef endian=
+    end
+
+    # little endian 8-byte integer
+    # @author Sylvain Daubert
+    class Int64le < Int64
+      # @param [Integer,nil] value
+      undef endian=
+
+      # @param [Integer, nil] value
+      def initialize(value=nil)
+        super(value, :little)
+      end
+    end
+  end
+end

data/lib/packetgen/types/int_string.rb

@@ -0,0 +1,69 @@
+# coding: utf-8
+# 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 Types
+
+    # Provides a class for creating strings preceeded by their length as a {Int}.
+    # By default, a null string will have one byte length (length byte set to 0).
+    # @author Sylvain Daubert
+    class IntString
+
+      # internal string
+      # @return [String]
+      attr_accessor :string
+
+      # @param [::String] str
+      # @param [Class] len_type should be a {Int} subclass
+      def initialize(str='', len_type=Int8)
+        @string = Types::String.new(str)
+        @length = len_type.new
+        calc_length
+      end
+
+      # @param [::String] str
+      # @return [IntString] self
+      def read(str)
+        unless str[0, @length.width].size == @length.width
+          raise ParseError, "String too short for type #{@length.type}"
+        end
+        @length.read str[0, @length.width]
+        @string.read str[@length.width, @length.to_i]
+        self
+      end
+
+      # @param [Integer] l
+      # @return [Integer]
+      def length=(l)
+        @length.read l
+        l
+      end
+
+      # @return [Integer]
+      def length
+        @length.to_i
+      end
+
+      # Get binary string
+      # @return [::String]
+      def to_s
+        @length.to_s << @string.to_s
+      end
+
+      # Set length from internal string length
+      # @return [Integer]
+      def calc_length
+        @length.read @string.length
+      end
+
+      # Give binary string length
+      # @return [Integer]
+      def sz
+        to_s.size
+      end
+    end
+  end
+end

data/lib/packetgen/types/string.rb

@@ -0,0 +1,36 @@
+# coding: utf-8
+# 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 Types
+
+    # This class is just like regular String. It only adds #read and #sz methods
+    # to be compatible with others {Types}.
+    # @author Sylvain Daubert
+    class String < ::String
+
+      # @param [String] str
+      # @param [Hash] options
+      # @option options [Types::Int] :length_from object from which takes length when
+      #   reading
+      def initialize(str='', options={})
+        super(str)
+        @length_from = options[:length_from]
+      end
+
+      # @param [::String] str
+      # @return [String] self
+      def read(str)
+        s = str.to_s
+        s = s[0, @length_from.to_i] unless @length_from.nil?
+        self.replace s
+        self
+      end
+
+      alias sz length
+    end
+  end
+end

data/lib/packetgen/types/tlv.rb

@@ -0,0 +1,41 @@
+module PacketGen
+  module Types
+
+    # Class to handle Type-Length-Value attributes
+    # @author Sylvain Daubert
+    class TLV < Fields
+      # @!attribute type
+      #  @return [Integer]
+      define_field :type, Int8
+      # @!attribute length
+      #  @return [Integer]
+      define_field :length, Int8
+      # @!attribute value
+      #  @return [String]
+      define_field :value, String,
+                   builder: ->(tlv) { String.new('', length_from: tlv[:length]) }
+
+      # @param [Hash] options
+      # @option options [Integer] :type
+      # @option options [Integer] :length
+      # @option options [String] :value
+      # @option options [Class] :t {Int} subclass for +:type+ attribute.
+      #   Default: {Int8}.
+      # @option options [Class] :l {Int} subclass for +:length+ attribute.
+      #   Default: {Int8}.
+      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])
+        end
+      end
+
+        # @return [String]
+        def to_human
+          "type=#{type},len=#{length},value=#{value.inspect}"
+        end
+    end
+  end
+end

data/lib/packetgen/types.rb

@@ -0,0 +1,13 @@
+module PacketGen
+  
+  # Module to group all type definitions
+  module Types
+  end
+end
+
+require_relative 'types/int'
+require_relative 'types/string'
+require_relative 'types/int_string'
+require_relative 'types/fields'
+require_relative 'types/array'
+require_relative 'types/tlv'

data/lib/packetgen/version.rb

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

data/lib/packetgen.rb

@@ -83,7 +83,7 @@ module PacketGen
   end
 end
 
-require 'packetgen/structfu'
+require 'packetgen/types'
 require 'packetgen/inspect'
 require 'packetgen/packet'
 require 'packetgen/capture'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: packetgen
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Sylvain Daubert
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-10 00:00:00.000000000 Z
+date: 2017-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pcaprub
@@ -111,10 +111,17 @@ files:
 - lib/packetgen/capture.rb
 - lib/packetgen/header.rb
 - lib/packetgen/header/arp.rb
+- lib/packetgen/header/base.rb
+- lib/packetgen/header/dns.rb
+- lib/packetgen/header/dns/name.rb
+- lib/packetgen/header/dns/opt.rb
+- lib/packetgen/header/dns/option.rb
+- lib/packetgen/header/dns/qdsection.rb
+- lib/packetgen/header/dns/question.rb
+- lib/packetgen/header/dns/rr.rb
+- lib/packetgen/header/dns/rrsection.rb
 - lib/packetgen/header/esp.rb
 - lib/packetgen/header/eth.rb
-- lib/packetgen/header/header_class_methods.rb
-- lib/packetgen/header/header_methods.rb
 - lib/packetgen/header/icmp.rb
 - lib/packetgen/header/icmpv6.rb
 - lib/packetgen/header/ip.rb
@@ -133,7 +140,13 @@ files:
 - lib/packetgen/pcapng/shb.rb
 - lib/packetgen/pcapng/spb.rb
 - lib/packetgen/pcapng/unknown_block.rb
-- lib/packetgen/structfu.rb
+- lib/packetgen/types.rb
+- lib/packetgen/types/array.rb
+- lib/packetgen/types/fields.rb
+- lib/packetgen/types/int.rb
+- lib/packetgen/types/int_string.rb
+- lib/packetgen/types/string.rb
+- lib/packetgen/types/tlv.rb
 - lib/packetgen/version.rb
 - packetgen.gemspec
 homepage: https://github.com/sdaubert/packetgen
@@ -155,7 +168,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Network packet generator and analyzor

data/lib/packetgen/header/header_class_methods.rb

@@ -1,106 +0,0 @@
-# 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 Header
-
-    module HeaderClassMethods
-
-      # @api private
-      # Simple class to handle header association
-      Binding = Struct.new(:key, :value)
-
-      # Bind a upper header to current class
-      # @param [Class] header_klass header class to bind to current class
-      # @param [Hash] args current class fields and their value when +header_klass+
-      #  is embedded in current class
-      # @return [void]
-      def bind_header(header_klass, args={})
-        @known_headers ||= {}
-        @known_headers[header_klass] ||= []
-        args.each do |key, value|
-          @known_headers[header_klass] << Binding.new(key, value)
-        end
-      end
-
-      # @api private
-      # Get knwon headers
-      # @return [Hash] keys: header classes, values: array of {Binding}
-      def known_headers
-        @known_headers ||= {}
-      end
-
-      # Define a bitfield on given attribute
-      #   class MyHeader < Struct.new(:flags)
-      #   
-      #     def initialize(options={})
-      #       super Int16.new(options[:flags])
-      #     end
-      #     
-      #     # define a bit field on :flag attribute:
-      #     # flag1, flag2 and flag3 are 1-bit fields
-      #     # type and stype are 3-bit fields. reserved is a 6-bit field
-      #     define_bit_fields_on :flags, :flag1, :flag2, :flag3, :type, 3, :stype, 3, :reserved: 6
-      #   end
-      # A bitfield of size 1 bit defines 2 methods:
-      # * +#field?+ which returns a Boolean,
-      # * +#field=+ which takes and returns a Boolean.
-      # A bitfield of more bits defines 2 methods:
-      # * +#field+ which returns an Integer,
-      # * +#field=+ which takes and returns an Integer.
-      # @param [Symbol] attr attribute name (attribute should a {StructFu::Int}
-      #   subclass)
-      # @param [Array] args list of bitfield names. Name may be followed
-      #   by bitfield size. If no size is given, 1 bit is assumed.
-      # @return [void]
-      def define_bit_fields_on(attr, *args)
-        total_size = self.new[attr].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
-                   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 <<-EOM
-              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
-              EOM
-            else
-              class_eval <<-EOM
-              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
-              EOM
-            end
-          end
-
-          idx -= size
-          field = args.shift
-        end
-      end
-    end
-  end
-end

data/lib/packetgen/header/header_methods.rb

@@ -1,73 +0,0 @@
-# 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 Header
-
-    # Mixin for various headers
-    # @author Sylvain Daubert
-    module HeaderMethods
-
-      # @api private
-      # Set reference of packet which owns this header
-      # @param [Packet] packet
-      # @return [void]
-      def packet=(packet)
-        @packet = packet
-      end
-
-      # @api private
-      # Get rference on packet which owns this header
-      # @return [Packet]
-      def packet
-        @packet
-      end
-
-      # @api private
-      # Get +header+ id in packet headers array
-      # @param [Header] header
-      # @return [Integer]
-      # @raise FormatError +header+ not in a packet
-      def header_id(header)
-        raise FormatError, "header of type #{header.class} not in a packet" if packet.nil?
-        id = packet.headers.index(header)
-        if id.nil?
-          raise FormatError, "header of type #{header.class} not in packet #{packet}"
-        end
-        id
-      end
-
-      # @api private
-      # Get IP or IPv6 previous header from +header+
-      # @param [Header] header
-      # @return [Header]
-      # @raise FormatError no IP or IPv6 header previous +header+ in packet
-      # @raise FormatError +header+ not in a packet
-      def ip_header(header)
-        hid = header_id(header)
-        iph = packet.headers[0...hid].reverse.find { |h| h.is_a? IP or h.is_a? IPv6 }
-        raise FormatError, 'no IP or IPv6 header in packet' if iph.nil?
-        iph
-      end
-
-      # Return header protocol name
-      # @return [String]
-      def protocol_name
-        self.class.to_s.sub(/.*::/, '')
-      end
-
-      # Common inspect method for headers
-      # @return [String]
-      def inspect
-        str = Inspect.dashed_line(self.class, 2)
-        to_h.each do |attr, value|
-          next if attr == :body
-          str << Inspect.inspect_attribute(attr, value, 2)
-        end
-        str
-      end
-    end
-  end
-end