packetgen 2.1.4 → 2.2.0

data/lib/packetgen/header/ipv6.rb

@@ -47,7 +47,7 @@ module PacketGen
 
       # IPv6 address, as a group of 8 2-byte words
       # @author Sylvain Daubert
-      class Addr < Base
+      class Addr < Types::Fields
 
         # @!attribute a1
         #  1st 2-byte word of IPv6 address

data/lib/packetgen/packet.rb

@@ -385,7 +385,9 @@ module PacketGen
         hdr = hdr.read(binary_str)
         # First header is found when:
         # * for one known header,
+        # * +#parse?+ is true
         # * it exists a known binding with a upper header
+        next unless hdr.parse?
         search_header(hdr) do
           first_header = hklass.to_s.gsub(/.*::/, '')
         end
@@ -404,8 +406,8 @@ module PacketGen
           str = last_known_hdr.body
           nheader = nh.new
           nheader = nheader.read(str)
+          next unless nheader.parse?
           add_header nheader, parsing: true
-          nheader.dissect if nheader.respond_to? :dissect
         end
         decode_packet_bottom_up = (@headers.last != last_known_hdr)
       end
@@ -413,7 +415,7 @@ module PacketGen
 
     def search_header(hdr)
       hdr.class.known_headers.each do |nh, bindings|
-        if bindings.check?(hdr) and hdr.parse?
+        if bindings.check?(hdr)
           yield nh
           break
         end

data/lib/packetgen/types.rb

@@ -13,6 +13,7 @@ require_relative 'types/int'
 require_relative 'types/enum'
 require_relative 'types/string'
 require_relative 'types/int_string'
+require_relative 'types/cstring'
 require_relative 'types/fields'
 require_relative 'types/array'
 require_relative 'types/tlv'

data/lib/packetgen/types/cstring.rb

@@ -0,0 +1,67 @@
+# 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 handles null-terminated strings (aka C strings).
+    # @author Sylvain Daubert
+    class CString < ::String
+
+      # @param [String] str
+      # @param [Hash] options
+      # @option options [Integer] :static_length set a static length for this string
+      def initialize(options={})
+        super()
+        @static_length = options[:static_length]
+      end
+
+      # @param [::String] str
+      # @return [String] self
+      def read(str)
+        s = str.to_s
+        if @static_length.is_a? Integer
+          s = s[0, @static_length]
+        end
+        idx = s.index(0.chr)
+        s = s[0, idx] unless idx.nil?
+        self.replace s
+        self
+      end
+
+      # get null-terminated string
+      # @return [String]
+      def to_s
+        if @static_length.is_a? Integer
+          if self.size >= @static_length
+            s = self[0, @static_length]
+            s[-1] = 0.chr
+            PacketGen.force_binary s
+          else
+            PacketGen.force_binary(self + "\0" * (@static_length - self.length))
+          end
+        else
+          PacketGen.force_binary(self + 0.chr)
+        end
+      end
+
+      # @return [Integer]
+      def sz
+        if @static_length.is_a? Integer
+          @static_length
+        else
+          to_s.size
+        end
+      end
+
+      # @return [String]
+      def to_human
+        idx = self.index(0.chr) || self.sz
+        self[0, idx].inspect
+      end
+    end
+  end
+end

data/lib/packetgen/types/fields.rb

@@ -132,7 +132,7 @@ module PacketGen
       #   +:builder+ option is not set.
       # @option options [Object] :default default value
       # @option options [Lambda] :builder lambda to construct this field.
-      #   Parameter to this lambda is the caller object.
+      #   Parameters to this lambda is the caller object and the field type class.
       # @option options [Lambda] :optional define this field as optional. Given lambda
       #   is used to known if this field is present or not. Parameter to this lambda is
       #   the being defined Field object.
@@ -296,7 +296,7 @@ module PacketGen
           type, default, builder, optional, enum, field_options = ary
           default = default.call if default.is_a?(Proc)
           @fields[field] = if builder
-                             builder.call(self)
+                             builder.call(self, type)
                            elsif enum
                              type.new(enum)
                            elsif !field_options.empty?
@@ -376,18 +376,20 @@ module PacketGen
         start = 0
         fields.each do |field|
           next unless is_present?(field)
+          obj = nil
           if self[field].respond_to? :width
             width = self[field].width
-            self[field].read str[start, width]
+            obj = self[field].read str[start, width]
             start += width
           elsif self[field].respond_to? :sz
-            self[field].read str[start..-1]
+            obj = self[field].read str[start..-1]
             size = self[field].sz
             start += size
           else
-            self[field].read str[start..-1]
+            obj = self[field].read str[start..-1]
             start = str.size
           end
+          self[field] = obj unless obj == self[field]
         end
 
         self

data/lib/packetgen/types/int.rb

@@ -64,6 +64,7 @@ module PacketGen
       def to_i
         @value || @default
       end
+      alias to_human to_i
 
       # Convert Int to Float
       # @return [Float]

data/lib/packetgen/types/int_string.rb

@@ -16,10 +16,10 @@ module PacketGen
       # @return [String]
       attr_reader :string
 
-      # @param [::String] str
       # @param [Class] len_type should be a {Int} subclass
-      def initialize(str='', len_type=Int8)
-        @string = Types::String.new(str)
+      # @param [::String] string
+      def initialize(len_type=Int8, string: '')
+        @string = Types::String.new.read(string)
         @length = len_type.new
         calc_length
       end
@@ -61,6 +61,13 @@ module PacketGen
         @length.to_s << @string.to_s
       end
 
+      # Get human readable string
+      # @return [::String]
+      # @since 2.2.0
+      def to_human
+        @string.to_s.inspect
+      end
+
       # Set length from internal string length
       # @return [Integer]
       def calc_length

data/lib/packetgen/types/string.rb

@@ -16,9 +16,11 @@ module PacketGen
       # @param [Hash] options
       # @option options [Types::Int,Proc] :length_from object or proc from which
       #   takes length when reading
-      def initialize(str='', options={})
-        super(str)
+      # @option options [Integer] :static_length set a static length for this string
+      def initialize(options={})
+        super()
         @length_from = options[:length_from]
+        @static_length = options[:static_length]
       end
 
       # @param [::String] str
@@ -26,10 +28,16 @@ module PacketGen
       def read(str)
         s = str.to_s
         s = case @length_from
-            when Int
+            when Types::Int
               s[0, @length_from.to_i]
+            when Proc
+              s[0, @length_from.call]
             else
-              s
+              if @static_length.is_a? Integer
+                s[0, @static_length]
+              else
+                s
+              end
             end
         self.replace s
         self

data/lib/packetgen/types/tlv.rb

@@ -30,8 +30,7 @@ module PacketGen
       define_field :length, Int8
       # @!attribute value
       #  @return [String]
-      define_field :value, String,
-                   builder: ->(tlv) { String.new('', length_from: tlv[:length]) }
+      define_field :value, String
 
       # @param [Hash] options
       # @option options [Integer] :type
@@ -41,16 +40,31 @@ module PacketGen
       #   Default: {Int8}.
       # @option options [Class] :l {Int} subclass for +:length+ attribute.
       #   Default: {Int8}.
+      # @option options [Class] :v {String} subclass for +:value+ attribute.
+      #   Default: {Types::String}.
       def initialize(options={})
         super
-        self[:type] = options[:t].new(type) if options[:t]
-        self[:length] = options[:l].new(length) if options[:l]
-        self[:value] = String.new('', length_from: self[:length])
+        self[:type] = options[:t].new(self.type) if options[:t]
+        self[:length] = options[:l].new(self.length) if options[:l]
+        self[:value] = options[:v].new if options[:v]
         self.type = options[:type] if options[:type]
         self.value = options[:value] if options[:value]
         self.length = options[:length] if options[:length]
       end
 
+      # Populate object from a binary string
+      # @param [String] str
+      # @return [Fields] self
+      def read(str)
+        idx = 0 
+        self[:type].read str[idx, self[:type].sz]
+        idx += self[:type].sz
+        self[:length].read str[idx, self[:length].sz]
+        idx += self[:length].sz
+        self[:value].read str[idx, self.length]
+        self
+      end
+
       # @private
       alias old_type= type=
 
@@ -73,13 +87,31 @@ module PacketGen
         end
       end
 
-      # Set +value+ and +length+ fields
-      # @param [::String] str
-      # @return [::String]
-      def value=(str)
-        self.length = str.length
-        self[:value].read str
-        str
+      # Set +value+. May set +length+ if value is a {Types::String}.
+      # @param [::String,Integer] val
+      # @return [::String,Integer]
+      def value=(val)
+        if self[:value].respond_to? :from_human
+          self[:value].from_human val
+        elsif self[:value].is_a? Types::Int
+          self[:value].value = val
+        else
+          self.length = val.length if val.is_a? ::String
+          self[:value].read val
+        end
+        val
+      end
+
+      # Get +value+
+      # @return [Object] depend on +value+ type
+      def value
+        if self[:value].respond_to? :to_human
+          self[:value].to_human
+        elsif self[:value].is_a? Types::Int
+          self[:value].to_i
+        else
+          self[:value]
+        end
       end
 
       # Return human readable type, if TYPES is defined

data/lib/packetgen/utils.rb

@@ -53,7 +53,8 @@ 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.hwaddr, spa: @config.ipaddr, tpa: ipaddr)
+      arp_pkt.add('ARP', sha: Config.instance.hwaddr, spa: Config.instance.ipaddr,
+                  tpa: ipaddr)
       
       capture = Capture.new(iface: iface, timeout: timeout, max: 1,
                             filter: "arp src #{ipaddr} and ether dst #{my_hwaddr}")
@@ -97,5 +98,54 @@ module PacketGen
       as.start(target_ip, spoofed_ip, mac: options[:mac])
       as.wait
     end
+
+    # Man in the middle attack. Capture all packets between two peers on
+    # same local network.
+    # @note This method is provided for test purpose.
+    # @param [String] target1 IP address of first peer to attack
+    # @param [String] target2 IP address of second peer to attack
+    # @param [Hash] options
+    # @option options [Float,Integer] :interval number of seconds between 2
+    #   ARP packets (default: 1.0).
+    # @option options [String] :iface interface to use. Default to
+    #   {PacketGen.default_iface}
+    # @return [void]
+    # @yieldparam [Packet] pkt captured packets between target1 and target2
+    # @yieldreturn [Packet] packet to send to target1 or 2. This may be
+    #   modified received packet
+    # @example Change ID in packets
+    #   PacketGen::Utils.mitm('192.168.0.1', '192.168.0.45') do |pkt|
+    #     if pkt.ip.src == '192.168.0.1'
+    #       # 192.168.0.1 -> 192.168.0.45
+    #       pkt.ip.id = 1
+    #     else
+    #       # 192.168.0.45 -> 192.168.0.1
+    #       pkt.ip.id = 2
+    #     end
+    #     pkt
+    #   end
+    # @since 2.2.0
+    def self.mitm(target1, target2, options={})
+      options = { iface: PacketGen.default_iface }.merge(options)
+
+      spoofer = Utils::ARPSpoofer.new(options)
+      spoofer.add target1, target2, options
+      spoofer.add target2, target1, options
+      
+      my_mac = Config.instance.hwaddr(options[:iface])
+      my_ip = Config.instance.ipaddr(options[:iface])
+      capture = Capture.new(iface: options[:iface],
+                            filter: "((ip src #{target1} and not ip dst #{my_ip}) or" +
+                                    " (ip src #{target2} and not ip dst #{my_ip}) or"+
+                                    " (ip dst #{target1} and not ip src #{my_ip}) or"+
+                                    " (ip dst #{target2} and not ip src #{my_ip}))"+
+                                    " and ether dst #{my_mac}")
+
+      spoofer.start_all
+      capture.start do |pkt|
+        modified_pkt = yield pkt
+        modified_pkt.ip.to_w(options[:iface])
+      end
+    end
   end
 end

data/lib/packetgen/utils/arp_spoofer.rb

@@ -147,7 +147,7 @@ module PacketGen
         @spoof_thread = Thread.new(@queue, @iface, @timeout, @interval) do |queue, iface, timeout, interval|
           while timeout.nil? or timeout > 0.0 do
             packets = queue.pop unless queue.empty?
-            send_packets_on_wire packets
+            send_packets_on_wire(packets) unless packets.empty?
             timeout -= interval if timeout
             sleep interval
           end
@@ -156,7 +156,7 @@ module PacketGen
 
       # send packets on wire
       def send_packets_on_wire(packets)
-        packets.each { |pkt| pkt.to_w(iface) }
+        packets.each { |pkt| pkt.to_w(@iface) }
       end
 
       # Deactivate spoofing for given target

data/lib/packetgen/version.rb

@@ -8,5 +8,5 @@
 # @author Sylvain Daubert
 module PacketGen
   # PacketGen version
-  VERSION = '2.1.4'
+  VERSION = '2.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: packetgen
 version: !ruby/object:Gem::Version
-  version: 2.1.4
+  version: 2.2.0
 platform: ruby
 authors:
 - Sylvain Daubert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-11 00:00:00.000000000 Z
+date: 2017-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pcaprub
@@ -150,7 +150,11 @@ files:
 - lib/packetgen/header/arp.rb
 - lib/packetgen/header/asn1_base.rb
 - lib/packetgen/header/base.rb
+- lib/packetgen/header/bootp.rb
 - lib/packetgen/header/crypto.rb
+- lib/packetgen/header/dhcp.rb
+- lib/packetgen/header/dhcp/option.rb
+- lib/packetgen/header/dhcp/options.rb
 - lib/packetgen/header/dns.rb
 - lib/packetgen/header/dns/name.rb
 - lib/packetgen/header/dns/opt.rb
@@ -175,6 +179,10 @@ files:
 - lib/packetgen/header/esp.rb
 - lib/packetgen/header/eth.rb
 - lib/packetgen/header/gre.rb
+- lib/packetgen/header/http.rb
+- lib/packetgen/header/http/headers.rb
+- lib/packetgen/header/http/request.rb
+- lib/packetgen/header/http/response.rb
 - lib/packetgen/header/icmp.rb
 - lib/packetgen/header/icmpv6.rb
 - lib/packetgen/header/ike.rb
@@ -211,6 +219,7 @@ files:
 - lib/packetgen/proto.rb
 - lib/packetgen/types.rb
 - lib/packetgen/types/array.rb
+- lib/packetgen/types/cstring.rb
 - lib/packetgen/types/enum.rb
 - lib/packetgen/types/fields.rb
 - lib/packetgen/types/int.rb