arp_scan 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ad523800941924d8ef1121a6d5757b55be171ca5
+  data.tar.gz: 47c2452c4d7a149cdb31d4103cae7e23344ce0c7
+SHA512:
+  metadata.gz: 2a840f2abb674944204976a51db4221b317efb1508860b060b795688d311e37a1120c564f5863d4b272de3ba7c91239205c63cb5b18a55fe25d73bfc2e7033a1
+  data.tar.gz: 5d1f0c22e868592708ba5f1425d1ec9b84975c9c2c3735525375e7c91a6d88e5718ff0977a230baca2064458e2a10a75e3e8c6e5b3c23be02e9f4b6ec5c8d450

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in arp_scan.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Michael Rodrigues
+
+MIT License
+
+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,86 @@
+# ARPScan
+
+Very simple wrapper for using and parsing output from `arp-scan`.
+
+You will need to make sure `arp-scan` is installed. See the arp-scan homepage at http://www.nta-monitor.com/tools/arp-scan/
+
+You'll also need superuser privileges to run `arp-scan`, you have have a few
+options but be sure to understand what you're doing before you do it:
+
+* Edit `/etc/sudoers` to allow user to run `arp-scan` as root without a
+  password.
+
+	`user host = (root) NOPASSWD: /usr/bin/arp-scan`
+
+* Set the SUID bit on the `arp-scan` bin:
+
+		sudo chmod u+s /usr/bin/arp-scan`
+
+* Run your Ruby code as root (I wouldn't do this)
+
+I use the SUID method but if you have other people logging into your machine you
+should probably go with the `/etc/sudoers` method.
+
+
+## Notes
+
+This code is untested and will hopefully be refactored soon.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'arp_scan', :git => 'git://github.com/mikerodrigues/arp_scan.git'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install arp_scan
+
+## Usage
+
+No argument parsing is done by the gem, it takes the same arguments as
+`arp-scan` and just passes them to the binary. The result is returned as a
+ScanReport object which makes it easy to iterate through hosts as well as see
+metainfo about the scan itself.
+
+Scanning is easy:
+
+    require 'arp_scan'
+
+    report = ARPScan('--localnet')
+
+    report.datalink 	=> "EN10MB (Ethernet)",
+    report.interface 	=> "eth0"
+    report.range_size 	=> "256"
+    report.reply_count 	=> "2"
+    report.scan_rate 	=> "169.99" # hosts/sec
+    report.scan_time 	=> "1.586" # seconds
+    report.version 	=> "1.8.1" # arp-scan version
+
+Each `ScanReport` also holds zero or more `Host` objects representing founds
+hosts:
+
+    first_host = report.hosts.first
+    first_host.ip_addr 	=> '10.0.0.1'
+    first_host.mac 	=> '00:11:22:33:44:55'
+    first_host.oui 	=> "NIC Manufacturer"
+
+
+
+
+
+
+## Contributing
+
+1. Fork it ( https://github.com/mikerodrigues/arp_scan/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/arp_scan.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'arp_scan/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "arp_scan"
+  spec.version       = ARPScan::VERSION
+  spec.authors       = ["Michael Rodrigues"]
+  spec.email         = ["mikebrodrigues@gmail.com"]
+  spec.summary       = %q{A ruby wrapper for the arp-scan utility.}
+  spec.description   = %q{Easily use the arp_scan utility from within your ruby programs.}
+  spec.homepage      = ""
+  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.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/arp_scan/arp_scanner.rb

@@ -0,0 +1,29 @@
+require_relative './arp_scanner'
+
+module ARPScan
+  module ARPScanner
+
+    # I got this method from: http://stackoverflow.com/questions/2108727
+    # Cross-platform way of finding an executable in the $PATH.
+    #
+    #   which('ruby') #=> /usr/bin/ruby
+    def self.which(cmd)
+      exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
+      ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
+        exts.each { |ext|
+          exe = File.join(path, "#{cmd}#{ext}")
+          return exe if File.executable?(exe) && !File.directory?(exe)
+        }
+      end
+      return nil
+    end
+
+
+    def self.scan(argument_string = nil)
+      @arp_scan_path = which 'arp-scan'
+      output_string = `#{@arp_scan_path} #{argument_string}`
+      OutputProcessor.process(output_string)
+    end
+  end
+end
+

data/lib/arp_scan/host.rb

@@ -0,0 +1,11 @@
+module ARPScan
+  class Host
+    attr_reader :ip_addr, :mac, :oui
+
+    def initialize(ip_addr, mac, oui)
+      @ip_addr = ip_addr
+      @mac = mac
+      @oui = oui
+    end
+  end
+end

data/lib/arp_scan/output_processor.rb

@@ -0,0 +1,25 @@
+require_relative './host'
+require_relative './scan_report'
+
+module ARPScan
+  module OutputProcessor
+
+    Host_Entry_Regex = /(\d+.\d+.\d+.\d+)\s(\w\w:\w\w:\w\w:\w\w:\w\w:\w\w)\s(.*)/
+    Interface_Summary_Regex = /Interface: (?<interface>.+), datalink type: (?<datalink>.*$)/
+    Received_Summary_Regex = /Ending arp-scan (?<version>.*): (?<range_size>.*) hosts scanned in (?<scan_time>.*) seconds \((?<scan_rate>.*) hosts\/sec\). (?<reply_count>.*) responded/
+
+    def self.process(string)
+      report = {}
+      report[:hosts] = string.scan(Host_Entry_Regex)
+      report[:interface],
+      report[:datalink] = string.scan(Interface_Summary_Regex)[0]
+      report[:version],
+      report[:range_size],
+      report[:scan_time],
+      report[:scan_rate],
+      report[:reply_count] = string.scan(Received_Summary_Regex)[0]
+      hosts = report[:hosts].map {|entry| Host.new(*entry)}
+      ScanReport.new(report)
+    end
+  end
+end

data/lib/arp_scan/scan_report.rb

@@ -0,0 +1,17 @@
+module ARPScan
+  class ScanReport
+
+    attr_reader :interface, :datalink, :version, :range_size, :scan_time, :scan_rate, :reply_count
+
+    def initialize(hash)
+      @hosts = hash[:hosts]
+      @interface = hash[:interface]
+      @datalink = hash[:datalink]
+      @version = hash[:version]
+      @range_size = Integer(hash[:range_size])
+      @scan_time = Float(hash[:scan_time])
+      @scan_rate = Float(hash[:scan_rate])
+      @reply_count = Integer(hash[:reply_count])
+    end
+  end
+end

data/lib/arp_scan/version.rb

@@ -0,0 +1,3 @@
+module ARPScan
+  VERSION = "0.0.1"
+end

data/lib/arp_scan.rb

@@ -0,0 +1,13 @@
+require_relative "./arp_scan/version"
+require_relative "./arp_scan/arp_scanner"
+require_relative "./arp_scan/scan_report"
+require_relative "./arp_scan/output_processor"
+require_relative "./arp_scan/host"
+
+module ARPScan
+
+end
+
+def ARPScan(argument_string = nil)
+  ARPScan::ARPScanner.scan argument_string
+end

data/spec/arp_scan_spec.rb

@@ -0,0 +1,8 @@
+require '../lib/arp_scan.rb'
+
+describe ARPScan, '#scan' do
+  it 'returns a ScanReport' do
+    report = ARPScan.scan('-I eth0.748 128.111.186.1-128.111.186.75')
+    report.class.should eq(ARPScan::ScanReport)
+  end
+end

data/spec/scan_report_spec.rb

@@ -0,0 +1,8 @@
+require '../lib/arp_scan.rb'
+
+describe ARPScan, '#scan' do
+  it 'returns a ScanReport' do
+    report = ARPScan.scan('-I eth0.748 128.111.186.1-128.111.186.75')
+    report.class.should eq(ARPScan::ScanReport)
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: arp_scan
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Michael Rodrigues
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
+description: Easily use the arp_scan utility from within your ruby programs.
+email:
+- mikebrodrigues@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- arp_scan.gemspec
+- lib/arp_scan.rb
+- lib/arp_scan/arp_scanner.rb
+- lib/arp_scan/host.rb
+- lib/arp_scan/output_processor.rb
+- lib/arp_scan/scan_report.rb
+- lib/arp_scan/version.rb
+- spec/arp_scan_spec.rb
+- spec/scan_report_spec.rb
+homepage: ''
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A ruby wrapper for the arp-scan utility.
+test_files:
+- spec/arp_scan_spec.rb
+- spec/scan_report_spec.rb