arp_scan 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 768a6997ecf0acffce32b3d52a16994e892b8f6fd93ec887613aebd478a6a86b
-  data.tar.gz: d8c053296aae885d75e79b70a71d4e7264fdc3f5cf61c84d65b3019b89e56262
+  metadata.gz: 35970ca5fd7010c821b2a553e4852e0b3e4cbccf186aa57a1ce26ac0ad6c049c
+  data.tar.gz: 1c63484f637139d6de689c29e9014ecce4d222506bc837c33a4edd75802944b4
 SHA512:
-  metadata.gz: 62d6e68337f32a52808e63dae880d09191b3b353c4338e4b05ee4349ed23572c594badb21af97a1336bba20dbad6b1d5aec23889acc16de63aa3e9e1ce8abbed
-  data.tar.gz: af52cd4506b2a847041e296fbf9d2483a0fb23a2c5e520b45168850ef986105736be7e0512832a88b39390c218a7eb5df5e10d233566af9107f9a8c1b745ebf6
+  metadata.gz: da55cbe303db00aca3fa6fa24818cedbf40f525b329d986a56cd5d9dfe16071a7f84e2c2a7fe74c9172e3e5debd0077a5337d51cd4942eba022289bd3bf09e21
+  data.tar.gz: 80c489f8604c905e732bb13fb48c7d2a3f13a8e923a28d71cb68e5d74774b1359805b160c02ea46bba5ee71ca8af16b9597674fed9b8cdd1de7231bb82223dab

data/.gitignore

@@ -0,0 +1 @@
+*.gem

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,12 @@ first_host.mac 	=> '00:11:22:33:44:55'
 first_host.oui 	=> "NIC Manufacturer"
 ```
 
+## Run the Tests
+```ruby
+cd arp_scan/spec
+rspec .
+```
+
 
 
 

data/arp_scan.gemspec

@@ -18,5 +18,4 @@ Gem::Specification.new do |spec|
   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/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.2'
 end

data/spec/arp_scan_spec.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative './spec_helper.rb'
+require_relative './spec_helper'
 
 RSpec.describe ARPScan do
   ARPScan('-l')

data/spec/scan_result_processor_spec.rb

@@ -6,23 +6,37 @@ module ARPScan
   describe ScanResultProcessor do
     argument_string = '-l'
     report_string = File.read './test_output.txt'
+    report_string_2 = File.read './test_output_2.txt'
     report = ARPScan::ScanResultProcessor.process(report_string, argument_string)
+    report_2 = ARPScan::ScanResultProcessor.process(report_string_2, argument_string)
 
     describe '#process' do
       it 'processes arp-scan output to create a ScanReport object' do
         expect(report.class).to eq(ARPScan::ScanReport)
+        expect(report_2.class).to eq(ARPScan::ScanReport)
       end
 
       it 'builds an array of Host objects' do
         expect(report.hosts[0].class).to eq(ARPScan::Host)
+        expect(report_2.hosts[0].class).to eq(ARPScan::Host)
       end
 
       it 'parses the scan interface name' do
         expect(report.interface).to eq('eth0')
+        expect(report_2.interface).to eq('enp4s0')
       end
 
       it 'parses the datalink type information' do
         expect(report.datalink).to eq('EN10MB (Ethernet)')
+        expect(report_2.datalink).to eq('EN10MB')
+      end
+
+      it 'parses the ip of the scanner on newer versions of arp-scan' do
+        expect(report_2.ipv4).to eq('10.0.0.5')
+      end
+
+      it 'parses the MAC of the scanner on newer versions of arp-scan' do
+        expect(report_2.mac).to eq('a1:b2:c3:d4:e5:f6')
       end
 
       it 'parses the version of arp-scan that ran the scan' do

data/spec/test_output_2.txt

@@ -0,0 +1,9 @@
+Interface: enp4s0, type: EN10MB, MAC: a1:b2:c3:d4:e5:f6, IPv4: 10.0.0.5
+Starting arp-scan 1.10.0 with 256 hosts (https://github.com/royhills/arp-scan)
+10.0.0.1	11:22:33:44:55:66	GL Technologies (Hong Kong) Limited
+10.0.0.100	aa:bb:cc:dd:ee:ff	SHENZHEN ZHIBOTONG ELECTRONICS CO.,LTD
+10.0.0.213	1a:2b:3c:4d:e5:f6	(Unknown)
+
+3 packets received by filter, 0 packets dropped by kernel
+Ending arp-scan 1.10.0: 256 hosts scanned in 1.965 seconds (130.28 hosts/sec). 3 responded
+

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: arp_scan
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 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,6 +16,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -35,11 +35,11 @@ files:
 - spec/scan_result_processor_spec.rb
 - spec/spec_helper.rb
 - spec/test_output.txt
+- spec/test_output_2.txt
 homepage: https://github.com/mikerodrigues/arp_scan
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -54,8 +54,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:
@@ -66,3 +65,4 @@ test_files:
 - spec/scan_result_processor_spec.rb
 - spec/spec_helper.rb
 - spec/test_output.txt
+- spec/test_output_2.txt