packetgen 2.8.7 → 3.0.0

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

@@ -56,9 +56,6 @@ module PacketGen
         74 => ['IRC_server', length: 4, v: IP::Addr]
       }.freeze
 
-      # @deprecated Use {DHCP_OPTIONS} instead.
-      DCHPOptions = DHCP_OPTIONS
-
       # Class to indicate DHCP options end
       class End < Types::Int8
         def initialize(value=255)
@@ -98,9 +95,10 @@ module PacketGen
         def initialize(options={})
           super
           return unless DHCP_OPTIONS.key?(self.type)
-          h = DHCP_OPTIONS[self.type].last
 
+          h = DHCP_OPTIONS[self.type].last
           return unless h.is_a? Hash
+
           h.each do |k, v|
             self.length = v if k == :length
             if k == :v
@@ -135,13 +133,8 @@ module PacketGen
           true
         end
 
-        # @deprecated Use {#human_types?} instead
-        # @return [true]
-        def has_human_types?
-          Deprecation.deprecated(self.class, __method__, 'human_types?')
-          human_types?
-        end
-
+        # Get human-readable type
+        # @return [String]
         def human_type
           if DHCP_OPTIONS.key?(type)
             DHCP_OPTIONS[type].first.dup
@@ -150,6 +143,7 @@ module PacketGen
           end
         end
 
+        # @return [String]
         def to_human
           s = human_type
           if length > 0

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

@@ -78,6 +78,8 @@ module PacketGen
         #  @return [Eth::MacAddr]
         define_field :link_addr, Eth::MacAddr
 
+        undef time, time=
+
         # @return [Time]
         def time
           BASE_TIME + self[:time].to_i

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

@@ -36,10 +36,12 @@ module PacketGen
           # @return [Hash]
           def subclasses
             return @klasses if defined? @klasses
+
             @klasses = []
             DHCPv6.constants.each do |cst|
               klass = DHCPv6.const_get(cst)
               next unless klass.is_a?(Class) && (klass < Option)
+
               @klasses[klass.new.type] = klass
             end
             @klasses
@@ -80,25 +82,6 @@ module PacketGen
         alias private_read read
         private :private_read
 
-        # Populate object from binary string
-        # @param [String] str
-        # @return [Option]
-        def read(str)
-          if self.class == Option
-            return self if str.nil?
-            PacketGen.force_binary str
-            type = Types::Int16.new.read(str).to_i
-            klass = Option.subclasses[type]
-            if klass
-              klass.new.read(str)
-            else
-              private_read str
-            end
-          else
-            private_read str
-          end
-        end
-
         # Get human-readable {#type}
         # @return [String]
         def human_type

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

@@ -23,6 +23,13 @@ module PacketGen
 
         # Separator used in {#to_human}.
         HUMAN_SEPARATOR = ';'
+
+        private
+
+        def real_type(opt)
+          real_klass = Option.subclasses[opt.type]
+          real_klass.nil? ? Option : real_klass
+        end
       end
     end
   end

data/lib/packetgen/header/dns.rb

@@ -97,12 +97,12 @@ module PacketGen
   end
 end
 
-require_relative 'dns/rrsection'
-require_relative 'dns/qdsection'
 require_relative 'dns/name'
 require_relative 'dns/question'
 require_relative 'dns/rr'
 require_relative 'dns/opt'
+require_relative 'dns/rrsection'
+require_relative 'dns/qdsection'
 
 module PacketGen
   module Header
@@ -184,27 +184,7 @@ module PacketGen
       define_bit_fields_on :u16, :qr, :opcode, 4, :aa, :tc, :rd, :ra, :z,
                            :ad, :cd, :rcode, 4
 
-      # Read DNS header and sections from a string
-      # @param [String] str binary string
-      # @return [self]
-      def read(str)
-        return self if str.nil?
-        force_binary str
-        self[:id].read str[0, 2]
-        self[:u16].read str[2, 2]
-        self[:qdcount].read str[4, 2]
-        self[:ancount].read str[6, 2]
-        self[:nscount].read str[8, 2]
-        self[:arcount].read str[10, 2]
-        self[:qd].read str[12..-1] if self.qdcount > 0
-        start = 12 + self[:qd].sz
-        self[:an].read str[start..-1] if self.ancount > 0
-        start += self[:an].sz
-        self[:ns].read str[start..-1] if self.nscount > 0
-        start += self[:ns].sz
-        self[:ar].read str[start..-1] if self.arcount > 0
-        self
-      end
+      undef opcode=, rcode=
 
       # Set opcode
       # @param [Integer,String] value
@@ -217,6 +197,7 @@ module PacketGen
                  OPCODES[value.to_s]
                end
         raise ArgumentError, "unknown opcode #{value.inspect}" unless intg
+
         self.u16 &= 0x87ff
         self.u16 |= (intg & 0xf) << 11
       end
@@ -232,6 +213,7 @@ module PacketGen
                  RCODES[value]
                end
         raise ArgumentError, "unknown rcode #{value.inspect}" unless intg
+
         self.u16 &= 0xfff0
         self.u16 |= intg & 0xf
       end

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

@@ -93,6 +93,7 @@ module PacketGen
 
         def pointer?(index)
           return false if index.nil?
+
           index & POINTER_MASK == POINTER_MASK
         end
 

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

@@ -30,6 +30,7 @@ module PacketGen
         def read(str)
           clear
           return self if str.nil?
+
           force_binary str
           while !str.empty? && (self.size < @counter.to_i)
             question = Question.new(@dns).read(str)

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

@@ -78,6 +78,8 @@ module PacketGen
           self.rrclass = options[:rrclass] if options[:rrclass]
         end
 
+        undef rrclass=
+
         # Setter for class
         # @param [Integer] val
         # @return [Integer,String]
@@ -89,6 +91,7 @@ module PacketGen
                 val
               end
           raise ArgumentError, "unknown class #{val.inspect}" unless v
+
           self[:rrclass].read v
         end
 
@@ -100,13 +103,6 @@ module PacketGen
           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

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

@@ -36,9 +36,12 @@ module PacketGen
         def initialize(dns, options={})
           super
           return unless options[:rdata] && options[:rdlength].nil?
+
           self.rdata = options[:rdata]
         end
 
+        undef rdata=
+
         # Set rdata and rdlength from +data+
         # @param [String] data
         # @return [void]

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

@@ -25,6 +25,7 @@ module PacketGen
         def read(str)
           clear
           return self if str.nil?
+
           force_binary str
           while !str.empty? && (self.size < @counter.to_i)
             rr = RR.new(@dns).read(str)

data/lib/packetgen/header/dot11.rb

@@ -68,8 +68,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 = PCAPRUB::Pcap.open_live(iface, PCAP_SNAPLEN, PCAP_PROMISC, PCAP_TIMEOUT)
         pcap.inject self.to_s
         pcap.close
       end
@@ -219,21 +218,6 @@ module PacketGen
         # @return [Boolean]
         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.fcs = true
 

data/lib/packetgen/header/dot1x.rb

@@ -52,6 +52,7 @@ module PacketGen
       # @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])

data/lib/packetgen/header/eap.rb

@@ -132,6 +132,7 @@ module PacketGen
       def read(str)
         super str
         return self unless self.class == EAP
+
         if type?
           obj = case self.type
                 when 4
@@ -162,6 +163,7 @@ module PacketGen
       # @raise [ParseError] not a Request nor a Response packet
       def human_type
         raise ParseError, 'not a Request nor a Response' unless type?
+
         self[:type].to_human
       end
 
@@ -194,6 +196,7 @@ module PacketGen
       # @raise [ParseError] not a Nak packet
       def desired_auth_type
         raise ParseError, 'not a Nak response' if (code != 2) && (type != 3)
+
         body.to_s.unpack('C*')
       end
 
@@ -210,13 +213,6 @@ module PacketGen
         [1, 2].include?(self.code)
       end
 
-      # @deprecated Use {#type?} instead.
-      # @return [Boolean]
-      def has_type?
-        Deprecation.deprecated(self.class, __method__, 'type?')
-        type?
-      end
-
       # Callback called when a EAP header is added to a packet
       # Here, add +#eap+ method as a shortcut to existing
       # +#eap_(md5|tls|ttls|fast)+.
@@ -224,6 +220,7 @@ module PacketGen
       # @return [void]
       def added_to_packet(packet)
         return if packet.respond_to? :eap
+
         packet.instance_eval("def eap(arg=nil); header(#{self.class}, arg); end")
       end
 

data/lib/packetgen/header/eth.rb

@@ -57,8 +57,10 @@ module PacketGen
         # @return [self]
         def from_human(str)
           return self if str.nil?
+
           bytes = str.split(/:/)
           raise ArgumentError, 'not a MAC address' unless bytes.size == 6
+
           self[:a0].read(bytes[0].to_i(16))
           self[:a1].read(bytes[1].to_i(16))
           self[:a2].read(bytes[2].to_i(16))

data/lib/packetgen/header/http/headers.rb

@@ -29,6 +29,7 @@ module PacketGen
           when String
             @data = s_or_h.split("\n").map do |h|
               next unless h.include?(':')
+
               k, v = h.split(':', 2)
               [k, v.strip]
             end.reject(&:nil?).to_h
@@ -42,6 +43,7 @@ module PacketGen
         # @return [String]
         def to_s
           return "\r\n" if @data.nil? || @data.empty?
+
           d = []
           @data.map do |k, v|
             d << k + ': ' + v
@@ -66,6 +68,7 @@ module PacketGen
         # @return [Boolean]
         def given?
           return true unless @data.nil? || @data.empty?
+
           false
         end
       end

data/lib/packetgen/header/http/request.rb

@@ -69,9 +69,9 @@ module PacketGen
           str = vrb + str.split(vrb)[-1]
           str = str.split("\n").map(&:chomp)
           first_line = str.shift.split
-          self[:method]  = first_line[0]
-          self[:path]    = first_line[1]
-          self[:version] = first_line[2]
+          self[:method].read first_line[0]
+          self[:path].read first_line[1]
+          self[:version].read first_line[2]
           # requests can sometimes have a payload
           if (data_index = str.find_index(''))
             data    = str[data_index + 1..-1].join("\n")
@@ -80,7 +80,7 @@ module PacketGen
             headers = str.join("\n")
           end
           self[:headers].read(headers)
-          self[:body] = data
+          self[:body].read data
           self
         end
 
@@ -90,6 +90,7 @@ module PacketGen
           raise FormatError, 'Missing #method.'  if self.method.empty?
           raise FormatError, 'Missing #path.'    if self.path.empty?
           raise FormatError, 'Missing #version.' if self.version.empty?
+
           str = ''.dup # build 'dat string
           str << self[:method] << ' ' << self[:path] << ' ' << self[:version] << "\r\n" << self[:headers].to_s << self[:body]
         end

data/lib/packetgen/header/http/response.rb

@@ -87,12 +87,12 @@ module PacketGen
           end
           unless headers.empty?
             first_line = headers.shift.split
-            self[:version]     = first_line[0]
-            self[:status_code] = first_line[1]
-            self[:status_mesg] = first_line[2..-1].join(' ')
+            self[:version].read first_line[0]
+            self[:status_code].read first_line[1]
+            self[:status_mesg].read first_line[2..-1].join(' ')
             self[:headers].read(headers.join("\n"))
           end
-          self[:body] = data.join("\n")
+          self[:body].read data.join("\n")
           self
         end
 
@@ -102,6 +102,7 @@ module PacketGen
           raise FormatError, 'Missing #status_code.' if self.status_code.empty?
           raise FormatError, 'Missing #status_mesg.' if self.status_mesg.empty?
           raise FormatError, 'Missing #version.'     if self.version.empty?
+
           str = ''.dup # build 'dat string
           str << self[:version] << ' ' << self[:status_code] << ' ' << self[:status_mesg] << "\r\n"
           str << self[:headers].to_s if self[:headers].given?

data/lib/packetgen/header/icmp.rb

@@ -7,6 +7,12 @@
 
 module PacketGen
   module Header
+    # ICMP header ({https://tools.ietf.org/html/rfc792 RFC 792})
+    #    0                   1                   2                   3
+    #    0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+    #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    #   |     Type      |     Code      |          Checksum             |
+    #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
     # A ICMP header consists of:
     # * a {#type} field ({Types::Int8} type),
     # * a {#code} field ({Types::Int8} type),

data/lib/packetgen/header/icmpv6.rb

@@ -7,6 +7,12 @@
 
 module PacketGen
   module Header
+    # ICMPv6 header ({https://tools.ietf.org/html/rfc4443 RFC 4443})
+    #    0                   1                   2                   3
+    #    0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+    #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    #   |     Type      |     Code      |          Checksum             |
+    #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
     # A ICMPv6 header consists of:
     # * a +type+ field ({Types::Int8} type),
     # * a +code+ field ({Types::Int8} type),