pcaprub 0.12.0 → 0.12.1

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    YTM1M2U0NmViOTRlNDVkNDk3ZWU5Yzk5NDI4OTk5MmQ0ZDE5ZWJlMg==
-  data.tar.gz: !binary |-
-    MzcyNDk3YTY1YjUzNGE2ZDQyYTQ1MTU4YTk3YjcyOGY3NGIxODIxMg==
+SHA1:
+  metadata.gz: b40590aca5ff2daad1628f3b1a0e6c97a9708c34
+  data.tar.gz: a6e49962b099f5d7a1e35db4052c35d532338b0e
 SHA512:
-  metadata.gz: !binary |-
-    OGYwOWYxMTM1Y2VjOTE0NzBlOTA1NTljMzJkNmFlZWEyOWQ2MTI2MDE0ODVh
-    NDJkNjgxOTM3ODk4YzRhMjFlMDMwYTcxZjM3Mzk4OTJiNTI5ODhiOTU5NmVm
-    MTBhNGQxNTI0ZDMyNGJmMmRhNzJlYmUzNjZhZGEzNjFiYjAyMTA=
-  data.tar.gz: !binary |-
-    ODc3OGFhY2RjZmEwNzIzM2IwNGQ1OGNiMTQ5MzhmY2JiMDUyNDA5NDAxYTZm
-    MGJmZDJmNGVkNmM4YjY4MjMwZTYwODI2NTc3OGE4MTNmZDAyZTE3MGM3Y2Qy
-    YzBhNTcyYTMxOTZkZTQ4YmIzY2Y2ZWQyYmZkOWQ5Mjc1MWYxODE=
+  metadata.gz: 8417a0109228972f697b536fb01ed951f582d05872188a874c0ffb939f44161153501289dfeaf269de8d24b7d013394549b02d9d758caa85fd0bf86860d6d3f8
+  data.tar.gz: adea669c22d2d0547bf772cb62ec1bb1ecdc53dd2cf7141b61fc886889b34bbcf3339aea37f6d2be39c170620ab781e5c4b5f57f74fbdaa30d8770236035a73d

data/Gemfile

@@ -18,3 +18,4 @@ end
 gem 'rake', '>= 0.9.2'
 gem 'rake-compiler', '>= 0.6.0'
 gem 'rubygems-tasks'
+gem 'git'

data/README.rdoc

@@ -1,6 +1,9 @@
 = pcaprub
 
+{<img src="https://badges.gitter.im/Join%20Chat.svg" alt="Join the chat at https://gitter.im/pcaprub/pcaprub">}[https://gitter.im/pcaprub/pcaprub?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge]
+
 {<img src="https://travis-ci.org/pcaprub/pcaprub.png" alt="Build Status" />}[https://travis-ci.org/pcaprub/pcaprub]
+{<img src="https://ci.appveyor.com/api/projects/status/7g3x62y9rgy3twds?svg=true" alt="Windows Builds" />}[https://ci.appveyor.com/project/shadowbq/pcaprub]
 {<img src="https://codeclimate.com/github/pcaprub/pcaprub.png" />}[https://codeclimate.com/github/pcaprub/pcaprub]
 {<img src="https://badge.fury.io/rb/pcaprub.png" alt="Gem Version" />}[http://badge.fury.io/rb/pcaprub]
 {<img src="https://gemnasium.com/pcaprub/pcaprub.svg" alt="Dependency Status" />}[https://gemnasium.com/pcaprub/pcaprub]
@@ -29,11 +32,16 @@ MRI Windows Ruby (Native compilation)
   Ruby 1.9.3 or higher
   Ruby 2.x or higher
 
-  WinPcap - http://www.winpcap.org
+  WinPcap Developer's Pack - http://www.winpcap.org
+  
 
 == Installation  
 
-  gem install pcaprub  
+  gem install pcaprub
+  
+Advanced options in a Windows ENV
+  
+  gem install pcaprub --no-ri --no-rdoc -- --with-pcap-dir="c:/dev/src/WpdPack"
 
 == Usage
 

data/Rakefile

@@ -5,7 +5,7 @@ def java?
   /java/ === RUBY_PLATFORM
 end
 
-ENV['LANG'] = "en_US.UTF-8" 
+ENV['LANG'] = "en_US.UTF-8"
 
 
 @gemspec = Gem::Specification.new do |spec|
@@ -38,8 +38,7 @@ ENV['LANG'] = "en_US.UTF-8"
     "lib/pcaprub/common.rb",
     "lib/pcaprub/ext.rb",
     "lib/pcaprub/version.rb",
-    "test/helper.rb",
-    "test/test_pcaprub.rb",
+    "test/test_helper.rb",
     "test/test_pcaprub_unit.rb"
   ]
 
@@ -56,33 +55,20 @@ ENV['LANG'] = "en_US.UTF-8"
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake", '>= 0.9.2'
-  spec.add_development_dependency "rake-compiler", '>= 0.6.0'
-  spec.add_development_dependency "shoulda-context", '~> 1.1.6'
-  spec.add_development_dependency "minitest", '~> 4.7.0'
+  spec.add_development_dependency "rake", '~> 0.9', '>= 0.9.2'
+  spec.add_development_dependency "rake-compiler", '~> 0.6', '>= 0.6.0'
+  spec.add_development_dependency "shoulda-context", '~> 1.1', '~> 1.1.6'
+  spec.add_development_dependency "minitest", '~> 4.7', '>= 4.7.0'
 
 end
 
 require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|
   test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
+  test.test_files = FileList['test/test_pcaprub_unit.rb']
   test.verbose = true
 end
 
-begin
-  require 'rcov/rcovtask'
-  Rcov::RcovTask.new do |test|
-    test.libs << 'test'
-    test.pattern = 'test/**/test_*.rb'
-    test.verbose = true
-  end
-rescue LoadError
-  task :rcov do
-    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
-  end
-end
-
 task :test
 
 require 'rubygems/package_task'
@@ -91,6 +77,20 @@ Gem::PackageTask.new(@gemspec) do |pkg|
   pkg.need_tar = false
 end
 
+# prepend DevKit into compilation phase
+if RUBY_PLATFORM =~ /mingw/
+  task :compile => [:devkit]
+  task :native  => [:devkit]
+end
+
+task :devkit do
+  begin
+    require "devkit"
+  rescue LoadError => e
+    abort "Failed to activate RubyInstaller's DevKit required for compilation."
+  end
+end
+
 require 'rake/extensiontask'
 Rake::ExtensionTask.new('pcaprub_c', @gemspec)
 
@@ -109,4 +109,22 @@ RDoc::Task.new do |rdoc|
 end
 
 require 'rubygems/tasks'
-Gem::Tasks.new
+Gem::Tasks.new
+
+# Override standard release task
+require 'git'
+Rake::Task["release"].clear
+task :release do
+  version = "#{PCAPRUB::VERSION::STRING}"
+  remote = 'origin'
+  puts "Creating tag v#{version}"
+  git = Git.open(".")
+  git.add_tag("v#{version}")
+  puts "Pushing tag to #{remote}"
+  git.push(remote, 'master', true)
+  Rake::Task['clobber'].invoke
+  Rake::Task['compile'].invoke
+  Rake::Task['gem'].invoke
+  gemtask = Gem::Tasks::Push.new
+  gemtask.push("pkg/pcaprub-#{version}.gem")
+end

data/ext/pcaprub_c/extconf.rb

@@ -34,6 +34,33 @@ elsif /i386-mswin32/ =~ RUBY_PLATFORM
   have_library("wpcap", "pcap_open_live")
   have_library("wpcap", "pcap_setnonblock")
 else
+  libdir = RbConfig::CONFIG['libdir']
+  includedir = RbConfig::CONFIG['includedir']
+
+  header_dirs = [
+    # macports
+    '/opt/local/include',
+    # source installations
+    '/usr/local/include',
+    # ruby install locations
+    includedir,
+    # finally fall back to usr
+    '/usr/include'
+  ]
+
+  lib_dirs = [
+    # macports
+    '/opt/local/lib',
+    # source installations
+    '/usr/local/lib',
+    # ruby install locations
+    libdir,
+    # usr
+    '/usr/lib'
+  ]
+
+  dir_config("pcap", header_dirs, lib_dirs)
+
   have_library("pcap", "pcap_open_live", ["pcap.h"])
   have_library("pcap", "pcap_setnonblock", ["pcap.h"])
 end

data/ext/pcaprub_c/pcaprub.c

@@ -18,7 +18,7 @@
 
 static VALUE mPCAP;
 static VALUE rb_cPcap, rb_cPkt;
-static VALUE ePCAPRUBError, eDumperError, eBindingError, eBPFilterError;
+static VALUE ePCAPRUBError, eDumperError, eBindingError, eBPFilterError, eLinkTypeError;
 
 #if defined(WIN32)
 static VALUE rbpcap_thread_wait_handle(HANDLE fno);
@@ -260,6 +260,73 @@ rbpcap_settimeout(VALUE self, VALUE timeout)
   }
 }
 
+/*
+* call-seq:
+*   listdatalinks()
+*
+* Get supported datalinks for this interface
+*
+* Returns an array of supported datalinks.
+*/
+static VALUE
+rbpcap_listdatalinks(VALUE self)
+{
+  rbpcap_t *rbp;
+  int *links, numlinks;
+  int i;
+  Data_Get_Struct(self, rbpcap_t, rbp);
+
+  numlinks = pcap_list_datalinks(rbp->pd, &links);
+  if (numlinks > 0) {
+    VALUE hash = rb_hash_new();
+    for (i = 0; i < numlinks; i++) {
+      const char *name = pcap_datalink_val_to_name(links[i]);
+      if (name != NULL) {
+        VALUE namestring = rb_str_new2(name);
+        rb_hash_aset(hash, INT2NUM(links[i]), namestring);
+      }
+    }
+    pcap_free_datalinks(links);
+    return hash;
+  } else {
+    rb_raise(eLinkTypeError, "unable to get datalinks (%d): %s", numlinks, pcap_geterr(rbp->pd));
+  }
+}
+
+
+/*
+* call-seq:
+*   setdatalink(1234)
+*
+* Set datalink type for the capture.
+*
+* Returns the object itself.
+*/
+static VALUE
+rbpcap_setdatalink(VALUE self, VALUE datalink)
+{
+  rbpcap_t *rbp;
+  int linktype, errcode;
+  Data_Get_Struct(self, rbpcap_t, rbp);
+
+  if(TYPE(datalink) == T_FIXNUM ) {
+    linktype = NUM2INT(datalink);
+  } else if (TYPE(datalink) == T_STRING) {
+    linktype = pcap_datalink_name_to_val(RSTRING_PTR(datalink));
+    if (linktype < 0) {
+      rb_raise(eLinkTypeError, "invalid datalink name: %s", RSTRING_PTR(datalink));
+    }
+  } else {
+    rb_raise(rb_eArgError, "datalink type must be a string or fixnum");
+  }
+
+  errcode = pcap_set_datalink(rbp->pd, linktype);
+  if (errcode == 0) {
+    return self;
+  } else {
+    rb_raise(eLinkTypeError, "unable to set datalink (%d): %s", errcode, pcap_geterr(rbp->pd));
+  }
+}
 
 /*
 * call-seq:
@@ -352,12 +419,39 @@ rbpcap_setfilter(VALUE self, VALUE filter)
   		rb_warn("unable to get IP: %s", eb);
   	}
 
-  if(pcap_compile(rbp->pd, &bpf, RSTRING_PTR(filter), 0, mask) < 0)
-  	rb_raise(eBPFilterError, "invalid bpf filter");
+  if(pcap_compile(rbp->pd, &bpf, RSTRING_PTR(filter), 0, mask) < 0) {
+  	rb_raise(eBPFilterError, "invalid bpf filter: %s", pcap_geterr(rbp->pd));
+  }
+
+  if(pcap_setfilter(rbp->pd, &bpf) < 0) {
+    pcap_freecode(&bpf);
+  	rb_raise(eBPFilterError, "unable to set bpf filter: %s", pcap_geterr(rbp->pd));
+  }
+
+  pcap_freecode(&bpf);
+  return self;
+}
 
-  if(pcap_setfilter(rbp->pd, &bpf) < 0)
-  	rb_raise(eBPFilterError, "unable to set bpf filter");
+/*
+* call-seq:
+*   compile(filter)
+*
+* Raises an exception if "filter" has a syntax error
+*
+* Returns self if the filter is valid
+*/
+static VALUE
+rbpcap_compile(VALUE self, VALUE filter) {
+  struct bpf_program bpf;
+  u_int32_t mask = 0;
+  rbpcap_t *rbp;
+
+  Data_Get_Struct(self, rbpcap_t, rbp);
+  if(pcap_compile(rbp->pd, &bpf, RSTRING_PTR(filter), 0, mask) < 0) {
+    rb_raise(eBPFilterError, "invalid bpf filter: %s", pcap_geterr(rbp->pd));
+  }
 
+  pcap_freecode(&bpf);
   return self;
 }
 
@@ -1177,6 +1271,7 @@ Init_pcaprub_c()
   eBindingError = rb_path2class("PCAPRUB::BindingError");
   eBPFilterError = rb_path2class("PCAPRUB::BPFError");
   eDumperError = rb_path2class("PCAPRUB::DumperError");
+  eLinkTypeError = rb_path2class("PCAPRUB::LinkTypeError");
 
   rb_define_module_function(rb_cPcap, "lookupdev", rbpcap_s_lookupdev, 0);
   rb_define_module_function(rb_cPcap, "lookupnet", rbpcap_s_lookupnet, 1);
@@ -1259,10 +1354,13 @@ Init_pcaprub_c()
 
   rb_define_method(rb_cPcap, "next", rbpcap_next_data, 0);
   rb_define_method(rb_cPcap, "setfilter", rbpcap_setfilter, 1);
+  rb_define_method(rb_cPcap, "compile", rbpcap_compile, 1);
   rb_define_method(rb_cPcap, "setmonitor", rbpcap_setmonitor, 1);
   rb_define_method(rb_cPcap, "setsnaplen", rbpcap_setsnaplen, 1);
   rb_define_method(rb_cPcap, "settimeout", rbpcap_settimeout, 1);
   rb_define_method(rb_cPcap, "setpromisc", rbpcap_setpromisc, 1);
+  rb_define_method(rb_cPcap, "setdatalink", rbpcap_setdatalink, 1);
+  rb_define_method(rb_cPcap, "listdatalinks", rbpcap_listdatalinks, 0);
   rb_define_method(rb_cPcap, "activate", rbpcap_activate, 0);
   rb_define_method(rb_cPcap, "inject", rbpcap_inject, 1);
   rb_define_method(rb_cPcap, "datalink", rbpcap_datalink, 0);

data/lib/pcaprub/common.rb

@@ -13,5 +13,8 @@ module PCAPRUB
   # deep.
   class DumperError < PCAPRUBError; end
 
+  # Raised if unable to set underlying capture link type
+  class LinkTypeError < PCAPRUBError; end
+
 end
 

data/lib/pcaprub/ext.rb

@@ -6,7 +6,7 @@ begin
   elsif RUBY_VERSION =~ /2.0/
     require '2.0/pcaprub_c'
   elsif RUBY_VERSION =~ /2.1/
-    require '2.1/pcapru_c'
+    require '2.1/pcaprub_c'
   else
     require 'pcaprub_c'
   end

data/lib/pcaprub/version.rb

@@ -4,7 +4,7 @@ module PCAPRUB #:nodoc:
 
     MAJOR = 0
     MINOR = 12
-    TINY = 0
+    TINY = 1
 
     STRING = [MAJOR, MINOR, TINY].join('.')
 
@@ -15,4 +15,4 @@ module PCAPRUB #:nodoc:
     end
   end
 
-end  
+end

data/test/{helper.rb → test_helper.rb}

@@ -1,14 +1,13 @@
 require 'rubygems'
 require 'bundler/setup'
-require 'test/unit'
-require 'shoulda-context'
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require "minitest/autorun"
+require 'test/unit'
 require 'pcaprub'
 
-class Test::Unit::TestCase
-end
 
 if RUBY_VERSION >= "1.9.2"
   require 'coveralls'

data/test/test_pcaprub_unit.rb

@@ -3,8 +3,8 @@
 base = File.symlink?(__FILE__) ? File.readlink(__FILE__) : __FILE__
 $:.unshift(File.join(File.dirname(base)))
 
-require 'test/unit'
-require 'pcaprub'
+
+require File.expand_path '../test_helper.rb', __FILE__
 
 #
 # Simple unit test, requires r00t.
@@ -117,10 +117,29 @@ class Pcap::UnitTest < Test::Unit::TestCase
     o.close
   end
 
+  def test_set_datalink
+    d = Pcap.lookupdev
+    o = Pcap.open_live(d, 65535, true, -1)
+    dls = o.listdatalinks
+    assert_equal(o,o.setdatalink(dls.values.first))
+  end
+
   def test_monitor
     return if RUBY_PLATFORM =~ /mingw|win/
     d = Pcap.lookupdev
     o = Pcap.create(d)
     assert_equal(o, o.setmonitor(true))
   end
+
+  def test_filter
+    d = Pcap.lookupdev
+    o = Pcap.create(d)
+    o.activate
+    assert_nothing_raised do
+      o.compile("ip host 1.2.3.4")
+    end
+    assert_raise PCAPRUB::BPFError do
+      o.compile("A non working filter")
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pcaprub
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.12.1
 platform: ruby
 authors:
 - shadowbq
@@ -11,88 +11,102 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-10 00:00:00.000000000 Z
+date: 2016-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: !binary |-
-          MS4z
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: !binary |-
-          MS4z
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: !binary |-
-          MC45LjI=
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: !binary |-
-          MC45LjI=
+        version: 0.9.2
 - !ruby/object:Gem::Dependency
   name: rake-compiler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: !binary |-
-          MC42LjA=
+        version: '0.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: !binary |-
-          MC42LjA=
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: shoulda-context
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: !binary |-
-          MS4xLjY=
+        version: '1.1'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: !binary |-
-          MS4xLjY=
+        version: 1.1.6
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: !binary |-
-          NC43LjA=
+        version: '4.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.7.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: !binary |-
-          NC43LjA=
+        version: 4.7.0
 description: libpcap bindings for ruby with Ruby1.8, Ruby1.9, Ruby 2.x
 email: shadowbq@gmail.com
 executables: []
@@ -105,8 +119,8 @@ extra_rdoc_files:
 - USAGE.rdoc
 - ext/pcaprub_c/pcaprub.c
 files:
-- .document
-- .travis.yml
+- ".document"
+- ".travis.yml"
 - FAQ.rdoc
 - Gemfile
 - LICENSE
@@ -123,8 +137,7 @@ files:
 - lib/pcaprub/common.rb
 - lib/pcaprub/ext.rb
 - lib/pcaprub/version.rb
-- test/helper.rb
-- test/test_pcaprub.rb
+- test/test_helper.rb
 - test/test_pcaprub_unit.rb
 homepage: https://github.com/pcaprub/pcaprub
 licenses:
@@ -136,22 +149,21 @@ 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:
 - libpcap
 rubyforge_project: 
-rubygems_version: 2.4.1
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: libpcap bindings for ruby
 test_files:
-- test/helper.rb
-- test/test_pcaprub.rb
+- test/test_helper.rb
 - test/test_pcaprub_unit.rb

data/test/test_pcaprub.rb

@@ -1,7 +0,0 @@
-require 'helper'
-
-class TestPcaprub < Test::Unit::TestCase
-  should "be true" do
-    assert true
-  end
-end