logstash-filter-accesswatch 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 34157f7c1c0392ebb20368b31fbf0007b79df4109c016e77a107732b4b41fbe2
+  data.tar.gz: cf687eb6c068bf62d241b838429ad1972a742e5318e41a27492b7c44d2a97078
+SHA512:
+  metadata.gz: b280d78583d33c7768afc4ec852f3bc26da8979c1713df177cb746978d765f59ef361985d5a5e47f3cbc26088f9abd6eacdf1ca5479d7c53e8b488fafc903e68
+  data.tar.gz: c5717ab2193781ee5024f5a28f6757b330c1c631f64c11c56192e32107a5bc739efaa3e8cd7a8e6bf71b726b9a2e180d5cc7a98ebf8224dc3145f69cf05ff4fe

data/CHANGELOG.md

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

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/accesswatch.rb

@@ -0,0 +1,132 @@
+# encoding: utf-8
+require "logstash/filters/base"
+require "logstash/namespace"
+require 'json'
+require 'set'
+require 'ipaddr'
+require 'interval_tree'
+require 'digest'
+
+# The Access Watch filter adds information about robots visiting
+# your website based on data from our robots database.
+#
+# The following fields might be created:
+# [identity][type]      "robot"   If the visitor is a robot.
+# [reputation][status]  string    The reputation of the visitor (see below).
+# [robot][id]           number    A unique robot identifier
+# [robot][name]         string    A robot's name to display to the user.
+# [robot][url]          string    A link to the robot's page on the Access Watch database.
+#
+# Access Watch defines the following reputation statuses:
+#
+# nice	        perfect, as far as we know you can trust this entity
+# ok	          all right, so far no reason to worry about this entity
+# suspicious	  warning, nothing really bad, but the entity is on our radar
+# bad           danger, there is good reasons to watch or block this entity
+#
+# This filter requires the Access Watch `robots.json` file to run.
+#
+
+class LogStash::Filters::Accesswatch < LogStash::Filters::Base
+
+  config_name "accesswatch"
+
+  # The path to the Access Watch database file.
+  #
+  # If not specified, this will default to './robots.json'.
+  #
+  config :db_path, :validate => :path, :default => "./robots.json"
+
+  # The field containing the IP address.
+  config :ip_source, :validate => :string, :required => true
+
+  # The field containing the User-Agent string.
+  config :ua_source, :validate => :string, :required => true
+
+  # Transform a CIDR described as a 2-array [start size]
+  # into a Ruby 3-dotted range.
+  private
+  def cidr2range(cidr)
+    first = cidr[0]
+    last = first + cidr[1]
+    (first...last)
+  end
+
+  # Group elements of a collection by each value of a multi-valued attribute
+  private
+  def group_by_multi(coll, key)
+    res = Hash.new {|hash, key| hash[key] = Array.new}
+    coll.each {|el|
+      if !el[key].nil?
+        el[key].each {|val|
+          res[val].push(el)
+        }
+      end
+    }
+    return res
+  end
+
+  private
+  def build_indices(filename)
+    file = File.read(filename)
+    robots = JSON.parse(file)
+    robots.each {|robot|
+      if !robot['cidrs'].nil?
+        robot['cidrs'] = robot['cidrs'].collect {|cidr| cidr2range(cidr)}
+      end
+    }
+    @ip2robots = group_by_multi(robots, 'ips')
+    @cidr2robots = group_by_multi(robots, 'cidrs')
+    @ip2cidrs = IntervalTree::Tree.new(@cidr2robots.keys)
+    @ua2robots = group_by_multi(robots, 'uas')
+  end
+
+  public
+  def register
+    build_indices(@db_path)
+  end
+
+  # Take a User-Agent string and an IP address and return a robot description, or nil.
+  private
+  def detect(ua, ip)
+    # Look for robots with the same IP addressor CIDR
+    ip_candidates = []
+    cidr_candidates = []
+    if ip
+      i = ip.ipv4? ? ip.ipv4_mapped.to_i : ip.to_i # convert IP to arbitrary length integer
+      ip_candidates = @ip2robots[i]
+      cidrs = @ip2cidrs.search(i)
+      cidr_candidates = cidrs.collect {|cidr| @cidr2robots[cidr]}.reduce([], :concat) unless cidrs.nil?
+    end
+    # Look for robots with the same User-Agent
+    ua_candidates = []
+    if ua
+      ua_candidates = @ua2robots[Digest::MD5.hexdigest(ua)]
+    end
+    # Make a final decision
+    robots = ((ip_candidates | cidr_candidates) & ua_candidates)
+    if !robots.empty?
+      robot = robots[0]
+      url = "https://access.watch/database/robots/#{robot['reputation']}/#{robot['urlid'] or robot['id']}"
+      {'identity'   => {'type' => 'robot'},
+       'robot'      => {'id'   => robot['id'],
+                        'name' => robot['name'],
+                        'url'  => url},
+       'reputation' => {'status' => robot['reputation']}}
+    end
+  end
+
+  public
+  def filter(event)
+    ip_s = event.get(@ip_source)
+    ip = IPAddr.new ip_s unless ip_s.nil?
+    robot = detect(event.get(@ua_source), ip)
+    if robot
+      event.set('identity',   robot['identity'])   unless robot['identity'].nil?
+      event.set('robot',      robot['robot'])      unless robot['robot'].nil?
+      event.set('reputation', robot['reputation']) unless robot['reputation'].nil?
+    end
+    filter_matched(event)
+  end
+
+end

data/logstash-filter-accesswatch.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+Gem::Specification.new do |s|
+  s.name          = 'logstash-filter-accesswatch'
+  s.version       = '0.1.0'
+  s.licenses      = ['Apache-2.0']
+  s.summary       = 'The Logstash filter plugin for Access Watch (http://access.watch).'
+  s.description   = 'The Access Watch filter adds information about robots visiting your website based on data from our robots database.'
+  s.homepage      = 'http://access.watch'
+  s.authors       = ['Benoît Fleury']
+  s.email         = 'benoit@access.watch'
+  s.require_paths = ['lib']
+
+  # Files
+  s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','Gemfile','LICENSE']
+   # 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 'augmented_interval_tree',  '~> 0.1.1'
+
+  s.add_development_dependency 'logstash-devutils', '1.3.3'
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: logstash-filter-accesswatch
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Benoît Fleury
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2017-07-18 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: 0.1.1
+  name: augmented_interval_tree
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.3
+  name: logstash-devutils
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.3
+description: The Access Watch filter adds information about robots visiting your website
+  based on data from our robots database.
+email: benoit@access.watch
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- lib/logstash/filters/accesswatch.rb
+- logstash-filter-accesswatch.gemspec
+homepage: http://access.watch
+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.6.11
+signing_key:
+specification_version: 4
+summary: The Logstash filter plugin for Access Watch (http://access.watch).
+test_files: []