packetgen 3.1.1 → 3.1.6

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

@@ -1,10 +1,10 @@
+# frozen_string_literal: true
+
 # 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
   module Header
     class DNS
@@ -98,7 +98,7 @@ module PacketGen
         def human_rrclass
           if self[:name].dns.is_a? MDNS
             str = self.class::CLASSES.key(self.rrclass & 0x7fff) || '0x%04x' % (self.rrclass & 0x7fff)
-            str += ' CACHE-FLUSH' if self.rrclass & 0x8000 > 0
+            str += ' CACHE-FLUSH' if (self.rrclass & 0x8000).positive?
             str
           else
             self.class::CLASSES.key(self.rrclass) || '0x%04x' % self.rrclass

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

@@ -1,10 +1,10 @@
+# frozen_string_literal: true
+
 # 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
   module Header
     class DNS

data/lib/packetgen/header/dot11.rb

@@ -1,11 +1,11 @@
 # coding: utf-8
+# frozen_string_literal: true
+
 # 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
-
 require 'zlib'
 
 module PacketGen
@@ -28,7 +28,7 @@ module PacketGen
       define_field :dlt, Types::Int32le
       # @!attribute ppi_fields
       #  @return [Type::String] concatenation of PPI fields
-      define_field :ppi_fields, Types::String
+      define_field :ppi_fields, Types::String, builder: ->(h, t) { t.new(length_from: -> { h.length - 8 }) }
       # @!attribute body
       #  @return [Type::String]
       define_field :body, Types::String
@@ -36,21 +36,6 @@ module PacketGen
       #  @return [Boolean] align flag from {#flags} attribute
       define_bit_fields_on :flags, :reserved, 7, :align
 
-      # @param [String] str
-      # @return [PPI] self
-      def read(str)
-        return self if str.nil?
-
-        force_binary str
-        self[:version].read str[0, 1]
-        self[:flags].read str[1, 1]
-        self[:length].read str[2, 2]
-        self[:dlt].read str[4, 4]
-        self[:ppi_fields].read str[8, length - 8]
-        self[:body].read str[length, str.size]
-        self
-      end
-
       # Check version field
       # @see [Base#parse?]
       def parse?
@@ -68,9 +53,7 @@ module PacketGen
       # @param [String] iface interface name
       # @return [void]
       def to_w(iface)
-        pcap = PCAPRUB::Pcap.open_live(iface, PCAP_SNAPLEN, PCAP_PROMISC, PCAP_TIMEOUT)
-        pcap.inject self.to_s
-        pcap.close
+        Inject.inject(iface: iface, data: self)
       end
     end
     self.add_class PPI
@@ -93,26 +76,11 @@ module PacketGen
       define_field :present_flags, Types::Int32le
       # @!attribute radio_fields
       #  @return [Type::String] concatenation of RadioTap fields
-      define_field :radio_fields, Types::String
+      define_field :radio_fields, Types::String, builder: ->(h, t) { t.new(length_from: -> { h.length - 8 }) }
       # @!attribute body
       #  @return [Type::String]
       define_field :body, Types::String
 
-      # @param [String] str
-      # @return [RadioTap] self
-      def read(str)
-        return self if str.nil?
-
-        force_binary str
-        self[:version].read str[0, 1]
-        self[:pad].read str[1, 1]
-        self[:length].read str[2, 2]
-        self[:present_flags].read str[4, 4]
-        self[:radio_fields].read str[8, length - 8]
-        self[:body].read str[length, str.size]
-        self
-      end
-
       # Check version field
       # @see [Base#parse?]
       def parse?
@@ -130,10 +98,7 @@ module PacketGen
       # @param [String] iface interface name
       # @return [void]
       def to_w(iface)
-        pcap = PCAPRUB::Pcap.open_live(iface, PCAP_SNAPLEN, PCAP_PROMISC,
-                                       PCAP_TIMEOUT)
-        pcap.inject self.to_s
-        pcap.close
+        Inject.inject(iface: iface, data: self)
       end
     end
     self.add_class RadioTap
@@ -315,7 +280,7 @@ module PacketGen
       def read(str)
         fcs = Dot11.fcs?
 
-        if self.class == Dot11
+        if self.instance_of? Dot11
           return self if str.nil?
 
           force_binary str
@@ -358,7 +323,7 @@ module PacketGen
 
       # @return [String]
       def inspect
-        str = if self.class == Dot11
+        str = if self.instance_of? Dot11
                 Inspect.dashed_line("#{self.class} #{human_type}", 1)
               elsif self.respond_to? :human_subtype
                 Inspect.dashed_line("#{self.class} #{human_subtype}", 1)
@@ -379,10 +344,7 @@ module PacketGen
       # @param [String] iface interface name
       # @return [void]
       def to_w(iface)
-        pcap = PCAPRUB::Pcap.open_live(iface, PCAP_SNAPLEN, PCAP_PROMISC,
-                                       PCAP_TIMEOUT)
-        pcap.inject self.to_s
-        pcap.close
+        Inject.inject(iface: iface, data: self)
       end
 
       # Callback called when a Dot11 header is added to a packet
@@ -398,27 +360,44 @@ module PacketGen
 
       private
 
-      def define_applicable_fields
+      def remove_from_applicable_fields(fields)
+        fields = [fields] unless fields.is_a? Array
+        @applicable_fields -= fields
+      end
+
+      def handle_mac4
         if to_ds? && from_ds?
           @applicable_fields[6, 0] = :mac4 unless @applicable_fields.include? :mac4
         else
-          @applicable_fields -= %i[mac4]
+          remove_from_applicable_fields :mac4
         end
+      end
+
+      def handle_ht_ctrl
         if order?
           unless @applicable_fields.include? :ht_ctrl
             idx = @applicable_fields.index(:body)
             @applicable_fields[idx, 0] = :ht_ctrl
           end
         else
-          @applicable_fields -= %i[ht_ctrl]
+          remove_from_applicable_fields %i[ht_ctrl]
         end
+      end
+
+      def handle_fcs
         if Dot11.fcs?
           @applicable_fields << :fcs unless @applicable_fields.include? :fcs
         else
-          @applicable_fields -= %i[fcs]
+          remove_from_applicable_fields :fcs
         end
       end
 
+      def define_applicable_fields
+        handle_mac4
+        handle_ht_ctrl
+        handle_fcs
+      end
+
       def private_read(str, fcs)
         self[:frame_ctrl].read str[0, 2]
         define_applicable_fields

data/lib/packetgen/header/dot11/control.rb

@@ -1,11 +1,11 @@
 # coding: utf-8
+# frozen_string_literal: true
+
 # 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
   module Header
     class Dot11
@@ -25,9 +25,9 @@ module PacketGen
       class Control < Dot11
         # Control subtypes
         SUBTYPES = {
-          7  => 'Wrapper',
-          8  => 'Block Ack Request',
-          9  => 'Block Ack',
+          7 => 'Wrapper',
+          8 => 'Block Ack Request',
+          9 => 'Block Ack',
           10 => 'PS-Poll',
           11 => 'RTS',
           12 => 'CTS',

data/lib/packetgen/header/dot11/data.rb

@@ -1,11 +1,11 @@
 # coding: utf-8
+# frozen_string_literal: true
+
 # 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
   module Header
     class Dot11
@@ -44,22 +44,22 @@ module PacketGen
           case ds
           when 0
             # MAC1: RA/DA, MAC2: TA/SA
-            self[:mac1], self[:mac2] = self[:mac2], self[:mac1]
+            invert_mac :mac1, :mac2
           when 1
             # MAC1: RA/BSSID, MAC2: TA/SA, MAC3: DA
-            self[:mac2], self[:mac1] = self[:mac1], self[:mac2]
+            invert_mac :mac1, :mac2
             self.to_ds = false
             self.from_ds = true
           when 2
             # MAC1: RA/DA, MAC2: BSSID, MAC3: SA or BSSID
-            self[:mac1], self[:mac2] = self[:mac2], self[:mac1]
+            invert_mac :mac1, :mac2
             self.to_ds = true
             self.from_ds = false
           when 3
             # MAC1: RA, MAC2: TA
-            self[:mac1], self[:mac2] = self[:mac2], self[:mac1]
+            invert_mac :mac1, :mac2
             # MAC3: DA, MAC4: SA
-            self[:mac4], self[:mac3] = self[:mac3], self[:mac4]
+            invert_mac :mac3, :mac4
           end
           self
         end
@@ -135,6 +135,10 @@ module PacketGen
             @applicable_fields -= %i[qos_ctrl]
           end
         end
+
+        def invert_mac(mac1, mac2)
+          self[mac1], self[mac2] = self[mac2], self[mac1]
+        end
       end
     end
   end

data/lib/packetgen/header/dot11/element.rb

@@ -1,11 +1,11 @@
 # coding: utf-8
+# frozen_string_literal: true
+
 # 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
   module Header
     class Dot11
@@ -22,20 +22,20 @@ module PacketGen
       class Element
         # Known element types
         TYPES = {
-          0 =>   'SSID',
-          1 =>   'Rates',
-          2 =>   'FHset',
-          3 =>   'DSset',
-          4 =>   'CFset',
-          5 =>   'TIM',
-          6 =>   'IBSSset',
-          16 =>  'challenge',
-          42 =>  'ERPinfo',
-          46 =>  'QoS Cap.',
-          47 =>  'ERPinfo',
-          48 =>  'RSNinfo',
-          50 =>  'ESRates',
-          68 =>  'reserved',
+          0 => 'SSID',
+          1 => 'Rates',
+          2 => 'FHset',
+          3 => 'DSset',
+          4 => 'CFset',
+          5 => 'TIM',
+          6 => 'IBSSset',
+          16 => 'challenge',
+          42 => 'ERPinfo',
+          46 => 'QoS Cap.',
+          47 => 'ERPinfo',
+          48 => 'RSNinfo',
+          50 => 'ESRates',
+          68 => 'reserved',
           221 => 'vendor'
         }.freeze
       end

data/lib/packetgen/header/dot11/management.rb

@@ -1,11 +1,11 @@
 # coding: utf-8
+# frozen_string_literal: true
+
 # 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
   module Header
     class Dot11

data/lib/packetgen/header/dot11/sub_mngt.rb

@@ -1,11 +1,11 @@
 # coding: utf-8
+# frozen_string_literal: true
+
 # 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
   module Header
     class Dot11
@@ -21,16 +21,6 @@ module PacketGen
         # @return [Array<Element>]
         define_field :elements, ArrayOfElements
 
-        # @return [String]
-        #def inspect
-        #  str = super
-        #  str << Inspect.dashed_line('Dot11 Elements', 2)
-        #  @elements.each do |el|
-        #    str << Inspect.shift_level(2) << el.to_human << "\n"
-        #  end
-        #  str
-        #end
-
         # Add an {Element} to header
         # @param [Integer,String] type element type
         # @param [Object] value element value

data/lib/packetgen/header/dot1q.rb

@@ -1,10 +1,10 @@
+# frozen_string_literal: true
+
 # 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
   module Header
     # IEEE 802.1Q VLAN tagging

data/lib/packetgen/header/dot1x.rb

@@ -1,10 +1,10 @@
+# frozen_string_literal: true
+
 # 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
   module Header
     # IEEE 802.1X / EAPOL
@@ -27,10 +27,10 @@ module PacketGen
 
       # IEEE 802.1X packet types
       TYPES = {
-        'EAP Packet'      => 0,
-        'Start'           => 1,
-        'Logoff'          => 2,
-        'Key'             => 3,
+        'EAP Packet' => 0,
+        'Start' => 1,
+        'Logoff' => 2,
+        'Key' => 3,
         'Encap-ASF-Alert' => 4
       }.freeze
 
@@ -45,20 +45,7 @@ module PacketGen
       define_field :length, Types::Int16
       # @!attribute body
       #  @return [Types::String,Header::Base]
-      define_field :body, Types::String
-
-      # Populate object from string
-      # @param [String] str
-      # @return [self]
-      def read(str)
-        return self if str.nil?
-
-        self[:version].read(str[0, 1])
-        self[:type].read(str[1, 1])
-        self[:length].read(str[2, 2])
-        self[:body].read(str[4, self.length])
-        self
-      end
+      define_field :body, Types::String, builder: ->(h, t) { t.new(length_from: h[:length]) }
 
       # Get human readable type
       # @return [String]

data/lib/packetgen/header/eap.rb

@@ -1,10 +1,10 @@
+# frozen_string_literal: true
+
 # 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
   module Header
     # Extensible Authentication Protocol (EAP),
@@ -58,25 +58,25 @@ module PacketGen
     class EAP < Base
       # EAP known codes
       CODES = {
-        'Request'   => 1,
-        'Response'  => 2,
-        'Success'   => 3,
-        'Failure'   => 4
+        'Request' => 1,
+        'Response' => 2,
+        'Success' => 3,
+        'Failure' => 4
       }.freeze
 
       # EAP known request/response types
       TYPES = {
-        'Identity'           => 1,
-        'Notification'       => 2,
-        'Nak'                => 3,
-        'MD5-Challenge'      => 4,
-        'One Time Password'  => 5,
+        'Identity' => 1,
+        'Notification' => 2,
+        'Nak' => 3,
+        'MD5-Challenge' => 4,
+        'One Time Password' => 5,
         'Generic Token Card' => 6,
-        'EAP-TLS'            => 13,
-        'EAP-TTLS'           => 21,
-        'EAP-FAST'           => 43,
-        'Expanded Types'     => 254,
-        'Experimental Use'   => 255
+        'EAP-TLS' => 13,
+        'EAP-TTLS' => 21,
+        'EAP-FAST' => 43,
+        'Expanded Types' => 254,
+        'Experimental Use' => 255
       }.freeze
 
       # @!attribute code
@@ -95,7 +95,8 @@ module PacketGen
       #  This field is present only for Request or Response packets,
       #  with type different from Expanded Types (254).
       #  @return [Integer] 8-bit request or response type
-      define_field :type, Types::Int8Enum, enum: TYPES,
+      define_field :type, Types::Int8Enum,
+                   enum: TYPES,
                    optional: ->(eap) { eap.type? }
 
       # @!attribute vendor_id
@@ -131,22 +132,18 @@ module PacketGen
       #   may be determined
       def read(str)
         super str
-        return self unless self.class == EAP
-
-        if type?
-          obj = case self.type
-                when 4
-                  EAP::MD5.new.read(str)
-                when 13
-                  EAP::TLS.new.read(str)
-                when 21
-                  EAP::TTLS.new.read(str)
-                when 43
-                  EAP::FAST.new.read(str)
-                else
-                  self
-                end
-          obj
+        return self unless self.instance_of?(EAP)
+        return self unless type?
+
+        case self.type
+        when 4
+          EAP::MD5.new.read(str)
+        when 13
+          EAP::TLS.new.read(str)
+        when 21
+          EAP::TTLS.new.read(str)
+        when 43
+          EAP::FAST.new.read(str)
         else
           self
         end