logstash-filter-weblookup 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a1c310e4e0feb0bf4c56096f6e5bad6a720df01f4ebd66f868b5ddc97d0052c6
+  data.tar.gz: 37b23ae97012cf03a00b9c07226da8ee51d363b546ad21978e3a4b795b68d597
+SHA512:
+  metadata.gz: 8151672a15f02a90c590de31ded5968896e68b1e5aaf6809beae5e8f803629c749c5949dacd5c8c5a77fbceca847d40c74d7c4a5c6fd86c2e776b9085694dbbd
+  data.tar.gz: b48a47c202874450f09d6d1e5390cf4ac123917ecf48283b4271e87b0eb31d19c1fd767b14cf9ef09299cd7a88ddc4bdf5e01305ddbdbe741ef4ff3787c0b4ca

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## 0.1.0
+  - Plugin created with the logstash plugin generator

data/CONTRIBUTORS

@@ -0,0 +1,10 @@
+The following is a list of people who have contributed ideas, code, bug
+reports, or in general have helped logstash along its way.
+
+Contributors:
+* Jan Geertsma - jan@janmg.com
+
+Note: If you've sent us patches, bug reports, or otherwise contributed to
+Logstash, and you aren't on the list above and want to be, please let us know
+and we'll make sure you're here. Contributions from folks like you are what make
+open source awesome.

data/DEVELOPER.md

@@ -0,0 +1,2 @@
+# logstash-filter-lookup
+Example filter plugin. This should help bootstrap your effort to write your own filter plugin!

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+gemspec
+

data/LICENSE

@@ -0,0 +1,11 @@
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,86 @@
+# Logstash Plugin
+
+This is a plugin for [Logstash](https://github.com/elastic/logstash).
+
+It is fully free and fully open source. The license is Apache 2.0, meaning you are pretty much free to use it however you want in whatever way.
+
+## Documentation
+
+Logstash provides infrastructure to automatically generate documentation for this plugin. We use the asciidoc format to write documentation so any comments in the source code will be first converted into asciidoc and then into html. All plugin documentation are placed under one [central location](http://www.elastic.co/guide/en/logstash/current/).
+
+- For formatting code or config example, you can use the asciidoc `[source,ruby]` directive
+- For more asciidoc formatting tips, see the excellent reference here https://github.com/elastic/docs#asciidoc-guide
+
+## Need Help?
+
+Need help? Try #logstash on freenode IRC or the https://discuss.elastic.co/c/logstash discussion forum.
+
+## Developing
+
+### 1. Plugin Developement and Testing
+
+#### Code
+- To get started, you'll need JRuby with the Bundler gem installed.
+
+- Create a new plugin or clone and existing from the GitHub [logstash-plugins](https://github.com/logstash-plugins) organization. We also provide [example plugins](https://github.com/logstash-plugins?query=example).
+
+- Install dependencies
+```sh
+bundle install
+```
+
+#### Test
+
+- Update your dependencies
+
+```sh
+bundle install
+```
+
+- Run tests
+
+```sh
+bundle exec rspec
+```
+
+### 2. Running your unpublished Plugin in Logstash
+
+#### 2.1 Run in a local Logstash clone
+
+- Edit Logstash `Gemfile` and add the local plugin path, for example:
+```ruby
+gem "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome"
+```
+- Install plugin
+```sh
+bin/logstash-plugin install --no-verify
+```
+- Run Logstash with your plugin
+```sh
+bin/logstash -e 'filter {awesome {}}'
+```
+At this point any modifications to the plugin code will be applied to this local Logstash setup. After modifying the plugin, simply rerun Logstash.
+
+#### 2.2 Run in an installed Logstash
+
+You can use the same **2.1** method to run your plugin in an installed Logstash by editing its `Gemfile` and pointing the `:path` to your local plugin development directory or you can build the gem and install it using:
+
+- Build your plugin gem
+```sh
+gem build logstash-filter-awesome.gemspec
+```
+- Install the plugin from the Logstash home
+```sh
+bin/logstash-plugin install /your/local/plugin/logstash-filter-awesome.gem
+```
+- Start Logstash and proceed to test the plugin
+
+## Contributing
+
+All contributions are welcome: ideas, patches, documentation, bug reports, complaints, and even something you drew up on a napkin.
+
+Programming is not a required skill. Whatever you've seen about open source and maintainers or community members  saying "send patches or die" - you will not see that here.
+
+It is more important to the community that you are able to contribute.
+
+For more information about contributing, see the [CONTRIBUTING](https://github.com/elastic/logstash/blob/master/CONTRIBUTING.md) file.

data/lib/logstash/filters/weblookup.rb

@@ -0,0 +1,180 @@
+# encoding: utf-8
+require 'logstash/filters/base'
+require 'redis'
+require 'json'
+require 'net/http'
+require 'connection_pool'
+require 'addressable/uri'
+
+class LogStash::Filters::Webookup < LogStash::Filters::Base
+
+  # This is how you configure this filter from your Logstash config.
+  # [source,ruby]
+  # ----------------------------------
+  # filter {
+  #    weblookup {
+  #       fields => ["ClientIP"]
+  #       url => "http://127.0.0.1/ripe.php?ip=<item>&TOKEN=token"
+  #       list => {
+  #           '127.0.0.1' => '{"ip":"127.0.0.1", "subnet":"127.0.0.0/8", "netname":"localnet", "hostname":"localhost"}',
+  #           '192.168.0.1' => '{"ip":"192.168.0.1", "subnet":"192.168.0.0/24", "netname":"private", "hostname":"router"}'
+  #       }
+  #       use_redis => false
+  #    }
+  # }
+  # ----------------------------------
+  #
+  config_name "weblookup"
+
+  config :fields, :validate => :array, :required => true, :default => ["ClientIP"]
+  # {"ip":"8.8.8.8","netname":"Google","subnet":"8.8.8.0\/24","hostname":"google-public-dns-a.google.com"}
+  # In the query parameter has the <ip> tag will be replaced by the IP address to lookup, other parameters are optional and according to your lookup service. 
+  config :destinations, :validate => :array, :required => false, :default => ["message"]
+
+  # {"ip":"8.8.8.8","netname":"Google","subnet":"8.8.8.0\/24","hostname":"google-public-dns-a.google.com"}
+  # In the query parameter has the <ip> tag will be replaced by the IP address to lookup, other parameters are optional and according to your lookup service. 
+  config :url, :validate => :string, :required => false, :default => "http://localhost/ripe.php?ip=<item>&TOKEN=token"
+
+  # Optional ruby hash with the key as a string and the value as a string in the form of a JSON object. These key's will not be looked up.
+  config :list, :validate => :hash, :required => false
+
+  # Optional Redis IP cache
+  config :use_redis, :validate => :boolean, :required => false, :default => false
+  config :redis_path, :validate => :string, :required => false
+  config :redis_expiry, :validate => :number, :required => false, :default => 604800 
+  config :normalize, :validate => :boolean, :required => false, :default => false
+
+  HTTP_OPTIONS = {
+      keep_alive_timeout: 300
+  }
+
+public
+def register
+    if use_redis
+        unless redis_path.to_s.strip.empty?
+            @red = Redis.new(path: redis_path)
+        else
+            @red = Redis.new()
+        end
+    end
+
+    # input fields and destinations
+    @is_one_destination=false
+    if destinations.size == 1
+        @logger.info("one destination found, it is #{destinations[0]}")
+	@is_one_destination=true
+    else
+        if destinations.size != fields.size
+            @logger.error("Configuration error, there must be an equal amount of destinations and fields, defaulting to using the field as a root for the new values. e.g. if the lookup is done on the value of [\"ClientIP\"] the destination will be [\"ClientIP\"][\"Key\"]")
+            destinations=fields
+        end
+    end
+
+    # http connectionpool
+    @uri = Addressable::URI.parse(url)
+    @uri.merge!(HTTP_OPTIONS)
+    #@http = Net::HTTP.new(uri.host, uri.port, HTTP_OPTIONS)
+    @uri.port=80 if (@uri.port.nil? && @uri.scheme=="http")
+    @uri.port=443 if (@uri.port.nil? && @uri.scheme=="https")
+    # find the key where the value is <item>, otherwise just use the value
+    @params = @uri.query_values(Hash)
+    @params.each do |key, value|
+        if value="\<item\>" 
+            @ip=key
+	    @params.delete(key)
+	    logger.info("the ip key in the uri is #{@ip}")
+        end
+    end
+    @connpool = ConnectionPool.new(size: 4, timeout: 180) { 
+        Net::HTTP.new(@uri.host, @uri.port)
+    }
+end # def register
+
+def filter(event)
+    if destinations[0] == "srcdst"
+        # ... do special sauce
+        src = parse(event.get(fields[0]).to_s)
+	dst = parse(event.get(fields[1]).to_s)
+        srcdst = { :srcnet => src["netname"], :srchost => src["hostname"], :dstnet => dst["netname"], :dsthost => dst["hostname"] }
+        event.set("srcdst", srcdst)
+        event.get("[srcdst]").each {|k, v| event.set(k, v) }
+        event.remove("[srcdst]")
+	@logger.trace("processed: #{event.get(fields[0]).to_s} #{src} #{event.get(fields[1]).to_s} #{dst} #{srcdst}")
+    else
+        fields.each_with_index do |field, index|
+            # @logger.info(event.get("["+field+"]"))
+            json = parse(event.get(field).to_s)
+            event.set("["+destinations[index]+"]", json)
+        end
+    end
+    # filter_matched should go in the last line of our successful code
+    filter_matched(event)
+end # def filter
+
+
+
+private
+def parse(field)
+    x = find(field)
+    begin
+        json = JSON.parse(x)
+    rescue JSON::ParserError
+        json = x
+    end			
+end
+
+def find(item)
+    res = nil
+    # Is item in list? (list is an optional hash)
+    unless list.nil? 
+        return list[item]
+    end
+    # Is item in redis?
+    unless @red.nil?
+        res = @red.get(item)
+	unless res.nil?
+            return res
+        end
+    end
+
+    # find the key where the value is <item>, otherwise just use the value
+    current_uri = @uri
+    current_uri.query_values = @params.merge({@ip => item})
+    #logger.info(@uri.to_s)
+    @connpool.with do |conn|
+        res = conn.request_get(current_uri).read_body
+	#logger.info(res.to_s)
+        unless @red.nil?
+            @red.set(item, res)
+            @red.expire(item,redis_expiry)
+        end
+    end
+    return res
+end
+
+def normalize(event)
+      event.set("net", JSON.parse(net))
+      event.get("[records][properties]").each {|k, v| event.set(k, v) }
+      event.remove("[records]")
+      event.remove("[message]")
+      return event
+end
+
+# From https://github.com/angel9484/logstash-filter-lookup
+  def json_loader(data)
+    get_map.merge!(JSON.parse(File.read(data)))
+  end
+
+  def csv_loader(data)
+    data = CSV.read(data).inject(Hash.new) do |acc, v|
+      acc[v[0]] = v[1]
+      acc
+    end
+    get_map.merge!(data)
+  end
+
+  def yml_loader(data)
+    get_map.merge!(YAML.load_file(data))
+  end
+
+end # class LogStash::Filters::Lookup

data/logstash-filter-weblookup.gemspec

@@ -0,0 +1,27 @@
+Gem::Specification.new do |s|
+  s.name          = 'logstash-filter-weblookup'
+  s.version       = '0.1.0'
+  s.licenses      = ['Apache-2.0']
+  s.summary       = 'This logstash filter plugin takes one or more fields and enriches with a lookup value from a list, redis cache or webservice'
+  s.description   = <<-EOF
+ This gem is a Logstash plugin. During filter it takes one or more fields and uses that as input to query additional information. The original purpose is to enrich IP addresses with matching subnet, netname and hostname, but it is generic so that any field can be looked up. The function is similar to the translate filter's dictionary lookup, which supports files and regex. The jdbc_streaming filter plugin is also very useful if the data resides in a database. This plugins features are web based lookups and redis caching, for fast lookups.
+EOF
+  s.homepage      = 'https://github.com/janmg/logstash-filter-weblookup'
+  s.authors       = ['Jan Geertsma']
+  s.email         = 'jan@janmg.com'
+  s.require_paths = ['lib']
+
+  # Files
+  s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE','NOTICE.TXT']
+   # Tests
+  s.test_files = s.files.grep(%r{^(test|spec|features)/})
+
+  # Special flag to let us know this is actually a logstash plugin
+  s.metadata = { "logstash_plugin" => "true", "logstash_group" => "filter" }
+
+  # Gem dependencies
+  s.add_runtime_dependency 'logstash-core-plugin-api', '~> 2.0'
+  s.add_runtime_dependency 'connection_pool', '~> 2.2'
+  #s.add_runtime_dependency 'addressable', '~> 2.3.8'
+  s.add_development_dependency 'logstash-devutils', '~> 0'
+end

data/spec/filters/lookup_spec.rb

@@ -0,0 +1,42 @@
+# encoding: utf-8
+require_relative '../spec_helper'
+require 'logstash/filters/lookup'
+require 'redis'
+
+class LogStash::Codecs::JSON
+end
+
+describe LogStash::Filters::Lookup do
+    describe "test ip lookup" do
+    let(:config) do <<-CONFIG
+      filter {
+        lookup {
+          fields => ["ClientIP"]
+          list => {
+	     '127.0.0.1' => '{"ip":"127.0.0.1", "subnet":"127.0.0.0/8", "netname":"localnet", "hostname"="localhost"}'
+	     '192.168.0.1' => '{"ip":"192.168.0.1", "subnet":"192.168.0.0/24", "netname":"private", "hostname":"router"}'
+          }
+        }
+      }
+    CONFIG
+    end
+
+    message = '{"ClientIP" : "23.100.57.65"}'
+    sample("message" => message) do
+        #insist { subject["clientIP"][0].to_s } == "192.168.0.1"
+	insist { find(subject["ClientIP"]) } == '{"ip":"192.168.0.1", "subnet":"192.168.0.0/24", "netname":"private", "hostname":"router"}'
+    end
+
+    sample("message" => message) do
+        #ip = subject[fields][0].to_s
+	ip = '23.100.57.65'
+        @red = Redis.new
+        @red.del(ip)
+	insist { find(ip) } == '{"ip":"23.100.57.65","netname":"Azure europenorth","subnet":"23.100.48.0\/20","hostname":"monitoring"}'
+	@red.del(ip)
+	@red.add(ip,'{"ip":"23.100.57.65","netname":"dummy"}')
+        insist { find(ip) } == '{"ip":"23.100.57.65","netname":"dummy"}'
+	@red.del(ip)
+    end
+  end
+end

data/spec/filters/lookup_spec.rb-orig

@@ -0,0 +1,21 @@
+# encoding: utf-8
+require_relative '../spec_helper'
+require "logstash/filters/lookup"
+
+describe LogStash::Filters::Lookup do
+  describe "Set to Hello World" do
+    let(:config) do <<-CONFIG
+      filter {
+        lookup {
+          message => "Hello World"
+        }
+      }
+    CONFIG
+    end
+
+    sample("message" => "some text") do
+      expect(subject).to include("message")
+      expect(subject.get('message')).to eq('Hello World')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+# encoding: utf-8
+require "logstash/devutils/rspec/spec_helper"

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: logstash-filter-weblookup
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jan Geertsma
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2019-05-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  name: logstash-core-plugin-api
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  name: connection_pool
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: logstash-devutils
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: " This gem is a Logstash plugin. During filter it takes one or more fields\
+  \ and uses that as input to query additional information. The original purpose is\
+  \ to enrich IP addresses with matching subnet, netname and hostname, but it is generic\
+  \ so that any field can be looked up. The function is similar to the translate filter's\
+  \ dictionary lookup, which supports files and regex. The jdbc_streaming filter plugin\
+  \ is also very useful if the data resides in a database. This plugins features are\
+  \ web based lookups and redis caching, for fast lookups.\n"
+email: jan@janmg.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTORS
+- DEVELOPER.md
+- Gemfile
+- LICENSE
+- README.md
+- lib/logstash/filters/weblookup.rb
+- logstash-filter-weblookup.gemspec
+- spec/filters/lookup_spec.rb
+- spec/filters/lookup_spec.rb-orig
+- spec/spec_helper.rb
+homepage: https://github.com/janmg/logstash-filter-weblookup
+licenses:
+- Apache-2.0
+metadata:
+  logstash_plugin: 'true'
+  logstash_group: filter
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.7.9
+signing_key:
+specification_version: 4
+summary: This logstash filter plugin takes one or more fields and enriches with a
+  lookup value from a list, redis cache or webservice
+test_files:
+- spec/filters/lookup_spec.rb
+- spec/filters/lookup_spec.rb-orig
+- spec/spec_helper.rb