logstash-filter-phpipam 0.5.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c59a75c38c05ad39dff02abca85f6cd80984335f72e054f1f1fa89dccca96f5a
-  data.tar.gz: f4d8722f7726151514c5a0bb02afcdb11c01b59ec892ee0ab7452699263d6d5f
+  metadata.gz: 86ccd5f712ea9d516d35656b23461458aef1dbcad3ccb2abb1b9317608b5666a
+  data.tar.gz: 0df24f83330d1d6805bcfeac7e3a74b99ca40c40fd4302658bd12a73dcb3a31e
 SHA512:
-  metadata.gz: 6c771f8f94a30d0ec188d2378c8906d0c3d02a0a62886375ec6ef5a2d3bba43532c2fcc1deb851e3976eddca29cb9d177ecf2a4be62af1ad670a59c24b694d51
-  data.tar.gz: ff3fe80c111102e8356232559bf7feec7bff26cdedbc3f8bc6bc285dcb65295228f3caf16da60541523726709cd6b9759a1f7d9ce100ead4d6204628dd04924d
+  metadata.gz: 3e926b71dbc4607835193539b8ee1c2ca7ec9f3b0065d6f36a88a3b2475f0898074f8c8b82d875604ee6a76a247aef562acdfe9c3a147733ce9fcdf96b99fa2d
+  data.tar.gz: a7a04639bfd827461d0522eb33b86d8931bc1d0bc992d0b420771251c59b894f5b09c68ff450c146a0ab9f533b03a3654c284010a63d290c72c4e412c3afcad4

data/lib/logstash/filters/phpipam.rb

@@ -23,7 +23,13 @@ class LogStash::Filters::Phpipam < LogStash::Filters::Base
   config :password, validate: :string, default: ''
 
   # Whether to use authentication or not
-  config :auth, validate: :boolean, required: true, default: true
+  config :auth, validate: :boolean, default: true
+
+  # Whether to use caching or not
+  config :cache, validate: :boolean, default: true
+
+  # Which file to use as cache storage. Should be placed on a tmpfs volume for maximum performance
+  config :cache_path, validate: :string, default: '/tmp/logstash-filter-phpipam.json'
 
   # IP-address field to look up
   config :source, validate: :string, required: true
@@ -46,8 +52,9 @@ class LogStash::Filters::Phpipam < LogStash::Filters::Base
 
     return unless valid_ip?(ip, event)
 
-    # Get data from phpIPAM
-    event_data = phpipam_data(ip)
+    # Get data from cache or phpIPAM if not in cache
+    event_data = search_cache(ip)
+    event_data = phpipam_data(ip) if event_data.is_a?(FalseClass)
 
     return if !event_data['error'].nil? && event_data['error']
 
@@ -63,7 +70,7 @@ class LogStash::Filters::Phpipam < LogStash::Filters::Base
   # @param target: the target to normalize
   # @return [string]
   def normalize_target(target)
-    target = "[#{target}]" if target && target !~ %r{^\[[^\[\]]+\]$}
+    target = "[#{target}]" if target !~ %r{^\[[^\[\]]+\]$}
     target
   end
 
@@ -87,7 +94,6 @@ class LogStash::Filters::Phpipam < LogStash::Filters::Base
   # Sends a GET method REST request.
   # @param method: which HTTP method to use (POST, GET)
   # @param url_path: path to connect to
-  # @param basic_auth: whether to use basic_auth or not
   # @return [hash]
   def send_rest_request(method, url_path)
     @logger.debug? && @logger.debug('Sending request', host: @host, path: url_path)
@@ -190,7 +196,42 @@ class LogStash::Filters::Phpipam < LogStash::Filters::Base
       base['vlan']['description'] = vlan_data['description'] unless nil_or_empty?(vlan_data['description'])
     end
 
+    # Cache it for future needs
+    cache_data(base)
+
     # all your base are belong to us
     base
   end
+
+  # Caches data (if possible)
+  # @param data: the data to cache
+  # @return [void]
+  def cache_data(data)
+    data = data.to_json
+
+    File.open(@cache_path, 'a') do |file|
+      file.write(data + "\n")
+      @logger.debug? && @logger.debug('Cached data', data: data)
+    rescue StandardError
+      @logger.debug? && @logger.debug('Cache file is not writable, skipping caching of data', data: data, cache_file: @cache_path)
+      break
+    end
+  end
+
+  # Seaches the cache file for the IP.
+  # Returns a hash if the IP was found, else false
+  # @param ip: The IP-address to search for
+  # @return [hash/bool]
+  def search_cache(ip)
+    @logger.debug? && @logger.debug('Searching cache...', ip: ip)
+
+    return false unless File.exist?(@cache_path)
+
+    File.foreach(@cache_path) do |line|
+      line = JSON.parse(line)
+      return line if line['ip']['address'] == ip
+    end
+
+    false
+  end
 end

data/logstash-filter-phpipam.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name          = 'logstash-filter-phpipam'
-  s.version       = '0.5.1'
+  s.version       = '0.7.0'
   s.licenses      = ['Apache-2.0']
   s.summary       = 'A Logstash filter that returns results from phpIPAM'
   s.description   = 'A Logstash filter that looks up an IP-address, and returns results from phpIPAM'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-phpipam
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.7.0
 platform: ruby
 authors:
 - magnuslarsen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-31 00:00:00.000000000 Z
+date: 2019-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstash-core-plugin-api