packetgen 2.6.0 → 2.7.0

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

@@ -8,7 +8,6 @@
 module PacketGen
   module Header
     class EAP
-
       # Extensible Authentication Protocol (EAP) - Flexible Authentication variable
       # Secure Tunneling, {https://tools.ietf.org/html/rfc4851 RFC 4851}
       #

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

@@ -8,8 +8,7 @@
 module PacketGen
   module Header
     class EAP
-
-      # Extensible Authentication Protocol (EAP) - 
+      # Extensible Authentication Protocol (EAP) -
       # {https://tools.ietf.org/html/rfc3748#section-5.4 MD5 challenge}
       # @author Sylvain Daubert
       # @since 2.1.4

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

@@ -8,7 +8,6 @@
 module PacketGen
   module Header
     class EAP
-
       # Extensible Authentication Protocol (EAP) - TLS,
       # {https://tools.ietf.org/html/rfc5216 RFC 5216}
       #
@@ -22,7 +21,7 @@ module PacketGen
         # @!attribute flags
         #  @return [Integer] 8-bit flags
         define_field_before :body, :flags, Types::Int8
-        
+
         # @!attribute l
         #  Say if length field is included. Defined on {#flags} field.
         #  @return [Boolean]
@@ -33,17 +32,17 @@ module PacketGen
         #  If set, this message is a TLS-Start. Defined on {#flags} field.
         #  @return [Boolean]
         define_bit_fields_on :flags, :l, :m, :s, :reserved, 5
-        alias :length_present? :l?
-        alias :more_fragments? :m?
-        alias :tls_start? :s?
-        
+        alias length_present? l?
+        alias more_fragments? m?
+        alias tls_start? s?
+
         # @!attribute tls_length
         #  TLS message length. This field provides the total length of the
         #  TLS message or set of messages that is being fragmented. So, it
         #  cannot be automatically calculated (no +#calc_length+ method).
         #  @return [Integer] 32-bit TLS length
         define_field_before :body, :tls_length, Types::Int32,
-                     optional: ->(h) { h.l? }
+                            optional: ->(h) { h.l? }
 
         # @return [EAP::TLS]
         def initialize(options={})
@@ -58,11 +57,11 @@ module PacketGen
             next unless is_present?(attr)
             if attr == :flags
               shift = Inspect.shift_level(2)
-              value = %i(l m s).map { |f| send("#{f}?") ? f.to_s : '.' }.join
+              value = %i[l m s].map { |f| send("#{f}?") ? f.to_s : '.' }.join
               value = '%-10s (0x%02x)' % [value, self.flags]
-              str << shift 
+              str << shift
               str << Inspect::FMT_ATTR % [self[attr].class.to_s.sub(/.*::/, ''),
-                                         attr, value]
+                                          attr, value]
             else
               str << Inspect.inspect_attribute(attr, self[attr], 2)
             end

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

@@ -8,7 +8,6 @@
 module PacketGen
   module Header
     class EAP
-
       # Extensible Authentication Protocol (EAP) - Tunneled-TLS,
       # {https://tools.ietf.org/html/rfc5281 RFC 5281}
       #
@@ -22,7 +21,7 @@ module PacketGen
         # @!attribute flags
         #  @return [Integer] 8-bit flags
         define_field_before :body, :flags, Types::Int8
-        
+
         # @!attribute l
         #  Say if length field is included. Defined on {#flags} field.
         #  @return [Boolean]
@@ -37,17 +36,17 @@ module PacketGen
         # @!attribute version
         #  @return [Integer] 3-bit version
         define_bit_fields_on :flags, :l, :m, :s, :reserved, 2, :version, 3
-        alias :length_present? :l?
-        alias :more_fragments? :m?
-        alias :tls_start? :s?
-        
+        alias length_present? l?
+        alias more_fragments? m?
+        alias tls_start? s?
+
         # @!attribute message_length
         #  Message length. This field provides the total length of the
         #  raw data message sequence prior to fragmentation. So, it
         #  cannot be automatically calculated (no +#calc_length+ method).
         #  @return [Integer] 32-bit message length
         define_field_before :body, :message_length, Types::Int32,
-                     optional: ->(h) { h.l? }
+                            optional: ->(h) { h.l? }
 
         # @return [EAP::TTLS]
         def initialize(options={})
@@ -62,11 +61,11 @@ module PacketGen
             next unless is_present?(attr)
             if attr == :flags
               shift = Inspect.shift_level(2)
-              value = %i(l m s).map { |f| send("#{f}?") ? f.to_s : '.' }.join
+              value = %i[l m s].map { |f| send("#{f}?") ? f.to_s : '.' }.join
               value = '%-10s (0x%02x)' % [value, self.flags]
-              str << shift 
+              str << shift
               str << Inspect::FMT_ATTR % [self[attr].class.to_s.sub(/.*::/, ''),
-                                         attr, value]
+                                          attr, value]
               str << Inspect::FMT_ATTR % ['', 'version', self.version]
             else
               str << Inspect.inspect_attribute(attr, self[attr], 2)

data/lib/packetgen/header/esp.rb

@@ -7,7 +7,6 @@
 
 module PacketGen
   module Header
-
     # A ESP header consists of:
     # * a Security Parameters Index (#{spi}, {Types::Int32} type),
     # * a Sequence Number ({#sn}, +Int32+ type),
@@ -49,7 +48,7 @@ module PacketGen
     #  esp.esp.icv_length = 16
     #  # encapsulate ICMP packet in ESP one
     #  esp.encapsulate icmp
-    #  
+    #
     #  # encrypt ESP payload
     #  cipher = OpenSSL::Cipher.new('aes-128-gcm')
     #  cipher.encrypt
@@ -61,11 +60,12 @@ module PacketGen
     #  cipher = OpenSSL::Cipher.new('aes-128-cbc')
     #  cipher.decrypt
     #  cipher.key = 16bytes_key
-    #  
+    #
     #  hmac = OpenSSL::HMAC.new(hmac_key, OpenSSL::Digest::SHA256.new)
     #
     #  pkt.esp.decrypt! cipher, intmode: hmac    # => true if ICV check OK
     # @author Sylvain Daubert
+    # @since 1.2.0
     class ESP < Base
       include Crypto
 
@@ -140,11 +140,11 @@ module PacketGen
         force_binary str
         self[:spi].read str[0, 4]
         self[:sn].read str[4, 4]
-        self[:body].read str[8...-@icv_length-2]
+        self[:body].read str[8...-@icv_length - 2]
         self[:tfc].read ''
         self[:padding].read ''
-        self[:pad_length].read str[-@icv_length-2, 1]
-        self[:next].read str[-@icv_length-1, 1]
+        self[:pad_length].read str[-@icv_length - 2, 1]
+        self[:next].read str[-@icv_length - 1, 1]
         self[:icv].read str[-@icv_length, @icv_length] if @icv_length
         self
       end
@@ -198,10 +198,10 @@ module PacketGen
 
         if opt[:pad_length]
           self.pad_length = opt[:pad_length]
-          padding = force_binary(opt[:padding] || (1..self.pad_length).to_a.pack("C*"))
+          padding = force_binary(opt[:padding] || (1..self.pad_length).to_a.pack('C*'))
           self[:padding].read padding
         else
-          padding = force_binary(opt[:padding] || (1..self.pad_length).to_a.pack("C*"))
+          padding = force_binary(opt[:padding] || (1..self.pad_length).to_a.pack('C*'))
           self[:padding].read padding[0...self.pad_length]
         end
 
@@ -209,12 +209,12 @@ module PacketGen
         if opt[:tfc]
           tfc_size = opt[:tfc_size] - body.sz
           if tfc_size > 0
-            case confidentiality_mode
-            when 'cbc'
-              tfc_size = (tfc_size / 16) * 16
-            else
-              tfc_size = (tfc_size / 4) * 4
-            end
+            tfc_size = case confidentiality_mode
+                       when 'cbc'
+                         (tfc_size / 16) * 16
+                       else
+                         (tfc_size / 4) * 4
+                       end
             tfc = force_binary("\0" * tfc_size)
           end
         end
@@ -237,7 +237,7 @@ module PacketGen
         # Remove enciphered headers from packet
         id = header_id(self)
         if id < packet.headers.size - 1
-          (packet.headers.size-1).downto(id+1) do |index|
+          (packet.headers.size - 1).downto(id + 1) do |index|
             packet.headers.delete_at index
           end
         end
@@ -260,7 +260,7 @@ module PacketGen
       #   confidentiality-only cipher. Only HMAC are supported.
       # @return [Boolean] +true+ if ESP packet is authenticated
       def decrypt!(cipher, options={})
-        opt = { :salt => '', parse: true }.merge(options)
+        opt = { salt: '', parse: true }.merge(options)
 
         set_crypto cipher, opt[:intmode]
 
@@ -279,7 +279,7 @@ module PacketGen
         end
         cipher.iv = real_iv
 
-        if authenticated? and (@icv_length == 0 or opt[:icv_length])
+        if authenticated? && (@icv_length.zero? || opt[:icv_length])
           raise ParseError, 'unknown ICV size' unless opt[:icv_length]
           @icv_length = opt[:icv_length].to_i
           # reread ESP to handle new ICV size
@@ -292,7 +292,7 @@ module PacketGen
         end
 
         authenticate_esp_header_if_needed options, iv, self[:icv]
-        private_decrypt cipher, opt
+        private_decrypt opt
       end
 
       private
@@ -329,7 +329,7 @@ module PacketGen
         end
       end
 
-      def private_decrypt(cipher, options)
+      def private_decrypt(options)
         # decrypt
         msg = self.body.to_s
         msg += self[:padding].to_s + self[:pad_length].to_s + self[:next].to_s
@@ -356,8 +356,8 @@ module PacketGen
         pkt = nil
         case self.next
         when 4   # IPv4
-        pkt = Packet.parse(body, first_header: 'IP')
-        encap_length = pkt.ip.length
+          pkt = Packet.parse(body, first_header: 'IP')
+          encap_length = pkt.ip.length
         when 41  # IPv6
           pkt = Packet.parse(body, first_header: 'IPv6')
           encap_length = pkt.ipv6.length + pkt.ipv6.sz
@@ -397,17 +397,17 @@ module PacketGen
 
     self.add_class ESP
 
-    IP.bind_header ESP, protocol: ESP::IP_PROTOCOL
-    IPv6.bind_header ESP, next: ESP::IP_PROTOCOL
-    UDP.bind_header ESP, procs: [ ->(f) { f.dport = f.sport = ESP::UDP_PORT },
-                                  ->(f) { (f.dport == ESP::UDP_PORT ||
-                                           f.sport == ESP::UDP_PORT) &&
-                                          Types::Int32.new.read(f.body[0..3]).to_i > 0 }]
-    ESP.bind_header IP, next: 4
-    ESP.bind_header IPv6, next: 41
-    ESP.bind_header TCP, next: TCP::IP_PROTOCOL
-    ESP.bind_header UDP, next: TCP::IP_PROTOCOL
-    ESP.bind_header ICMP, next: ICMP::IP_PROTOCOL
-    ESP.bind_header ICMPv6, next: ICMPv6::IP_PROTOCOL
+    IP.bind ESP, protocol: ESP::IP_PROTOCOL
+    IPv6.bind ESP, next: ESP::IP_PROTOCOL
+    UDP.bind ESP, procs: [->(f) { f.dport = f.sport = ESP::UDP_PORT },
+                          ->(f) { (f.dport == ESP::UDP_PORT ||
+                                     f.sport == ESP::UDP_PORT) &&
+                                   Types::Int32.new.read(f.body[0..3]).to_i > 0 }]
+    ESP.bind IP, next: 4
+    ESP.bind IPv6, next: 41
+    ESP.bind TCP, next: TCP::IP_PROTOCOL
+    ESP.bind UDP, next: TCP::IP_PROTOCOL
+    ESP.bind ICMP, next: ICMP::IP_PROTOCOL
+    ESP.bind ICMPv6, next: ICMPv6::IP_PROTOCOL
   end
 end

data/lib/packetgen/header/eth.rb

@@ -7,7 +7,6 @@
 
 module PacketGen
   module Header
-
     # An Ethernet header consists of:
     # * a destination MAC address ({MacAddr}),
     # * a source MAC address (MacAddr),
@@ -31,7 +30,6 @@ module PacketGen
     #
     # @author Sylvain Daubert
     class Eth < Base
-
       # Ethernet MAC address, as a group of 6 bytes
       # @author Sylvain Daubert
       class MacAddr < Types::Fields
@@ -53,16 +51,14 @@ module PacketGen
         # @!attribute a5
         #  @return [Integer] sixth byte from MacAddr
         define_field :a5, Types::Int8
-        
+
         # Read a human-readable string to populate +MacAddr+
         # @param [String] str
         # @return [self]
         def from_human(str)
           return self if str.nil?
           bytes = str.split(/:/)
-          unless bytes.size == 6
-            raise ArgumentError, 'not a MAC address'
-          end
+          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))
@@ -75,7 +71,7 @@ module PacketGen
         # +MacAddr+ in human readable form (colon format)
         # @return [String]
         def to_human
-          fields.map { |m| "#{'%02x' % self[m]}" }.join(':')
+          fields.map { |m| '%02x' % self[m] }.join(':')
         end
       end
 
@@ -100,8 +96,15 @@ module PacketGen
         pcap.inject self.to_s
         pcap.close
       end
-    end
 
+      # Invert destination and source addresses
+      # @return [self]
+      # @since 2.7.0
+      def reply!
+        self[:src], self[:dst] = self[:dst], self[:src]
+        self
+      end
+    end
     self.add_class Eth
   end
 end

data/lib/packetgen/header/gre.rb

@@ -7,7 +7,6 @@
 
 module PacketGen
   module Header
-
     # Generic Routing Encapsulation (RFC 2784 and 2890)
     #                       1 1 1 1 1 1 1 1 1 1 2 2 2 2 2 2 2 2 2 2 3 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
@@ -21,8 +20,8 @@ module PacketGen
     #  |                 Sequence Number (Optional)                    |
     #  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
     # @author Sylvain Daubert
+    # @since 2.1.0
     class GRE < Base
-
       # IP protocol number for GRE
       IP_PROTOCOL = 47
 
@@ -76,10 +75,10 @@ module PacketGen
     end
 
     self.add_class GRE
-    IP.bind_header GRE, protocol: GRE::IP_PROTOCOL
-    IPv6.bind_header GRE, next: GRE::IP_PROTOCOL
+    IP.bind GRE, protocol: GRE::IP_PROTOCOL
+    IPv6.bind GRE, next: GRE::IP_PROTOCOL
 
-    GRE.bind_header IP, protocol_type: IP::ETHERTYPE
-    GRE.bind_header IPv6, protocol_type: IPv6::ETHERTYPE
+    GRE.bind IP, protocol_type: IP::ETHERTYPE
+    GRE.bind IPv6, protocol_type: IPv6::ETHERTYPE
   end
 end

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

@@ -7,12 +7,16 @@
 
 module PacketGen
   module Header
-
     # @since 2.2.0
-    module HTTP 
+    module HTTP
       # @abstract Base class for HTTP headers.
       # @author Kent 'picat' Gruber
       class Headers
+        # Underlying Headers data (or nil).
+        # @return [Hash, nil]
+        attr_reader :data
+        alias to_h data
+
         def initialize
           @data = nil
         end
@@ -23,10 +27,10 @@ module PacketGen
         def read(s_or_h)
           case s_or_h
           when String
-            @data = s_or_h.split("\n").map do |h| 
-              next unless h.include?(":")
-              k, v = h.split(":", 2)
-              [k, v.strip] 
+            @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
           when Hash
             @data = s_or_h
@@ -40,7 +44,7 @@ module PacketGen
           return "\r\n" if @data.nil? || @data.empty?
           d = []
           @data.map do |k, v|
-            d << k + ": " + v
+            d << k + ': ' + v
           end
           d.join("\r\n") << "\r\n\r\n"
         end
@@ -64,13 +68,6 @@ module PacketGen
           return true unless @data.nil? || @data.empty?
           false
         end
-
-        # Shorcut to the underlying Headers data or nil.
-        # @return [Hash, nil]
-        def data
-          @data
-        end
-        alias to_h data
       end
     end
   end

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

@@ -26,28 +26,28 @@ module PacketGen
       # attributes of TCP header are not set.
       #
       # == HTTP Request attributes
-      #	  http_rqst.version = "HTTP/1.1"
-      #	  http_rqst.method  = "GET"
-      #	  http_rqst.path    = "/meow.html"
+      #   http_rqst.version = "HTTP/1.1"
+      #   http_rqst.method  = "GET"
+      #   http_rqst.path    = "/meow.html"
       #   http_rqst.headers = "Host: tcpdump.org"     # string or
-      #	  http_rqst.headers = { "Host": "tcpdump.org" } # even a hash
+      #   http_rqst.headers = { "Host": "tcpdump.org" } # even a hash
       #
       # @author Kent 'picat' Gruber
       class Request < Base
         # @!attribute method
         #   @return [Types::String]
         define_field :method,  Types::String
-        # @!attribute path 
+        # @!attribute path
         #   @return [Types::String]
         define_field :path,    Types::String
-        # @!attribute version 
+        # @!attribute version
         #   @return [Types::String]
-        define_field :version, Types::String, default: "HTTP/1.1"
+        define_field :version, Types::String, default: 'HTTP/1.1'
         # @!attribute headers
         #   associated http/1.1 headers
         #   @return [HTTP::Headers]
-        define_field :headers, HTTP::Headers 
-        # @!attribute body 
+        define_field :headers, HTTP::Headers
+        # @!attribute body
         #   @return [Types::String]
         define_field :body, Types::String
 
@@ -61,7 +61,7 @@ module PacketGen
           self.headers ||= options[:headers]
         end
 
-        # Read in the HTTP portion of the packet, and parse it. 
+        # Read in the HTTP portion of the packet, and parse it.
         # @return [PacketGen::HTTP::Request]
         def read(str)
           str = str.bytes.map!(&:chr).join unless str.valid_encoding?
@@ -73,9 +73,9 @@ module PacketGen
           self[:path]    = first_line[1]
           self[:version] = first_line[2]
           # requests can sometimes have a payload
-          if data_index = str.find_index("")
-            data    = str[data_index+1..-1].join("\n")
-            headers = str[0..data_index-1].join("\n")
+          if (data_index = str.find_index(''))
+            data    = str[data_index + 1..-1].join("\n")
+            headers = str[0..data_index - 1].join("\n")
           else
             headers = str.join("\n")
           end
@@ -87,16 +87,16 @@ module PacketGen
         # String representation of data.
         # @return [String]
         def to_s
-          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]
+          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
       end
     end
 
-    self.add_class HTTP::Request 
-    TCP.bind_header HTTP::Request, body: ->(b) { HTTP::REQUEST_REGEX =~ b.chars.select(&:valid_encoding?).join }
+    self.add_class HTTP::Request
+    TCP.bind HTTP::Request, body: ->(b) { HTTP::REQUEST_REGEX =~ b.chars.select(&:valid_encoding?).join }
   end
 end