logstash-filter-ieee_oui 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b61037e52fda75b4e8a35244d59dea7246e8c8ce719853dfcfb45d8eba1ad01
-  data.tar.gz: ab87f272af68fe7f88ef6ed3117839f5beab36d74ce8f8ee6ccad8731873359a
+  metadata.gz: 7934ac9a7081a5aed7682884cd113b01c19343fbc61057b4fcd8a641ecf81125
+  data.tar.gz: 75b024faa7cfdbdafec42410ea2d3fe709350c1be6e5c3c8bbe25b8d2f6ba85e
 SHA512:
-  metadata.gz: 7abfa3b8c0575693846535c186ed1799041b294fc5e6d6a38dbae20adae34ac9c6de11fb4f6d27aebd2865b3fa27cb69e4ae965517a0da26fef7368e121e1d06
-  data.tar.gz: 79eb3c71569239ceb9a7968c77f7d9a696e82871758dba3f7758b32d07b37b58773394aadc3ccee6713dd1bb89b61995afc75c9014c1c25e0d55c3408ebd181d
+  metadata.gz: 27df1ac1fce0efbc62fd0100701cc5d8eedf08b081538004bfbc16966e7be1945b19f6d882102fa3d4c5767b71f14085794d2cb71cca311edbe7bcab232040f0
+  data.tar.gz: b1fa8960e81efdfcec07490c4af05c57034285f2a5a01d42715ca9772e42893f98ede8f17fee56559c2bf2ba054e884829dc523c37bae2a7d73fd2063ab42c44

data/CHANGELOG.md

@@ -1,3 +1,5 @@
+## 1.0.5
+  - thread locking and refresh interval of oui file
 ## 1.0.4
   - added auto refresh of ouifile
 ## 1.0.3

data/lib/logstash/filters/ieee_oui.rb

@@ -3,6 +3,8 @@ require "logstash/filters/base"
 require "logstash/namespace"
 require 'digest'
 
+java_import 'java.util.concurrent.locks.ReentrantReadWriteLock'
+
 # The ieee_oui filter allows you to match mac addresses to vendor names.
 # It accepts source mac addresses delimited by a colon(:), a dash(-) or no delimiter.
 # The filter requires a specially formatted oui-logstash.txt file for the ouifile.
@@ -27,44 +29,98 @@ class LogStash::Filters::IeeeOui < LogStash::Filters::Base
   config :source, :validate => :string, :default => 'mac'
   # Target field for manufacture
   config :target, :validate => :string, :default => 'mac_mfr'
+  # Indicates how frequently (in seconds) to check the oui text file for updates
+  config :refresh_interval, :validate => :number, :default => 300
   # Tag if lookup failure occurs
   config :tag_on_failure, :validate => :array, :default => ["_ouilookupfailure"]
 
   public
   def register
+    rw_lock = java.util.concurrent.locks.ReentrantReadWriteLock.new
+    @read_lock = rw_lock.readLock
+    @write_lock = rw_lock.writeLock
+
     if @ouifile.nil?
-      @logger.debug("You must specifiy 'ouifile => path_to_file' in your ieee_oui filter")
       @ouihash = nil
+      raise LogStash::ConfigurationError, I18n.t(
+        "logstash.agent.configuration.invalid_plugin_register",
+        :plugin => "filter",
+        :type => "ieee_oui",
+        :error => "You must specifiy 'ouifile => path_to_file' in your ieee_oui filter"
+      )
     else
-      @logger.info("Using oui file", :path => @ouifile)
-      @md5 = md5file(@ouifile)
-      @newmd5 = md5file(@ouifile)
-      @ouihash = hashfile(@ouifile)
+      @logger.info("Using OUI file", :path => @ouifile)
+      @logger.info("OUI file refresh check seconds", :number => @refresh_interval)
+      @md5 = nil
+      @newmd5 = nil
+      @ouihash = nil
+      @next_refresh = Time.now + @refresh_interval
+      lock_for_write { refreshfile(@ouifile) }
     end
   end # def register
 
-  #public
+  private
+  def lock_for_write
+    @write_lock.lock
+    begin
+      yield
+    ensure
+      @write_lock.unlock
+    end
+  end # def lock_for_write
+
+  private
+  def lock_for_read # ensuring only one thread updates the OUI hash
+    @read_lock.lock
+    begin
+      yield
+    ensure
+      @read_lock.unlock
+    end
+  end #def lock_for_read
+
+  private
   def md5file(file)
     return Digest::MD5.file(file).hexdigest
   end
 
+  private
   def hashfile(file)
     return Hash[*File.read(file).split(/\t|\n/)]
   end
 
+  private
   def refreshfile(file)
     @newmd5 = md5file(file)
     if @newmd5 != @md5
       @md5 = md5file(file)
       @ouihash = hashfile(file)
-      @logger.info("Refreshing oui file" , :path => file)
+      @next_refresh = Time.now + @refresh_interval
+      @logger.info("Refreshing OUI file", :path => file)
+    else
+      @logger.debug("OUI file unchanged", :path => file)
     end
+    @logger.debug("OUI file MD5", :string => @md5)
+  end
+
+  private
+  def needs_refresh?
+    @next_refresh < Time.now
   end
 
+  public
   def filter(event)
     matched = false
+
     if ! @ouihash.nil?
-      refreshfile(@ouifile) 
+      if needs_refresh?
+        lock_for_write do
+          if needs_refresh?
+            refreshfile(@ouifile)
+          end
+        end
+      end
+
       validhex = false
       mac = event.get(@source)
       delimiter = mac[2]
@@ -75,7 +131,10 @@ class LogStash::Filters::IeeeOui < LogStash::Filters::Base
       end
       if !mfrid[/\H/]
         validhex = true
-        vendor = @ouihash[mfrid]
+        vendor = nil
+        lock_for_read do
+          vendor = @ouihash[mfrid]
+        end
         if vendor.nil?
           vendor = 'unknown'
         else
@@ -85,8 +144,10 @@ class LogStash::Filters::IeeeOui < LogStash::Filters::Base
         event.set("#{@target}", vendor)
       end
     end
-    @logger.debug("Invalid Hex in source", :string => @source) if not validhex
+
+    @logger.debug("Invalid MAC address in source", :string => @source) if not validhex
     @tag_on_failure.each{|tag| event.tag(tag)} if not matched
     filter_matched(event) if matched
   end # def filter
+
 end # class LogStash::Filters::IeeeOui

data/logstash-filter-ieee_oui.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name          = 'logstash-filter-ieee_oui'
-  s.version       = '1.0.4'
+  s.version       = '1.0.5'
   s.licenses      = ['Apache-2.0']
   s.summary       = 'Logstash filter to parse OUI data from mac addresses, requires external OUI txt file from ieee.org'
   s.description   = 'This gem is a Logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This gem is not a stand-alone program'
@@ -20,4 +20,4 @@ Gem::Specification.new do |s|
   # Gem dependencies
   s.add_runtime_dependency "logstash-core-plugin-api", ">= 1.60", "<= 2.99"
   s.add_development_dependency 'logstash-devutils', '= 1.3.6'
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-ieee_oui
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors:
 - Mike Pananen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-02-02 00:00:00.000000000 Z
+date: 2019-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement