packetfu 1.1.9 → 1.1.10

data/lib/packetfu/protos/icmp.rb

@@ -9,85 +9,85 @@ require 'packetfu/protos/icmp/header'
 require 'packetfu/protos/icmp/mixin'
 
 module PacketFu
-  # ICMPPacket is used to construct ICMP Packets. They contain an EthHeader, an IPHeader, and a ICMPHeader.
-  #
-  # == Example
-  #
-  #  icmp_pkt.new
-  #  icmp_pkt.icmp_type = 8
-  #  icmp_pkt.icmp_code = 0
-  #  icmp_pkt.payload = "ABC, easy as 123. As simple as do-re-mi. ABC, 123, baby, you and me!"
-  #
-  #  icmp_pkt.ip_saddr="1.2.3.4"
-  #  icmp_pkt.ip_daddr="5.6.7.8"
-  #
-  #  icmp_pkt.recalc	
-  #  icmp_pkt.to_f('/tmp/icmp.pcap')
-  #
-  # == Parameters
-  #
-  #  :eth
-  #   A pre-generated EthHeader object.
-  #  :ip
-  #   A pre-generated IPHeader object.
-  #  :flavor
-  #   TODO: Sets the "flavor" of the ICMP packet. Pings, in particular, often betray their true
-  #   OS.
-  #  :config
-  #   A hash of return address details, often the output of Utils.whoami?
-  class ICMPPacket < Packet
+	# ICMPPacket is used to construct ICMP Packets. They contain an EthHeader, an IPHeader, and a ICMPHeader.
+	#
+	# == Example
+	#
+	#  icmp_pkt.new
+	#  icmp_pkt.icmp_type = 8
+	#  icmp_pkt.icmp_code = 0
+	#  icmp_pkt.payload = "ABC, easy as 123. As simple as do-re-mi. ABC, 123, baby, you and me!"
+	#
+	#  icmp_pkt.ip_saddr="1.2.3.4"
+	#  icmp_pkt.ip_daddr="5.6.7.8"
+	#
+	#  icmp_pkt.recalc	
+	#  icmp_pkt.to_f('/tmp/icmp.pcap')
+	#
+	# == Parameters
+	#
+	#  :eth
+	#   A pre-generated EthHeader object.
+	#  :ip
+	#   A pre-generated IPHeader object.
+	#  :flavor
+	#   TODO: Sets the "flavor" of the ICMP packet. Pings, in particular, often betray their true
+	#   OS.
+	#  :config
+	#   A hash of return address details, often the output of Utils.whoami?
+	class ICMPPacket < Packet
     include ::PacketFu::EthHeaderMixin
     include ::PacketFu::IPHeaderMixin
     include ::PacketFu::ICMPHeaderMixin
 
-    attr_accessor :eth_header, :ip_header, :icmp_header
+		attr_accessor :eth_header, :ip_header, :icmp_header
 
-    def self.can_parse?(str)
-      return false unless str.size >= 38
-      return false unless EthPacket.can_parse? str
-      return false unless IPPacket.can_parse? str
-      return false unless str[23,1] == "\x01"
-      return true
-    end
+		def self.can_parse?(str)
+			return false unless str.size >= 38
+			return false unless EthPacket.can_parse? str
+			return false unless IPPacket.can_parse? str
+			return false unless str[23,1] == "\x01"
+			return true
+		end
 
-    def read(str=nil, args={})
-      raise "Cannot parse `#{str}'" unless self.class.can_parse?(str)
-      @eth_header.read(str)
-      super(args)
-      self
-    end
+		def read(str=nil, args={})
+			raise "Cannot parse `#{str}'" unless self.class.can_parse?(str)
+			@eth_header.read(str)
+			super(args)
+			self
+		end
 
-    def initialize(args={})
-      @eth_header = EthHeader.new(args).read(args[:eth])
-      @ip_header = IPHeader.new(args).read(args[:ip])
-      @ip_header.ip_proto = 1
-      @icmp_header = ICMPHeader.new(args).read(args[:icmp])
+		def initialize(args={})
+			@eth_header = EthHeader.new(args).read(args[:eth])
+			@ip_header = IPHeader.new(args).read(args[:ip])
+			@ip_header.ip_proto = 1
+			@icmp_header = ICMPHeader.new(args).read(args[:icmp])
 
-      @ip_header.body = @icmp_header
-      @eth_header.body = @ip_header
+			@ip_header.body = @icmp_header
+			@eth_header.body = @ip_header
 
-      @headers = [@eth_header, @ip_header, @icmp_header]
-      super
-    end
+			@headers = [@eth_header, @ip_header, @icmp_header]
+			super
+		end
 
-    # Peek provides summary data on packet contents.
-    def peek_format
-      peek_data = ["IC "] # I is taken by IP
-      peek_data << "%-5d" % self.to_s.size
-      type = case self.icmp_type.to_i
-             when 8
-               "ping"
-             when 0
-               "pong"
-             else
-               "%02x-%02x" % [self.icmp_type, self.icmp_code]
-             end
-      peek_data << "%-21s" % "#{self.ip_saddr}:#{type}"
-      peek_data << "->"
-      peek_data << "%21s" % "#{self.ip_daddr}"
-      peek_data << "%23s" % "I:"
-      peek_data << "%04x" % self.ip_id
-      peek_data.join
-    end
-  end
+		# Peek provides summary data on packet contents.
+		def peek_format
+			peek_data = ["IC "] # I is taken by IP
+			peek_data << "%-5d" % self.to_s.size
+			type = case self.icmp_type.to_i
+						 when 8
+							 "ping"
+						 when 0
+							 "pong"
+						 else
+							 "%02x-%02x" % [self.icmp_type, self.icmp_code]
+						 end
+			peek_data << "%-21s" % "#{self.ip_saddr}:#{type}"
+			peek_data << "->"
+			peek_data << "%21s" % "#{self.ip_daddr}"
+			peek_data << "%23s" % "I:"
+			peek_data << "%04x" % self.ip_id
+			peek_data.join
+		end
+	end
 end

data/lib/packetfu/protos/icmp/header.rb

@@ -1,94 +1,94 @@
 # -*- coding: binary -*-
 module PacketFu
-  # ICMPHeader is a complete ICMP struct, used in ICMPPacket. ICMP is 
-  # typically used for network administration and connectivity testing.
-  #
-  # For more on ICMP packets, see 
-  # http://www.networksorcery.com/enp/protocol/icmp.htm
-  # 
-  # ==== Header Definition
-  #
-  #   Int8    :icmp_type                        # Type
-  #   Int8    :icmp_code                        # Code
-  #   Int16   :icmp_sum    Default: calculated  # Checksum
-  #   String  :body
-  class ICMPHeader < Struct.new(:icmp_type, :icmp_code, :icmp_sum, :body)
+	# ICMPHeader is a complete ICMP struct, used in ICMPPacket. ICMP is 
+	# typically used for network administration and connectivity testing.
+	#
+	# For more on ICMP packets, see 
+	# http://www.networksorcery.com/enp/protocol/icmp.htm
+	# 
+	# ==== Header Definition
+	#
+	#   Int8    :icmp_type                        # Type
+	#   Int8    :icmp_code                        # Code
+	#   Int16   :icmp_sum    Default: calculated  # Checksum
+	#   String  :body
+	class ICMPHeader < Struct.new(:icmp_type, :icmp_code, :icmp_sum, :body)
 
-    include StructFu
+		include StructFu
 
-    def initialize(args={})
-      super(
-        Int8.new(args[:icmp_type]),
-        Int8.new(args[:icmp_code]),
-        Int16.new(args[:icmp_sum] || icmp_calc_sum),
-        StructFu::String.new.read(args[:body])
-      )
-    end
+		def initialize(args={})
+			super(
+				Int8.new(args[:icmp_type]),
+				Int8.new(args[:icmp_code]),
+				Int16.new(args[:icmp_sum] || icmp_calc_sum),
+				StructFu::String.new.read(args[:body])
+			)
+		end
 
-    # Returns the object in string form.
-    def to_s
-      self.to_a.map {|x| x.to_s}.join
-    end
+		# Returns the object in string form.
+		def to_s
+			self.to_a.map {|x| x.to_s}.join
+		end
 
-    # Reads a string to populate the object.
-    def read(str)
-      force_binary(str)
-      return self if str.nil?
-      self[:icmp_type].read(str[0,1])
-      self[:icmp_code].read(str[1,1])
-      self[:icmp_sum].read(str[2,2])
-      self[:body].read(str[4,str.size])
-      self
-    end
+		# Reads a string to populate the object.
+		def read(str)
+			force_binary(str)
+			return self if str.nil?
+			self[:icmp_type].read(str[0,1])
+			self[:icmp_code].read(str[1,1])
+			self[:icmp_sum].read(str[2,2])
+			self[:body].read(str[4,str.size])
+			self
+		end
 
-    # Setter for the type.
-    def icmp_type=(i); typecast i; end
-    # Getter for the type.
-    def icmp_type; self[:icmp_type].to_i; end
-    # Setter for the code.
-    def icmp_code=(i); typecast i; end
-    # Getter for the code.
-    def icmp_code; self[:icmp_code].to_i; end
-    # Setter for the checksum. Note, this is calculated automatically with 
-    # icmp_calc_sum.
-    def icmp_sum=(i); typecast i; end
-    # Getter for the checksum.
-    def icmp_sum; self[:icmp_sum].to_i; end
+		# Setter for the type.
+		def icmp_type=(i); typecast i; end
+		# Getter for the type.
+		def icmp_type; self[:icmp_type].to_i; end
+		# Setter for the code.
+		def icmp_code=(i); typecast i; end
+		# Getter for the code.
+		def icmp_code; self[:icmp_code].to_i; end
+		# Setter for the checksum. Note, this is calculated automatically with 
+		# icmp_calc_sum.
+		def icmp_sum=(i); typecast i; end
+		# Getter for the checksum.
+		def icmp_sum; self[:icmp_sum].to_i; end
 
-    # Calculates and sets the checksum for the object.
-    def icmp_calc_sum
-      checksum = (icmp_type.to_i << 8)	+ icmp_code.to_i
-      chk_body = (body.to_s.size % 2 == 0 ? body.to_s : body.to_s + "\x00")
-      if 1.respond_to? :ord
-        chk_body.scan(/../).map { |x| (x[0].ord << 8) + x[1].ord }.each { |y| checksum += y }
-      else
-        chk_body.scan(/../).map { |x| (x[0] << 8) + x[1] }.each { |y| checksum += y }
-      end
-      checksum = checksum % 0xffff
-      checksum = 0xffff - checksum
-      checksum == 0 ? 0xffff : checksum
-    end
-    
-    # Recalculates the calculatable fields for ICMP.
-    def icmp_recalc(arg=:all)
-      # How silly is this, you can't intern a symbol in ruby 1.8.7pl72?
-      # I'm this close to monkey patching Symbol so you can force it...
-      arg = arg.intern if arg.respond_to? :intern
-      case arg
-      when :icmp_sum
-        self.icmp_sum=icmp_calc_sum
-      when :all
-        self.icmp_sum=icmp_calc_sum
-      else
-        raise ArgumentError, "No such field `#{arg}'"
-      end
-    end
+		# Calculates and sets the checksum for the object.
+		def icmp_calc_sum
+			checksum = (icmp_type.to_i << 8)	+ icmp_code.to_i
+			chk_body = (body.to_s.size % 2 == 0 ? body.to_s : body.to_s + "\x00")
+			if 1.respond_to? :ord
+				chk_body.scan(/../).map { |x| (x[0].ord << 8) + x[1].ord }.each { |y| checksum += y }
+			else
+				chk_body.scan(/../).map { |x| (x[0] << 8) + x[1] }.each { |y| checksum += y }
+			end
+			checksum = checksum % 0xffff
+			checksum = 0xffff - checksum
+			checksum == 0 ? 0xffff : checksum
+		end
+		
+		# Recalculates the calculatable fields for ICMP.
+		def icmp_recalc(arg=:all)
+			# How silly is this, you can't intern a symbol in ruby 1.8.7pl72?
+			# I'm this close to monkey patching Symbol so you can force it...
+			arg = arg.intern if arg.respond_to? :intern
+			case arg
+			when :icmp_sum
+				self.icmp_sum=icmp_calc_sum
+			when :all
+				self.icmp_sum=icmp_calc_sum
+			else
+				raise ArgumentError, "No such field `#{arg}'"
+			end
+		end
 
-    # Readability aliases
+		# Readability aliases
 
-    def icmp_sum_readable
-      "0x%04x" % icmp_sum
-    end
+		def icmp_sum_readable
+			"0x%04x" % icmp_sum
+		end
 
-  end
+	end
 end

data/lib/packetfu/protos/icmp/mixin.rb

@@ -1,18 +1,18 @@
 # -*- coding: binary -*-
 module PacketFu
-  # This Mixin simplifies access to the ICMPHeaders. Mix this in with your 
-  # packet interface, and it will add methods that essentially delegate to
-  # the 'icmp_header' method (assuming that it is a ICMPHeader object)
-  module ICMPHeaderMixin
-    def icmp_type=(v); self.icmp_header.icmp_type= v; end
-    def icmp_type; self.icmp_header.icmp_type; end
-    def icmp_code=(v); self.icmp_header.icmp_code= v; end
-    def icmp_code; self.icmp_header.icmp_code; end
-    def icmp_sum=(v); self.icmp_header.icmp_sum= v; end
-    def icmp_sum; self.icmp_header.icmp_sum; end
-    def icmp_calc_sum; self.icmp_header.icmp_calc_sum; end
-    def icmp_recalc(*v); self.icmp_header.icmp_recalc(*v); end
-    def icmp_sum_readable; self.icmp_header.icmp_sum_readable; end
-  end
+	# This Mixin simplifies access to the ICMPHeaders. Mix this in with your 
+	# packet interface, and it will add methods that essentially delegate to
+	# the 'icmp_header' method (assuming that it is a ICMPHeader object)
+	module ICMPHeaderMixin
+		def icmp_type=(v); self.icmp_header.icmp_type= v; end
+		def icmp_type; self.icmp_header.icmp_type; end
+		def icmp_code=(v); self.icmp_header.icmp_code= v; end
+		def icmp_code; self.icmp_header.icmp_code; end
+		def icmp_sum=(v); self.icmp_header.icmp_sum= v; end
+		def icmp_sum; self.icmp_header.icmp_sum; end
+		def icmp_calc_sum; self.icmp_header.icmp_calc_sum; end
+		def icmp_recalc(*v); self.icmp_header.icmp_recalc(*v); end
+		def icmp_sum_readable; self.icmp_header.icmp_sum_readable; end
+	end
 end
 

data/lib/packetfu/protos/invalid.rb

@@ -1,55 +1,55 @@
 # -*- coding: binary -*-
 module PacketFu
 
-  # InvalidHeader catches all packets that we don't already have a Struct for,
-  # or for whatever reason, violates some basic packet rules for other packet 
-  # types.
-  class InvalidHeader < Struct.new(:body)
-    include StructFu
-
-    def initialize(args={})
-      args[:body] ||= StructFu::String.new
-      super(args[:body])
-    end
-
-    # Returns the object in string form.
-    def to_s
-      self.to_a.map {|x| x.to_s}.join
-    end
-
-    # Reads a string to populate the object.
-    def read(str)
-      force_binary(str)
-      return self if str.nil?
-      self[:body].read str
-      self
-    end
-
-  end
-
-  # You probably don't want to write invalid packets on purpose.
-  class	InvalidPacket < Packet
-    attr_accessor :invalid_header
-
-    # Any packet is potentially an invalid packet
-    def self.can_parse?(str)
-      true
-    end
-
-    def self.layer
-      0
-    end
-
-    def read(str=nil,args={})
-      @invalid_header.read(str)
-      self
-    end
-
-    def initialize(args={})
-      @invalid_header = 	(args[:invalid] || InvalidHeader.new)
-      @headers = [@invalid_header]
-    end
-  end
+	# InvalidHeader catches all packets that we don't already have a Struct for,
+	# or for whatever reason, violates some basic packet rules for other packet 
+	# types.
+	class InvalidHeader < Struct.new(:body)
+		include StructFu
+
+		def initialize(args={})
+			args[:body] ||= StructFu::String.new
+			super(args[:body])
+		end
+
+		# Returns the object in string form.
+		def to_s
+			self.to_a.map {|x| x.to_s}.join
+		end
+
+		# Reads a string to populate the object.
+		def read(str)
+			force_binary(str)
+			return self if str.nil?
+			self[:body].read str
+			self
+		end
+
+	end
+
+	# You probably don't want to write invalid packets on purpose.
+	class	InvalidPacket < Packet
+		attr_accessor :invalid_header
+
+		# Any packet is potentially an invalid packet
+		def self.can_parse?(str)
+			true
+		end
+
+		def self.layer
+			0
+		end
+
+		def read(str=nil,args={})
+			@invalid_header.read(str)
+			self
+		end
+
+		def initialize(args={})
+			@invalid_header = 	(args[:invalid] || InvalidHeader.new)
+			@headers = [@invalid_header]
+		end
+	end
 
 end # module PacketFu