whiff 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 89a4e377d396fd2d1f9e6877c6db0682acfc53cb
+  data.tar.gz: 3dafb788f5ca88a0e7cab3926151e181206652ce
+SHA512:
+  metadata.gz: e869d03bb40beb6daa5b746bfd596af045b40e767654662bfa86632aa59771dc55c8c26dc4d1f12efb1db10b8470cef2046593dad41d39a77123416f7633f125
+  data.tar.gz: 6b74c227f2b3f11d85e80c25cc266aeb7ef6db37681fadbc217b28b8de05ff94eba208d20399186d1677b0ea83b2b06e1a980b451ce001a7171ee07c248279f0

data/.gitignore

@@ -0,0 +1,37 @@
+.DS_Store
+
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 2.1.0
+  - 2.0.0
+  - 1.9.3
+script: bundle exec rspec spec
+cache: apt
+before_install:
+ - sudo apt-get update -qq
+ - sudo apt-get install -qq arp-scan

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    whiff (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    awesome_print (1.2.0)
+    coderay (1.1.0)
+    diff-lcs (1.2.5)
+    method_source (0.8.2)
+    pry (0.9.12.6)
+      coderay (~> 1.0)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rake (10.3.0)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.8)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.6)
+    slop (3.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  awesome_print
+  bundler (~> 1.6)
+  pry
+  rake (~> 10.3.0)
+  rspec (~> 2.14)
+  whiff!

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Chase Southard
+
+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,64 @@
+# whiff
+
+_catch a whiff of this._
+
+an interface to sniffing MAC addresses on the local network through [arp-scan](http://www.nta-monitor.com/wiki/index.php/Arp-scan_Documentation).
+
+[![Build Status](https://travis-ci.org/chaserx/whiff.svg?branch=master)](https://travis-ci.org/chaserx/whiff)
+
+## Getting Started
+
+**installing arp-scan**
+
+mac os x:
+
+1. brew update
+1. brew install arp-scan
+
+linux:
+
+1. sudo apt-get update
+1. sudo apt-get intall arp-scan
+
+**arp-scan usage**
+
+on mac os x, try:
+
+`sudo arp-scan -l -s 10.0.1.1 -I en1 -q`
+
+where 10.0.1.1 is the IP address of your router, and en1 is the name of your active network interface.
+
+on linux, try:
+
+`sudo arp-scan -l -s 10.0.1.1 -I wlan0 -q`
+
+where 10.0.1.1 is the IP address of your router, and wlan0 is the name of your active network interface.
+
+either of these should return something similar to the following:
+
+        Interface: en1, datalink type: EN10MB (Ethernet)
+        Starting arp-scan 1.8 with 256 hosts (http://www.nta-monitor.com/tools/arp-scan/)
+        10.0.1.29   00:13:21:c1:28:9a
+        10.0.1.4    20:c9:d0:b5:61:21
+        10.0.1.3    8c:3a:e3:98:81:2d
+        10.0.1.8    94:94:26:95:09:f0
+        10.0.1.2    00:00:48:64:11:ef
+        10.0.1.200  b8:27:eb:13:65:e7
+
+        537 packets received by filter, 0 packets dropped by kernel
+        Ending arp-scan 1.8: 256 hosts scanned in 1.171 seconds (218.62 hosts/sec). 6 responded
+
+**whiff usage**
+
+`sudo irb -r whiff`
+
+`Whiff::ArpScan.fetch('10.0.1.1', 'en1', verbose: true)`
+
+results in:
+
+        00:13:21:c1:28:9a
+        20:c9:d0:b5:61:21
+        8c:3a:e3:98:81:2d
+        94:94:26:95:09:f0
+        00:00:48:64:11:ef
+        b8:27:eb:13:65:e7

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+
+task :console do
+  exec "irb -r whiff -I ./lib"
+end

data/lib/whiff.rb

@@ -0,0 +1,10 @@
+require 'whiff/version'
+require 'whiff/arp_scan'
+
+begin
+  require "pry"
+rescue LoadError
+end
+
+module Whiff
+end

data/lib/whiff/arp_scan.rb

@@ -0,0 +1,33 @@
+module Whiff
+  module ArpScan
+
+    IP_ADDRESS_REGEX = /\A(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})\Z/
+
+    MAC_ADDRESS_REGEX = /([0-9A-F]{2}[:]){5}([0-9A-F]{2})/i
+
+    def self.fetch(ip_address, interface, options={})
+      raise 'Must run as root' unless options[:test] == true || Process.uid == 0
+      raise 'arp-scan not installed' unless arp_scan_installed?
+      raise 'invalid IP address' unless ip_address =~ IP_ADDRESS_REGEX
+      cmd = "#{options[:env]} arp-scan -l -s #{ip_address} -I #{interface} -q"
+      puts cmd
+      addresses = []
+      stdout = `#{cmd}`
+      stdout.each_line do |line|
+        addresses << extract_mac_address(line)
+      end
+      addresses.delete_if{|a| a.nil?}.uniq!
+      puts addresses if options[:verbose]
+      addresses
+    end
+
+    def self.extract_mac_address(str)
+      str.match(MAC_ADDRESS_REGEX) { |m| m }
+    end
+
+    def self.arp_scan_installed?
+      `which arp-scan`
+      $?.success?
+    end
+  end
+end

data/lib/whiff/version.rb

@@ -0,0 +1,3 @@
+module Whiff
+  VERSION = '0.0.1'
+end

data/spec/data/arp-scan/9489ad861b94a4dd85e0b7faa03e6dd1/exit_code

@@ -0,0 +1 @@
+0

data/spec/data/arp-scan/9489ad861b94a4dd85e0b7faa03e6dd1/stderr

@@ -0,0 +1 @@
+

data/spec/data/arp-scan/9489ad861b94a4dd85e0b7faa03e6dd1/stdout

@@ -0,0 +1,7 @@
+Interface: en1, datalink type: EN10MB (Ethernet)
+Starting arp-scan 1.8 with 256 hosts (http://www.nta-monitor.com/tools/arp-scan/)
+10.0.1.7	b8:8d:12:59:43:b9
+10.0.1.29	00:13:21:c1:28:9a
+
+519 packets received by filter, 0 packets dropped by kernel
+Ending arp-scan 1.8: 256 hosts scanned in 1.176 seconds (217.69 hosts/sec). 2 responded

data/spec/data/bin/act-like.rb

@@ -0,0 +1,37 @@
+#!/usr/bin/env ruby
+require 'digest/md5'
+require 'open3'
+require 'fileutils'
+
+# from: http://3till7.net/2014/01/24/vcr-for-shell-scripts/index.html
+
+command = ARGV.join(' ')
+program = File.basename(ARGV.shift)
+# Compute a hash of the command being run, including its arguments:
+hash = Digest::MD5.hexdigest(program + ARGV.join(' '))
+test_data_dir = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+fixtures = File.join(test_data_dir, program, hash)
+stdout_path = File.join(fixtures, 'stdout')
+stderr_path = File.join(fixtures, 'stderr')
+exit_code_path = File.join(fixtures, 'exit_code')
+
+# If we can't find a directory for this particular command, we need to
+# record new cassettes.
+unless Dir.exists?(fixtures)
+  FileUtils.mkdir_p fixtures
+  stdin, stdout, stderr, wait_thr = Open3.popen3(command)
+  stdin.close # Assume no further input necessary for the command
+  output = stdout.read
+  error = stderr.read
+  exit_code = wait_thr.value.exitstatus
+  # Write cassettes:
+  File.open(stdout_path, 'w') {|file| file.puts output }
+  File.open(stderr_path, 'w') {|file| file.puts error }
+  File.open(exit_code_path, 'w') {|file| file.puts exit_code }
+end
+
+# This script responds just as the actual program did, writing the same
+# data to stdout and stderr, exiting with the same exit code.
+$stdout.print File.read(stdout_path)
+$stderr.print File.read(stderr_path)
+exit File.read(exit_code_path).to_i

data/spec/data/bin/arp-scan

@@ -0,0 +1,2 @@
+#!/usr/bin/env bash
+act-like.rb /usr/local/bin/arp-scan "$@"

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require "whiff"
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/whiff/arp_scan_spec.rb

@@ -0,0 +1,36 @@
+require "spec_helper"
+
+module Whiff::ArpScan
+  describe "fetching MAC addresses through arp-scan" do
+    let(:bin_dir) { File.join('spec', 'data', 'bin') }
+    let(:path_env) { File.expand_path(bin_dir) }
+    let(:env) { "PATH=#{path_env}:$PATH" }
+
+    it "returns an array" do
+      output = Whiff::ArpScan.fetch('10.0.1.1', 'en1', test: true, env: env)
+      expect(output.class).to eq(Array)
+    end
+
+    it "returns MAC address from output" do
+      def output
+        <<-OUTPUT.gsub(/^ {4}/, '')
+          Interface: en1, datalink type: EN10MB (Ethernet)
+          Starting arp-scan 1.8 with 256 hosts (http://www.nta-monitor.com/tools/arp-scan/)
+          10.0.1.7  b8:8d:12:59:43:b9
+          10.0.1.29 00:13:21:c1:28:9a
+
+          519 packets received by filter, 0 packets dropped by kernel
+          Ending arp-scan 1.8: 256 hosts scanned in 1.176 seconds (217.69 hosts/sec). 2 responded
+        OUTPUT
+      end
+
+      expect(Whiff::ArpScan.extract_mac_address(output)[0]).to include("b8:8d:12:59:43:b9")
+    end
+
+    it "returns an array of MAC addresses" do
+      output = Whiff::ArpScan.fetch('10.0.1.1', 'en1', test: true, env: env)
+      expect(output.size).to be > 0
+      expect(output[0].to_s).to match(MAC_ADDRESS_REGEX)
+    end
+  end
+end

data/whiff.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'whiff/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "whiff"
+  spec.version       = Whiff::VERSION
+  spec.authors       = ["Chase Southard"]
+  spec.email         = ["chase.southard@gmail.com"]
+  spec.summary       = %q{A ruby wrapper for arp-scan.}
+  spec.description   = %q{A ruby wrapper for arp-scan. Currently, returns an array of MAC addresses.}
+  spec.homepage      = "https://github.com/chaserx/whiff"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.3.0"
+  spec.add_development_dependency "rspec", "~> 2.14"
+  spec.add_development_dependency "awesome_print"
+  spec.add_development_dependency "pry"
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: whiff
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Chase Southard
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.3.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A ruby wrapper for arp-scan. Currently, returns an array of MAC addresses.
+email:
+- chase.southard@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- CHANGES.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/whiff.rb
+- lib/whiff/arp_scan.rb
+- lib/whiff/version.rb
+- spec/data/arp-scan/9489ad861b94a4dd85e0b7faa03e6dd1/exit_code
+- spec/data/arp-scan/9489ad861b94a4dd85e0b7faa03e6dd1/stderr
+- spec/data/arp-scan/9489ad861b94a4dd85e0b7faa03e6dd1/stdout
+- spec/data/bin/act-like.rb
+- spec/data/bin/arp-scan
+- spec/spec_helper.rb
+- spec/whiff/arp_scan_spec.rb
+- whiff.gemspec
+homepage: https://github.com/chaserx/whiff
+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.1.11
+signing_key: 
+specification_version: 4
+summary: A ruby wrapper for arp-scan.
+test_files:
+- spec/data/arp-scan/9489ad861b94a4dd85e0b7faa03e6dd1/exit_code
+- spec/data/arp-scan/9489ad861b94a4dd85e0b7faa03e6dd1/stderr
+- spec/data/arp-scan/9489ad861b94a4dd85e0b7faa03e6dd1/stdout
+- spec/data/bin/act-like.rb
+- spec/data/bin/arp-scan
+- spec/spec_helper.rb
+- spec/whiff/arp_scan_spec.rb