packetgen 2.8.3 → 2.8.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ed1bb8d789bf32ec06fefdb337c59a0bc798c681b109414e3c84e29d7668890
-  data.tar.gz: 938c883c20a2a5452aa4ade8d55cec86971eafc4c561c8980260c509b57312fb
+  metadata.gz: bd941670ed94baa729f5ee91da53062195f6764b3e75d7e70cbbc09075adfdc2
+  data.tar.gz: 4e5b3082f9ada7a234fc559baf53f8abb0ab374e76391c938505f82235a2a58a
 SHA512:
-  metadata.gz: 8cccb84679cdf8934e2e26b267cb4d00576201ff309311d70d7907dd3ea1ddb6ea3f61a11b2a081b4648a8e3263083ba7484961448ea60f944b6f0541e145d58
-  data.tar.gz: dfda8ea794e137b501bcbf1810f35ed637113ee33c548132d8f0f0db2cb24b6ca8603222eaf8185d02f37ca8ba2a0bd7ff60701cedd28fbaf8ccedd1c3985d35
+  metadata.gz: ebe8bf700763779d708b96bc7731dec2e73b2aa9c23308b9b2f63743c785bc989dfeea01d1b04dba8210f031f6047791151f06a4671b0980bd429becc653403c
+  data.tar.gz: 9243425668eba786664e28a55edb7458b0d51bb27e3ca09ac68573b9d41e0cb5f087fe677f93c5d05aef05ac55adc08220475c643e1da81958259ab07b34407c

data/.rubocop.yml

@@ -1,3 +1,4 @@
+TargetRubyVersion: 2.3
 Layout/SpaceAroundEqualsInParameterDefault:
   EnforcedStyle: no_space
 Lint/EmptyWhen:

data/lib/packetgen/header/base.rb

@@ -9,10 +9,10 @@ module PacketGen
   module Header
     # @abstract Base class for all header types.
     #    Subclasses may define magic methods:
-    #    * {#calc_checksum}, which computes header checksum,
-    #    * {#calc_length}, which computes header length,
-    #    * {#parse?},
-    #    * {#reply!}, which inverts needed fields to forge a response.
+    #    * +#calc_checksum+, which computes header checksum,
+    #    * +#calc_length+, which computes header length,
+    #    * +#parse?+,
+    #    * +#reply!+, which inverts needed fields to forge a response.
     # @author Sylvain Daubert
     class Base < Types::Fields
       # @api private

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

@@ -61,7 +61,7 @@ module PacketGen
       # DUID Based on Link-layer Address Plus Time
       # @author Sylvain Daubert
       class DUID_LLT < DUID
-        delete_field :body
+        remove_field :body
 
         # Base time for time computation
         BASE_TIME = Time.utc(2000, 1, 1)
@@ -99,7 +99,7 @@ module PacketGen
       # DUID Based on Enterprise Number
       # @author Sylvain Daubert
       class DUID_EN < DUID
-        delete_field :body
+        remove_field :body
 
         # @!attribute en
         #  32-bit entreprise number
@@ -119,7 +119,7 @@ module PacketGen
       # DUID Based on Link-layer
       # @author Sylvain Daubert
       class DUID_LL < DUID
-        delete_field :body
+        remove_field :body
 
         # @!attribute htype
         #  16-bit hardware protocol type

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

@@ -72,10 +72,6 @@ module PacketGen
         # Create an Option
         # @param [Hash] options
         def initialize(options={})
-          if self.class.const_defined?(:TYPE) && options[:type].nil?
-            options[:type] = self.class.const_get(:TYPE)
-          end
-
           options[:length] = options[:data].to_s.size if options[:data]
           super
           self.length = self.sz - 4 if options[:data].nil?
@@ -131,10 +127,8 @@ module PacketGen
       # DHCPv6 Client ID option
       # @author Sylvain Daubert
       class ClientID < Option
-        # Option type value
-        TYPE = 1
-
-        delete_field :data
+        update_field :type, default: 1
+        remove_field :data
 
         # @!attribute duid
         #  @return [DUID]
@@ -150,17 +144,14 @@ module PacketGen
       # DHCPv6 Server ID option
       # @author Sylvain Daubert
       class ServerID < ClientID
-        # Option type value
-        TYPE = 2
+        update_field :type, default: 2
       end
 
       # DHCPv6 Identity Association for Non-temporary Addresses Option
       # @author Sylvain Daubert
       class IANA < Option
-        # Option type value
-        TYPE = 3
-
-        delete_field :data
+        update_field :type, default: 3
+        remove_field :data
 
         # @!attribute iaid
         #  32-bit IAID field
@@ -190,10 +181,8 @@ module PacketGen
       # DHCPv6 Identity Association for Temporary Addresses Option
       # @author Sylvain Daubert
       class IATA < Option
-        # Option type value
-        TYPE = 4
-
-        delete_field :data
+        update_field :type, default: 4
+        remove_field :data
 
         # @!attribute iaid
         #  32-bit IAID field
@@ -215,10 +204,8 @@ module PacketGen
       # DHCPv6 IA Address option
       # @author Sylvain Daubert
       class IAAddr < Option
-        # Option type value
-        TYPE = 5
-
-        delete_field :data
+        update_field :type, default: 5
+        remove_field :data
 
         # @attribute ipv6
         #  IPv6 address
@@ -255,10 +242,8 @@ module PacketGen
       # DHCPv6 Option Request Option
       # @author Sylvain Daubert
       class ORO < Option
-        # Option type value
-        TYPE = 6
-
-        delete_field :data
+        update_field :type, default: 6
+        remove_field :data
 
         # @!attribute options
         #   @return [RequestedOptions]
@@ -284,10 +269,8 @@ module PacketGen
       # DHCPv6 Preference option
       # @author Sylvain Daubert
       class Preference < Option
-        # Option type value
-        TYPE = 7
-
-        delete_field :data
+        update_field :type, default: 7
+        remove_field :data
 
         # @!attribute value
         #  8-bit value
@@ -304,10 +287,8 @@ module PacketGen
       # DHCPv6 Elapsed Time option
       # @author Sylvain Daubert
       class ElapsedTime < Option
-        # Option type value
-        TYPE = 8
-
-        delete_field :data
+        update_field :type, default: 8
+        remove_field :data
 
         # @!attribute value
         #  16-bit value
@@ -324,17 +305,14 @@ module PacketGen
       # DHCPv6 Relay Message option
       # @author Sylvain Daubert
       class RelayMessage < Option
-        # Option type value
-        TYPE = 9
+        update_field :type, default: 9
       end
 
       # DHCPv6 Server Unicast option
       # @author Sylvain Daubert
       class ServerUnicast < Option
-        # Option type value
-        TYPE = 12
-
-        delete_field :data
+        update_field :type, default: 12
+        remove_field :data
 
         # @!attribute addr
         #  IPv6 server address
@@ -351,17 +329,14 @@ module PacketGen
       # DHCPv6 Status Code option
       # @author Sylvain Daubert
       class StatusCode < ElapsedTime
-        # Option type value
-        TYPE = 13
+        update_field :type, default: 13
       end
 
       # DHCPv6 Rapid Commit option
       # @author Sylvain Daubert
       class RapidCommit < Option
-        # Option type value
-        TYPE = 14
-
-        delete_field :data
+        update_field :type, default: 14
+        remove_field :data
       end
     end
   end

data/lib/packetgen/header/dot11.rb

@@ -222,13 +222,13 @@ module PacketGen
 
         # rubocop:disable Naming/PredicateName
 
-        # @deprecated Use {#fcs?} instead.
+        # @deprecated Use {.fcs?} instead.
         def has_fcs
           Deprecation.deprecated(self, __method__, 'fcs?', klass_method: true)
           fcs?
         end
 
-        # @deprecated Use {#fcs=} instead.
+        # @deprecated Use {.fcs=} instead.
         def has_fcs=(fcs)
           Deprecation.deprecated(self, __method__, 'fcs=', klass_method: true)
           self.fcs = fcs

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

@@ -18,10 +18,7 @@ module PacketGen
       # @author Sylvain Daubert
       # @since 2.1.4
       class FAST < TTLS
-        # @return [EAP::FAST]
-        def initialize(options={})
-          super({ type: 43 }.merge!(options))
-        end
+        update_field :type, default: 43
       end
     end
   end

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

@@ -13,7 +13,8 @@ module PacketGen
       # @author Sylvain Daubert
       # @since 2.1.4
       class MD5 < EAP
-        delete_field :body
+        update_field :type, default: 4
+        remove_field :body
 
         # @!attribute value_size
         #  @return [Integer] 8-bit value size
@@ -25,11 +26,6 @@ module PacketGen
         # @!attribute optional_name
         #  @return [::String]
         define_field :optional_name, Types::String
-
-        # @return [EAP::MD5]
-        def initialize(options={})
-          super({ type: 4 }.merge!(options))
-        end
       end
     end
   end

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

@@ -18,6 +18,7 @@ module PacketGen
       # @author Sylvain Daubert
       # @since 2.1.4
       class TLS < EAP
+        update_field :type, default: 13
         # @!attribute flags
         #  @return [Integer] 8-bit flags
         define_field_before :body, :flags, Types::Int8
@@ -44,11 +45,6 @@ module PacketGen
         define_field_before :body, :tls_length, Types::Int32,
                             optional: ->(h) { h.l? }
 
-        # @return [EAP::TLS]
-        def initialize(options={})
-          super({ type: 13 }.merge!(options))
-        end
-
         # @return [String]
         def inspect
           str = Inspect.dashed_line(self.class, 1)

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

@@ -18,6 +18,7 @@ module PacketGen
       # @author Sylvain Daubert
       # @since 2.1.4
       class TTLS < EAP
+        update_field :type, default: 21
         # @!attribute flags
         #  @return [Integer] 8-bit flags
         define_field_before :body, :flags, Types::Int8
@@ -48,11 +49,6 @@ module PacketGen
         define_field_before :body, :message_length, Types::Int32,
                             optional: ->(h) { h.l? }
 
-        # @return [EAP::TTLS]
-        def initialize(options={})
-          super({ type: 21 }.merge!(options))
-        end
-
         # @return [String]
         def inspect
           str = Inspect.dashed_line(self.class, 1)

data/lib/packetgen/header/igmpv3.rb

@@ -70,7 +70,7 @@ module PacketGen
         'MembershipReport' => 0x22,
       }.freeze
 
-      delete_field :group_addr
+      remove_field :group_addr
 
       # Encode value for IGMPv3 Max Resp Code and QQIC.
       # Value may be encoded as a float, so some error may occur.

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

@@ -528,7 +528,7 @@ module PacketGen
         # Payload type number
         PAYLOAD_TYPE = 33
 
-        delete_field :content
+        remove_field :content
 
         # @!attribute proposals
         #  Set of SA proposals

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

@@ -220,7 +220,7 @@ module PacketGen
         # Payload type number
         PAYLOAD_TYPE = 44
 
-        delete_field :content
+        remove_field :content
 
         # @!attribute num_ts
         #   8-bit Number of TSs

data/lib/packetgen/header/ip.rb

@@ -224,7 +224,7 @@ module PacketGen
       #
       # When sending packet at IP level, +checksum+ and +length+ fields are set by
       # kernel, so bad IP packets cannot be sent this way. To do so, use {Eth#to_w}.
-      # @param [String,nil] iface interface name. Not used
+      # @param [String,nil] _iface interface name. Not used
       # @return [void]
       def to_w(_iface=nil)
         sock = Socket.new(Socket::AF_INET, Socket::SOCK_RAW, Socket::IPPROTO_RAW)

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

@@ -109,8 +109,8 @@ module PacketGen
 
       # End-of-option-List IP option
       class EOL < Option
-        delete_field :length
-        delete_field :data
+        remove_field :length
+        remove_field :data
       end
 
       # No OPeration IP option
@@ -119,7 +119,7 @@ module PacketGen
 
       # Loose Source and Record Route IP option
       class LSRR < Option
-        delete_field :data
+        remove_field :data
 
         # @!attribute pointer
         #  8-bit pointer on next address
@@ -165,7 +165,7 @@ module PacketGen
 
       # Stream Identifier IP option
       class SI < Option
-        delete_field :data
+        remove_field :data
 
         # @!attribute id
         #  16-bit stream ID
@@ -175,7 +175,7 @@ module PacketGen
 
       # Router Alert IP option
       class RA < Option
-        delete_field :data
+        remove_field :data
 
         # @!attribute value
         #  16-bit value. Should be 0.

data/lib/packetgen/header/ipv6/hop_by_hop.rb

@@ -107,7 +107,7 @@ module PacketGen
       # @author Sylvain Daubert
       class HopByHop < Extension
         # redefine options field
-        delete_field :options
+        remove_field :options
         # @!attribute options
         #  Specific options of extension header
         #  @return [Options]

data/lib/packetgen/header/ospfv2/ls_ack.rb

@@ -25,7 +25,7 @@ module PacketGen
       #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
       #   |                              ...                              |
       # This paylod is implemented as a unique field: {#lsas}, which is an
-      # {ArrayOfLSAHeader} object.
+      # {ArrayOfLSA} object.
       #
       # == Create a LSAck payload
       #   # standalone
@@ -43,7 +43,7 @@ module PacketGen
       class LSAck < Base
         # @!attribute lsas
         #  Array of LSA headers
-        #  @return [ArrayOfLSAHeader]
+        #  @return [ArrayOfLSA]
         define_field :lsas, ArrayOfLSA, builder: ->(_h, t) { t.new(only_headers: true) }
       end
     end

data/lib/packetgen/header/tftp.rb

@@ -137,7 +137,7 @@ module PacketGen
 
       # TFTP Read Request header
       class RRQ < TFTP
-        delete_field :body
+        remove_field :body
 
         # @!attribute filename
         #   Filename to access
@@ -163,7 +163,7 @@ module PacketGen
 
       # TFTP ACK header
       class ACK < TFTP
-        delete_field :body
+        remove_field :body
 
         # @!attribute block_num
         #   16-bit block number
@@ -173,7 +173,7 @@ module PacketGen
 
       # TFTP ERROR header
       class ERROR < TFTP
-        delete_field :body
+        remove_field :body
 
         # @!attribute error_code
         #   16-bit error code

data/lib/packetgen/types/fields.rb

@@ -105,8 +105,11 @@ module PacketGen
       # @param [Class] klass
       # @return [void]
       def self.inherited(klass)
+        field_defs = {}
+        @field_defs.each do |k, v|
+          field_defs[k] = v.clone
+        end
         ordered = @ordered_fields.clone
-        field_defs = @field_defs.clone
         bf = @bit_fields.clone
         klass.class_eval do
           @ordered_fields = ordered
@@ -208,16 +211,43 @@ module PacketGen
         @ordered_fields[idx + 1, 0] = name
       end
 
-      # Delete a previously defined field
+      # Remove a previously defined field
       # @param [Symbol] name
       # @return [void]
-      def self.delete_field(name)
+      # @since 2.8.4
+      def self.remove_field(name)
         @ordered_fields.delete name
         @field_defs.delete name
         undef_method name
         undef_method "#{name}="
       end
 
+      # Delete a previously defined field
+      # @param [Symbol] name
+      # @return [void]
+      # @deprecated Use {.remove_field} instead.
+      # @since 2.8.4 deprecated
+      def self.delete_field(name)
+        Deprecation.deprecated(self, __method__, 'remove_field', klass_method: true)
+        remove_field name
+      end
+      # Update a previously defined field
+      # @param [Symbol] field field name to create
+      # @param [Hash] options See {.define_field}.
+      # @return [void]
+      # @see .define_field
+      # @raise [ArgumentError] unknown +field+
+      # @since 2.8.4
+      def self.update_field(field, options)
+        raise ArgumentError, "unkown #{field} field for #{self}" unless @field_defs.key?(field)
+
+        @field_defs[field][1] = options.delete(:default) if options.key?(:default)
+        @field_defs[field][2] = options.delete(:builder) if options.key?(:builder)
+        @field_defs[field][3] = options.delete(:optional) if options.key?(:optional)
+        @field_defs[field][4] = options.delete(:enum) if options.key?(:enum)
+        @field_defs[field][5].merge!(options)
+      end
+
       # Define a bitfield on given attribute
       #   class MyHeader < PacketGen::Types::Fields
       #     define_field :flags, Types::Int16
@@ -296,6 +326,20 @@ module PacketGen
         end
       end
 
+      # Remove all bit fields defined on +attr+
+      # @param [Symbol] attr attribute defining bit fields
+      # @return [void]
+      # @since 2.8.4
+      def self.remove_bit_fields_on(attr)
+        fields = @bit_fields.delete(attr)
+        return if fields.nil?
+
+        fields.each do |field, size|
+          undef_method "#{field}="
+          undef_method(size == 1 ? "#{field}?" : "#{field}")
+        end
+      end
+
       # Create a new header object
       # @param [Hash] options Keys are symbols. They should have name of object
       #   attributes, as defined by {.define_field} and by {.define_bit_fields_on}.

data/lib/packetgen/types/int_string.rb

@@ -36,7 +36,7 @@ module PacketGen
         self
       end
 
-      # @param [Integer] l
+      # @param [Integer] len
       # @return [Integer]
       def length=(len)
         @length.read len
@@ -48,7 +48,7 @@ module PacketGen
         @length.to_i
       end
 
-      # @param [#to_s] s
+      # @param [#to_s] str
       # @return [String]
       def string=(str)
         @length.value = str.to_s.size

data/lib/packetgen/utils.rb

@@ -74,7 +74,7 @@ module PacketGen
     # @note This method is provided for test purpose.
     # For more control, see {ARPSpoofer} class.
     # @param [String] target_ip target IP address
-    # @param [String] spoofed_ip IP address to spoofed_ip
+    # @param [String] spoofed_ip IP address to spoof
     # @param [Hash] options
     # @option options [String] :mac MAC address used to poison target
     #   ARP cache. Default to local MAC address.
@@ -87,7 +87,7 @@ module PacketGen
     # @return [void]
     def self.arp_spoof(target_ip, spoofed_ip, options={})
       interval = options[:interval] || 1.0
-      as = ARPSpoofer.new(for_seconds: options[:for_seconds], interval: interval,
+      as = ARPSpoofer.new(timeout: options[:for_seconds], interval: interval,
                           iface: options[:iface])
       as.start(target_ip, spoofed_ip, mac: options[:mac])
       as.wait
@@ -122,6 +122,9 @@ module PacketGen
     def self.mitm(target1, target2, options={})
       options = { iface: PacketGen.default_iface }.merge(options)
 
+      mac1 = arp(target1)
+      mac2 = arp(target2)
+
       spoofer = Utils::ARPSpoofer.new(options)
       spoofer.add target1, target2, options
       spoofer.add target2, target1, options
@@ -138,7 +141,21 @@ module PacketGen
       spoofer.start_all
       capture.start do |pkt|
         modified_pkt = yield pkt
-        modified_pkt.ip.to_w(options[:iface])
+        iph = modified_pkt.ip
+        l2 = modified_pkt.is?('Dot11') ? modified_pkt.dot11 : modified_pkt.eth
+
+        if (iph.dst != my_ip) && (iph.src != my_ip)
+          if (iph.src == target1)  || (iph.dst == target2)
+            l2.dst = mac2
+          elsif (iph.src == target2) ||(iph.dst == target1)
+            l2.dst = mac1
+          else
+            next
+          end
+        else
+          next
+        end
+        modified_pkt.to_w(options[:iface])
       end
     end
   end

data/lib/packetgen/version.rb

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

metadata

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