pcapz 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6739f9dd7736d0651579bba73505cb5a60a744ed9447eff3ea412cc415b14156
-  data.tar.gz: 63e9c4491915e9fb02ce3e9e59e90a980a473ddbd743e5b55f2a8143110a6140
+  metadata.gz: 8999b84015d8bea49b3d193ab221751a04a777428e88416064231792a4de501c
+  data.tar.gz: 43c189e57dd69a75e838833eb7e8f2d3c1d8bd3c60fb732c6deb671697472da5
 SHA512:
-  metadata.gz: 958d14f4d1a2372dae05371f18850070857f3d73e69e83b474803a71b160a03a3b1c4f1ef0c5fe85c6060d47559e34a0d7d1eac3201ab70725645290bc4363c8
-  data.tar.gz: 1588501e28fb5c092af8beddab8a57edf3b3313a137a84bab3a15636e697ee3742b8cf6be743888e40f0298a636332dac83a5e7a0f0d4464b9c18e9a9a87c5f2
+  metadata.gz: 9b0b294db2523c938be928a4150d2e78216d28ce402fb69fca9be135fe3431104737cb41e48676c3a1925b42d24b3a47cd208452f51b10d914a0454369e32bef
+  data.tar.gz: 0ebe1b2dce738fe8159d7d385bbe90694d35b1adffe1ecbec31a4f696397b7cc81ed3e1c807e50f2f4cfa2061b2f57017cc380f8ff78356ab022c89d778bdb40

data/.gitignore

@@ -1,4 +1,5 @@
 /.bundle/
+/.vagrant/
 /.yardoc
 /_yardoc/
 /coverage/
@@ -9,3 +10,4 @@
 
 # rspec failure tracking
 .rspec_status
+ubuntu-xenial-16.04-cloudimg-console.log

data/Gemfile.lock

@@ -1,14 +1,19 @@
 PATH
   remote: .
   specs:
-    pcapz (1.0.0)
+    pcapz (1.0.1)
       interfacez (~> 1.0.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    coderay (1.1.2)
     diff-lcs (1.3)
     interfacez (1.0.0)
+    method_source (0.9.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
     rake (10.5.0)
     rspec (3.7.0)
       rspec-core (~> 3.7.0)
@@ -30,6 +35,7 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 1.16)
   pcapz!
+  pry (~> 0.11.3)
   rake (~> 10.0)
   rspec (~> 3.0)
 

data/README.md

@@ -24,9 +24,9 @@ cap.packets do |packet|
 end
 ```
 
-## Development
+## Supported Platforms
 
-Currently this is only implemented for macOS. 
+Currently this has only been implemented/tested on macOS and Linux.
 
 ## License
 

data/Vagrantfile

@@ -0,0 +1,76 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+# All Vagrant configuration is done below. The "2" in Vagrant.configure
+# configures the configuration version (we support older styles for
+# backwards compatibility). Please don't change it unless you know what
+# you're doing.
+Vagrant.configure("2") do |config|
+  # The most common configuration options are documented and commented below.
+  # For a complete reference, please see the online documentation at
+  # https://docs.vagrantup.com.
+
+  # Every Vagrant development environment requires a box. You can search for
+  # boxes at https://vagrantcloud.com/search.
+  config.vm.box = "ubuntu/xenial64"
+
+  # Disable automatic box update checking. If you disable this, then
+  # boxes will only be checked for updates when the user runs
+  # `vagrant box outdated`. This is not recommended.
+  # config.vm.box_check_update = false
+
+  # Create a forwarded port mapping which allows access to a specific port
+  # within the machine from a port on the host machine. In the example below,
+  # accessing "localhost:8080" will access port 80 on the guest machine.
+  # NOTE: This will enable public access to the opened port
+  # config.vm.network "forwarded_port", guest: 80, host: 8080
+
+  # Create a forwarded port mapping which allows access to a specific port
+  # within the machine from a port on the host machine and only allow access
+  # via 127.0.0.1 to disable public access
+  # config.vm.network "forwarded_port", guest: 80, host: 8080, host_ip: "127.0.0.1"
+
+  # Create a private network, which allows host-only access to the machine
+  # using a specific IP.
+  # config.vm.network "private_network", ip: "192.168.33.10"
+
+  # Create a public network, which generally matched to bridged network.
+  # Bridged networks make the machine appear as another physical device on
+  # your network.
+  # config.vm.network "public_network"
+
+  # Share an additional folder to the guest VM. The first argument is
+  # the path on the host to the actual folder. The second argument is
+  # the path on the guest to mount the folder. And the optional third
+  # argument is a set of non-required options.
+  # config.vm.synced_folder "../data", "/vagrant_data"
+
+  # Provider-specific configuration so you can fine-tune various
+  # backing providers for Vagrant. These expose provider-specific options.
+  # Example for VirtualBox:
+  #
+  # config.vm.provider "virtualbox" do |vb|
+  #   # Display the VirtualBox GUI when booting the machine
+  #   vb.gui = true
+  #
+  #   # Customize the amount of memory on the VM:
+  #   vb.memory = "1024"
+  # end
+  #
+  # View the documentation for the provider you are using for more
+  # information on available options.
+
+  # Enable provisioning with a shell script. Additional provisioners such as
+  # Puppet, Chef, Ansible, Salt, and Docker are also available. Please see the
+  # documentation for more information about their specific syntax and use.
+  config.vm.provision "shell", inline: <<-SHELL
+    apt-get update
+    gpg --keyserver hkp://keys.gnupg.net --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3 7D2BAF1CF37B13E2069D6956105BD0E739499BDB
+    curl -sSL https://get.rvm.io | bash -s stable
+    source /home/$USER/.rvm/scripts/rvm
+    echo "source /home/$USER/.rvm/scripts/rvm" >> ~/.bashrc
+    source /home/$USER/.rvm/scripts/rvm # good measure
+    rvm install 2.5.0
+    rvm use ruby-2.5.0 --default
+  SHELL
+end

data/examples/debug.rb

@@ -4,6 +4,12 @@ require 'pry'
 
 cap = Pcapz.capture.new
 
+# CTRL+C Exit
+trap "SIGINT" do
+  cap.stop! unless cap.stopped?
+  exit
+end
+
 begin
   binding.pry
 ensure

data/examples/pps.rb

@@ -0,0 +1,22 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'pcapz'
+require 'timeout'
+
+cap = Pcapz.capture.new
+
+# CTRL+C Exit
+trap "SIGINT" do
+  cap.stop! unless cap.stopped?
+end
+
+begin
+  counter = 0
+  Timeout::timeout(1) {
+    cap.packets { |packet| counter += 1 }
+  }
+rescue
+  puts "#{counter} packets per second"
+  retry
+ensure
+  cap.stop! unless cap.stopped?
+end

data/lib/pcapz.rb

@@ -4,6 +4,12 @@ require "pcapz/capture"
 
 module Pcapz
   def self.capture
-    Capture
+    if RUBY_PLATFORM =~ /linux/
+      return Capture::Linux
+    elsif  RUBY_PLATFORM =~ /darwin|freebsd|netbsd/
+      return Capture::BSD
+    else
+      raise "This platform #{RUBY_PLATFORM} is not yet supported!"
+    end
   end
 end

data/lib/pcapz/capture.rb

@@ -1,83 +1,2 @@
-module Pcapz
-  class Capture
-    def initialize(interface = Interfacez.default)
-      @interface   = interface
-      @buffer_size = 0
-      @file        = nil
-      configure_bpf_dev
-    end
-
-    def packets
-      return nil if @file.closed?
-      if block_given?
-        loop do
-          buffer = @file.read_nonblock(@buffer_size)
-          while buffer.size > 0
-            datalen = buffer.slice(12,4).unpack('L')[0]
-            hdrlen  = buffer.slice(16,2).unpack('v')[0]
-            size    = (datalen+hdrlen) + 3 & ~3
-            pkt = buffer.slice!(0,size)[hdrlen..-1] 
-            yield pkt unless pkt.nil?
-          end
-        end
-      else
-        packets = []
-        buffer = @file.read_nonblock(@buffer_size)
-        while buffer.size > 0
-          size, hdrlen = header_decode(buffer)
-          pkt = buffer.slice!(0,size)[hdrlen..-1] 
-          packets << pkt unless pkt.nil?
-        end
-        return packets
-      end
-      return true
-    rescue EOFError, Errno::EAGAIN
-      retry
-    rescue IO::WaitReadable
-      IO.select([@file])
-      retry
-    end
-
-    def file
-      @file
-    end
-
-    def stop!
-      return nil if stopped?
-      @file.close
-      stopped?
-    end
-
-    def stopped?
-      @file.closed?
-    end
-
-    private
-
-    def configure_bpf_dev(interface: @interface)
-      Dir.glob('/dev/bpf*') do |item|
-        begin
-          @file = File.open(item)   
-        rescue Errno::EBUSY
-          next
-        end
-      end
-      raise "Unable to start a packet capture on any device" if @file.nil?
-      @file.ioctl(0x8020426c, [interface].pack("a#{interface.size+1}"))
-      @file.ioctl(0x80044270, [1].pack('I'))
-      @file.ioctl(0x40044274, [0].pack('N'))
-      buf = [0].pack('i')
-      @file.ioctl(0x40044266, buf)
-      @buffer_size = buf.unpack('i')[0]
-      timeout = [5,0].pack('LL')
-      @file.ioctl(0x8008426d, timeout)
-      return @file 
-    rescue
-      @file.close unless @file.nil? or @file.closed?
-    end
-
-    def packet_size(n)
-      n+3 & ~3
-    end
-  end  
-end
+require_relative "capture_types/linux"
+require_relative "capture_types/bsd"

data/lib/pcapz/capture_types/bsd.rb

@@ -0,0 +1,79 @@
+module Pcapz
+  module Capture
+    class BSD
+      def initialize(interface = Interfacez.default)
+        @interface       = interface
+        @buffer_size     = 0
+        @file            = nil
+        @internal_buffer = nil
+        configure_bpf_dev
+      end
+
+      def packets
+        until @file.closed?
+          yield next_packet
+        end
+      end
+
+      def next_packet
+        @internal_buffer.resume
+      rescue Interrupt
+        exit
+      rescue
+        @internal_buffer = Fiber.new do
+          loop do
+            begin
+              buffer = @file.read_nonblock(@buffer_size)
+              while buffer.size > 0
+                Fiber.yield buffer.slice!(0,(((buffer.slice(12,4).unpack('L')[0])+18) + 3 & ~3))[18..-1] 
+              end
+            rescue IO::WaitReadable
+              IO.select([@file])
+              retry
+            end
+          end
+        end
+        retry
+      end
+
+      def file
+        @file
+      end
+
+      def stop!
+        return nil if stopped?
+        @file.close
+        stopped?
+      end
+
+      def stopped?
+        @file.closed?
+      end
+
+      private
+
+      def configure_bpf_dev(interface: @interface)
+        Dir.glob('/dev/bpf*') do |item|
+          begin
+            @file = File.open(item)   
+          rescue Errno::EBUSY
+            next
+          end
+        end
+        raise "Unable to start a packet capture on any device" if @file.nil?
+        @file.ioctl(0x8020426c, [interface].pack("a#{interface.size+1}"))
+        @file.ioctl(0x80044270, [1].pack('I'))
+        @file.ioctl(0x40044274, [0].pack('N'))
+        buf = [0].pack('i')
+        @file.ioctl(0x40044266, buf)
+        @buffer_size = buf.unpack('i')[0]
+        timeout = [5,0].pack('LL')
+        @file.ioctl(0x8008426d, timeout)
+        return @file 
+      rescue
+        @file.close unless @file.nil? or @file.closed?
+        raise "Unable to create network listener on #{@interface}!"
+      end
+    end  
+  end
+end

data/lib/pcapz/capture_types/linux.rb

@@ -0,0 +1,52 @@
+module Pcapz
+  module Capture
+    class Linux
+      def initialize(interface = Interfacez.default)
+        @interface   = interface
+        @buffer_size = 0
+        @file        = nil
+        configure_socket
+      end
+
+      def packets
+        until @file.closed?
+          yield next_packet
+        end
+      end
+
+      def next_packet
+        @file.recvfrom_nonblock(@buffer_size)[0]
+      rescue IO::WaitReadable
+        IO.select([@file])
+        retry
+      rescue Interrupt
+        exit
+      end
+
+      def file
+        @file
+      end
+
+      def stop!
+        return nil if stopped?
+        @file.close
+        stopped?
+      end
+
+      def stopped?
+        @file.closed?
+      end
+
+      private
+
+      def configure_socket(interface: @interface)
+        @file = Socket.new(Socket::PF_PACKET, Socket::SOCK_RAW, 0x03_00) 
+        @file.setsockopt(Socket::SOL_SOCKET, Socket::SO_BINDTODEVICE, interface)
+        @buffer_size = 65535
+      rescue
+        @file.close unless @file.nil? or @file.closed?
+        raise "Unable to create network listener on #{@interface}!"
+      end
+    end  
+  end
+end

data/lib/pcapz/version.rb

@@ -1,3 +1,3 @@
 module Pcapz
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/pcapz.gemspec

@@ -25,4 +25,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry", "~> 0.11.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pcapz
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Kent 'picat' Gruber
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-04 00:00:00.000000000 Z
+date: 2018-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: interfacez
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.3
 description: 
 email:
 - kgruber1@emich.edu
@@ -82,12 +96,16 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- Vagrantfile
 - bin/console
 - bin/setup
 - examples/debug.rb
 - examples/headers.rb
+- examples/pps.rb
 - lib/pcapz.rb
 - lib/pcapz/capture.rb
+- lib/pcapz/capture_types/bsd.rb
+- lib/pcapz/capture_types/linux.rb
 - lib/pcapz/version.rb
 - pcapz.gemspec
 homepage: https://github.com/picatz/pcapz