nmunch 0.1.0

data/nmunch.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/nmunch/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Michael Henriksen"]
+  gem.email         = ["michenriksen87@gmail.com"]
+  gem.description   = %q{Nmunch is a passive network discovery tool that finds live network nodes by analyzing ARP and broadcast packets.}
+  gem.summary       = %q{OM NOM NOM NOM}
+  gem.homepage      = "https://github.com/michenriksen/nmunch"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "nmunch"
+  gem.require_paths = ["lib"]
+  gem.version       = Nmunch::VERSION
+  gem.add_development_dependency('rspec')
+  gem.add_development_dependency('rake', '>= 0.9.2')
+  gem.add_dependency('methadone', '~> 1.2.3')
+  gem.add_dependency('pcap', '~> 0.7.7')
+  gem.add_dependency('paint')
+end

data/spec/lib/nmunch/dissectors/arp_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe Nmunch::Dissectors::Arp do
+  let(:arp_pcap_packet) do
+    packet = stub(Pcap::Packet)
+    packet.stub(:raw_data).and_return(ARP_PACKET_DATA)
+    packet.stub(:ip?).and_return(false)
+    packet
+  end
+
+  subject { Nmunch::Dissectors::Arp.new(arp_pcap_packet) }
+
+  describe '#ip_address' do
+    it 'returns correct IP address' do
+      subject.ip_address.should == '192.168.0.125'
+    end
+  end
+
+  describe '#mac_address' do
+    it 'returns correct MAC address' do
+      subject.mac_address.should == 'de:ad:be:ef:de:ad'
+    end
+  end
+end

data/spec/lib/nmunch/dissectors/base_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe Nmunch::Dissectors::Base do
+  let(:arp_pcap_packet) do
+    packet = stub(Pcap::Packet)
+    packet.stub(:raw_data).and_return(ARP_PACKET_DATA)
+    packet.stub(:ip?).and_return(false)
+    packet
+  end
+
+  let(:ip_pcap_packet) do
+    packet = stub(Pcap::Packet)
+    packet.stub(:raw_data).and_return(IP_PACKET_DATA)
+    packet.stub(:ip?).and_return(true)
+    packet
+  end
+
+  subject { Nmunch::Dissectors::Base.new(arp_pcap_packet) }
+
+  describe '#pcap_packet' do
+    it 'returns pcap packet given in initializer' do
+      subject.pcap_packet.should == arp_pcap_packet
+    end
+  end
+
+  describe '#raw_data' do
+    it 'returns an array of bytes represented in HEX' do
+      subject.raw_data.should == ARP_PACKET_DATA.unpack('H*').first.scan(/.{2}/)
+    end
+  end
+
+  describe '.factory' do
+    context 'when given ARP packet' do
+      it 'returns an ARP dissector' do
+        Nmunch::Dissectors::Base.factory(arp_pcap_packet).should be_a(Nmunch::Dissectors::Arp)
+      end
+    end
+
+    context 'when given an IP packet' do
+      it 'returns an IP dissector' do
+        Nmunch::Dissectors::Base.factory(ip_pcap_packet).should be_a(Nmunch::Dissectors::Ip)
+      end
+    end
+  end
+end

data/spec/lib/nmunch/dissectors/ip_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe Nmunch::Dissectors::Ip do
+  let(:ip_pcap_packet) do
+    packet = stub(Pcap::Packet)
+    packet.stub(:raw_data).and_return(IP_PACKET_DATA)
+    packet.stub(:ip?).and_return(true)
+    packet
+  end
+
+  subject { Nmunch::Dissectors::Ip.new(ip_pcap_packet) }
+
+  describe '#ip_address' do
+    it 'returns correct IP address' do
+      ip_pcap_packet.should_receive(:ip_src).and_return('192.168.0.125')
+      subject.ip_address.should == '192.168.0.125'
+    end
+  end
+
+  describe '#mac_address' do
+    it 'returns correct MAC address' do
+      subject.mac_address.should == 'de:ad:be:ef:de:ad'
+    end
+  end
+end

data/spec/lib/nmunch/mac_oui_lookup_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe Nmunch::MacOuiLookup do
+  context 'when given an Apple mac address' do
+    it 'returns Apple' do
+      Nmunch::MacOuiLookup.instance.lookup('58:b0:35:31:33:73').should == 'Apple'
+    end
+  end
+
+  context 'when given a Cisco mac address' do
+    it 'returns Cisco Systems' do
+      Nmunch::MacOuiLookup.instance.lookup('00:01:63:42:42:42').should == 'Cisco Systems'
+    end
+  end
+
+  context 'when given a mac address with an unknown prefix' do
+    it 'returns Unknown' do
+      Nmunch::MacOuiLookup.instance.lookup('de:ad:be:ef:de:ad').should == 'Unknown'
+    end
+  end
+end

data/spec/lib/nmunch/node_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe Nmunch::Node do
+  subject { Nmunch::Node.new(ip_address: '192.168.0.1', mac_address: 'de:ad:be:ef:de:ad') }
+
+  describe '#ip_address' do
+    it 'returns correct IP address' do
+      subject.ip_address.should == '192.168.0.1'
+    end
+  end
+
+  describe '#mac_address' do
+    it 'returns correct MAC address' do
+      subject.mac_address.should == 'de:ad:be:ef:de:ad'
+    end
+  end
+
+  describe '#meta_address?' do
+    context 'when IP is not a meta address' do
+      it 'returns false' do
+        subject.should_not be_meta_address
+      end
+    end
+
+    context 'when IP is a meta address' do
+      it 'returns true' do
+        subject.stub(:ip_address).and_return('0.0.0.0')
+        subject.should be_meta_address
+      end
+    end
+  end
+
+  describe '.create_from_dissector' do
+    let(:dissector) do
+      dissector = stub
+      dissector.stub(:ip_address).and_return('192.168.0.1')
+      dissector.stub(:mac_address).and_return('de:ad:be:ef:de:ad')
+      dissector
+    end
+    subject { Nmunch::Node.create_from_dissector(dissector) }
+
+    it 'returns a node' do
+      subject.should be_a(Nmunch::Node)
+    end
+
+    it 'has correct IP address' do
+      subject.ip_address.should == '192.168.0.1'
+    end
+
+    it 'has correct MAC address' do
+      subject.mac_address.should == 'de:ad:be:ef:de:ad'
+    end
+  end
+end

data/spec/lib/nmunch/report_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+class TestSubscriber
+  def process(node); end
+end
+
+describe Nmunch::Report do
+  let(:node) { Nmunch::Node.new(ip_address: '192.168.0.1', mac_address: 'de:ad:be:ef:de:ad') }
+  let(:options) { {interface: 'en1'} }
+  let(:subscriber) { TestSubscriber.new }
+  subject { Nmunch::Report.new(options) }
+
+  describe '#publish_node' do
+    before(:each) do
+      subject.register_subscriber(subscriber)
+    end
+
+    it 'delegates the node to the subscriber' do
+      subscriber.should_receive(:process).with(node)
+      subject.publish_node(node)
+    end
+
+    context 'when node has a meta address' do
+      it 'does not delegate node to subscribers' do
+        node.stub(:ip_address).and_return('0.0.0.0')
+        subscriber.should_not_receive(:process)
+        subject.publish_node(node)
+      end
+    end
+
+    context 'when node is already discovered' do
+      it 'does not delegate node to subscribers' do
+        subject.publish_node(node)
+        subscriber.should_not_receive(:process)
+        subject.publish_node(node)
+      end
+    end
+  end
+end

data/spec/lib/nmunch/subscribers/base_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe Nmunch::Subscribers::Base do
+  let(:options) { {interface: 'en1'} }
+  subject { Nmunch::Subscribers::Base.new(options) }
+
+  describe '.initialize' do
+    it 'assigns options to instance variable' do
+      subject.options.should == options
+    end
+  end
+end

data/spec/lib/nmunch/subscribers/stdout_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe Nmunch::Subscribers::Stdout do
+  let(:node) { Nmunch::Node.new(ip_address: '192.168.0.1', mac_address: 'de:ad:be:ef:de:ad') }
+  let(:options) { {interface: 'en1'} }
+  subject { Nmunch::Subscribers::Stdout.new(options) }
+
+  describe '#process' do
+    it 'prints node details to STDOUT' do
+      output = capture_stdout { subject.process(node) }
+      output.should include('192.168.0.1')
+      output.should include('de:ad:be:ef:de:ad')
+      output.should include('Unknown')
+    end
+
+    context 'when --no-prefix-lookup option is set' do
+      it 'does not look up mac address prefix' do
+        options['no-prefix-lookup'] = true
+        output = capture_stdout { subject.process(node) }
+        output.should include('192.168.0.1')
+        output.should include('de:ad:be:ef:de:ad')
+        output.should_not include('Unknown')
+      end
+    end
+  end
+end

data/spec/lib/nmunch_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe Nmunch do
+  describe 'PCAP filter expression' do
+    it 'allows only ARP and broadcast packets' do
+      Nmunch::CAPTURE_FILTER.should == 'arp or broadcast'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,43 @@
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts 'Run `bundle install` to install missing gems'
+  exit e.status_code
+end
+
+require 'pcap'
+require 'ipaddr'
+require 'paint'
+require 'nmunch'
+
+RSpec.configure do |config|
+  config.filter_run :focus => true
+  config.run_all_when_everything_filtered = true
+end
+
+def capture_stdout
+  original_stdout = $stdout
+  $stdout = fake = StringIO.new
+  begin
+    yield
+  ensure
+    $stdout = original_stdout
+  end
+  fake.string
+end
+
+ARP_PACKET_DATA = "\xff\xff\xff\xff\xff\xff\xde\xad\xbe\xef\xde\xad\x08\x06\x00\x01" +
+                  "\x08\x00\x06\x04\x00\x01\xde\xad\xbe\xef\xde\xad\xc0\xa8\x00\x7d" +
+                  "\x00\x00\x00\x00\x00\x00\xc0\xa8\x00\x42"
+
+IP_PACKET_DATA  = "\x7b\x22\x68\x6f\x73\x74\xde\xad\xbe\xef\xde\xad\x20\x32\x36\x37" +
+                  "\x35\x37\x32\x31\x31\x30\x2c\x20\x22\x76\x65\x72\x73\x69\x6f\x6e" +
+                  "\x22\x3a\x20\x5b\x31\x2c\x20\x38\x5d\x2c\x20\x22\x64\x69\x73\x70" +
+                  "\x6c\x61\x79\x6e\x61\x6d\x65\x22\x3a\x20\x22\x32\x36\x37\x35\x37" +
+                  "\x32\x31\x31\x30\x22\x2c\x20\x22\x70\x6f\x72\x74\x22\x3a\x20\x31" +
+                  "\x37\x35\x30\x30\x2c\x20\x22\x6e\x61\x6d\x65\x73\x70\x61\x63\x65" +
+                  "\x73\x22\x3a\x20\x5b\x31\x34\x33\x30\x30\x33\x33\x37\x36\x2c\x20" +
+                  "\x31\x31\x35\x36\x33\x34\x38\x35\x38\x2c\x20\x31\x31\x38\x39\x30" +
+                  "\x36\x37\x30\x31\x5d\x7d"

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification
+name: nmunch
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Michael Henriksen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: methadone
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.3
+- !ruby/object:Gem::Dependency
+  name: pcap
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.7
+- !ruby/object:Gem::Dependency
+  name: paint
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Nmunch is a passive network discovery tool that finds live network nodes
+  by analyzing ARP and broadcast packets.
+email:
+- michenriksen87@gmail.com
+executables:
+- nmunch
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/nmunch
+- lib/nmunch.rb
+- lib/nmunch/dissectors/arp.rb
+- lib/nmunch/dissectors/base.rb
+- lib/nmunch/dissectors/ip.rb
+- lib/nmunch/mac_oui_lookup.rb
+- lib/nmunch/node.rb
+- lib/nmunch/report.rb
+- lib/nmunch/subscribers/base.rb
+- lib/nmunch/subscribers/stdout.rb
+- lib/nmunch/version.rb
+- mac-prefixes.txt
+- nmunch.gemspec
+- spec/lib/nmunch/dissectors/arp_spec.rb
+- spec/lib/nmunch/dissectors/base_spec.rb
+- spec/lib/nmunch/dissectors/ip_spec.rb
+- spec/lib/nmunch/mac_oui_lookup_spec.rb
+- spec/lib/nmunch/node_spec.rb
+- spec/lib/nmunch/report_spec.rb
+- spec/lib/nmunch/subscribers/base_spec.rb
+- spec/lib/nmunch/subscribers/stdout_spec.rb
+- spec/lib/nmunch_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/michenriksen/nmunch
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: OM NOM NOM NOM
+test_files:
+- spec/lib/nmunch/dissectors/arp_spec.rb
+- spec/lib/nmunch/dissectors/base_spec.rb
+- spec/lib/nmunch/dissectors/ip_spec.rb
+- spec/lib/nmunch/mac_oui_lookup_spec.rb
+- spec/lib/nmunch/node_spec.rb
+- spec/lib/nmunch/report_spec.rb
+- spec/lib/nmunch/subscribers/base_spec.rb
+- spec/lib/nmunch/subscribers/stdout_spec.rb
+- spec/lib/nmunch_spec.rb
+- spec/spec_helper.rb