oui-offline 1.2.5-java

data/lib/oui.rb

@@ -0,0 +1,380 @@
+autoload :FileUtils, 'fileutils'
+autoload :JSON, 'json'
+require 'monitor'
+require 'open-uri'
+
+require 'sequel'
+
+# Organizationally Unique Identifier
+module OUI
+  extend self
+
+  private
+
+  DEBUGGING_DEFAULT = false
+  TABLE = :ouis
+  # import data/oui.txt instead of fetching remotely
+  IMPORT_LOCAL_TXT_FILE_DEFAULT = false
+  # use in-memory instead of persistent file
+  IN_MEMORY_ONLY_DEFAULT = false
+  ROOT = File.expand_path(File.join('..', '..'), __FILE__)
+  LOCAL_DB_DEFAULT = File.join(ROOT, 'db', 'oui.sqlite3')
+  LOCAL_TXT_FILE = File.join(ROOT, 'data', 'oui.txt')
+  REMOTE_TXT_URI = 'http://standards.ieee.org/develop/regauth/oui/oui.txt'
+  LOCAL_MANUAL_FILE = File.join(ROOT, 'data', 'oui-manual.json')
+  FIRST_LINE_INDEX = 7
+  EXPECTED_DUPLICATES = [0x0001C8, 0x080030]
+  LINE_LENGTH = 22
+  HEX_BEGINNING_REGEX = /\A[[:space:]]{2}[[:xdigit:]]{2}-/
+  ERASE_LINE = "\b" * LINE_LENGTH
+  BLANK_LINE = ' ' * LINE_LENGTH
+
+  MISSING_COUNTRIES = [
+    0x000052,
+    0x002142,
+    0x684CA8
+  ]
+
+  COUNTRY_OVERRIDES = {
+    0x000052 => 'UNITED STATES',
+    0x002142 => 'SERBIA',
+    0x684CA8 => 'CHINA'
+  }
+
+  public
+
+  @@local_db = LOCAL_DB_DEFAULT
+
+  def local_db
+    @@local_db
+  end
+
+  def local_db=(v)
+    @@local_db = v || LOCAL_DB_DEFAULT
+  end
+
+
+  @@debugging = DEBUGGING_DEFAULT
+
+  def debugging
+    @@debugging
+  end
+
+  def debugging=(v)
+    @@debugging = (v.nil?) ? DEBUGGING_DEFAULT : v
+  end
+
+
+  @@import_local_txt_file = IMPORT_LOCAL_TXT_FILE_DEFAULT
+
+  def import_local_txt_file
+    @@import_local_txt_file
+  end
+
+  def import_local_txt_file=(v)
+    @@import_local_txt_file = (v.nil?) ? IMPORT_LOCAL_TXT_FILE_DEFAULT : v
+  end
+
+
+  @@in_memory_only = IN_MEMORY_ONLY_DEFAULT
+
+  def in_memory_only
+    @@in_memory_only
+  end
+
+  def in_memory_only=(v)
+    if v != @@in_memory_only
+      @@in_memory_only = (v.nil?) ? IN_MEMORY_ONLY_DEFAULT : v
+      close_db
+    end
+  end
+
+  # @param oui [String,Integer] hex or numeric OUI to find
+  # @return [Hash,nil]
+  def find(oui)
+    semaphore.synchronize do
+      update_db unless table? && table.count > 0
+      r = table.where(id: self.to_i(oui)).first
+      r.delete :create_table if r # not sure why this is here, but nuking it
+      r
+    end
+  end
+
+  # Converts an OUI string to an integer of equal value
+  # @param oui [String,Integer] MAC OUI in hexadecimal formats
+  #                             hhhh.hh, hh:hh:hh, hh-hh-hh or hhhhhh
+  # @return [Integer] numeric representation of oui
+  def to_i(oui)
+    return oui if oui.is_a? Integer
+    oui = oui.strip.gsub(/[:\- .]/, '')
+    if oui =~ /([[:xdigit:]]{6})/
+      $1.to_i(16)
+    end
+  end
+
+  # Convert an id to OUI
+  # @param oui [String,nil] string to place between pairs of hex digits, nil for none
+  # @return [String] hexadecimal format of id
+  def to_s(id, sep = '-')
+    return id if id.is_a? String
+    unless id >= 0x000000 && id <= 0xFFFFFF
+      raise ArgumentError, "#{id} is not a valid 24-bit OUI"
+    end
+    format('%06x', id).scan(/../).join(sep)
+  end
+
+  @@db = nil
+  # Release backend resources
+  def close_db
+    semaphore.synchronize do
+      debug 'Closing database'
+      if @@db 
+        @@db.disconnect
+        @@db = nil
+      end
+    end
+  end
+
+  def clear_table
+    debug 'clear_table'
+    table.delete_sql
+  end
+
+  # Update database from fetched URL
+  # @param [Boolean] whether to connect to the network or not
+  # @return [Integer] number of unique records loaded
+  def update_db(local = nil, db_file = nil)
+    semaphore.synchronize do
+      debug "update_db(local = #{local}, db_file = #{db_file})"
+      close_db
+      old_import_local_txt_file = self.import_local_txt_file
+      self.import_local_txt_file = local
+      old_local_db = self.local_db
+      self.local_db = db_file
+      ## Sequel
+      debug '--- close db ---'
+      debug '--- close db ---'
+      debug '--- drop table ---'
+      drop_table
+#      debug '--- drop table ---'
+#      debug '--- create table ---'
+      create_table
+#      debug '--- create table ---'
+      db.transaction do
+        debug '--- clear table ---'
+        clear_table
+        debug '--- clear table ---'
+        debug '--- install manual ---'
+        install_manual
+        debug '--- install manual ---'
+        debug '--- install updates ---'
+        install_updates
+        debug '--- install updates ---'
+      end
+      debug '--- close db ---'
+      close_db
+      debug '--- close db ---'
+
+      self.local_db = old_local_db
+      self.import_local_txt_file = old_import_local_txt_file
+      ## AR
+      # self.transaction do
+      #   self.delete_all
+      #   self.install_manual
+      #   self.install_updates
+      # end
+      debug "update_db(local = #{local}, db_file = #{db_file}) finish"
+    end
+  end
+  
+  private
+
+  def connect_file_db(f)
+    FileUtils.mkdir_p(File.dirname(f))
+    if RUBY_PLATFORM == 'java'
+      u = 'jdbc:sqlite:'+f
+    else
+      u = 'sqlite:'+f
+    end
+    debug "Connecting to db file #{u}"
+    Sequel.connect(u)
+  end
+
+  def connect_db
+    if in_memory_only
+      debug 'Connecting to in-memory database'
+      if RUBY_PLATFORM == 'java'
+        Sequel.connect('jdbc:sqlite::memory:')
+      else 
+        Sequel.sqlite # in-memory sqlite database
+      end
+    else
+      connect_file_db local_db
+    end
+  end
+
+  def db
+    @@db ||= connect_db
+  end
+
+  def table?
+    db.tables.include? TABLE
+  end
+
+  def table
+    db[TABLE]
+  end
+
+  def drop_table
+    debug 'drop_table'
+    db.drop_table(TABLE) if table? 
+  end
+
+  def create_table
+#    debug 'create_table'
+    db.create_table TABLE do
+      primary_key :id
+      String :organization, null: false
+      String :address1
+      String :address2
+      String :address3
+      String :country
+      index :id
+    end
+  end
+
+  # @param lines [Array<String>]
+  # @return [Array<Array<String>>]
+  def parse_lines_into_groups(lines)
+    grps, curgrp = [], []
+    lines[FIRST_LINE_INDEX..-1].each do |line|
+      if !curgrp.empty? && line =~ HEX_BEGINNING_REGEX
+        grps << curgrp
+        curgrp = []
+      end
+      line.strip!
+      next if line.empty?
+      curgrp << line
+    end
+    grps << curgrp # add last group and return
+  end
+
+  # @param g [Array<String>]
+  def parse_org(g)
+    g[0].split("\t").last
+  end
+
+  # @param g [Array<String>]
+  def parse_id(g)
+    g[1].split(' ')[0].to_i(16)
+  end
+
+  def parse_address1(g)
+    g[2] if g.length >= 4
+  end
+
+  def parse_address2(g, id)
+    g[3] if g.length >= 5 || MISSING_COUNTRIES.include?(id)
+  end
+
+  def parse_address3(g)
+    g[4] if g.length == 6
+  end
+
+  # @param g [Array<String>]
+  # @param id [Integer]
+  def parse_country(g, id)
+    c = COUNTRY_OVERRIDES[id] || g[-1]
+    c if c !~ /\A\h/
+  end
+
+  # @param g [Array<String>]
+  def create_from_line_group(g)
+    n = g.length
+    raise ArgumentError, "Parse error lines: #{n}" unless (2..6).include? n
+    id = parse_id(g)
+    create_unless_present(id: id, organization: parse_org(g),
+                          address1: parse_address1(g),
+                          address2: parse_address2(g, id),
+                          address3: parse_address3(g),
+                          country: parse_country(g, id))
+  end
+
+  def fetch
+    uri = oui_uri
+    $stderr.puts "Fetching #{uri}"
+    open(uri).read
+  end
+
+  def install_manual
+    debug 'install_manual'
+    JSON.load(File.read(LOCAL_MANUAL_FILE)).each do |g|
+      # convert keys to symbols
+      g = g.map { |k, v| [k.to_sym, v] }
+      g = Hash[g]
+      # convert OUI octets to integers
+      g[:id] = self.to_i(g[:id])
+      create_unless_present(g)
+    end
+  rescue Errno::ENOENT
+  end
+
+  def install_updates
+    debug 'install_updates'
+    lines = fetch.split("\n").map { |x| x.sub(/\r$/, '') } 
+    parse_lines_into_groups(lines).each_with_index do |group, idx|
+      create_from_line_group(group)
+      debug "#{ERASE_LINE}Created records #{idx}" if idx % 1000 == 0
+    end.count
+    debug "#{ERASE_LINE}#{BLANK_LINE}"
+  end
+
+  # Expected duplicates are 00-01-C8 (2x) and 08-00-30 (3x)
+  def expected_duplicate?(id)
+    EXPECTED_DUPLICATES.include? id
+  end
+
+  # Has a particular id been added yet?
+  def added
+    @@added ||= {}
+  end
+
+  def debug?
+    $DEBUG || debugging || ENV['DEBUG_OUI']
+  end
+
+  def debug(*args)
+    $stderr.puts(*args) if debug?
+  end
+
+  def debug_print(*args)
+    $stderr.print(*args) if debug?
+  end
+
+  def semaphore
+    @@semaphore ||= Monitor.new
+  end
+
+  def create_unless_present(opts)
+    id = opts[:id]
+    if added[id]
+      unless expected_duplicate? id
+        debug "OUI unexpected duplicate #{opts}"
+      end
+    else
+      table.insert(opts)
+      # self.create! opts
+      added[id] = true
+    end
+  end
+
+  def oui_uri
+    if import_local_txt_file
+      debug 'oui_uri = local'
+      LOCAL_TXT_FILE
+    else
+      debug 'oui_uri = remote'
+      REMOTE_TXT_URI
+    end
+  end
+end

data/oui-offline.gemspec

@@ -0,0 +1,40 @@
+Gem::Specification::new do |s|
+  s.name = 'oui-offline'
+  s.version = '1.2.5'
+  s.summary = 'Organizationally Unique Idenitfiers (OUI)'
+  s.description = 'Organizationally Unique Idenitfiers (OUI) offline database'
+  s.license = 'MIT'
+
+  s.files =
+['Gemfile',
+ 'README.md',
+ 'bin/oui',
+ 'data/oui-manual.json',
+ 'db/oui.sqlite3',
+ 'lib/oui.rb',
+ 'oui-offline.gemspec',
+  ]
+  s.files << 'data/oui.txt' if File.exist?('data/oui.txt')
+
+  s.required_ruby_version = '>= 1.9.3'
+
+  s.require_path = 'lib'
+  s.executables << 'oui'
+
+  s.author = 'Barry Allard'
+  s.email = 'barry.allard@gmail.com'
+  s.homepage = 'https://github.com/steakknife/oui'
+  s.post_install_message = 'Oui!'
+
+  s.add_dependency 'sequel', '~> 4'
+  if RUBY_PLATFORM == 'java'
+    s.platform = 'java'
+    s.add_dependency 'jdbc-sqlite3'
+  else
+    s.platform = Gem::Platform::RUBY
+    s.add_dependency 'sqlite3', '~> 1'
+  end
+  s.add_development_dependency 'rake', '~> 10'
+  s.add_development_dependency 'minitest', '~> 5'
+end
+.tap {|gem| pk = File.expand_path(File.join('~/.keys', 'gem-private_key.pem')); gem.signing_key = pk if File.exist? pk; gem.cert_chain = ['gem-public_cert.pem']} # pressed firmly by waxseal

data.tar.gz.sig

@@ -0,0 +1,5 @@
+8=�%)�Gk�!���厶9�� ]`�,��N�Q+�ŠՉ��d`"=�Hc
+��	������Ҵ丶8]���[�-����h�c/��?��l�������
+��3�RB*��S��&0<iw�7�G<-�7w4�������&
�*�����o�:\T�m#@���|n�'�fn��Z—?��P�4��ı�i�1�V����h(Z�X�n����B<�L3�e�v�Ή
�����2�Ja�F%<�̺��^�r�o�r��8c�#Z�����eP����W�,NB���[�6脅K�=��!��֕�ҸV�6n˯��#
+s�_��r�)S�I���Z&��N����h9��ƌ �A�G����a�4E i��1p-�6:������\�^�"4js?ƞ��mF����-(��������B��s��?�B�|�r^�"
+�C=:i��g��8��z1��[l����̥�~H�ҵP<���҇
�z��

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: oui-offline
+version: !ruby/object:Gem::Version
+  version: 1.2.5
+platform: java
+authors:
+- Barry Allard
+autorequire:
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIFgDCCA2igAwIBAgIBATANBgkqhkiG9w0BAQUFADBDMRUwEwYDVQQDDAxiYXJy
+  eS5hbGxhcmQxFTATBgoJkiaJk/IsZAEZFgVnbWFpbDETMBEGCgmSJomT8ixkARkW
+  A2NvbTAeFw0xNDExMjcxMzMzMjlaFw0xNTExMjcxMzMzMjlaMEMxFTATBgNVBAMM
+  DGJhcnJ5LmFsbGFyZDEVMBMGCgmSJomT8ixkARkWBWdtYWlsMRMwEQYKCZImiZPy
+  LGQBGRYDY29tMIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEA0xJH/kux
+  PRBS4y2r4YM+dtEfTOECrEw6JHpQOszJAT8FvJ5cTdPNpUtHGFYUruYRA+qHGM4a
+  If/YX7X17W77PvzqFalb1wicroRVDEgbyQWYkLVUL/vKugf7U3YknWhbBxkph23k
+  xGG6PO9nMKLk16rPaU6stJJvUjL4Yi7JUSwFWNrgx/t6O/iNzq5kcVR7F+NeCt+W
+  sWiXQGm6uZ6OJH0jpK2F1ic5/CWhPWKh+DKngZhN2As6H/m+ea9cm1Emcg+T/oDM
+  8T980i0MvZXrQ1wXoipVAjqmM4/dlqcy3nBxxG2IUg1zQrd30VzwNC2Rb0VovYJ9
+  OHyiYi1X4KQlIwpJ0STzRAfy231ZulDTST9KiOkprIz/ERAPv3OiiN6P6Cyz/Bus
+  9VjlaPn3maMiIQq9H6UK4cwA587esoBLT8uHrCc+qOfc8JGbfzzwe86BAVPvZ9gJ
+  B/gk+gXbEH84nsZLYT5iTNCrZjzeXb+OhK3OE9t4oEm/U0laN58/orVWDxx8xYT1
+  9Pdf0716KexmdvwgouKsrog8aWvfIaj2uNEbLTX/hKWRF3rENtYT8/h3KBraIiro
+  vhphbyJaiEMV3RrKSyDMT0TIZT8sWLPpx+EyTlsYTjUH1x1UOZCn8JwyXA5smLcb
+  QV3nmKeFP+05dM0827Rs0aHUyPDGb35p3p8CAwEAAaN/MH0wCQYDVR0TBAIwADAL
+  BgNVHQ8EBAMCBLAwHQYDVR0OBBYEFM/lqcZWJ4qeWFRhpoaKdEFkd6gjMCEGA1Ud
+  EQQaMBiBFmJhcnJ5LmFsbGFyZEBnbWFpbC5jb20wIQYDVR0SBBowGIEWYmFycnku
+  YWxsYXJkQGdtYWlsLmNvbTANBgkqhkiG9w0BAQUFAAOCAgEAiE2W4tGDNitT+iVA
+  kxshcdPkIp5vO4eWi9c1ccxuW/BdJU4fW5A9Fh2v0gfmQ1A4G8OuTdMyJXK+hmGl
+  dc7LOeBID5h/bAfEBi1zNJoW7XootEA9iksnt8BPd4ugKXmlypMfMNX8vYBIDLjk
+  Qvqzr3+iNr3WGVvLBAOc/PoZA2CncAcruNdEAYgLrw5N8GjpQ8mwxsSReCd6jVsW
+  tjuLCf8vMH5kkkaU99/wMMhEGKG1BsjvlXoMo9Wqh59z3ec/oW7TUmO5GOP2qkKt
+  2je0Z2HKawn2HBANU7sRuvqa6jfJED5v++iAnXVkFcJxfNbQB48/Nvsx9PZtxfKF
+  Yys6dceHu5nceqUpkpTeBCto9CN6heUdFRqWQKQX8Mc/MhO91EHVfpHq8LBu6ZHY
+  /lQ0Pqu2tdnZ7/xQ9D419DZmiT1PPgT45WIDqcc4zEvAHtPhuG97IbXYXSaHgKxT
+  EIiCOfhftUXnq+QdbegXYLy4N89PSa0FjJfVMi6kTgl4IBrAMuwXhpDptGZ6RUJm
+  bOWXoekmbZsc6hZ5qpmp+f/xyHQo70vBav8R8uqecU88WBfFtRkru9akvxHgiLwl
+  TE/ChTQStrIVMKgW+FbU3E6AmrM6HcwTi7mwsDM8S36y2NZ5DVaZPCpvkiTDgPSW
+  t/HWh1yhriCUe/y8+De8M87btOs=
+  -----END CERTIFICATE-----
+date: 2015-01-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4'
+  name: sequel
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: jdbc-sqlite3
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10'
+  name: rake
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5'
+  name: minitest
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5'
+description: Organizationally Unique Idenitfiers (OUI) offline database
+email: barry.allard@gmail.com
+executables:
+- oui
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- bin/oui
+- data/oui-manual.json
+- db/oui.sqlite3
+- lib/oui.rb
+- oui-offline.gemspec
+- data/oui.txt
+homepage: https://github.com/steakknife/oui
+licenses:
+- MIT
+metadata: {}
+post_install_message: Oui!
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.1.9
+signing_key:
+specification_version: 4
+summary: Organizationally Unique Idenitfiers (OUI)
+test_files: []