DIY-pcap 0.0.1 → 0.0.2

data/README.md

@@ -0,0 +1,55 @@
+DIY-pcap
+=============
+
+## 这是什么?
+
+自定义发包工具,可以轻易实现包交互, 实现是来自 [ffi-pcap](https://github.com/sophsec/ffi-pcap/) 的二次封装.
+
+## 使用方法,完全自定义发包 ( 一 )
+
+1. 安装很简单
+
+    ```
+        gem install DIY-pcap
+    ```
+        
+    服务端与本机需要同时安装.
+        
+2. 准备好要发送和接收的数据放在 `pcaps` 目录下, 创建文件 spec.rb:
+
+    ```ruby
+          pcap do |s|
+            s.dir = "pcaps"
+            s.send "r1.dat"
+            s.recv "s1.dat"
+            s.recv "s2.dat"
+            s.send "r2.dat"
+          end
+    ```
+        
+    上面的意思是, 从本机发送 `r1.dat` 到 服务端, 并等待接收 `s1.dat`, `s2.dat` 数据包, 之后再发送 `r2.dat`, 最后结束.
+    更多内容请参考: simple/ 里面的内容.
+
+3. 开始发送与接收数据
+
+  * 服务端,执行 `rpcap spec.rb`
+  
+  * 本机, 执行 `pcap spec.rb`
+  
+## 使用方法, 回放pcap报文 ( 二 )
+
+1. 安装同上
+
+2. 准备好 pcap 文件放在 `pcaps/simple.pcap` 目录下, 创建文件 spec.rb:
+
+    ```ruby
+          DIY::Builder.new do
+            pcapfile "pcaps/simple.pcap"
+            use SimpleStrategy.new
+          end
+    ```
+3. 同上
+
+4. (其他说明) 扩展策略, 自定义日志, 修改报文内容.
+  
+OK, 祝你好运.

data/bin/pcap

@@ -1,5 +1,5 @@
 $LOAD_PATH.unshift File.join( File.dirname(__FILE__), '..', 'lib' )
-require 'diy/pcap'
+require 'diy-pcap'
 require 'diy/task'
 
 if ARGV[0].nil?

data/bin/rpcap

@@ -1,5 +1,5 @@
 $LOAD_PATH.unshift File.join( File.dirname(__FILE__), '..', 'lib' )
-require 'diy/pcap'
+require 'diy-pcap'
 require 'diy/task'
 
 $SERVER = true

data/lib/DIY-pcap.rb

@@ -1,2 +1,3 @@
 require "diy/version"
 require 'diy/pcap'
+require 'diy/dig'

data/lib/diy/dig.rb

@@ -0,0 +1,337 @@
+# encoding : utf-8
+module DIY
+  
+  class Error < RuntimeError; end
+  # 数据包读取完毕
+  class EOFError < Error; end
+
+  class Recver
+    def initialize(live)
+      @live = live
+      @watchers = []
+    end
+    
+    def run
+      @live.loop do |this, pkt|
+        notify_recv_pkt(pkt)
+      end
+    end
+    
+    def stop
+      @live.stop
+    end
+    
+    def notify_recv_pkt(pkt)
+      @watchers.each do |watcher|
+        watcher.recv_pkt(pkt.body)
+      end
+    end
+    
+    def add_watcher(watcher)
+      @watchers = [] unless @watchers
+      @watchers << watcher
+    end
+    
+    def del_watcher(watcher)
+      @watchers.delete(watcher)
+    end
+  end
+  
+  class Sender
+    def initialize(live)
+      @live = live
+    end
+    
+    def inject(pkt)
+      puts "send: #{Time.now}"
+      @live.inject(pkt)
+    end
+  end
+  
+  require 'thread'
+  require 'timeout'
+  class Queue
+    
+    def initialize(offline)
+      @expect_recv_queue = []
+      @offline = offline
+      @m = Mutex.new
+      # 暂存 next_send_pkt 数据
+      @tmp_send_pkt = nil
+    end
+    
+    def expect_recv_queue
+      @expect_recv_queue
+    end
+    
+    def pop
+      return nil if @expect_recv_queue.empty?
+      @m.synchronize {
+        return @expect_recv_queue.shift
+      }
+    end
+    
+    def delete(what)
+      if @expect_recv_queue.include?(what)
+        @m.synchronize {
+          if @expect_recv_queue.include?(what)
+            return @expect_recv_queue.delete(what)
+          end
+        }
+      end
+      return nil
+    end
+    
+    def delete_at(index)
+      @m.synchronize {
+        return @expect_recv_queue.delete_at(index)
+      }
+    end
+    
+    def peek
+      return nil if @expect_recv_queue.empty?
+      @expect_recv_queue[0]
+    end
+    
+    # 处理发送报文
+    #
+    # 等待接受报文完成后, 返回发送报文, 并重新填充接受报文
+    # TODO: 支持多个pcap文件
+    def next_send_pkt(&block)
+      wait_until { @expect_recv_queue.empty? }
+      if @tmp_send_pkt
+        pkt = @tmp_send_pkt
+        @tmp_send_pkt = nil
+      else
+        pkt = write_recv_pkt
+        wait_until { @expect_recv_queue.empty? }
+      end
+      raise EOFError, " no pkt to send" unless pkt
+      pkt = pkt.copy
+      
+      recv_pkt = write_recv_pkt
+      
+      yield(pkt.body) if block_given?
+      
+      @tmp_send_pkt = recv_pkt.copy if recv_pkt
+      pkt.body
+    end
+    alias_method :next, :next_send_pkt
+    
+    def write_recv_pkt
+      while ( (recv_pkt = @offline.next) && ( set_first_gout(recv_pkt.body); comein?(recv_pkt.body) ) )
+        @m.synchronize {
+          @expect_recv_queue << recv_pkt.copy.body
+        }
+      end
+      recv_pkt
+    end
+    
+    def do_loop(&block)
+      raise "Must give me block" unless block_given?
+      while(true) do 
+        next_send_pkt(&block)
+      end
+    end
+    
+    def set_first_gout(pkt)
+      return @src_mac if @src_mac
+      if pkt.size < 12
+        raise PktError,"can't find src mac: error format packet"
+      end
+      @src_mac = pkt[6..11]
+    end
+    
+    def comein?(pkt)
+      ret = judge_direct(pkt) do | pkt_mac, src_mac|
+        (pkt_mac != src_mac) ^ server?
+      end
+      ret
+    end
+    
+    def gout?(pkt)
+      judge_direct(pkt) do | pkt_mac, src_mac|
+        (pkt_mac == src_mac) ^ server?
+      end
+    end
+    
+    def server?
+      $SERVER
+    end
+    
+    def judge_direct(pkt,&block)
+      if pkt.size < 12
+        raise PktError,"can't find src mac: error format packet"
+      end
+      raise "src_mac not set" unless @src_mac
+      yield( pkt[6..11], @src_mac )
+    end
+    
+    def wait_until( timeout = 20, &block )
+      timeout(timeout) do
+        loop do
+          break if block.call
+          sleep 0.01
+        end
+      end
+    end
+    
+  end
+  
+  # 这个策略是一个最基本的: 
+  # 具体返回值含义见 @BasicStrategy
+  class Strategy
+    OK = true
+    OK_NO_POP = 1
+    FAIL = false
+    NONE = nil
+  end
+  
+  class BasicStrategy < Strategy
+    
+    # @argument:
+    # hope_pkt: 期望的报文
+    # recv_pkt: 接收的报文
+    # queue: 期望接收队列, 如果期望乱序时,你可以使用这个参数
+    # 
+    # @return: 
+    # OK : 匹配, 可以进行下一个报文的处理
+    # OK_NO_POP: 匹配了接收队列中的报文, 但是不需要框架自动pop掉期望报文( 注意, 你需要自行处于报文 )
+    # FAIL: 肯定失败时使用
+    # NONE: 不匹配, 让框架进行下一个报文匹配
+    def call(hope_pkt, recv_pkt, queue)
+      raise "write code here"
+    end
+  end
+  
+  class SimpleStrategy < BasicStrategy
+    def call(hope_pkt, recv_pkt, queue)
+      if hope_pkt == recv_pkt
+        return OK
+      else
+        return NONE
+      end
+    end
+  end
+  
+  require 'logger'
+  class StrategyBuilder
+    def initialize(queue)
+      @ins = []
+      @logger = Logger.new(STDOUT)
+      @queue = queue
+    end
+    attr_reader :queue
+    
+    def add(strategy)
+      @ins << strategy
+    end
+    alias << add
+    
+    def logger=(logger)
+      @logger = logger
+    end
+    
+    def logger
+      @logger
+    end
+    
+    def recv_pkt(pkt)
+      recv_pkt_queue(queue,pkt)
+    end
+    
+    def recv_pkt_queue(queue, recv_pkt)
+      hope_pkt = queue.peek
+      logger.debug("recv_pkt, I hope: #{ hope_pkt[0..10].dump rescue nil }...")
+      return if hope_pkt.nil?
+      @ins.each do |strategy|
+        begin
+        ret = strategy.call(hope_pkt, recv_pkt, queue)
+        rescue Exception => e
+          logger.error("strategy call exception: #{e.class} -> #{e.message}")
+          raise
+          #仅仅忽略
+        else
+          if ret == Strategy::OK
+            logger.info("pkt same:")
+            queue.pop
+            return
+          elsif ret == Strategy::OK_NO_POP
+            logger.info("pkt same but no pop:")
+            return
+          elsif ret == Strategy::FAIL
+            logger.warn("pkt fail:")
+          elsif ret == Strategy::NONE
+            logger.debug("pkt jumpped:")
+            next
+          end
+        end
+      end
+    end
+  end
+  
+
+  class Controller
+    def initialize(live, offline, strategy)
+      @live = live
+      @recver = Recver.new(@live)
+      @recver.add_watcher(strategy)
+      @recver_t = nil
+      @sender = Sender.new(@live)
+      @queue = strategy.queue
+      @logger = Logger.new(STDOUT)
+    end
+    attr_accessor :logger
+    
+    def run
+      @recver_t = Thread.new do
+        @recver.run
+      end
+      
+      begin
+        @queue.do_loop do |pkt|
+          @sender.inject(pkt)
+        end
+        @recver_t.join
+      rescue EOFError
+        @recver.stop
+      end
+    end
+    
+  end
+  
+  class Builder
+    def initialize(&block)
+      @strategies = []
+      instance_eval(&block)
+    end
+    
+    def find_device
+      @device_name ||= FFI::PCap.dump_devices[0][0]
+      @live = FFI::PCap::Live.new(:dev=>@device_name, :handler => FFI::PCap::Handler, :promisc => true)
+    end
+    
+    def device(name)
+      @device_name = name
+    end
+    
+    def use(what)
+      @strategies.unshift(what)
+    end
+    
+    def pcapfile(pcaps)
+      @offline = FFI::PCap::Offline.new(pcaps)
+    end
+    
+    def run
+      @offline ||= FFI::PCap::Offline.new('pcaps/example.pcap')
+      @queue = Queue.new(@offline)
+      @strategy_builder = DIY::StrategyBuilder.new(@queue)
+      @strategies.each { |builder| @strategy_builder.add(builder) }
+      find_device
+      controller = Controller.new( @live, @offline, @strategy_builder )
+      controller.run
+    end
+    
+  end
+end

data/lib/diy/version.rb

@@ -1,5 +1,5 @@
 module DIY
   class PCAP
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

data/simple/cmd-pcap.rb

@@ -1,5 +1,11 @@
+# encoding : utf-8
+# 这是一个单个包交互发送的例子
+# 安装 DIY-pcap 后, 先启动服务端 `rpcap cmd-pcap`, 服务端会开始等待接收包文.
+# 启动客户端 `pcap cmd-pcap`
+# 等待收包完成, 如果出现超时, 说明中间数据不一致, 被修改了.
+
 pcap do |s|  
-  s.dir = File.join( File.dirname(__FILE__), 'pcaps')
+  s.dir = 'pcaps'
   s.send("r1.dat")
   s.recv("s1.dat")
   s.recv("s2.dat")

data/simple/pcap.rb

@@ -0,0 +1,13 @@
+$LOAD_PATH.unshift File.join( File.dirname(__FILE__), '..', 'lib')
+require 'rubygems'
+require 'diy-pcap'
+require 'diy/dig'
+
+ss = DIY::SimpleStrategy.new
+
+a = DIY::Builder.new do 
+  use ss
+  pcapfile "pcaps/gre.pcap"
+end
+
+a.run

data/spec/dig_spec.rb

@@ -0,0 +1,103 @@
+require 'spec_helper'
+describe DIY::Queue do
+  
+  before(:each) do
+    @device_name = FFI::PCap.dump_devices[0][0]
+    @live = FFI::PCap::Live.new(:dev=>@device_name, :handler => FFI::PCap::Handler, :promisc => true)
+    @offline = FFI::PCap::Offline.new('../simple/pcaps/gre.pcap')
+  end
+  
+  it "#next_send_pkt" do
+    $SERVER = nil
+    q = DIY::Queue.new(@offline)
+    q.stub(:wait_until).and_return(true)
+    q.next_send_pkt.should == File.read( File.join( File.dirname(__FILE__), 'helper/pkt1' ) )
+    pkt1 = q.instance_variable_get("@expect_recv_queue")[0]
+    pkt2 = q.instance_variable_get("@expect_recv_queue")[1]
+    q.instance_variable_get("@expect_recv_queue").size.should == 2
+    pkt1.should == File.read( File.join( File.dirname(__FILE__), 'helper/pkt2' ) )
+    pkt2.should == File.read( File.join( File.dirname(__FILE__), 'helper/pkt3' ) )
+    q.instance_variable_set("@expect_recv_queue", [])
+    q.next_send_pkt.should == File.read( File.join( File.dirname(__FILE__), 'helper/pkt4' ) )
+    q.instance_variable_get("@expect_recv_queue").should == []
+    lambda { loop { q.next_send_pkt } }.should raise_error
+  end
+  
+  it "#next_send_pkt server" do
+    $SERVER = true
+    q = DIY::Queue.new(@offline)
+    q.stub(:wait_until).and_return(true)
+    q.next_send_pkt.should == File.read( File.join( File.dirname(__FILE__), 'helper/pkt2' ) )
+    q.instance_variable_get("@expect_recv_queue").should == [ File.read( File.join( File.dirname(__FILE__), 'helper/pkt1' ) )  ]
+    q.instance_variable_set("@expect_recv_queue", [])
+    q.next_send_pkt.should == File.read( File.join( File.dirname(__FILE__), 'helper/pkt3' ) )
+    q.instance_variable_get("@expect_recv_queue").should == [ File.read( File.join( File.dirname(__FILE__), 'helper/pkt4' )), File.read( File.join( File.dirname(__FILE__), 'helper/pkt5' )) ]
+    $SERVER = nil
+  end
+  
+  it "#comein? server" do
+    $SERVER = true
+    q = DIY::Queue.new(@offline)
+    pkt =  File.read( File.join( File.dirname(__FILE__), 'helper/pkt1' ) )
+    pkt2 =  File.read( File.join( File.dirname(__FILE__), 'helper/pkt2' ) )
+    q.set_first_gout(pkt)
+    q.set_first_gout(pkt2).should == pkt[6..11]
+    q.comein?(pkt).should == true
+    q.comein?(pkt2).should == false
+    $SERVER = nil
+  end
+  
+  it "#peek #pop" do
+    q = DIY::Queue.new(@offline)
+    q.stub(:wait_until).and_return(true)
+    q.next_send_pkt
+    q.peek.should == File.read( File.join( File.dirname(__FILE__), 'helper/pkt2' ) )
+    q.pop.should == File.read( File.join( File.dirname(__FILE__), 'helper/pkt2' ) )
+    q.peek.should == File.read( File.join( File.dirname(__FILE__), 'helper/pkt3' ) )
+    q.pop
+    q.peek.should == nil
+  end
+  
+  it "#delete" do
+    q = DIY::Queue.new(@offline)
+    q.stub(:wait_until).and_return(true)
+    q.next_send_pkt
+    q.delete(File.read( File.join( File.dirname(__FILE__), 'helper/pkt2' ) )).should == File.read( File.join( File.dirname(__FILE__), 'helper/pkt2' ) )
+    q.pop
+    q.peek.should == nil
+  end
+  
+  it "#delete_at" do
+    q = DIY::Queue.new(@offline)
+    q.stub(:wait_until).and_return(true)
+    q.next_send_pkt
+    q.delete_at(0).should == File.read( File.join( File.dirname(__FILE__), 'helper/pkt2' ) )
+  end
+
+end
+
+describe DIY::Controller do
+  before(:each) do 
+    @device_name = FFI::PCap.dump_devices[0][0]
+    @live = FFI::PCap::Live.new(:dev=>@device_name, :handler => FFI::PCap::Handler, :promisc => true)
+    @offline = FFI::PCap::Offline.new('../simple/pcaps/gre.pcap')
+  end
+  
+  it "#run" do
+    q = nil
+    server = Thread.new do
+      q = DIY::Queue.new(@offline)
+      q.stub(:server?).and_return(true)
+      DIY::Queue.stub(:new).and_return(q)
+      s = DIY::Controller.new(@live, @offline)
+      s.run
+    end
+    device_name = FFI::PCap.dump_devices[0][0]
+    live = FFI::PCap::Live.new(:dev=>@device_name, :handler => FFI::PCap::Handler, :promisc => true)
+    offline = FFI::PCap::Offline.new('../simple/pcaps/gre.pcap')
+    c = DIY::Controller.new(live, offline)
+    q.wait_until { q.peek != nil }
+    lambda { c.run ; server.join }.should_not raise_error
+  end
+  
+end

data/spec/spec_helper.rb

@@ -1,17 +1,2 @@
-# This file was generated by the `rspec --init` command. Conventionally, all
-# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
-# Require this file using `require "spec_helper"` to ensure that it is only
-# loaded once.
-#
-# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
-RSpec.configure do |config|
-  config.treat_symbols_as_metadata_keys_with_true_values = true
-  config.run_all_when_everything_filtered = true
-  config.filter_run :focus
-
-  # Run specs in random order to surface order dependencies. If you find an
-  # order dependency and want to debug it, you can fix the order by providing
-  # the seed, which is printed after each run.
-  #     --seed 1234
-  config.order = 'random'
-end
+$LOAD_PATH.unshift File.join( File.dirname(__FILE__), '..', 'lib' )
+require 'DIY-pcap'

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - yafei Lee
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-08-30 00:00:00 +08:00
+date: 2012-09-10 00:00:00 +08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -47,16 +47,18 @@ files:
 - .rspec
 - DIY-pcap.gemspec
 - Gemfile
+- README.md
 - Rakefile
 - bin/pcap
 - bin/rpcap
 - lib/DIY-pcap.rb
+- lib/diy/dig.rb
 - lib/diy/pcap.rb
-- lib/diy/sender.rb
 - lib/diy/task.rb
 - lib/diy/version.rb
 - simple/cmd-pcap.rb
-- simple/diy-pcap.rb
+- simple/pcap.rb
+- simple/pcaps/gre.pcap
 - simple/pcaps/r1.dat
 - simple/pcaps/r3-2.dat
 - simple/pcaps/r3.dat
@@ -64,6 +66,12 @@ files:
 - simple/pcaps/s2.dat
 - simple/pcaps/s3.dat
 - simple/pcaps/s4.dat
+- spec/dig_spec.rb
+- spec/helper/pkt1
+- spec/helper/pkt2
+- spec/helper/pkt3
+- spec/helper/pkt4
+- spec/helper/pkt5
 - spec/spec_helper.rb
 has_rdoc: true
 homepage: ""

data/lib/diy/sender.rb

@@ -1,10 +0,0 @@
-require 'eventmachine'
-
-
-module DIY
-  class Sender < EM::Connection
-    def notify_readable(*arg)
-    end
-    
-  end
-end

data/simple/diy-pcap.rb

@@ -1,13 +0,0 @@
-$LOAD_PATH.unshift File.join( File.dirname(__FILE__), '..', 'lib' )
-require 'rubygems'
-require 'diy/pcap'
-
-# client and server
-DIY::PCAP.new do |s|
-  s.dir = File.join( File.dirname(__FILE__), 'pcaps')
-  s.send("r1.dat")
-  s.recv("s1.dat")
-  s.recv("s2.dat")
-  s.recv("s3.dat")
-  s.send("r3.dat")
-end