reassemble_tcp 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    M2MxOGE4MTU0NTE2OTVkMmJkYmE3MzA4Y2VmMmRmNDc1ZmMzOTJhNw==
+  data.tar.gz: !binary |-
+    YmExYjJkOWMyOTNmZTc1NDMzMjg3NWMzNzQ0YTAyMGJhNDFmNGQ4Zg==
+SHA512:
+  metadata.gz: !binary |-
+    OGE2OWIxODBiMGI1YmViOTNjMzEwODk2ZDgxMjczNzdjOWYyZWJhYzcxNjFh
+    NGY5MTk0ZDg2NzBhYjEwNTMxMWMzMTg0ZWI3ZjMwMTU5ZjVhZmY3YTM5MGY1
+    MzU4ZWIyMTA3Zjk4NmI1MzcwNDdjMTk1MDk3ZjhlMDFmNjRkZDU=
+  data.tar.gz: !binary |-
+    OTFiYWY2MGU0ZjcxM2RkZmE5ZWQ4NzgzYTU2NDI3ZjkxY2NmMjI5YzBlZWRl
+    M2M0YzI1ZTFmMzk2OWUzNjA1N2Q4ZTljMzE1ZjdiOTg5YTU2YWI5NTJjNmIw
+    YjM0NTY4NTQxOTdiY2QzYmY3OWE4OGFhYjI2ZWYzMDI4YjlmNzk=

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in reassemble_tcp.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 masatanish
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# ReassembleTcp
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'reassemble_tcp'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install reassemble_tcp
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/reassemble_tcp/packet_stream.rb

@@ -0,0 +1,55 @@
+module ReassembleTcp
+
+  # packet stream for the same direction and sequence(or acknowledge) number
+  class PacketStream
+    attr_reader :direction, :seq_ack_num, :range, :pkts
+
+    # @param [Symbol] direction :send or :recv
+    # @param [PacketFu::Packet] pkt packet
+    def initialize(direction, pkt)
+      case direction
+      when :send
+        @seq_ack_num = pkt.tcp_seq.to_i
+      when :recv
+        @seq_ack_num = pkt.tcp_ack.to_i
+      else
+        raise ArgumentError, "direction should be :send or :recv"
+      end
+      @direction = direction
+      @range = pkt.timestamp..pkt.timestamp
+      @pkts = [pkt]
+    end
+
+    # @param [Symbol] direction :send or :recv
+    # @param [PacketFu::Packet] pkt packet
+    # @return [Array<PacketFu::Packet>]
+    def append(direction, pkt)
+      raise ArgumentError unless match?(direction, pkt)
+      @pkts << pkt
+      @range = Range.new(*[@range.begin, @range.end, pkt.timestamp].minmax)
+      @pkts
+    end
+    alias :<< :append
+
+    # @return [Float] unix time value
+    def last_timestamp
+      @range.last
+    end
+
+    # @param [Symbol] direction :send or :recv
+    # @param [PacketFu::Packet] pkt packet
+    # @return [Boolean] 
+    def match?(direction, pkt)
+      num = (direction == :send) ?  pkt.tcp_seq.to_i : pkt.tcp_ack.to_i
+      @direction == direction && @seq_ack_num == num
+    end
+
+    # reassemble tcp stream data
+    # @return [String] reassembled data
+    def data
+      pkts = @pkts.sort_by!{|pk| pk.timestamp }
+      pkts.map{|pkt| pkt.payload }.select{|pay| pay !~ /\A\0+\Z/}.compact.join
+    end
+  end
+end
+

data/lib/reassemble_tcp/packetfu_extend.rb

@@ -0,0 +1,33 @@
+require 'packetfu'
+
+# extension for PacketFu
+module PacketFu
+  class Timestamp
+    def to_f
+      sec.to_i + (usec.to_i / 1000_000.0)
+    end
+  end
+
+  class PcapFile
+    def self.read_packets_with_timestamp(fname, &block)
+      count = 0
+      packets = [] unless block
+      read(fname) do |packet| 
+        pkt = Packet.parse(packet.data.to_s)
+        pkt.timestamp = packet.timestamp.to_f
+        if block
+          count += 1
+          yield pkt
+        else
+          packets << pkt
+        end
+      end
+      block ? count : packets
+    end
+  end
+
+  class Packet
+    # @return [Fixnum] timestamp unix time
+    attr_accessor :timestamp
+  end
+end

data/lib/reassemble_tcp/tcp_connection.rb

@@ -0,0 +1,98 @@
+require 'packetfu'
+
+module ReassembleTcp
+
+  # TCP connection object
+  class TcpConnection
+    attr_reader :syn, :timestamp_range
+
+    # @param [PacketFu::TCPPacket] pkt SYN packet
+    def initialize(pkt)
+      raise ArgumentError, "#{pkt} is not PacketFu::TCPPacket." unless pkt.kind_of? PacketFu::TCPPacket
+      raise ArgumentError, "#{pkt} is not TCP packet." unless pkt.is_tcp?
+      raise ArgumentError, "#{pkt} is not SYN packet." unless pkt.tcp_flags[:syn] == 1
+
+      @syn = pkt
+      @timestamp_range = (@syn.timestamp .. Float::INFINITY)
+      @stream_array = []
+    end
+
+    def send?(pkt)
+      ((@syn.tcp_dport == pkt.tcp_dport and @syn.ip_dst == pkt.ip_dst) and
+       (@syn.tcp_sport == pkt.tcp_sport and @syn.ip_src == pkt.ip_src))
+    end
+
+    def recv?(pkt)
+      ((@syn.tcp_sport == pkt.tcp_dport and @syn.ip_src == pkt.ip_dst) and
+       (@syn.tcp_dport == pkt.tcp_sport and @syn.ip_dst == pkt.ip_src))
+    end
+
+    def src_ip
+      @syn.ip_src_readable
+    end
+
+    def src_port
+      @syn.tcp_sport
+    end
+
+    def dst_ip
+      @syn.ip_dst_readable
+    end
+
+    def dst_port
+      @syn.tcp_dport
+    end
+
+    def direction(pkt)
+      raise ArgumentError, "#{pkt} is not matched with this connection" unless match?(pkt)
+      return :send if send?(pkt)
+      return :recv if recv?(pkt)
+      raise "error"
+    end
+
+    def match?(pkt)
+      raise ArgumentError, "#{pkt} is not TCP packet." unless pkt.is_tcp?
+      # target packet is the same source and destination
+      return false unless (send?(pkt) || recv?(pkt))
+      # target packet is in connection's time range
+      return @timestamp_range.include? pkt.timestamp
+    end
+
+    def append(pkt)
+      raise ArgumentError, "#{pkt} is not matched with this connection" unless match?(pkt)
+      if pkt.tcp_flags[:fin] == 1 || pkt.tcp_flags[:rst] == 1
+        # FIN or RST packet is treated as end of the TCP stream.
+        # and it determines time range of the TCP stream.
+        # FIN packet is not included int Streams
+        @timestamp_range = (@syn.timestamp .. pkt.timestamp)
+        return
+      end
+      dir = direction(pkt)
+      # store packets into packet stream
+      pkt_stm = @stream_array.find{|stm| stm.match? dir, pkt }
+      if pkt_stm.nil?
+        @stream_array << PacketStream.new(dir, pkt)
+      else
+        pkt_stm.append(dir, pkt)
+      end
+    end
+    alias :<< :append
+
+    # @yieldparam [Range] time time range of stream data
+    # @yieldparam [Symbol] direction :send or :recv
+    # @yieldparam [String] data reassembled TCP data
+    def tcpdata(&block)
+      arr = []
+      @stream_array.sort_by{|pstm| pstm.last_timestamp }.each do |s|
+        next if s.data.nil? || s.data.empty?
+        if block.nil?
+          arr << [s.range, s.direction, s.data]
+        else
+          yield s.range, s.direction, s.data
+        end
+      end
+      return arr
+    end
+  end
+end
+

data/lib/reassemble_tcp/version.rb

@@ -0,0 +1,3 @@
+module ReassembleTcp
+  VERSION = "0.0.1"
+end

data/lib/reassemble_tcp.rb

@@ -0,0 +1,54 @@
+require 'reassemble_tcp/version'
+require 'reassemble_tcp/version'
+require 'reassemble_tcp/packetfu_extend'
+require 'reassemble_tcp/packet_stream'
+require 'reassemble_tcp/tcp_connection'
+
+module ReassembleTcp
+
+  # get TCP connections from pcap file
+  # @param [String] filepath pcapfile path
+  # @return [Array<ReassembleTcp::TcpConnection>] tcp connections
+  def self.tcp_connections(filepath)
+    streams = []
+    PacketFu::PcapFile.read_packets_with_timestamp(filepath) {|pkt|
+      next unless pkt.is_ip? and pkt.is_tcp?
+      stm = streams.find{|ts| ts.match?(pkt) }
+      if pkt.tcp_flags[:syn] == 1 && pkt.tcp_flags[:ack] == 0
+        next unless stm.nil?
+        streams << TcpConnection.new(pkt)
+      else
+        next if stm.nil?
+        stm << pkt
+      end
+    }
+    streams
+  end
+
+  # get reassembled tcp data
+  # @param [String] filepath pcapfile path
+  # @yield [time, from, to, data]
+  # @yieldparam [Time] time packet timestamp
+  # @yieldparam [String] from source IP address
+  # @yieldparam [String] to destination IP address
+  # @yieldparam [String] data tcp resassembled data
+  def self.tcp_data_stream(filepath, &block)
+    stream_data = {}
+    ReassembleTcp.tcp_connections(filepath).each do |conn|
+      dst = conn.dst_ip
+      src = conn.src_ip
+      conn.tcpdata do |range, dir, data|
+        next if data.nil? || data.empty?
+        from, to = (dir == :send ) ? [src, dst] : [dst, src]
+        p range.last
+        etime = Time.at(range.last)
+        stream_data[etime] = [from, to, data]
+      end
+    end
+    stream_data.keys.sort.each do |etime|
+      from, to, data = stream_data[etime]
+      yield etime, from, to, data
+    end
+    nil
+  end
+end

data/reassemble_tcp.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'reassemble_tcp/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "reassemble_tcp"
+  spec.version       = ReassembleTcp::VERSION
+  spec.authors       = ["masatanish"]
+  spec.email         = ["masatanish@gmail.com"]
+  spec.description   = %q{Reassemble TCP fragment data from pcap file like Wireshark.}
+  spec.summary       = %q{Reassemble TCP fragment data from pcap file like Wireshark.}
+  spec.homepage      = "https://github.com/masatanish/reassemble_tcp"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "packetfu", "~> 1.1.9"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/spec/reassemble_tcp_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe ReassembleTcp do
+  it 'should have a version number' do
+    ReassembleTcp::VERSION.should_not be_nil
+  end
+
+  let(:test_pcap_path){ File.expand_path(File.dirname(__FILE__) + '/data/test.pcap') }
+
+  describe '.tcp_connections' do
+    subject { ReassembleTcp.tcp_connections(path) }
+    context 'with test pcap file' do
+      let(:path) { test_pcap_path }
+      it { expect(subject).to be_a Array }
+      it 'should return 4 connections' do
+        expect(subject.size).to eq 4
+      end
+      it 'should return an array of ReassembleTcp::TcpConnection' do
+        expect(subject.first).to be_a ReassembleTcp::TcpConnection
+      end
+    end
+  end
+
+  describe '.tcp_data_stream' do
+    pending 'not implemented yet.'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'reassemble_tcp'

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: reassemble_tcp
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- masatanish
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: packetfu
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.9
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Reassemble TCP fragment data from pcap file like Wireshark.
+email:
+- masatanish@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/reassemble_tcp.rb
+- lib/reassemble_tcp/packet_stream.rb
+- lib/reassemble_tcp/packetfu_extend.rb
+- lib/reassemble_tcp/tcp_connection.rb
+- lib/reassemble_tcp/version.rb
+- reassemble_tcp.gemspec
+- spec/data/test.pcap
+- spec/reassemble_tcp_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/masatanish/reassemble_tcp
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.5
+signing_key: 
+specification_version: 4
+summary: Reassemble TCP fragment data from pcap file like Wireshark.
+test_files:
+- spec/data/test.pcap
+- spec/reassemble_tcp_spec.rb
+- spec/spec_helper.rb