pcaprub 0.12.1 → 0.13.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b40590aca5ff2daad1628f3b1a0e6c97a9708c34
-  data.tar.gz: a6e49962b099f5d7a1e35db4052c35d532338b0e
+SHA256:
+  metadata.gz: c73d004b9ff68405a37b7f4a9466c187f3c5fd30110b8688ef9ec35a1a58954c
+  data.tar.gz: 48d2147906a775f47b76192b6c407fd9d2393b39a7383c08e2e14270daded436
 SHA512:
-  metadata.gz: 8417a0109228972f697b536fb01ed951f582d05872188a874c0ffb939f44161153501289dfeaf269de8d24b7d013394549b02d9d758caa85fd0bf86860d6d3f8
-  data.tar.gz: adea669c22d2d0547bf772cb62ec1bb1ecdc53dd2cf7141b61fc886889b34bbcf3339aea37f6d2be39c170620ab781e5c4b5f57f74fbdaa30d8770236035a73d
+  metadata.gz: b2d143fb92771897a20ababd154e1e4d136ce6d4685538211a4d80ab8c67337fc00728e75509fd8bfb2d9a77b146c23db130ac793f328acb2d63da113c4a5554
+  data.tar.gz: 2c57a1ea128a82e91b5f65f187849cae11a53eec67fb4f35291208e92fba27370cc1150910a55b7452cc55dbe9e040d987fa65f12ed7a8f634b8ee14bad0b7c2

data/.travis.yml

@@ -1,11 +1,20 @@
 language: ruby
 before_install:
  - sudo apt-get install libpcap-dev -qq
+before_script:
+ - travis_retry gem update bundler
 rvm:
-  - 1.8.7
-  - 1.9.3
-  - 2.0.0
-  - 2.1.0
-#  - ruby-head
+  - 2.5
+  - 2.6
+  - 2.7
+  - 3.0
+  - ruby-head
+env:
+  rvmsudo_secure_path: 1
+cache: bundler
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+  fast_finish: true
 script:
-  - rvmsudo bundle exec rake
+  - rvmsudo bundle exec rake

data/Gemfile

@@ -1,21 +1,17 @@
 source 'https://rubygems.org'
 
-# No more static spec file
-
-platforms :ruby_18 do
-    gem 'rdoc'
-end
-
 group :development, :test do
   # Prevent occasions where minitest is not bundled in packaged versions of ruby (see #3826)
   gem 'minitest', '~> 4.7.0'
   gem 'shoulda-context', '~> 1.1.6'
-  platforms :ruby_19, :ruby_20, :ruby_21 do
-    gem 'coveralls', :require => false
-  end
+  gem 'test-unit'
+  gem 'coveralls', :require => false
 end
 
-gem 'rake', '>= 0.9.2'
 gem 'rake-compiler', '>= 0.6.0'
 gem 'rubygems-tasks'
-gem 'git'
+
+if Bundler.current_ruby.mri? || Bundler.current_ruby.mingw? || Bundler.current_ruby.x64_mingw?
+  gem 'rake', '>= 0.9.2'
+  gem 'git', '~> 1.3.0'
+end

data/README.rdoc

@@ -20,21 +20,17 @@ For packet processing capability look at ruby gems PCAPFU, PCAPLET, etc..
 
 == Requirements
 
-MRI POSIX Ruby (Native compilation)
-  Ruby 1.8.7  (EOL June 2014)
-  Ruby 1.9.3 or higher
-  Ruby 2.x or higher
+MRI POSIX Ruby (Native compilation) [Travis-CI Tested]
+  ~> Ruby 2.4
 
   libpcap - http://www.tcpdump.org
 
-MRI Windows Ruby (Native compilation)
-  Ruby 1.8.7 (EOL June 2014)
-  Ruby 1.9.3 or higher
-  Ruby 2.x or higher
-
+Ruby with DevKit(32bit) on Windows [AppVeyor Tested]
+  Ruby 1.9.3
+  ~> Ruby 2.x
+  
   WinPcap Developer's Pack - http://www.winpcap.org
   
-
 == Installation  
 
   gem install pcaprub

data/Rakefile

@@ -9,15 +9,16 @@ ENV['LANG'] = "en_US.UTF-8"
 
 
 @gemspec = Gem::Specification.new do |spec|
-  spec.name          = "pcaprub"
-  spec.version       = PCAPRUB::Pcap.version
-  spec.authors       = ["shadowbq", "crondaemon", "jmcavinee", "unmarshal"]
-  spec.email         = "shadowbq@gmail.com"
-  spec.description   = "libpcap bindings for ruby with Ruby1.8, Ruby1.9, Ruby 2.x"
-  spec.summary       = "libpcap bindings for ruby"
-  spec.homepage      = "https://github.com/pcaprub/pcaprub"
-  spec.requirements  = "libpcap"
-  spec.license       = "LGPL-2.1"
+  spec.name                  = "pcaprub"
+  spec.version               = PCAPRUB::Pcap.version
+  spec.authors               = ["shadowbq", "crondaemon", "jmcavinee", "unmarshal"]
+  spec.email                 = "shadowbq@gmail.com"
+  spec.description           = "libpcap bindings for Ruby 2.x"
+  spec.summary               = "libpcap bindings for ruby"
+  spec.homepage              = "https://github.com/pcaprub/pcaprub"
+  spec.requirements          = "libpcap"
+  spec.license               = "LGPL-2.1"
+  spec.required_ruby_version = '>= 2.0'
 
   spec.files = [
     ".document",
@@ -114,6 +115,7 @@ Gem::Tasks.new
 # Override standard release task
 require 'git'
 Rake::Task["release"].clear
+desc 'Release the gem (create tag, build, publish)'
 task :release do
   version = "#{PCAPRUB::VERSION::STRING}"
   remote = 'origin'

data/ext/pcaprub_c/extconf.rb

@@ -4,8 +4,7 @@ extension_name = 'pcaprub_c'
 puts "\n[*] Running checks for #{extension_name} code..."
 puts("platform is #{RUBY_PLATFORM}")
 
-if /i386-mingw32/ =~ RUBY_PLATFORM
-
+if /i386-mingw32/ =~ RUBY_PLATFORM || /x64-mingw32/ =~ RUBY_PLATFORM
   unless  have_library("ws2_32" ) and
     have_library("iphlpapi") and
     have_header("windows.h") and
@@ -18,19 +17,38 @@ if /i386-mingw32/ =~ RUBY_PLATFORM
   pcap_dir        = with_config("pcap-dir", "C:/WpdPack")
   pcap_includedir = with_config("pcap-includedir", pcap_dir + "/include")
   pcap_libdir     = with_config("pcap-libdir", pcap_dir + "/lib")
+  
+  if /x64-mingw32/ =~ RUBY_PLATFORM
+    pcap_libdir += "/x64"
+  end
+
   $CFLAGS  = "-DWIN32 -I#{pcap_includedir}"
+  $CFLAGS += " -g" if with_config("debug")
   $LDFLAGS = "-L#{pcap_libdir}"
+  $LDFLAGS += " -g" if with_config("debug")
   
+  have_header("ruby/thread.h")
+  have_func("rb_thread_blocking_region") # Pre ruby 2.2
+  have_func("rb_thread_call_without_gvl") # Post ruby 2.2
   have_library("wpcap", "pcap_open_live")
   have_library("wpcap", "pcap_setnonblock")
-
-elsif /i386-mswin32/ =~ RUBY_PLATFORM
+elsif /i386-mswin32/ =~ RUBY_PLATFORM || /x64-mswin32/ =~ RUBY_PLATFORM
   pcap_dir        = with_config("pcap-dir", "C:\\WpdPack")
   pcap_includedir = with_config("pcap-includedir", pcap_dir + "\\include")
   pcap_libdir     = with_config("pcap-libdir", pcap_dir + "\\lib")
 
+  if /x64-mingw32/ =~ RUBY_PLATFORM
+    pcap_libdir += "\\x64"
+  end
+
   $CFLAGS  = "-DWIN32 -I#{pcap_includedir}"
+  $CFLAGS += " -g" if with_config("debug")
   $LDFLAGS = "/link /LIBPATH:#{pcap_libdir}"
+  $LDFLAGS += " -g" if with_config("debug")
+  have_header("ruby/thread.h")
+  have_func("rb_thread_blocking_region") # Pre ruby 2.2
+  have_func("rb_thread_call_without_gvl") # Post ruby 2.2
+
   have_library("wpcap", "pcap_open_live")
   have_library("wpcap", "pcap_setnonblock")
 else
@@ -61,8 +79,15 @@ else
 
   dir_config("pcap", header_dirs, lib_dirs)
 
+  have_header("ruby/thread.h")
+  have_func("rb_thread_blocking_region") # Pre ruby 2.2
+  have_func("rb_thread_call_without_gvl") # Post ruby 2.2
+
   have_library("pcap", "pcap_open_live", ["pcap.h"])
   have_library("pcap", "pcap_setnonblock", ["pcap.h"])
+  
+  $CFLAGS = "-g" if with_config("debug")
+  $LDFLAGS = "-g" if with_config("debug")
 end
 
 create_makefile(extension_name)

data/ext/pcaprub_c/pcaprub.c

@@ -1,10 +1,13 @@
 #include "ruby.h"
 
+#ifdef HAVE_RUBY_THREAD_H
+  #include "ruby/thread.h"
+#endif
+
 #ifdef MAKE_TRAP
 #include "rubysig.h"
 #endif
 
-
 #include <pcap.h>
 #if defined(WIN32)
 #include <Win32-Extensions.h>
@@ -29,6 +32,7 @@ static VALUE rbpcap_thread_wait_handle(HANDLE fno);
 
 #define OFFLINE 1
 #define LIVE 2
+#define DEAD 3
 
 #if !defined(PCAP_NETMASK_UNKNOWN)
 /*
@@ -57,6 +61,15 @@ typedef struct rbpacket {
   u_char* pkt;
 } rbpacket_t;
 
+/*
+* Return the pcap version
+*/
+static VALUE
+rbpcap_s_lib_version(VALUE self)
+{
+  return rb_str_new2(pcap_lib_version());
+}
+
 /*
 * Return the name of a network device on the system.
 *
@@ -410,7 +423,11 @@ rbpcap_setfilter(VALUE self, VALUE filter)
   if(TYPE(filter) != T_STRING)
   	rb_raise(eBPFilterError, "filter must be a string");
 
-	if(! rbpcap_ready(rbp)) return self;
+  if(! rbpcap_ready(rbp)) return self;
+
+  if(rbp->type == DEAD) {
+  	rb_raise(eBPFilterError, "unable to set bpf filter on OPEN_DEAD");
+  }
 
   if(rbp->type == LIVE)
   	if(pcap_lookupnet(rbp->iface, &netid, &mask, eb) < 0) {
@@ -424,7 +441,7 @@ rbpcap_setfilter(VALUE self, VALUE filter)
   }
 
   if(pcap_setfilter(rbp->pd, &bpf) < 0) {
-    pcap_freecode(&bpf);
+  	pcap_freecode(&bpf);
   	rb_raise(eBPFilterError, "unable to set bpf filter: %s", pcap_geterr(rbp->pd));
   }
 
@@ -659,7 +676,6 @@ rbpcap_open_dead(VALUE self, VALUE linktype, VALUE snaplen)
 {
   rbpcap_t *rbp;
 
-
   if(TYPE(linktype) != T_FIXNUM)
       rb_raise(rb_eArgError, "linktype must be a fixnum");
   if(TYPE(snaplen) != T_FIXNUM)
@@ -668,7 +684,7 @@ rbpcap_open_dead(VALUE self, VALUE linktype, VALUE snaplen)
   Data_Get_Struct(self, rbpcap_t, rbp);
 
   memset(rbp->iface, 0, sizeof(rbp->iface));
-  rbp->type = OFFLINE;
+  rbp->type = DEAD;
 
   rbp->pd = pcap_open_dead(
       NUM2INT(linktype),
@@ -887,6 +903,10 @@ rbpcap_next_data(VALUE self)
 	if(rbp->type == OFFLINE && ret <= 0)
 	  return Qnil;
 
+  if(rbp->type == DEAD && ret <= 0)
+    return Qnil;
+
+
 	if(ret > 0 && job.hdr.caplen > 0)
     return rb_str_new((char *) job.pkt, job.hdr.caplen);
 
@@ -932,6 +952,9 @@ rbpcap_next_packet(VALUE self)
 	if(rbp->type == OFFLINE && ret <= 0)
 	  return Qnil;
 
+  if(rbp->type == DEAD && ret <= 0)
+    return Qnil;
+
 	if(ret > 0 && job.hdr.caplen > 0)
     {
       rbpacket = ALLOC(rbpacket_t);
@@ -974,6 +997,7 @@ rbpcap_each_data(VALUE self)
   for(;;) {
   	VALUE packet = rbpcap_next_data(self);
   	if(packet == Qnil && rbp->type == OFFLINE) break;
+    if(packet == Qnil && rbp->type == DEAD) break;
 #if defined(WIN32)
 	  packet == Qnil ? rbpcap_thread_wait_handle(fno) : rb_yield(packet);
 #else
@@ -1015,6 +1039,7 @@ rbpcap_each_packet(VALUE self)
   for(;;) {
   	VALUE packet = rbpcap_next_packet(self);
   	if(packet == Qnil && rbp->type == OFFLINE) break;
+    if(packet == Qnil && rbp->type == DEAD) break;
 #if defined(WIN32)
 	  packet == Qnil ? rbpcap_thread_wait_handle(fno) : rb_yield(packet);
 #else
@@ -1244,6 +1269,10 @@ rbpcap_thread_wait_handle(HANDLE fno)
 #if MAKE_TRAP
   // Ruby 1.8 doesn't support rb_thread_blocking_region
   result = rb_thread_polling();
+#elif defined(HAVE_RB_THREAD_CALL_WITHOUT_GVL)
+  result = (VALUE)rb_thread_call_without_gvl(
+      rbpcap_thread_wait_handle_blocking,
+	  fno, RUBY_UBF_IO, 0);
 #else
   result = (VALUE)rb_thread_blocking_region(
       rbpcap_thread_wait_handle_blocking,
@@ -1275,6 +1304,7 @@ Init_pcaprub_c()
 
   rb_define_module_function(rb_cPcap, "lookupdev", rbpcap_s_lookupdev, 0);
   rb_define_module_function(rb_cPcap, "lookupnet", rbpcap_s_lookupnet, 1);
+  rb_define_module_function(rb_cPcap, "lib_version", rbpcap_s_lib_version, 0);
 
   rb_define_const(rb_cPcap, "DLT_NULL",   INT2NUM(DLT_NULL));
   rb_define_const(rb_cPcap, "DLT_EN10MB", INT2NUM(DLT_EN10MB));
@@ -1293,10 +1323,41 @@ Init_pcaprub_c()
   rb_define_const(rb_cPcap, "DLT_PPP_BSDOS", INT2NUM(DLT_PPP_BSDOS));
   rb_define_const(rb_cPcap, "DLT_IEEE802_11", INT2NUM(DLT_IEEE802_11));
   rb_define_const(rb_cPcap, "DLT_IEEE802_11_RADIO", INT2NUM(DLT_IEEE802_11_RADIO));
+#ifdef DLT_IEEE802_11_RADIO_AVS
   rb_define_const(rb_cPcap, "DLT_IEEE802_11_RADIO_AVS", INT2NUM(DLT_IEEE802_11_RADIO_AVS));
+#endif /* DLT_IEEE802_11_RADIO_AVS */
+#ifdef DLT_LINUX_SLL
   rb_define_const(rb_cPcap, "DLT_LINUX_SLL", INT2NUM(DLT_LINUX_SLL));
+#endif /* DLT_LINUX_SLL */
+#ifdef DLT_PRISM_HEADER
   rb_define_const(rb_cPcap, "DLT_PRISM_HEADER", INT2NUM(DLT_PRISM_HEADER));
+#endif /* DLT_PRISM_HEADER */
+#ifdef DLT_AIRONET_HEADER
   rb_define_const(rb_cPcap, "DLT_AIRONET_HEADER", INT2NUM(DLT_AIRONET_HEADER));
+#endif /* DLT_AIRONET_HEADER */
+
+#ifdef DLT_BLUETOOTH_HCI_H4
+  rb_define_const(rb_cPcap, "DLT_BLUETOOTH_HCI_H4", INT2NUM(DLT_BLUETOOTH_HCI_H4));
+#endif
+#ifdef DLT_BLUETOOTH_HCI_H4_WITH_PHDR
+  rb_define_const(rb_cPcap, "DLT_BLUETOOTH_HCI_H4_WITH_PHDR", INT2NUM(DLT_BLUETOOTH_HCI_H4_WITH_PHDR));
+#endif
+#ifdef DLT_IPFILTER
+  rb_define_const(rb_cPcap, "DLT_IPFILTER", INT2NUM(DLT_IPFILTER));
+#endif
+#ifdef DLT_LOOP
+  rb_define_const(rb_cPcap, "DLT_LOOP", INT2NUM(DLT_LOOP));
+#endif
+#ifdef DLT_USB
+  rb_define_const(rb_cPcap, "DLT_USB", INT2NUM(DLT_USB));
+#endif
+#ifdef DLT_USB_LINUX
+  rb_define_const(rb_cPcap, "DLT_USB_LINUX", INT2NUM(DLT_USB_LINUX));
+#endif
+#ifdef DLT_DOCSIS
+  rb_define_const(rb_cPcap, "DLT_DOCSIS", INT2NUM(DLT_DOCSIS));
+#endif
+
   /* Pcap Error Codes
    * Error codes for the pcap API.
    * These will all be negative, so you can check for the success or

data/lib/pcaprub/ext.rb

@@ -1,15 +1,15 @@
 begin
-  if RUBY_VERSION =~ /1.8/
-    require '1.8/pcaprub_c'
-  elsif RUBY_VERSION =~ /1.9/
-    require '1.9/pcaprub_c'
-  elsif RUBY_VERSION =~ /2.0/
+  if RUBY_VERSION =~ /2.0/
     require '2.0/pcaprub_c'
   elsif RUBY_VERSION =~ /2.1/
     require '2.1/pcaprub_c'
+  elsif RUBY_VERSION =~ /2.2/
+    require '2.2/pcaprub_c'
+  elsif RUBY_VERSION =~ /2.3/
+    require '2.3/pcaprub_c'
   else
     require 'pcaprub_c'
   end
 rescue Exception
   require 'pcaprub_c'
-end
+end

data/lib/pcaprub/version.rb

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

data/test/test_helper.rb

@@ -8,9 +8,5 @@ require "minitest/autorun"
 require 'test/unit'
 require 'pcaprub'
 
-
-if RUBY_VERSION >= "1.9.2"
-  require 'coveralls'
-  Coveralls.wear!
-end
-
+require 'coveralls'
+Coveralls.wear!

data/test/test_pcaprub_unit.rb

@@ -13,19 +13,20 @@ require File.expand_path '../test_helper.rb', __FILE__
 class Pcap::UnitTest < Test::Unit::TestCase
   def test_version
     assert_equal(String, Pcap.version.class)
-    puts "Pcaprub version: #{Pcap.version}"
+    # puts "Pcaprub version: #{Pcap.version}"
   end
 
   def test_lookupdev
     assert_equal(String, Pcap.lookupdev.class)
-    puts "Pcaprub default device: #{Pcap.lookupdev}"
+    # puts "Pcaprub default device: #{Pcap.lookupdev}"
   end
 
   def test_lookupnet
     dev = Pcap.lookupdev
     assert_equal(Array, Pcap.lookupnet(dev).class)
     net = Pcap.lookupnet(dev)
-    puts "Pcaprub net (#{dev}): #{net[0]} #{[net[1]].pack("N").unpack("H*")[0]}"
+    assert net
+    # puts "Pcaprub net (#{dev}): #{net[0]} #{[net[1]].pack("N").unpack("H*")[0]}"
   end
 
   def test_pcap_new
@@ -56,19 +57,21 @@ class Pcap::UnitTest < Test::Unit::TestCase
     o = Pcap.open_live(d, 65535, true, 1)
     r = o.inject("X" * 512)
 
+    assert_equal(512, r)
+    # UPDATE: TRAVIS CI is now on a new hardware platform.
     # Travis CI's virtual network interface does not support injection
-    if ENV['CI']
-      assert_equal(-1,r)
-    else
-      assert_equal(512, r)
-    end
+    #if ENV['CI']
+    #  assert_equal(-1,r)
+    #else
+    #  assert_equal(512, r)
+    #end
   end
 
   def test_pcap_datalink
     d = Pcap.lookupdev
     o = Pcap.open_live(d, 65535, true, 1)
     r = o.datalink
-    assert_equal(Fixnum, r.class)
+    assert_equal(Integer, r.class)
   end
 
   def test_pcap_snapshot
@@ -104,8 +107,8 @@ class Pcap::UnitTest < Test::Unit::TestCase
     end
 
     t.kill
-    puts "Background thread ticked #{@c} times while capture was running"
-    puts "Captured #{pkt_count} packets"
+    # puts "Background thread ticked #{@c} times while capture was running"
+    # puts "Captured #{pkt_count} packets"
     assert(0 < @c, "Background thread failed to tick while capture was running");
     true
   end
@@ -121,7 +124,12 @@ class Pcap::UnitTest < Test::Unit::TestCase
     d = Pcap.lookupdev
     o = Pcap.open_live(d, 65535, true, -1)
     dls = o.listdatalinks
-    assert_equal(o,o.setdatalink(dls.values.first))
+    begin
+      assert_equal(o,o.setdatalink(dls.values.first))
+    rescue PCAPRUB::LinkTypeError
+      print "#{dls} - Data LinkType Binding issue in the environment (Skipping)"
+      assert_equal(o,o)
+    end
   end
 
   def test_monitor
@@ -131,6 +139,17 @@ class Pcap::UnitTest < Test::Unit::TestCase
     assert_equal(o, o.setmonitor(true))
   end
 
+  def test_open_dead
+    # No applied filters on OPEN_DEAD just compile checking
+    o = Pcap.open_dead(Pcap::DLT_NULL, 65535)
+    assert_nothing_raised do
+      o.compile("ip host 1.2.3.4")
+    end
+    assert_raise PCAPRUB::BPFError do
+      o.setfilter("ip host 1.2.3.5")
+    end
+  end
+
   def test_filter
     d = Pcap.lookupdev
     o = Pcap.create(d)
@@ -142,4 +161,11 @@ class Pcap::UnitTest < Test::Unit::TestCase
       o.compile("A non working filter")
     end
   end
+
+  def test_lib_version
+    v = Pcap.lib_version.split
+    assert_equal "libpcap", v[0]
+    assert_equal "version", v[1]
+    assert_equal 3, v[2].split('.').size
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pcaprub
 version: !ruby/object:Gem::Version
-  version: 0.12.1
+  version: 0.13.1
 platform: ruby
 authors:
 - shadowbq
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-20 00:00:00.000000000 Z
+date: 2021-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -107,7 +107,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.7.0
-description: libpcap bindings for ruby with Ruby1.8, Ruby1.9, Ruby 2.x
+description: libpcap bindings for Ruby 2.x
 email: shadowbq@gmail.com
 executables: []
 extensions:
@@ -151,7 +151,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -159,8 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - libpcap
-rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: libpcap bindings for ruby