packetgen 2.6.0 → 2.7.0

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

@@ -8,11 +8,9 @@
 module PacketGen
   module Header
     class DNS
-
       # DNS option
       # @author Sylvain Daubert
       class Option < Types::TLV
-
         # Force {#type} and {#length} fields to be {Types::Int16}
         # @see TLV#initialize
         def initialize(options={})

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

@@ -8,7 +8,6 @@
 module PacketGen
   module Header
     class DNS
-
       # Define a DNS Question Section
       # @author Sylvain Daubert
       class QDSection < RRSection
@@ -32,7 +31,7 @@ module PacketGen
           clear
           return self if str.nil?
           force_binary str
-          while str.length > 0 and self.size < @counter.to_i
+          while !str.empty? && (self.size < @counter.to_i)
             question = Question.new(@dns).read(str)
             str.slice!(0, question.sz)
             self.push question

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

@@ -8,11 +8,9 @@
 module PacketGen
   module Header
     class DNS
-
       # DNS Question
       # @author Sylvain Daubert
       class Question < Base
-
         # Ressource Record types
         TYPES = {
           'A'        => 1,
@@ -84,12 +82,12 @@ module PacketGen
         # @param [Integer] val
         # @return [Integer,String]
         def rrclass=(val)
-              v = case val
-                  when String
-                    self.class::CLASSES[val.upcase]
-                  else
-                    val
-                  end
+          v = case val
+              when String
+                self.class::CLASSES[val.upcase]
+              else
+                val
+              end
           raise ArgumentError, "unknown class #{val.inspect}" unless v
           self[:rrclass].read v
         end
@@ -97,30 +95,38 @@ module PacketGen
         # Check type
         # @param [String] type name
         # @return [Boolean]
-        def has_type?(type)
+        # @since 2.7.0
+        def type?(type)
           self.class::TYPES[type] == self.type
         end
 
+        # @deprecated Use {#type?} instead
+        # @return [Boolean]
+        def has_type?(type)
+          Deprecation.deprecated(self.class, __method__, 'type?')
+          type?(type)
+        end
+
         # Get human readable type
         # @return [String]
         def human_type
-          self.class::TYPES.key(type) || "0x%04x" % type
+          self.class::TYPES.key(type) || '0x%04x' % type
         end
 
         # Get human readable class
         # @return [String]
         def human_rrclass
           if self[:name].dns.is_a? MDNS
-            self.class::CLASSES.key(self.rrclass & 0x7fff) || "0x%04x" % (self.rrclass & 0x7fff)
+            self.class::CLASSES.key(self.rrclass & 0x7fff) || '0x%04x' % (self.rrclass & 0x7fff)
           else
-            self.class::CLASSES.key(self.rrclass) || "0x%04x" % self.rrclass
+            self.class::CLASSES.key(self.rrclass) || '0x%04x' % self.rrclass
           end
         end
 
         # @return [String]
         def to_human
           if self[:name].dns.is_a? MDNS
-            unicast_bit = (self.rrclass & 0x8000 == 0x8000) ? 'QU' : 'QM'
+            unicast_bit = self.rrclass & 0x8000 == 0x8000 ? 'QU' : 'QM'
             "#{human_type} #{human_rrclass} #{unicast_bit} #{name}"
           else
             "#{human_type} #{human_rrclass} #{name}"

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

@@ -8,11 +8,9 @@
 module PacketGen
   module Header
     class DNS
-
       # DNS Ressource Record
       # @author Sylvain Daubert
       class RR < Question
-
         # @!attribute ttl
         #  32-bit time to live
         #  @return [Integer]
@@ -37,9 +35,8 @@ module PacketGen
         # @option options [String] :rdata
         def initialize(dns, options={})
           super
-          if options[:rdata] and options[:rdlength].nil?
-            self.rdata = options[:rdata]
-          end
+          return unless options[:rdata] && options[:rdlength].nil?
+          self.rdata = options[:rdata]
         end
 
         # Set rdata and rdlength from +data+
@@ -49,7 +46,7 @@ module PacketGen
           self[:rdlength].read data.size
           self[:rdata].read data
         end
-        
+
         # Get human readable rdata
         # @return [String]
         def human_rdata
@@ -71,11 +68,11 @@ module PacketGen
           when TYPES['SOA']
             mname = name.read(self[:rdata]).dup
             rname = name.read(self[:rdata][mname.sz..-1])
-            serial = Types::Int32.new.read(self[:rdata][mname.sz+rname.sz, 4])
-            refresh = Types::Int32.new.read(self[:rdata][mname.sz+rname.sz+4, 4])
-            retryi = Types::Int32.new.read(self[:rdata][mname.sz+rname.sz+8, 4])
-            expire = Types::Int32.new.read(self[:rdata][mname.sz+rname.sz+12, 4])
-            minimum = Types::Int32.new.read(self[:rdata][mname.sz+rname.sz+16, 4])
+            serial = Types::Int32.new.read(self[:rdata][mname.sz + rname.sz, 4])
+            refresh = Types::Int32.new.read(self[:rdata][mname.sz + rname.sz + 4, 4])
+            retryi = Types::Int32.new.read(self[:rdata][mname.sz + rname.sz + 8, 4])
+            expire = Types::Int32.new.read(self[:rdata][mname.sz + rname.sz + 12, 4])
+            minimum = Types::Int32.new.read(self[:rdata][mname.sz + rname.sz + 16, 4])
             str = "#{mname.to_human} #{rname.to_human} #{serial.to_i} #{refresh.to_i} " \
                   "#{retryi.to_i} #{expire.to_i} #{minimum.to_i}"
           when TYPES['MX']
@@ -93,15 +90,15 @@ module PacketGen
           str
         end
 
-        def human_rrclass
         # Get human readable class
         # @return [String]
+        def human_rrclass
           if self[:name].dns.is_a? MDNS
-            str = self.class::CLASSES.key(self.rrclass & 0x7fff) || "0x%04x" % (self.rrclass & 0x7fff)
+            str = self.class::CLASSES.key(self.rrclass & 0x7fff) || '0x%04x' % (self.rrclass & 0x7fff)
             str += ' CACHE-FLUSH' if self.rrclass & 0x8000 > 0
             str
           else
-            self.class::CLASSES.key(self.rrclass) || "0x%04x" % self.rrclass
+            self.class::CLASSES.key(self.rrclass) || '0x%04x' % self.rrclass
           end
         end
 

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

@@ -8,17 +8,15 @@
 module PacketGen
   module Header
     class DNS
-
       # Define a DNS Ressource Record Section
       # @author Sylvain Daubert
       class RRSection < Types::Array
-
         # @api private
         # @param [DNS] dns
         # @param [Types::Int] counter
         def initialize(dns, counter)
+          super(counter: counter)
           @dns = dns
-          @counter = counter
         end
 
         # Read RR section from a string
@@ -28,11 +26,11 @@ module PacketGen
           clear
           return self if str.nil?
           force_binary str
-          while str.length > 0 and self.size < @counter.to_i
+          while !str.empty? && (self.size < @counter.to_i)
             rr = RR.new(@dns).read(str)
-            rr = OPT.new(@dns).read(str) if rr.has_type?('OPT')
+            rr = OPT.new(@dns).read(str) if rr.type?('OPT')
             str.slice!(0, rr.sz)
-            self.push rr
+            push rr
           end
           self
         end
@@ -40,7 +38,7 @@ module PacketGen
         private
 
         def record_from_hash(hsh)
-          if hsh.has_key? :rtype
+          if hsh.key? :rtype
             case hsh.delete(:rtype)
             when 'Question'
               Question.new(@dns, hsh)

data/lib/packetgen/header/dot11.rb

@@ -5,13 +5,14 @@
 # This program is published under MIT license.
 
 # frozen_string_literal: true
+
 require 'zlib'
 
 module PacketGen
   module Header
-
     # PPI (Per-Packet Information) packet
-    #@author Sylvain Daubert
+    # @author Sylvain Daubert
+    # @since 1.4.0
     class PPI < Base
       # @!attribute version
       #  @return [Integer] 8-bit PPI version
@@ -52,7 +53,7 @@ module PacketGen
       # Check version field
       # @see [Base#parse?]
       def parse?
-        version == 0 and length >= 8
+        version.zero? && (length >= 8)
       end
 
       # Calculate header length
@@ -76,6 +77,7 @@ module PacketGen
 
     # Radiotap header (see http://www.radiotap.org/)
     # @author Sylvain Daubert
+    # @since 1.4.0
     class RadioTap < Base
       # @!attribute version
       #  @return [Integer] 8-bit version
@@ -113,9 +115,9 @@ module PacketGen
       # Check version field
       # @see [Base#parse?]
       def parse?
-        version == 0 and length >= 8
+        version.zero? && (length >= 8)
       end
-      
+
       # Calculate header length
       # @return [Integer] calculated length
       # @since 2.1.3
@@ -204,18 +206,34 @@ module PacketGen
     #   pkt.calc
     #   pkt.to_w('wlan0')
     # @author Sylvain Daubert
+    # @since 1.4.0
     class Dot11 < Base
-
       # Frame types
-      TYPES = %w(Management Control Data Reserved).freeze
+      TYPES = %w[Management Control Data Reserved].freeze
 
       class << self
         # Set a flag for parsing Dot11 packets. If set to +true+, parse FCS field,
         # else don't. Default is +true+.
         # @return [Boolean]
-        attr_accessor :has_fcs
+        attr_accessor :fcs
+        alias fcs? fcs
+
+        # rubocop:disable Naming/PredicateName
+
+        # @deprecated Use {#fcs?} instead.
+        def has_fcs
+          Deprecation.deprecated(self, __method__, 'fcs?', klass_method: true)
+          fcs?
+        end
+
+        # @deprecated Use {#fcs=} instead.
+        def has_fcs=(fcs)
+          Deprecation.deprecated(self, __method__, 'fcs=', klass_method: true)
+          self.fcs = fcs
+        end
+        # rubocop:enable Naming/PredicateName
       end
-      Dot11.has_fcs = true
+      Dot11.fcs = true
 
       # @!attribute frame_ctrl
       #  @return [Integer] 16-bit frame control word
@@ -273,9 +291,8 @@ module PacketGen
       #  @return [Boolean] from_ds flag from {#frame_ctrl}
       # @!attribute to_ds
       #  @return [Boolean] to_ds flag from {#frame_ctrl}
-      define_bit_fields_on :frame_ctrl,  :subtype, 4, :type, 2, :proto_version, 2,
-                            :order, :wep, :md, :pwmngt, :retry, :mf, :from_ds, :to_ds
-
+      define_bit_fields_on :frame_ctrl, :subtype, 4, :type, 2, :proto_version, 2,
+                           :order, :wep, :md, :pwmngt, :retry, :mf, :from_ds, :to_ds
 
       # @!attribute sequence_number (12-bit field from {#sequence_ctrl})
       #  @return [Integer]
@@ -310,7 +327,7 @@ module PacketGen
       # @return [Dot11] may return a subclass object if a more specific class
       #   may be determined
       def read(str)
-        has_fcs = Dot11.has_fcs
+        fcs = Dot11.fcs?
 
         if self.class == Dot11
           return self if str.nil?
@@ -325,10 +342,10 @@ module PacketGen
           when 2
             Dot11::Data.new.read str
           else
-            private_read str, has_fcs
+            private_read str, fcs
           end
         else
-          private_read str, has_fcs
+          private_read str, fcs
         end
       end
 
@@ -359,7 +376,7 @@ module PacketGen
               elsif self.respond_to? :human_subtype
                 Inspect.dashed_line("#{self.class} #{human_subtype}", 2)
               else
-                Inspect.dashed_line("#{self.class}", 2)
+                Inspect.dashed_line(self.class.to_s, 2)
               end
         define_applicable_fields
         @applicable_fields.each do |attr|
@@ -378,25 +395,24 @@ module PacketGen
         pcap.inject self.to_s
         pcap.close
       end
-      
+
       # Callback called when a Dot11 header is added to a packet
       # Here, add +#dot11+ method as a shortcut to existing
       # +#dot11_(control|management|data)+.
       # @param [Packet] packet
       # @return [void]
       def added_to_packet(packet)
-        unless packet.respond_to? :dot11
-          packet.instance_eval("def dot11(arg=nil); header(#{self.class}, arg); end")
-        end
+        return if packet.respond_to? :dot11
+        packet.instance_eval("def dot11(arg=nil); header(#{self.class}, arg); end")
       end
 
       private
 
       def define_applicable_fields
-        if to_ds? and from_ds?
+        if to_ds? && from_ds?
           @applicable_fields[6, 0] = :mac4 unless @applicable_fields.include? :mac4
         else
-          @applicable_fields -= %i(mac4)
+          @applicable_fields -= %i[mac4]
         end
         if order?
           unless @applicable_fields.include? :ht_ctrl
@@ -404,19 +420,19 @@ module PacketGen
             @applicable_fields[idx, 0] = :ht_ctrl
           end
         else
-          @applicable_fields -= %i(ht_ctrl)
+          @applicable_fields -= %i[ht_ctrl]
         end
-        if Dot11.has_fcs
+        if Dot11.fcs?
           @applicable_fields << :fcs unless @applicable_fields.include? :fcs
         else
-          @applicable_fields -= %i(fcs)
+          @applicable_fields -= %i[fcs]
         end
       end
 
-      def private_read(str, has_fcs)
+      def private_read(str, fcs)
         self[:frame_ctrl].read str[0, 2]
         define_applicable_fields
-        if has_fcs
+        if fcs
           old_read str[0...-4]
           self[:fcs].read str[-4..-1]
         else
@@ -427,8 +443,8 @@ module PacketGen
     end
 
     self.add_class Dot11
-    PPI.bind_header Dot11, dlt: PcapNG::LINKTYPE_IEEE802_11
-    RadioTap.bind_header Dot11
+    PPI.bind Dot11, dlt: PcapNG::LINKTYPE_IEEE802_11
+    RadioTap.bind Dot11
   end
 end
 

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

@@ -9,7 +9,6 @@
 module PacketGen
   module Header
     class Dot11
-
       # IEEE 802.11 control frame header
       #
       # This class make a {Dot11} header with {#type} set to +1+
@@ -24,7 +23,6 @@ module PacketGen
       # * and a Frame check sequence ({#fcs}, of type {Types::Int32le}).
       # @author Sylvain Daubert
       class Control < Dot11
-
         # Control subtypes
         SUBTYPES = {
           7  => 'Wrapper',
@@ -44,8 +42,8 @@ module PacketGen
         # @param [Hash] options
         # @see Base#initialize
         def initialize(options={})
-          super({type: 1}.merge!(options))
-          @applicable_fields -= %i(mac3 sequence_ctrl mac4 qos_ctrl ht_ctrl)
+          super({ type: 1 }.merge!(options))
+          @applicable_fields -= %i[mac3 sequence_ctrl mac4 qos_ctrl ht_ctrl]
           define_applicable_fields
         end
 
@@ -60,7 +58,7 @@ module PacketGen
         def define_applicable_fields
           super
           if @applicable_fields.include? :mac2
-            @applicable_fields -= %i(mac2) unless SUBTYPES_WITH_MAC2.include? self.subtype
+            @applicable_fields -= %i[mac2] unless SUBTYPES_WITH_MAC2.include? self.subtype
           elsif SUBTYPES_WITH_MAC2.include? self.subtype
             @applicable_fields[3, 0] = :mac2
           end

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

@@ -9,7 +9,6 @@
 module PacketGen
   module Header
     class Dot11
-
       # IEEE 802.11 data frame header
       #
       # This class make a {Dot11} header with {#type} set to +2+
@@ -27,20 +26,49 @@ module PacketGen
       # * and a Frame check sequence ({#fcs}, of type {Types::Int32le}).
       # @author Sylvain Daubert
       class Data < Dot11
-
         # @param [Hash] options
         # @see Base#initialize
         def initialize(options={})
-          super({type: 2}.merge!(options))
-          @applicable_fields -= %i(mac4 qos_ctrl ht_ctrl)
+          super({ type: 2 }.merge!(options))
+          @applicable_fields -= %i[mac4 qos_ctrl ht_ctrl]
           define_applicable_fields
         end
 
+        # Invert source and destination addresses (see Table 8-19 from
+        # IEEE 802.11-2012 document to known which MAC is SA, and which
+        # one is DA).
+        # Also invert Receiver and Transmitter address in case ToDS and
+        # FromDS are true.
+        def reply!
+          ds = frame_ctrl & 3
+          case ds
+          when 0
+            # MAC1: RA/DA, MAC2: TA/SA
+            self[:mac1], self[:mac2] = self[:mac2], self[:mac1]
+          when 1
+            # MAC1: RA/BSSID, MAC2: TA/SA, MAC3: DA
+            self[:mac2], self[:mac1] = self[:mac1], self[: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]
+            self.to_ds = true
+            self.from_ds = false
+          when 3
+            # MAC1: RA, MAC2: TA
+            self[:mac1], self[:mac2] = self[:mac2], self[:mac1]
+            # MAC3: DA, MAC4: SA
+            self[:mac4], self[:mac3] = self[:mac3], self[:mac4]
+          end
+          self
+        end
+
         private
 
         def define_applicable_fields
           super
-          if subtype >= 8 and !@applicable_fields.include? :qos_ctrl
+          if (subtype >= 8) && !@applicable_fields.include?(:qos_ctrl)
             # Insert after mac4, if present
             # else insert after sequence_ctrl
             if @applicable_fields.include? :mac4
@@ -50,7 +78,7 @@ module PacketGen
               @applicable_fields[6, 0] = :qos_ctrl
             end
           elsif subtype < 8
-            @applicable_fields -= %i(qos_ctrl)
+            @applicable_fields -= %i[qos_ctrl]
           end
         end
       end