arp_scan 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 768a6997ecf0acffce32b3d52a16994e892b8f6fd93ec887613aebd478a6a86b
-  data.tar.gz: d8c053296aae885d75e79b70a71d4e7264fdc3f5cf61c84d65b3019b89e56262
+  metadata.gz: e9acd4f2a06b8706a4991c24b6ed5ddce3e71f280440a1bfec82e2155c76375c
+  data.tar.gz: 26bef346fb5f6ee4f5c97dee98283c44b8b443fe7065e130ca9698c2ed569734
 SHA512:
-  metadata.gz: 62d6e68337f32a52808e63dae880d09191b3b353c4338e4b05ee4349ed23572c594badb21af97a1336bba20dbad6b1d5aec23889acc16de63aa3e9e1ce8abbed
-  data.tar.gz: af52cd4506b2a847041e296fbf9d2483a0fb23a2c5e520b45168850ef986105736be7e0512832a88b39390c218a7eb5df5e10d233566af9107f9a8c1b745ebf6
+  metadata.gz: 01af8e6a6a14daca95e60cc39ea2d529163019c48741bbcf0d70e527becd0b8c01ec43d9938b6e1e9c88efaa5ed36affce1fe6dd860df6dc0c1102c2652b99b4
+  data.tar.gz: 5665f838a56d966809fbeedc527efcbc9753677cc51847cacfe39af8b0177d8f54bcd95fd46fbbfa05b028026e433dee93f28da9bf019fe55dd409b554cd2db0

data/README.md

@@ -7,23 +7,12 @@ 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.
+`arp-scan` generally requires root privs to run. I use `setcap` to give it the
+raw socket privs it needs so normal users can run it without sudo:
 
+```shell
+	sudo setcap cap_net_raw+ep /usr/bin/arp-scan
+```
 
 ## Notes
 
@@ -86,6 +75,20 @@ first_host.mac 	=> '00:11:22:33:44:55'
 first_host.oui 	=> "NIC Manufacturer"
 ```
 
+## Build the Gem
+
+```shell
+bundle exec rake build
+```
+
+This writes the packaged gem to `pkg/`.
+
+## Run the Tests
+
+```shell
+bundle exec rake spec
+```
+
 
 
 

data/lib/arp_scan/arp_scanner.rb

@@ -7,14 +7,23 @@ module ARPScan
   # delegates the parsing of the scan results to the ScanResultProcessor module.
   #
   module ARPScanner
+    # get array of file extensions, relevant for Windows
+    def self.exts
+      ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
+    end
+
+    # get array of paths
+    def self.paths
+      ENV['PATH'].split(File::PATH_SEPARATOR)
+    end
+
     # 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|
+      paths.each do |path|
         exts.each do |ext|
           exe = File.join(path, "#{cmd}#{ext}")
           return exe if File.executable?(exe) && !File.directory?(exe)
@@ -32,6 +41,6 @@ module ARPScan
       ScanResultProcessor.process(result_string, argument_string)
     end
 
-    private_class_method :which
+    private_class_method :which, :exts, :paths
   end
 end

data/lib/arp_scan/scan_report.rb

@@ -17,6 +17,14 @@ module ARPScan
     #
     attr_reader :datalink
 
+    # IP address of interface
+    # 
+    attr_reader :ipv4
+
+    # MAC address of the interface
+    # 
+    attr_reader :mac
+
     # `arp-scan` version number.
     #
     attr_reader :version
@@ -46,6 +54,8 @@ module ARPScan
       @hosts = hash[:hosts]
       @interface = hash[:interface]
       @datalink = hash[:datalink]
+      @ipv4 = hash[:ipv4]
+      @mac = hash[:mac]
       @version = hash[:version]
       @range_size = Integer(hash[:range_size])
       @scan_time = Float(hash[:scan_time])
@@ -74,6 +84,8 @@ module ARPScan
       { hosts: @hosts.map(&:to_hash),
         interface: @interface,
         datalink: @datalink,
+        ipv4: @ipv4,
+        mac: @mac,
         version: @version,
         range_size: @range_size,
         scan_time: @scan_time,

data/lib/arp_scan/scan_result_processor.rb

@@ -10,16 +10,24 @@ module ARPScan
   module ScanResultProcessor
     # Regex to capture IP address, MAC address, and OUI information
     #
-    HOST_ENTRY_REGEX = /(\d+.\d+.\d+.\d+)\s(\w\w:\w\w:\w\w:\w\w:\w\w:\w\w)\s(.*)/.freeze
+    HOST_ENTRY_REGEX = /(\d+.\d+.\d+.\d+)\s(\w\w:\w\w:\w\w:\w\w:\w\w:\w\w)\s(.*)/
 
     # Regex to capture interface and datalink
     #
-    INTERFACE_SUMMARY_REGEX = /Interface: (?<interface>.+), datalink type: (?<datalink>.*$)/.freeze
+    INTERFACE_SUMMARY_REGEX = /
+    ^Interface:\s+(?<interface>[^,\n]+),
+    (?:\s*datalink)?\s*type:\s*(?<datalink>[^\n,]+?)(?=,\s*MAC:|$)
+    (?:,\s*MAC:\s*(?<mac>[0-9A-Fa-f]{2}(?::[0-9A-Fa-f]{2}){5}))?
+      (?:,\s*IPv4:\s*(?<ipv4>(?:(?:25[0-5]|2[0-4]\d|1?\d?\d)\.){3}(?:25[0-5]|2[0-4]\d|1?\d?\d)))?
+      $
+    /x
+
+
 
     # Regex to capture arp-scan version, scan range size, scan time, scan rate,
     # and the number of responding hosts.
     #
-    SCAN_SUMMARY_REGEX = %r{Ending arp-scan (?<version>.*): (?<range_size>.*) hosts scanned in (?<scan_time>.*) seconds \((?<scan_rate>.*) hosts/sec\). (?<reply_count>.*) responded}.freeze
+    SCAN_SUMMARY_REGEX = %r{Ending arp-scan (?<version>.*): (?<range_size>.*) hosts scanned in (?<scan_time>.*) seconds \((?<scan_rate>.*) hosts/sec\). (?<reply_count>.*) responded}
 
     # This method does the actual processing of the arp-scan result string. It
     # uses the Regexes to capture data then passes the results to ScanRepor.new
@@ -29,12 +37,14 @@ module ARPScan
       results = {}
       results[:hosts] = string.scan(HOST_ENTRY_REGEX).map { |entry| Host.new(*entry) }
       results[:interface],
-      results[:datalink] = string.scan(INTERFACE_SUMMARY_REGEX)[0]
+        results[:datalink],
+        results[:mac],
+        results[:ipv4] = 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]
+        results[:range_size],
+        results[:scan_time],
+        results[:scan_rate],
+        results[:reply_count] = string.scan(SCAN_SUMMARY_REGEX)[0]
       results[:arguments] = arguments
       ScanReport.new(results)
     end

data/lib/arp_scan/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ARPScan
-  VERSION = '0.1.1'
+  VERSION = '0.1.3'
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: arp_scan
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Michael Rodrigues
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-11 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
 description: Use the arp-scan utility from your ruby programs.
 email:
@@ -17,29 +16,18 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- Gemfile
-- Gemfile.lock
 - 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/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/spec_helper.rb
-- spec/test_output.txt
 homepage: https://github.com/mikerodrigues/arp_scan
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -54,15 +42,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
-signing_key: 
+rubygems_version: 3.7.1
 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/spec_helper.rb
-- spec/test_output.txt
+test_files: []

data/Gemfile

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-group :test do
-  gem 'rspec'
-  gem 'rspec-support', '~>3.0.0'
-end
-
-# Specify your gem's dependencies in arp_scan.gemspec
-# gemspec

data/Gemfile.lock

@@ -1,26 +0,0 @@
-GEM
-  remote: https://rubygems.org/
-  specs:
-    diff-lcs (1.4.4)
-    rspec (3.0.0)
-      rspec-core (~> 3.0.0)
-      rspec-expectations (~> 3.0.0)
-      rspec-mocks (~> 3.0.0)
-    rspec-core (3.0.4)
-      rspec-support (~> 3.0.0)
-    rspec-expectations (3.0.4)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.0.0)
-    rspec-mocks (3.0.4)
-      rspec-support (~> 3.0.0)
-    rspec-support (3.0.4)
-
-PLATFORMS
-  x86_64-linux
-
-DEPENDENCIES
-  rspec
-  rspec-support (~> 3.0.0)
-
-BUNDLED WITH
-   2.2.15

data/arp_scan.gemspec

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-lib = File.expand_path('lib', __dir__)
-$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       = 'A ruby wrapper for the arp-scan utility.'
-  spec.description   = 'Use the arp-scan utility from your ruby programs.'
-  spec.homepage      = 'https://github.com/mikerodrigues/arp_scan'
-  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']
-
-end

data/spec/arp_scan_spec.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-require_relative './spec_helper.rb'
-
-RSpec.describe ARPScan do
-  ARPScan('-l')
-  it 'is a method' do
-    expect(ARPScan.respond_to?('__send__')).to eq(true)
-  end
-end

data/spec/arp_scanner_spec.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-require_relative './spec_helper'
-
-module ARPScan
-  describe ARPScanner do
-    describe '#scan' do
-      it 'accepts arp-scan arguments as a string' do
-        expect(ARPScanner.scan('-l').class).to eq(ScanReport)
-      end
-    end
-  end
-end

data/spec/host_spec.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-require_relative './spec_helper'
-
-module ARPScan
-  describe Host do
-    host = Host.new('10.0.0.1', '00:11:22:33:44:55', 'NIC Manufacturer')
-
-    describe '#ip_addr' do
-      it "returns the host's IP address" do
-        expect(host.ip_addr).to eq('10.0.0.1')
-      end
-    end
-
-    describe '#mac' do
-      it "returns the host's MAC address" do
-        expect(host.mac).to eq('00:11:22:33:44:55')
-      end
-    end
-
-    describe '#oui' do
-      it "returns the host's OUI information" do
-        expect(host.oui).to eq('NIC Manufacturer')
-      end
-    end
-  end
-end

data/spec/scan_report_spec.rb

@@ -1,76 +0,0 @@
-# frozen_string_literal: true
-
-require_relative './spec_helper'
-
-module ARPScan
-  describe ScanReport do
-    report_hash = {
-      hosts: [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,
-      arguments: '-l'
-    }
-
-    scan_report = ScanReport.new(report_hash)
-
-    describe '#hosts' do
-      it 'returns an Array of Host objects' do
-        expect(scan_report.hosts.class).to eq(Array)
-        expect(scan_report.hosts.first.class).to eq(Host)
-      end
-    end
-
-    describe '#interface' do
-      it 'returns the network interface used to scan' do
-        expect(scan_report.interface).to eq('eth0')
-      end
-    end
-
-    describe '#datalink' do
-      it 'returns the datalink type of the network interface used to scan' do
-        expect(scan_report.datalink).to eq('EN10MB (Ethernet)')
-      end
-    end
-
-    describe '#version' do
-      it 'returns the version of `arp-scan` used for the scan' do
-        expect(scan_report.version).to eq('1.8.1')
-      end
-    end
-
-    describe '#range_size' do
-      it 'returns the size of the range of scanned IPs' do
-        expect(scan_report.range_size).to eq(256)
-      end
-    end
-
-    describe '#scan_time' do
-      it 'returns the duration of the scan in seconds' do
-        expect(scan_report.scan_time).to eq(1.503)
-      end
-    end
-
-    describe '#scan_rate' do
-      it 'returns the scan rate in hosts per second' do
-        expect(scan_report.scan_rate).to eq(170.33)
-      end
-    end
-
-    describe '#reply_count' do
-      it 'returns the number of hosts that responded' do
-        expect(scan_report.reply_count).to eq(1)
-      end
-    end
-
-    describe '#arguments' do
-      it 'returns the argument string used to scan' do
-        expect(scan_report.arguments).to eq('-l')
-      end
-    end
-  end
-end

data/spec/scan_result_processor_spec.rb

@@ -1,53 +0,0 @@
-# frozen_string_literal: true
-
-require_relative './spec_helper'
-
-module ARPScan
-  describe ScanResultProcessor do
-    argument_string = '-l'
-    report_string = File.read './test_output.txt'
-    report = ARPScan::ScanResultProcessor.process(report_string, argument_string)
-
-    describe '#process' do
-      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
-
-      it 'includes the argument string in the report' do
-        expect(report.arguments).to eq('-l')
-      end
-    end
-  end
-end

data/spec/spec_helper.rb

@@ -1,3 +0,0 @@
-# frozen_string_literal: true
-
-require '../lib/arp_scan'

data/spec/test_output.txt

@@ -1,6 +0,0 @@
-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