arp_scan 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a350836a9cf6579fa714992273f38bce584c7457
-  data.tar.gz: d118e275d8c1c3e3b3e0f10588752cf96fe90ab8
+  metadata.gz: 21449e6fd38960eb78e357a1db2e75022ec3a0cd
+  data.tar.gz: 2b23e39343027d0366e1caa578f68c31722f8542
 SHA512:
-  metadata.gz: 029d7744afbcb0a3c6bc5474bcf0f868696d33d489f44a01a1e2b4927510959acfb7c8f7ecfca5eef31c216b05422db1d397b622bd0f94b3cd2dac3a499562b5
-  data.tar.gz: 144b8459b0c4b3b9c5997895a6790b281b1f1be5737ee9371aa2366ee764385b191fedce487b84e23c1f53198f5ed90ebf237eaeccbf55baed091918c9749787
+  metadata.gz: 819fbd9535f90d617d3bbe3448aea31e50fe155cafb44e25fd8c03d2b6332e14b5b42a6a5e35a9fbca3a112938eb181e07c3777fd1e02097d47b9bafc74ef10f
+  data.tar.gz: cc4ad8109f6426074b01f1dddd5b5affb7bc9439658517594331b731b091534aacba601b7cd4164e2361d83cbb0278a19648788c437178445700b7efe3129f95

data/README.md

@@ -14,7 +14,7 @@ options but be sure to understand what you're doing before you do it:
 
 * Set the SUID bit on the `arp-scan` bin:
 
-		sudo chmod u+s /usr/bin/arp-scan`
+	 `sudo chmod u+s /usr/bin/arp-scan`
 
 * Run your Ruby code as root (I wouldn't do this)
 

data/lib/arp_scan.rb

@@ -1,7 +1,7 @@
 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/scan_result_processor"
 require_relative "./arp_scan/host"
 
 module ARPScan

data/lib/arp_scan/arp_scanner.rb

@@ -1,4 +1,4 @@
-require_relative './arp_scanner'
+require_relative './scan_result_processor'
 
 module ARPScan
   module ARPScanner
@@ -18,12 +18,12 @@ module ARPScan
       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)
+      result_string = `#{which 'arp-scan'} #{argument_string}`
+      ScanResultProcessor.process(result_string)
     end
+
+    private_class_method :which
   end
 end
 

data/lib/arp_scan/host.rb

@@ -7,5 +7,19 @@ module ARPScan
       @mac = mac
       @oui = oui
     end
+
+    def to_hash
+      { :ip_addr => @ip_addr,
+        :mac     => @mac,
+        :oui      => @oui
+      }
+    end
+
+    def to_array
+      [ @ip_addr,
+        @mac,
+        @oui
+      ]
+    end
   end
 end

data/lib/arp_scan/scan_report.rb

@@ -1,7 +1,7 @@
 module ARPScan
   class ScanReport
 
-    attr_reader :interface, :datalink, :version, :range_size, :scan_time, :scan_rate, :reply_count
+    attr_reader :hosts, :interface, :datalink, :version, :range_size, :scan_time, :scan_rate, :reply_count
 
     def initialize(hash)
       @hosts = hash[:hosts]
@@ -13,5 +13,28 @@ module ARPScan
       @scan_rate = Float(hash[:scan_rate])
       @reply_count = Integer(hash[:reply_count])
     end
+
+    def to_array
+      self.instance_variables.map do |var|
+        if var == :@hosts
+          self.instance_variable_get(var).map {|host| host.to_array}
+        else
+          self.instance_variable_get(var)
+        end
+      end
+    end
+
+    def to_hash
+      { :hosts => @hosts.map {|host| host.to_hash},
+        :interface => @interface,
+        :datalink => @datalink,
+        :version => @version,
+        :range_size => @range_size,
+        :scan_time => @scan_time,
+        :scan_rate => @scan_rate,
+        :reply_count => @reply_count
+      }
+    end
+
   end
 end

data/lib/arp_scan/scan_result_processor.rb

@@ -0,0 +1,24 @@
+require_relative './host'
+require_relative './scan_report'
+
+module ARPScan
+  module ScanResultProcessor
+
+    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>.*$)/
+    Scan_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)
+      results = {}
+      results[:hosts] = string.scan(Host_Entry_Regex).map {|entry| Host.new(*entry)}
+      results[:interface],
+      results[:datalink] = string.scan(Interface_Summary_Regex)[0]
+      results[:version],
+      results[:range_size],
+      results[:scan_time],
+      results[:scan_rate],
+      results[:reply_count] = string.scan(Scan_Summary_Regex)[0]
+      ScanReport.new(results)
+    end
+  end
+end

data/lib/arp_scan/version.rb

@@ -1,3 +1,3 @@
 module ARPScan
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/arp_scan_spec.rb

@@ -1,8 +1,17 @@
-require '../lib/arp_scan.rb'
+require '../lib/arp_scan'
 
-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)
+RSpec.describe ARPScan do
+  report = ARPScan('-l')
+
+  it "is a method you can pass arp-scan arguments to as a string" do
+    expect(ARPScan('-l').class).to eq(ARPScan::ScanReport)
+  end
+
+  it "returns a nested hash of attributes" do
+    expect(report.to_hash.class).to eq(Hash)
+  end
+
+  it "returns a nested array of attributes" do
+    expect(report.to_array.class).to eq(Array)
   end
 end

data/spec/arp_scanner_spec.rb

@@ -0,0 +1,10 @@
+require '../lib/arp_scan'
+
+RSpec.describe ARPScan::ARPScanner do
+
+  it "has a #scan method to pass arp-scan arguments to as a string" do
+    expect(ARPScan::ARPScanner.scan('-l').class).to eq(ARPScan::ScanReport)
+  end
+  
+end
+

data/spec/host_spec.rb

@@ -0,0 +1,19 @@
+require '../lib/arp_scan'
+
+RSpec.describe ARPScan::Host do
+
+  host = ARPScan::Host.new('10.0.0.1', '00:11:22:33:44:55', "NIC Manufacturer")
+
+  it "contains the host's IP address" do
+    expect(host.ip_addr).to eq('10.0.0.1')
+  end
+
+  it "contains the host's MAC address" do
+    expect(host.mac).to eq('00:11:22:33:44:55')
+  end
+
+  it "contians the host's OUI information" do
+    expect(host.oui).to eq('NIC Manufacturer')
+  end
+
+end

data/spec/scan_report_spec.rb

@@ -1,8 +1,51 @@
-require '../lib/arp_scan.rb'
+require '../lib/arp_scan'
 
-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)
+RSpec.describe ARPScan::ScanReport do
+
+  report_hash = {
+    :hosts => [ARPScan::Host.new(*['10.0.0.1', '00:11:22:33:44:55', 'NIC Manufacturer'])],
+    :interface => "eth0",
+    :datalink => "EN10MB (Ethernet)",
+    :version => "1.8.1",
+    :range_size => 256,
+    :scan_time => 1.503,
+    :scan_rate => 170.33,
+    :reply_count => 1
+  }
+
+  scan_report = ARPScan::ScanReport.new(report_hash)
+
+  it "has a list of zero or more responding hosts" do
+    expect(scan_report.hosts.first.class).to eq(ARPScan::Host)
+  end
+
+  it "reports the network interface used to scan" do
+    expect(scan_report.interface).to eq("eth0")
   end
+
+  it "reports the datalink type of the network interface used to scan" do
+    expect(scan_report.datalink).to eq('EN10MB (Ethernet)')
+  end
+
+  it "reports the version of `arp-scan` used for the scan" do
+    expect(scan_report.version).to eq('1.8.1')
+  end
+
+  it "reports the size of the range of scanned IPs" do
+    expect(scan_report.range_size).to eq(256)
+  end
+
+  it "reports the duration of the scan in seconds" do
+    expect(scan_report.scan_time).to eq(1.503)
+  end
+
+  it "reports the scan rate in hosts per second" do
+    expect(scan_report.scan_rate).to eq(170.33)
+  end
+
+  it "reports the number of hosts that responded" do
+    expect(scan_report.reply_count).to eq(1)
+  end
+
+
 end

data/spec/scan_result_processor_spec.rb

@@ -0,0 +1,44 @@
+require '../lib/arp_scan'
+
+RSpec.describe ARPScan::ScanResultProcessor do
+
+  report_string = File.read './test_output.txt'
+  report = ARPScan::ScanResultProcessor.process(report_string)
+  
+  it "processes arp-scan output to create a ScanReport object" do
+    expect(report.class).to eq(ARPScan::ScanReport)
+  end
+
+  it "builds an array of Host objects" do
+    expect(report.hosts[0].class).to eq(ARPScan::Host)
+  end
+
+  it "parses the scan interface name" do
+    expect(report.interface).to eq("eth0")
+  end
+
+  it "parses the datalink type information" do
+    expect(report.datalink).to eq("EN10MB (Ethernet)")
+  end
+
+  it "parses the version of arp-scan that ran the scan" do
+    expect(report.version).to eq('1.8.1')
+  end
+
+  it "parses the number of hosts scanned" do
+    expect(report.range_size).to eq(256)
+  end
+
+  it "parses the duration of the scan in seconds" do
+    expect(report.scan_time).to eq(1.494)
+  end
+
+  it "parses the rate of the scan in hosts per second" do
+    expect(report.scan_rate).to eq(171.35)
+  end
+
+  it "parses the number of hosts that responded to the scan" do
+    expect(report.reply_count).to eq(1)
+  end
+end
+

data/spec/test_output.txt

@@ -0,0 +1,6 @@
+Interface: eth0, datalink type: EN10MB (Ethernet)
+Starting arp-scan 1.8.1 with 256 hosts (http://www.nta-monitor.com/tools/arp-scan/)
+10.0.0.1	00:11:22:33:44:55	NIC Manufacturer
+
+1 packets received by filter, 0 packets dropped by kernel
+Ending arp-scan 1.8.1: 256 hosts scanned in 1.494 seconds (171.35 hosts/sec). 1 responded

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arp_scan
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Michael Rodrigues
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-06 00:00:00.000000000 Z
+date: 2014-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,11 +52,15 @@ files:
 - 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/scan_result_processor.rb
 - lib/arp_scan/version.rb
 - spec/arp_scan_spec.rb
+- spec/arp_scanner_spec.rb
+- spec/host_spec.rb
 - spec/scan_report_spec.rb
+- spec/scan_result_processor_spec.rb
+- spec/test_output.txt
 homepage: ''
 licenses:
 - MIT
@@ -83,4 +87,8 @@ specification_version: 4
 summary: A ruby wrapper for the arp-scan utility.
 test_files:
 - spec/arp_scan_spec.rb
+- spec/arp_scanner_spec.rb
+- spec/host_spec.rb
 - spec/scan_report_spec.rb
+- spec/scan_result_processor_spec.rb
+- spec/test_output.txt

data/lib/arp_scan/output_processor.rb

@@ -1,24 +0,0 @@
-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).map {|entry| Host.new(*entry)}
-      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]
-      ScanReport.new(report)
-    end
-  end
-end