logstash-filter-sanitize_mac 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 939dc138695bc3f6396f42d17d6ab48cc60f5a2e
+  data.tar.gz: c1dba234a312e4d04c24871723bc0ba2488df343
+SHA512:
+  metadata.gz: 14aefd60009065b2543a6a20bf77b04bf14223dec9d6c393530f92da398bb81e1a230192fa5abf312099563e74445b1147a70e2e55ea26c8684952090b6c28c5
+  data.tar.gz: 9a5ea392249735181dd5c95f88b429cb53b71db63cadf8f4276c03f0858d9540605f48db164a3b6b16652b15ab137f76532fa0b46380f133a640dc464d8d76a6

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## 0.1.0
+  - Plugin from logstash v1 (was at https://github.com/mcnewton/elk/tree/master/logstash-filters)

data/CONTRIBUTORS

@@ -0,0 +1,11 @@
+The following is a list of people who have contributed ideas, code, bug
+reports, or in general have helped logstash along its way.
+
+Contributors:
+*  - Matthew Newton
+*  - Enno Gröper
+
+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-sanitize_mac
+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/sanitize_mac.rb

@@ -0,0 +1,129 @@
+# encoding: utf-8
+require "logstash/filters/base"
+require "logstash/namespace"
+
+# Sanitize MAC addresses
+#
+# Many logs contain MAC addresses, but they can arrive in several different
+# formats, such as colon-delimited (00:11:22:aa:bb:cc), hyphen-delimited, Cisco
+# format (aabb.ccdd.1122), or just plain hex (001122334455). They can also be
+# uppercase, lowercase or mixed. This is especially problematic in logs such as
+# from a RADIUS server where clients are not all under local control and can
+# contain many different formats. This filter makes it easy to convert MAC
+# addresses into the same pattern to make searching easier.
+#
+# Examples:
+#
+#     # Create new field "client_mac_sanitized" with copy of "client_mac" field
+#     # in lowercase colon-delimited format.
+#     filter {
+#       sanitize_mac {
+#         match => { "client_mac" => "client_mac_sanitized" }
+#         separator => ":"
+#         fixcase => "lower"
+#       } 
+#     } 
+#
+#    # Replace "client_mac" and "server_mac" fields with versions in uppercase
+#    # Cisco format.
+#     filter {
+#       sanitize_mac {
+#         match => { "client_mac" => "client_mac"
+#                    "server_mac" => "server_mac" }
+#         separator => "."
+#         fixcase => "upper"
+#       } 
+#     } 
+
+class LogStash::Filters::SanitizeMac < LogStash::Filters::Base
+  config_name "sanitize_mac"
+
+  # Hash of fields to process; key is input field, value is output field.
+  # Input and output field may be the same, in which case the value of the field
+  # is replaced assuming the data looks like a MAC address and can be sanitized.
+  config :match, :validate => :hash, :required => true
+
+  # MAC address separator for rewritten address; can be any of
+  #  ":", "-", "." or "".
+  config :separator, :validate => :string, :default => "-"
+
+  # Fix case of MAC address. "lower", "upper" or "" to just leave it alone.
+  config :fixcase, :validate => :string, :default => ""
+
+  public
+  def register
+    if [":", "-", ".", ""].index(@separator).nil?
+      @logger.error("Invalid sanitize_mac configuration. 'separator' must be one of ':', '-', '.' or blank.")
+      raise "Bad configuration, aborting."
+    end
+    
+    if ["lower", "upper", ""].index(@fixcase).nil?
+      @logger.error("Invalid sanitize_mac configuration. 'fixcase' must be one of 'lower', 'upper', blank.")
+      raise "Bad configuration, aborting."
+    end
+
+    if @match.nil?
+      @logger.error("Invalid sanitize_mac configuration. 'match' must be defined.")
+      raise "Bad configuration, aborting."
+    end
+  end # def register
+
+  public
+  def filter(event)
+    return unless filter?(event)
+
+    @match.keys.each do |field|
+      next if event.get(field).nil?
+
+      # Work out what format the incoming MAC address is in. As well as
+      # well-formed addresses, this has to cope with things like missing
+      # leading-zeroes, and ensuring that something using mixed delimiters
+      # does not parse.
+
+      # looks colon-delimited?
+      if event.get(field) =~ /^(?:[0-9a-f]{1,2}:){5}[0-9a-f]{1,2}$/i
+        octets = event.get(field).split(":")
+        mac = octets.map { |o| (o.length == 1 ? "0" + o : o) }.join
+
+      # looks hyphen-delimited?
+      elsif event.get(field) =~ /^(?:[0-9a-f]{1,2}-){5}[0-9a-f]{1,2}$/i
+        octets = event.get(field).split("-")
+        mac = octets.map { |o| (o.length == 1 ? "0" + o : o) }.join
+
+      # looks cisco dot-delimited?
+      elsif event.get(field) =~ /^[0-9a-f]{1,4}\.[0-9a-f]{1,4}\.[0-9a-f]{1,4}$/i
+        words = event.get(field).split(".")
+        mac = words.map { |o| (o.length < 4 ? ("000" + o)[-4..-1] : o) }.join
+
+      # last try; could just be 12-digit hex?
+      elsif event.get(field) =~ /^[0-9a-f]{12}$/i
+        mac = event.get(field)
+
+      # give up, it doesn't look like a MAC address
+      else
+        next
+      end
+
+      # verify what we're left with really does look like a mac address
+      next unless mac.length == 12
+
+      # split up into octets (or 16 bits for cisco format)
+      if separator == "."
+        octets = mac.unpack("A4A4A4")
+      else
+        octets = mac.unpack("A2A2A2A2A2A2")
+      end
+
+      # push the updated value back
+      new_field = @match[field]
+      case @fixcase
+        when "lower" then event.set(new_field, octets.join(separator).downcase)
+        when "upper" then event.set(new_field, octets.join(separator).upcase)
+        else event.set(new_field, octets.join(separator))
+      end
+
+    end
+
+    filter_matched(event)
+  end # def filter
+end # class LogStash::Filters::SanitizeMac

data/logstash-filter-sanitize_mac.gemspec

@@ -0,0 +1,23 @@
+Gem::Specification.new do |s|
+  s.name          = 'logstash-filter-sanitize_mac'
+  s.version       = '0.1.0'
+  s.licenses      = ['Apache License (2.0)']
+  s.summary       = 'Logstash filter plugin to sanitize network MAC addresss'
+  s.description   = 'MAC addresses can come in many different forms. This filter attempts to standardise them to make elasticsearch logs easier to search.'
+  s.homepage      = 'https://github.com/mcnewton/logstash-filter-sanitize_mac'
+  s.authors       = ['Matthew Newton']
+  s.email         = 'matthew-git@newtoncomputing.co.uk'
+  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_development_dependency 'logstash-devutils'
+end

data/spec/filters/sanitize_mac_spec.rb

@@ -0,0 +1,117 @@
+# encoding: utf-8
+require_relative '../spec_helper'
+require "logstash/filters/sanitize_mac"
+
+describe LogStash::Filters::SanitizeMac do
+  describe "Clean up a MAC address to hyphen and lowercase" do
+    let(:config) do <<-CONFIG
+      filter {
+        sanitize_mac {
+          match => { "client_mac" => "client_mac_sanitized" }
+          separator => "-"
+          fixcase => "lower"
+        }
+      }
+    CONFIG
+    end
+
+    sample("client_mac" => "A98c.c2ff.fe37") do
+      expect(subject).to include("client_mac")
+      expect(subject.get('client_mac_sanitized')).to eq('a9-8c-c2-ff-fe-37')
+    end
+
+    sample("client_mac" => "11:23:4D:66:77:aB") do
+      expect(subject).to include("client_mac")
+      expect(subject.get('client_mac_sanitized')).to eq('11-23-4d-66-77-ab')
+    end
+
+    sample("client_mac" => "ad561297fEEd") do
+      expect(subject).to include("client_mac")
+      expect(subject.get('client_mac_sanitized')).to eq('ad-56-12-97-fe-ed')
+    end
+  end
+
+  describe "Clean up a MAC address to colon and same case" do
+    let(:config) do <<-CONFIG
+      filter {
+        sanitize_mac {
+          match => { "client_mac" => "client_mac_sanitized" }
+          separator => ":"
+          fixcase => ""
+        }
+      }
+    CONFIG
+    end
+
+    sample("client_mac" => "A98c.c2ff.fe37") do
+      expect(subject).to include("client_mac")
+      expect(subject.get('client_mac_sanitized')).to eq('A9:8c:c2:ff:fe:37')
+    end
+
+    sample("client_mac" => "11:23:4D:66:77:aB") do
+      expect(subject).to include("client_mac")
+      expect(subject.get('client_mac_sanitized')).to eq('11:23:4D:66:77:aB')
+    end
+
+    sample("client_mac" => "ad561297fEEd") do
+      expect(subject).to include("client_mac")
+      expect(subject.get('client_mac_sanitized')).to eq('ad:56:12:97:fE:Ed')
+    end
+  end
+
+  describe "Clean up a MAC address to dots and uppercase" do
+    let(:config) do <<-CONFIG
+      filter {
+        sanitize_mac {
+          match => { "client_mac" => "client_mac_sanitized" }
+          separator => "."
+          fixcase => "upper"
+        }
+      }
+    CONFIG
+    end
+
+    sample("client_mac" => "A98c.c2ff.fe37") do
+      expect(subject).to include("client_mac")
+      expect(subject.get('client_mac_sanitized')).to eq('A98C.C2FF.FE37')
+    end
+
+    sample("client_mac" => "11:23:4D:66:77:aB") do
+      expect(subject).to include("client_mac")
+      expect(subject.get('client_mac_sanitized')).to eq('1123.4D66.77AB')
+    end
+
+    sample("client_mac" => "ad561297fEEd") do
+      expect(subject).to include("client_mac")
+      expect(subject.get('client_mac_sanitized')).to eq('AD56.1297.FEED')
+    end
+  end
+
+  describe "Clean up a MAC address to no separator and uppercase" do
+    let(:config) do <<-CONFIG
+      filter {
+        sanitize_mac {
+          match => { "client_mac" => "client_mac_sanitized" }
+          separator => ""
+          fixcase => "upper"
+        }
+      }
+    CONFIG
+    end
+
+    sample("client_mac" => "A98c.c2ff.fe37") do
+      expect(subject).to include("client_mac")
+      expect(subject.get('client_mac_sanitized')).to eq('A98CC2FFFE37')
+    end
+
+    sample("client_mac" => "11:23:4D:66:77:aB") do
+      expect(subject).to include("client_mac")
+      expect(subject.get('client_mac_sanitized')).to eq('11234D6677AB')
+    end
+
+    sample("client_mac" => "ad561297fEEd") do
+      expect(subject).to include("client_mac")
+      expect(subject.get('client_mac_sanitized')).to eq('AD561297FEED')
+    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,86 @@
+--- !ruby/object:Gem::Specification
+name: logstash-filter-sanitize_mac
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Matthew Newton
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-12-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: logstash-core-plugin-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: logstash-devutils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: MAC addresses can come in many different forms. This filter attempts
+  to standardise them to make elasticsearch logs easier to search.
+email: matthew-git@newtoncomputing.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTORS
+- DEVELOPER.md
+- Gemfile
+- LICENSE
+- README.md
+- lib/logstash/filters/sanitize_mac.rb
+- logstash-filter-sanitize_mac.gemspec
+- spec/filters/sanitize_mac_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/mcnewton/logstash-filter-sanitize_mac
+licenses:
+- Apache License (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.5.2.1
+signing_key: 
+specification_version: 4
+summary: Logstash filter plugin to sanitize network MAC addresss
+test_files:
+- spec/filters/sanitize_mac_spec.rb
+- spec/spec_helper.rb