logstash-filter-phpipam 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86ccd5f712ea9d516d35656b23461458aef1dbcad3ccb2abb1b9317608b5666a
-  data.tar.gz: 0df24f83330d1d6805bcfeac7e3a74b99ca40c40fd4302658bd12a73dcb3a31e
+  metadata.gz: 1958f973db608ec8a6d334f5ac17e7cdcc086090ec98edaa47581171ce69cd43
+  data.tar.gz: 6cdd9bf4973d25c9e6436a8738841c906d59bf2ae92cd59097c06770fa04ba74
 SHA512:
-  metadata.gz: 3e926b71dbc4607835193539b8ee1c2ca7ec9f3b0065d6f36a88a3b2475f0898074f8c8b82d875604ee6a76a247aef562acdfe9c3a147733ce9fcdf96b99fa2d
-  data.tar.gz: a7a04639bfd827461d0522eb33b86d8931bc1d0bc992d0b420771251c59b894f5b09c68ff450c146a0ab9f533b03a3654c284010a63d290c72c4e412c3afcad4
+  metadata.gz: def36e7c9853d630b10f6bd483efdfcf60eff8be42462bb2bdbe75cfb6a5e0ed33bda0344d7f58b6176d379e1e3b25abb584b67662a71a106287309059916ab4
+  data.tar.gz: b40a8985553daab7f1cba3321ffbcc786823dabf85e5a4977682bc1d5d0bb10fb2ccc7451ac885563a48a93eef08355d166a2a63f7112e9fcfc958125cf6c78f

data/lib/logstash/filters/phpipam.rb

@@ -54,7 +54,7 @@ class LogStash::Filters::Phpipam < LogStash::Filters::Base
 
     # 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)
+    event_data = phpipam_data(ip, event) if event_data.is_a?(FalseClass)
 
     return if !event_data['error'].nil? && event_data['error']
 
@@ -149,19 +149,32 @@ class LogStash::Filters::Phpipam < LogStash::Filters::Base
     value.nil? || value.empty?
   end
 
+  # Checks if the value is defined and not nil or error
+  # @param value: a value to check
+  # @return [bool]
+  def okay?(value)
+    !defined?(value).nil? && !value.nil? && value['error'].nil?
+  end
+
   # Queries phpIPAM and formats the data
   # @param ip: an IP-address to query
   # @return [hash]
-  def phpipam_data(ip)
+  def phpipam_data(ip, event)
     # Fetch base data needed from phpIPAM
     ip_data = send_rest_request('GET', "api/#{@app_id}/addresses/search/#{ip}/")
 
     # If the IP wasn't found, return and do nuthin'
-    return { 'error' => true } if !ip_data['error'].nil? && ip_data['error']
+    if !ip_data['error'].nil? && ip_data['error']
+      event.tag('_phpipam_ip_not_found')
+      return { 'error' => true }
+    end
 
     subnet_data = send_rest_request('GET', "api/#{@app_id}/subnets/#{ip_data['subnetId']}/") unless nil_or_empty?(ip_data['subnetId'])
     vlan_data   = send_rest_request('GET', "api/#{@app_id}/vlans/#{subnet_data['vlanId']}/") unless nil_or_empty?(subnet_data['vlanId'])
 
+    device_data   = send_rest_request('GET', "api/#{@app_id}/tools/devices/#{ip_data['deviceId']}/") unless ip_data['deviceId'] == '0' || nil_or_empty?(ip_data['deviceId'])
+    location_data = send_rest_request('GET', "api/#{@app_id}/tools/locations/#{ip_data['location']}/") unless ip_data['location'] == '0' || nil_or_empty?(ip_data['location'])
+
     # Base hash to format data in
     base = {
       'ip' => {},
@@ -177,7 +190,7 @@ class LogStash::Filters::Phpipam < LogStash::Filters::Base
     base['ip']['owner']       = ip_data['owner'] unless nil_or_empty?(ip_data['owner'])
 
     # Subnet information
-    if !defined?(subnet_data).nil? && subnet_data['error'].nil?
+    if okay?(subnet_data)
       base['subnet']               = {}
       base['subnet']['id']         = ip_data['subnetId'].to_i
       base['subnet']['section_id'] = subnet_data['sectionId'].to_i
@@ -188,7 +201,7 @@ class LogStash::Filters::Phpipam < LogStash::Filters::Base
     end
 
     # VLAN information
-    if !defined?(vlan_data).nil? && vlan_data['error'].nil?
+    if okay?(vlan_data)
       base['vlan']                = {}
       base['vlan']['id']          = subnet_data['vlanId'].to_i
       base['vlan']['number']      = vlan_data['number'].to_i unless nil_or_empty?(vlan_data['number'])
@@ -196,6 +209,32 @@ class LogStash::Filters::Phpipam < LogStash::Filters::Base
       base['vlan']['description'] = vlan_data['description'] unless nil_or_empty?(vlan_data['description'])
     end
 
+    # Device information
+    if okay?(device_data)
+      type = send_rest_request('GET', "api/#{@app_id}/tools/device_types/#{device_data['type']}/")
+
+      base['device']                = {}
+      base['device']['id']          = ip_data['deviceId'].to_i
+      base['device']['name']        = device_data['hostname'] unless nil_or_empty?(device_data['hostname'])
+      base['device']['description'] = device_data['description'] unless nil_or_empty?(device_data['description'])
+      base['device']['type']        = type['tname'] unless nil_or_empty?(type['tname'])
+
+      # If the IP doesn't have the location directly, use the one from the device (if that has one)
+      unless okay?(location_data)
+        location_data = send_rest_request('GET', "api/#{@app_id}/tools/locations/#{device_data['location']}/") unless device_data['location'] == '0' || nil_or_empty?(device_data['location'])
+      end
+    end
+
+    # Location information
+    if okay?(location_data)
+      base['location']                = {}
+      base['location']['id']          = ip_data['location'].to_i
+      base['location']['address']     = location_data['address'] unless nil_or_empty?(location_data['address'])
+      base['location']['name']        = location_data['name'] unless nil_or_empty?(location_data['name'])
+      base['location']['description'] = location_data['description'] unless nil_or_empty?(location_data['description'])
+      base['location']['location']    = { 'lat' => location_data['lat'], 'lon' => location_data['long'] } unless nil_or_empty?(location_data['lat'])
+    end
+
     # Cache it for future needs
     cache_data(base)
 

data/logstash-filter-phpipam.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name          = 'logstash-filter-phpipam'
-  s.version       = '0.7.0'
+  s.version       = '0.7.1'
   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.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - magnuslarsen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-05 00:00:00.000000000 Z
+date: 2019-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstash-core-plugin-api