mac_vendor 0.0.0

data/.gitignore

@@ -0,0 +1,24 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+
+# Ignore Emacs backups everywhere.
+*~
+
+# Ignore textmate projects
+*.tmproj

data/LICENSE.txt

@@ -0,0 +1,21 @@
+Copyright (c) 2013 Uceem Idaho, Inc.
+
+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.rdoc

@@ -0,0 +1,38 @@
+= mac_vendor
+
+* {Homepage}[https://github.com/uceem/mac_vendor.git]
+* {Email}[mailto:doug at uceem.com]
+
+== Description
+
+Given a MAC address, lookup the vendor of the interface.
+
+Inspired by the Net-MAC-Vendor perl package.
+
+== Examples
+
+  require 'mac_vendor'
+
+  v = MacVendor.new
+  v.lookup '00-11-22-33-44-55'
+
+To preload all data up front:
+
+  v = MacVendor.new
+  v.preload_cache
+  v.lookup '00:ff:bb:11:22:33'
+
+To use a local copy of the data, as of the gem release date:
+
+  v = MacVendor.new :use_local => true
+  v.lookup 'aabbccddeeff'
+
+== Install
+
+  $ gem install mac_vendor
+
+== Copyright
+
+Copyright (c) 2013 Uceem Idaho, Inc.
+
+See LICENSE.txt for details.

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/lib/mac_vendor.rb

@@ -0,0 +1,90 @@
+require 'net/http'
+
+class MacVendor
+  OUI_FULL_URL = 'http://standards.ieee.org/develop/regauth/oui/oui.txt'
+  OUI_SINGLE_URL = 'http://standards.ieee.org/cgi-bin/ouisearch?'  # ex: http://standards.ieee.org/cgi-bin/ouisearch?00-11-22
+  
+  def initialize(opts={})
+    @prefix_cache = {}
+    @preloaded = false
+    @network_hits = 0 if opts[:enable_network_tracking]
+    preload_cache_via_local_data if opts[:use_local]
+  end
+  
+  def lookup(mac)
+    prefix = self.normalize_prefix mac
+    return @prefix_cache[prefix] if @preloaded or @prefix_cache.has_key?(prefix)
+    @prefix_cache[prefix] = fetch_single(prefix)
+  end
+
+  # Attempts to turn anything MAC-like into the first six digits, e.g.: AABBCC
+  def normalize_prefix(mac)
+    mac.strip.upcase.gsub(/^0[xX]/,'').gsub(/[^0-9A-F]/,'')[0..5]
+  end
+  
+  # Converts a normalized prefix into something with hyphens, e.g.: AA-BB-CC
+  def hyphen_prefix(p)
+    "#{p[0..1]}-#{p[2..3]}-#{p[4..5]}"
+  end
+
+  def get_url(url)
+    @network_hits +=1 unless @network_hits.nil?
+    Net::HTTP.get URI(url)
+  end
+
+  def fetch_single(prefix)
+    single_txt = get_url OUI_SINGLE_URL + hyphen_prefix(prefix)
+    
+    if single_txt =~ /The public OUI listing contains no match for the query/
+      return @prefix_cache[prefix] = nil
+    end
+    
+    if single_txt.gsub(/[\r\n]/,"\t") =~ /([0-9A-F]+)\s+\(base 16\)(.*?)pre/
+      mac_prefix = normalize_prefix $1
+      lines = $2.strip.split("\t")
+      company_name = lines[0]
+      company_address = lines[1..-2].reject {|x| x == ''}
+
+      return @prefix_cache[prefix] = {:name => company_name, :address => company_address}
+    end
+    nil
+  end
+  
+  def preload_cache_via_string(oui_txt)
+    # First entry is a header
+    entries = oui_txt.split("\n\n")
+
+    entries[1..-1].each do |entry|
+      base16_fields = entry.strip.split("\n")[1].split("\t")
+      mac_prefix = base16_fields[0][0..5]
+      company_name = base16_fields[-1]
+      company_address = entry.strip.gsub("\t",'').split("\n")[2..-1]
+
+      # This actually happens three times in the current dataset!
+      unless @prefix_cache[mac_prefix].nil?
+        #puts "MAC PREFIX COLLISION: #{mac_prefix}"
+        #puts "CURRENT = #{@prefix_cache[mac_prefix].inspect}"
+        #puts "NEW = #{{:name => company_name, :address => company_address}.inspect}"
+        #raise "MAC prefix key collision: #{mac_prefix}"
+        next
+      end
+    
+      @prefix_cache[mac_prefix] = {:name => company_name, :address => company_address}
+    end
+    @preloaded = true
+  end
+
+  def preload_cache_via_local_data
+    local_path = File.expand_path(File.dirname(__FILE__) + "/../data/oui.txt.gz")
+    preload_cache_via_string Zlib::GzipReader.open(local_path).read
+  end
+  
+  def preload_cache
+    preload_cache_via_string get_url(OUI_FULL_URL)
+  end
+  
+  def network_hits
+    @network_hits
+  end
+end
+

data/mac_vendor.gemspec

@@ -0,0 +1,16 @@
+Gem::Specification.new do |s|
+  s.name        = 'mac_vendor'
+  s.version     = '0.0.0'
+  s.date        = '2013-01-09'
+  s.license     = "MIT"
+  s.summary     = "MAC address vendor lookup"
+  s.description = "Given a MAC address, lookup the vendor of the interface."
+  s.authors     = ["Doug Wiegley"]
+  s.email       = 'doug@uceem.com'
+
+  s.files         = `git ls-files`.split($/)
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ['lib']
+  
+  s.homepage    = 'https://github.com/uceem/mac_vendor.git'
+end

data/test/test_mac_vendor.rb

@@ -0,0 +1,57 @@
+require 'test/unit'
+require 'mac_vendor'
+
+class MacVendorTest < Test::Unit::TestCase
+  def setup
+    @x = { :name=> "CIMSYS Inc",
+           :address=> ["#301,Sinsung-clean BLDG,140, Nongseo-Ri,Kiheung-Eup",
+                       "Yongin-City Kyunggi-Do 449-711",
+                       "KOREA, REPUBLIC OF"] }
+    @v = MacVendor.new :enable_network_tracking => true
+  end
+
+  def test_normalize_prefix
+    [ 'aa-11-bb', 'aa:11:bb:22:cc:33', 'AA11BBCCDD22', 'aa-11-bb-00-00-00' ].each do |s|
+      assert_equal @v.normalize_prefix(s), 'AA11BB'
+    end
+    assert_equal @v.normalize_prefix('junk'), ''
+    assert_equal @v.network_hits, 0
+  end
+  
+  def test_hyphen_prefix
+    assert_equal @v.hyphen_prefix('AA11BB'), 'AA-11-BB'
+    assert_equal @v.hyphen_prefix('junk'), 'ju-nk-'
+    assert_equal @v.network_hits, 0
+  end
+  
+  def test_fetch_single
+    assert_equal @v.lookup('00:11:22:33:44:55'), @x
+    assert_equal @v.lookup('00-11-22-33-44-55'), @x
+    assert_equal @v.network_hits, 1
+  end
+
+  def test_fetch_single_not_found
+    assert_equal @v.lookup('FF:FF:FF:33:44:55'), nil
+    assert_equal @v.lookup('FF-FF-FF-33-44-55'), nil
+    assert_equal @v.network_hits, 1
+  end
+  
+  def test_preloaded_local
+    mv = MacVendor.new :enable_network_tracking => true, :use_local => true
+    assert_equal mv.network_hits, 0
+    assert_equal mv.lookup('00-11-22-33-44-55'), @x
+    assert_equal mv.network_hits, 0
+    assert_equal mv.lookup('FF-FF-FF-33-44-55'), nil
+    assert_equal mv.network_hits, 0
+  end
+  
+  def test_preloaded
+    @v.preload_cache
+    assert_equal @v.network_hits, 1
+    assert_equal @v.lookup('00-11-22-33-44-55'), @x
+    assert_equal @v.network_hits, 1
+    assert_equal @v.lookup('FF-FF-FF-33-44-55'), nil
+    assert_equal @v.network_hits, 1
+  end
+end
+

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: mac_vendor
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Doug Wiegley
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-09 00:00:00.000000000Z
+dependencies: []
+description: Given a MAC address, lookup the vendor of the interface.
+email: doug@uceem.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- data/oui.txt.gz
+- lib/mac_vendor.rb
+- mac_vendor.gemspec
+- test/test_mac_vendor.rb
+homepage: https://github.com/uceem/mac_vendor.git
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: MAC address vendor lookup
+test_files:
+- test/test_mac_vendor.rb