bilbo 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8767616e7296e136fc055e44fdd92d587c8a4e25
+  data.tar.gz: 0efec03b0f85b474d87a93603656182b554aabf0
+SHA512:
+  metadata.gz: 16ae6cb8b3c5c698ae145e758ebdd133e108c9be0ac41cebdeeb9a18d8faa95b69a57d924213f1f63b47e53c91b7e892eba87a5edcf6ac8370b9bd78253edd6b
+  data.tar.gz: 90bbef7c1255f4fa73c33f9e40d478ffc8e90e8bac5d1fa2f55c4d622449eda4803f26fc17d3213660312521daff0e62b6cc313e91acc511e43bf284766e60ee

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

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

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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bilbo.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 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,148 @@
+# Bilbo
+
+Bilbo is a tiny packet capture library built on [pcaprub](https://github.com/pcaprub/pcaprub) to interface with libpcap. 
+
+![Bilbo Baggins](https://upload.wikimedia.org/wikipedia/en/1/1f/Bilbo_Baggins_Tolkien_illustration.jpg)
+
+### Why?
+
+You never know when you're going need a simple, hobbit-like ( small ) network packet burglaring ( capturing ) library such as Bilbo.
+
+## Installation
+
+    $ gem install bilbo
+
+## Usage
+
+Packet capturing with Bilbo is incredibly straight-forward.
+
+```ruby
+require 'bilbo'
+
+Bilbo::Capture.new do |packet|
+  # do something with the packet 
+end
+```
+### Customizations
+
+Of course!
+
+```ruby
+require 'bilbo'
+
+cap = Bilbo::Capture.new
+ 
+cap.iface   = "en0"  # interface en0
+cap.promisc = true   # promiscuous mode, on
+cap.start            # start capturing
+
+cap.packets do |packet|
+  # do something with the packet 
+end
+```
+
+Pretty flexible, doing the same thing as above:
+
+```ruby
+require 'bilbo'
+
+cap = Bilbo::Capture.new(iface: "en0", promisc: true)
+cap.start do |packet|
+  # do something with the packet 
+end 
+```
+
+### Packet Parsing?
+
+Bilbo provides no packet parsing abstractions. You can use something like [PacketGen](https://github.com/sdaubert/packetgen) with Bilbo together:
+
+### PacketGen
+
+PacketGen works really well for parsing the packets into a human-friendly interface.
+
+```ruby
+require 'bilbo'
+require 'packetgen'
+
+cap = Bilbo::Capture.new
+
+cap do |packet|
+  parsed_packet = PacketGen.parse(packet)
+  # do something with the parsed packet 
+end
+```
+
+### PacketFu
+
+Since Bilbo is simply capturing packets, you can easily use [PacketFu](https://github.com/packetfu/packetfu) if wanted to:
+
+```ruby
+require 'bilbo'
+require 'packetfu'
+
+cap = Bilbo::Capture.new
+
+cap do |packet|
+  parsed_packet = PacketFu::Packet.parse(packet)
+  # do something with the parsed packet 
+end
+```
+### TODO's
+
+* Methods for checking state of the capture, like:
+```ruby
+require 'bilbo'
+
+cap = Bilbo::Capture.new(start: true)
+
+cap.capturing?
+# => true
+
+cap.started? 
+# => true
+
+# stop capture
+cap.stop
+
+# but, we know it was started beforehand
+cap.started?
+# => true
+
+# and we can check that we aren't capturing still
+cap.capturing?
+# => false
+```
+* Human friendly alias features?
+```ruby
+require 'bilbo'
+
+cap = Bilbo::Capture.new
+
+cap.promisc = true
+# or 
+cap.promiscuous = true
+# or 
+cap.promiscuous!
+# and
+cap.promiscuous?
+
+# stuff like that
+```
+* Check internal documentation and inline documentation for ma' errorz.
+* More packet wrangle'n features for the `.packets()` method?
+* Some sort of PacketFu/PacketGen shell like functionality.
+* Specs? Because that'd be nice.
+* Write some sort of ngrep like clone using Bilbo.
+
+### ❤️  Ruby Community
+
+Bilbo has taken inspriation from many ruby packet capturing / parsing gems:
+
+* [PacketGen](https://github.com/sdaubert/packetgen)
+* [PacketFu](https://github.com/packetfu/packetfu)
+* [pcaprub](https://github.com/pcaprub/pcaprub)
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://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/bilbo.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bilbo/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bilbo"
+  spec.version       = Bilbo::VERSION
+  spec.authors       = ["Kent 'picat' Gruber"]
+  spec.email         = ["kgruber1@emich.edu"]
+
+  spec.summary       = %q{A simple, hobbit-like network packet capturing gem.}
+  spec.description   = %q{You never know when you're going need a simple, hobbit-like ( small ) network packet burglaring ( capturing ) library such as Bilbo.}
+  spec.homepage      = "https://github.com/picatz/bilbo"
+  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 'pcaprub', '~>0.12.4'
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "bilbo"
+
+# 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/capture_example.rb

@@ -0,0 +1,11 @@
+# path setting magic for example directory only
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require "bilbo"
+
+# start a new capture instance
+cap = Bilbo::Capture.new
+
+# start the capture, optional block
+cap.start do |packet|
+  # do something with the packet
+end

data/examples/capture_example_2.rb

@@ -0,0 +1,9 @@
+# path setting magic for example directory only
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require "bilbo"
+
+# start a new capture instance
+Bilbo::Capture.new do |packet|
+  # do something with the packet
+end
+

data/examples/capture_example_3.rb

@@ -0,0 +1,9 @@
+# path setting magic for example directory only
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require "bilbo"
+
+# start a new capture instance on interface en0
+Bilbo::Capture.new(iface: 'en0') do |packet|
+  # do something with the packet
+end
+

data/examples/capture_example_4.rb

@@ -0,0 +1,13 @@
+# path setting magic for example directory only
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require "bilbo"
+
+# start a new capture instance on interface en0
+cap = Bilbo::Capture.new(iface: 'en0') 
+cap.snaplen = 1234 # lol
+
+cap.start
+
+cap.packets do |packet|
+  # do something with the packet
+end

data/lib/bilbo/capture.rb

@@ -0,0 +1,130 @@
+module Bilbo
+
+  # Capture packets simply.
+  # @author Kent 'picat' Gruber
+  class Capture
+    # packet stream
+    # @return [PCAPRUB::Pcap]
+    attr_reader :packet_stream
+
+    # interface to capture on 
+    # @return [String]
+    attr_accessor :iface
+
+    # amount of data for each frame that is actually captured
+    # @return [Integer]
+    attr_accessor :snaplen
+
+    # capture packets in promiscuous mode
+    # @return [Boolean]
+    attr_accessor :promisc
+
+    # capture packet timeout
+    # @return [Integer]
+    attr_accessor :timeout
+
+    # Create a new Bilbo capture instance.
+    #
+    # == Simple Defaults
+    # You can let bilbo take care of things for you with its defaults:
+    #  cap = Bilbo::Capture.new(start: true)
+    #   
+    # == Custom Options
+    # You can also set you own options with defaults and check them easily:
+    #   cap = Bilbo::Capture.new(iface: "eth0")
+    #   cap.iface
+    #   # => "eth0"
+    #   
+    def initialize(args={})
+      @iface   = args[:iface]   || Pcap.lookupdev # lookup default interface
+      @snaplen = args[:snaplen] || 65535          # default snaplen
+      @promisc = args[:promisc] || false          # default promisc
+      @timeout = args[:timeout] || 0              # default timeout
+      start(args) if args[:start]
+      if block_given?
+        start
+        @packet_stream.each { |packet| yield packet }
+      end
+    end
+
+    # Start the actual packet capturing.
+    # @param [Hash] args capture options when started
+    # @option options [String] :iface interface to capture on
+    # @option options [Integer] :snaplen ammount of data for each frame that is actually captured
+    # @option options [Boolean] :promisc whether to capture in promiscuous mode or not 
+    # @option options [Integer] :timeout ammount for timeout on capture
+    # @return [PCAPRUB::Pcap]
+    #
+    # == Example
+    #
+    #   cap = Bilbo::Capture(iface: "eth0")
+    #   cap.start
+    #
+    # == Block Example
+    #
+    #   cap = Bilbo::Capture(iface: "eth0")
+    #   cap.start do |packet|
+    #     # do something with packet
+    #   end
+    #
+    def start(args={})
+      iface   = args[:iface]   || @iface   # default interface
+      snaplen = args[:snaplen] || @snaplen # default snaplen
+      promisc = args[:promisc] || @promisc # default promisc
+      timeout = args[:timeout] || @timeout # default timeout
+      @packet_stream = Pcap.open_live(iface, snaplen, promisc, timeout) 
+      if block_given?
+        @packet_stream.each { |packet| yield packet }
+      end
+    end
+
+    # Simple interface to work with the +packet stream+.
+    #
+    # @param [Hash] args options to wrangle streaming packets, totally optional
+    # @option options [Integer] :count ammount of packets to wrangle up 
+    #
+    # @example Block
+    #   
+    #   cap = Bilbo::Capture(iface: "eth0")
+    #   cap.start 
+    #   cap.packets do |packet|
+    #       
+    #   end
+    #   
+    # @example Direct PCAP:Pcap Access
+    #
+    #   cap = Bilbo::Capture(iface: "eth0")
+    #   cap.start 
+    #   cap.packets 
+    #   # => <PCAPRUB::Pcap>
+    #   cap.packets.each do |packet|
+    #     # do something with the packet
+    #   end
+    #   cap.packets.stats
+    #
+    # @example Wrangle a few packets
+    #
+    #   cap = Bilbo::Capture(iface: "eth0")
+    #   cap.start 
+    #   cap.packets(count: 30)
+    #   
+    #
+    def packets(args={})
+      if block_given?
+        @packet_stream.each { |packet| yield packet }
+      else
+        if args[:count]
+          packets = []
+          @packet_stream.each do |packet| 
+            packets << packet
+            break if packets.count.eql? args[:count]
+          end
+          return packets
+        end
+        @packet_stream 
+      end
+    end
+
+  end
+
+end

data/lib/bilbo/version.rb

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

data/lib/bilbo.rb

@@ -0,0 +1,28 @@
+require "bilbo/version"
+require "bilbo/capture"
+require "pcaprub"
+
+
+# Bilbo is a simple, +hobbit-like+ ( small ) network packet +burglaring+ ( capturing ) library. 
+# # @author Kent 'picat' Gruber
+module Bilbo
+  
+  # A few quotes from dear 'ol Mr. Bilbo Baggins
+  # @easter_egg
+  QUOTES = [
+    "It's a dangerous business, Frodo, going out your door. You step onto the road, and if you don't keep your feet, there's no knowing where you might be swept off to.",
+    "Go back? No good at all! Go sideways? Impossible! Go forward? Only thing to do! On we go!",
+    "Now I know what a piece of bacon feels like when it is suddenly picked out of the pan on a fork and put back on the shelf!",
+    "I will give you a name, and I shall call you Sting.",
+    "I came from the end of bag, but no bag went over me. I am the friend of bears and the guest of eagles. I am Ring-winner and Luckwearer; and I am Barrel-rider.",
+    "I don’t know half of you half as well as I should like; and I like less than half of you half as well as you deserve."
+  ].freeze
+ 
+  # Get a random quote from Bilbo.
+  #
+  # @return [String]
+  def quote
+    QUOTES.sample
+  end
+
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: bilbo
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Kent 'picat' Gruber
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pcaprub
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.4
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: You never know when you're going need a simple, hobbit-like ( small )
+  network packet burglaring ( capturing ) library such as Bilbo.
+email:
+- kgruber1@emich.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bilbo.gemspec
+- bin/console
+- bin/setup
+- examples/capture_example.rb
+- examples/capture_example_2.rb
+- examples/capture_example_3.rb
+- examples/capture_example_4.rb
+- lib/bilbo.rb
+- lib/bilbo/capture.rb
+- lib/bilbo/version.rb
+homepage: https://github.com/picatz/bilbo
+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.6.8
+signing_key: 
+specification_version: 4
+summary: A simple, hobbit-like network packet capturing gem.
+test_files: []