pcapz 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6739f9dd7736d0651579bba73505cb5a60a744ed9447eff3ea412cc415b14156
+  data.tar.gz: 63e9c4491915e9fb02ce3e9e59e90a980a473ddbd743e5b55f2a8143110a6140
+SHA512:
+  metadata.gz: 958d14f4d1a2372dae05371f18850070857f3d73e69e83b474803a71b160a03a3b1c4f1ef0c5fe85c6060d47559e34a0d7d1eac3201ab70725645290bc4363c8
+  data.tar.gz: 1588501e28fb5c092af8beddab8a57edf3b3313a137a84bab3a15636e697ee3742b8cf6be743888e40f0298a636332dac83a5e7a0f0d4464b9c18e9a9a87c5f2

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at kgruber1@emich.edu. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in pcapz.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    pcapz (1.0.0)
+      interfacez (~> 1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    interfacez (1.0.0)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  pcapz!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Kent Gruber
+
+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,33 @@
+# Pcapz
+> Pure ruby network capture API
+
+## Installation
+
+    $ gem install pcapz
+
+## Usage
+
+```ruby
+require "pcapz"
+
+# start packet capture
+cap = Pcapz.capture.new
+
+# CTRL+C Exit
+trap "SIGINT" do
+  cap.stop!
+end
+
+cap.packets do |packet|
+  # do something with packet
+  puts packet.size
+end
+```
+
+## Development
+
+Currently this is only implemented for macOS. 
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pcapz"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/examples/debug.rb

@@ -0,0 +1,11 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'pcapz'
+require 'pry'
+
+cap = Pcapz.capture.new
+
+begin
+  binding.pry
+ensure
+  cap.stop! unless cap.stopped?
+end

data/examples/headers.rb

@@ -0,0 +1,18 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'pcapz'
+require 'packetgen'
+
+cap = Pcapz.capture.new
+
+# CTRL+C Exit
+trap "SIGINT" do
+  cap.stop! unless cap.stopped?
+end
+
+begin
+  cap.packets do |packet|
+    puts PacketGen.parse(packet).headers.map(&:method_name).join(" ")
+  end
+ensure
+  cap.stop! unless cap.stopped?
+end

data/lib/pcapz.rb

@@ -0,0 +1,9 @@
+require "interfacez"
+require "pcapz/version"
+require "pcapz/capture"
+
+module Pcapz
+  def self.capture
+    Capture
+  end
+end

data/lib/pcapz/capture.rb

@@ -0,0 +1,83 @@
+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

data/lib/pcapz/version.rb

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

data/pcapz.gemspec

@@ -0,0 +1,28 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "pcapz/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "pcapz"
+  spec.version       = Pcapz::VERSION
+  spec.authors       = ["Kent 'picat' Gruber"]
+  spec.email         = ["kgruber1@emich.edu"]
+
+  spec.summary       = %q{Pure ruby packet capturing API}
+  #spec.description   = %q{TODO: Write a longer description or delete this line.}
+  spec.homepage      = "https://github.com/picatz/pcapz"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  
+  spec.add_dependency "interfacez", "~> 1.0.0"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: pcapz
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Kent 'picat' Gruber
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-04-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: interfacez
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- kgruber1@emich.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- examples/debug.rb
+- examples/headers.rb
+- lib/pcapz.rb
+- lib/pcapz/capture.rb
+- lib/pcapz/version.rb
+- pcapz.gemspec
+homepage: https://github.com/picatz/pcapz
+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.7.3
+signing_key: 
+specification_version: 4
+summary: Pure ruby packet capturing API
+test_files: []