logstash-filter-cef 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ebf5ff9780644f0093381ec3656ca654381e5d9b
+  data.tar.gz: b0561ae6cdf87c42d0e0a631156607c99f15e89a
+SHA512:
+  metadata.gz: 1ed5271e8f064de97df95576c4017337ef754089fc6ca2aee827db9515bff596b21a9dd7b657f2cdb5aa62ee2bd0175679e6ad7bcde61aa2b45513ae80a1a85e
+  data.tar.gz: 9f5c141c735d740c5b3808048b35c1f88e299a2173963c5bcd0536c8cae987b236d949d6ae78dab2348adc9f2f79773e458899a0bb2ab0d16685b3f4fde8ec73

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## 2.0.0
+ - Plugins were updated to follow the new shutdown semantic, this mainly allows Logstash to instruct input plugins to terminate gracefully, 
+   instead of using Thread.raise on the plugins' threads. Ref: https://github.com/elastic/logstash/pull/3895
+ - Dependency on logstash-core update to 2.0
+

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:
+* Aaron Mildenstein (untergeek)
+* Pier-Hugues Pellerin (ph)
+
+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-example
+Example filter plugin. This should help bootstrap your effort to write your own filter plugin!

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2012–2015 Elasticsearch <http://www.elastic.co>
+
+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/NOTICE.TXT

@@ -0,0 +1,5 @@
+Elasticsearch
+Copyright 2012-2015 Elasticsearch
+
+This product includes software developed by The Apache Software
+Foundation (http://www.apache.org/).

data/README.md

@@ -0,0 +1,89 @@
+# Logstash Plugin
+
+[![Build
+Status](http://build-eu-00.elastic.co/view/LS%20Plugins/view/LS%20Filters/job/logstash-plugin-filter-cef-unit/badge/icon)](http://build-eu-00.elastic.co/view/LS%20Plugins/view/LS%20Filters/job/logstash-plugin-filter-cef-unit/)
+
+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=cef).
+
+- 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/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/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/cef.rb

@@ -0,0 +1,177 @@
+# encoding: utf-8
+require 'logstash/filters/base'
+require 'logstash/namespace'
+
+# This is a CEF parsing filter. It takes an existing field which contains CEF and
+# expands it into an actual data structure within the Logstash event.
+#
+# Inspired from: https://github.com/logstash-plugins/logstash-codec-cef
+#
+# A CEF string such as:
+#
+# 'CEF: 0|Figgity Foo Bar Inc.|ThingyThang|1.0.0|Firewall|Something Bad Happened|Informative|foo=bar baz=ah Hellz Nah'
+#
+#  results in the following parsed structure.
+# {
+#   "cef_version"=>"0",
+#   "cef_vendor"=>"Figgity Foo Bar Inc.",
+#   "cef_product"=>"ThingyThang",
+#   "cef_device_version"=>"1.0.0",
+#   "cef_sigid"=>"Firewall",
+#   "cef_name"=>"Something Bad Happened",
+#   "cef_severity"=>"Informative",
+#   "cef_syslog"=>"CEF:",
+#   "cef_ext"=> {
+#     "foo"=>"bar",
+#     "baz"=>"ah Hellz Nah"
+#   }
+# }
+#
+#
+# By default it will place the parsed CEF in the root (top level) of the Logstash event, but this
+# filter can be configured to place the CEF into any arbitrary event field, using the
+# `target` configuration.
+#
+class LogStash::Filters::CEF < LogStash::Filters::Base
+    # Implementation of a Logstash codec for the ArcSight Common Event Format (CEF)
+    # Based on Revision 20 of Implementing ArcSight CEF, dated from June 05, 2013
+    # https://protect724.hp.com/servlet/JiveServlet/downloadBody/1072-102-6-4697/CommonEventFormat.pdf
+    config_name 'cef'
+
+    # The configuration for the CEF filter:
+    # [source,ruby]
+    #     source => source_field
+    #
+    # For example, if you have CEF data in the `message` field:
+    # [source,ruby]
+    #     filter {
+    #       cef {
+    #         source => "message"
+    #       }
+    #     }
+    #
+    # The above would parse the cef from the `message` field
+    config :source, validate: :string, required: true
+
+    # Define the target field for placing the parsed data. If this setting is
+    # omitted, the CEF data will be stored at the root (top level) of the event.
+    #
+    # For example, if you want the data to be put in the `doc` field:
+    # [source,ruby]
+    #     filter {
+    #       cef {
+    #         target => "doc"
+    #       }
+    #     }
+    #
+    # CEF in the value of the `source` field will be expanded into a
+    # data structure in the `target` field.
+    #
+    # NOTE: if the `target` field already exists, it will be overwritten!
+    config :target, validate: :string
+
+    # Append values to the `tags` field when there has been no
+    # successful match
+    config :tag_on_failure, validate: :array, default: ['_cefparsefailure']
+
+    def register
+        # Nothing to do here
+    end # def register
+
+    def filter(event)
+        @logger.debug? && @logger.debug('Running CEF filter', event: event)
+
+        source = event[@source]
+        return unless source
+
+        begin
+            parsed = cef_decode(source)
+        rescue => e
+            @tag_on_failure.each { |tag| event.tag(tag) }
+            @logger.warn('Error parsing CEF', source: @source, raw: source, exception: e)
+            return
+        end
+
+        if @target
+            event[@target] = parsed
+        else
+            unless parsed.is_a?(Hash)
+                @tag_on_failure.each { |tag| event.tag(tag) }
+                @logger.warn('Parsed CEF object/hash requires a target configuration option', source: @source, raw: source)
+                return
+            end
+
+            # TODO: (colin) the timestamp initialization should be DRY'ed but exposing the similar code
+            # in the Event#init_timestamp method. See https://github.com/elastic/logstash/issues/4293
+
+            # a) since the parsed hash will be set in the event root, first extract any @timestamp field to properly initialized it
+            parsed_timestamp = parsed.delete(LogStash::Event::TIMESTAMP)
+            begin
+                timestamp = parsed_timestamp ? LogStash::Timestamp.coerce(parsed_timestamp) : nil
+            rescue LogStash::TimestampParserError => e
+                timestamp = nil
+            end
+
+            # b) then set all parsed fields in the event
+            parsed.each { |k, v| event[k] = v }
+            # c) finally re-inject proper @timestamp
+            if parsed_timestamp
+                if timestamp
+                    event.timestamp = timestamp
+                else
+                    event.timestamp = LogStash::Timestamp.new
+                    @logger.warn("Unrecognized #{LogStash::Event::TIMESTAMP} value, setting current time to #{LogStash::Event::TIMESTAMP}, original in #{LogStash::Event::TIMESTAMP_FAILURE_FIELD} field", value: parsed_timestamp.inspect)
+                    event.tag(LogStash::Event::TIMESTAMP_FAILURE_TAG)
+                    event[LogStash::Event::TIMESTAMP_FAILURE_FIELD] = parsed_timestamp.to_s
+                end
+            end
+      end
+
+        # filter_matched should go in the last line of our successful code
+        filter_matched(event)
+
+        @logger.debug? && @logger.debug('Event after CEF filter', event: event)
+    end # def filter
+
+    private
+
+    # CEF deocoding logic
+    def cef_decode(data)
+        # Strip any quotations at the start and end, flex connectors seem to send this
+        data = data[1..-2] if data[0] == '"'
+        event = {}
+
+        # Split by the pipes
+        event['cef_version'], event['cef_vendor'], event['cef_product'], event['cef_device_version'], event['cef_sigid'], event['cef_name'], event['cef_severity'], message = data.split /(?<!\\)[\|]/
+
+        # Try and parse out the syslog header if there is one
+        if event['cef_version'].include? ' '
+            event['cef_syslog'], unused, event['cef_version'] = event['cef_version'].rpartition(' ')
+        end
+
+        # Get rid of the CEF bit in the version
+        version = event['cef_version'].sub /^CEF:/, ''
+        event['cef_version'] = version
+
+        # Strip any whitespace from the message
+        if !message.nil? && message.include?('=')
+            message = message.strip
+
+            # If the last KVP has no value, add an empty string, this prevents hash errors below
+            message += ' ' if message.end_with?('=')
+
+            # Now parse the key value pairs into it
+            extensions = {}
+            message = message.split(/ ([\w\.]+)=/)
+            key, value = message.shift.split('=', 2)
+            extensions[key] = value
+
+            Hash[*message].each { |k, v| extensions[k] = v }
+
+            # And save the new has as the extensions
+            event['cef_ext'] = extensions
+        end
+
+        return event
+     end
+end # class LogStash::Filters::Example

data/logstash-filter-cef.gemspec

@@ -0,0 +1,23 @@
+Gem::Specification.new do |s|
+  s.name = 'logstash-filter-cef'
+  s.version         = '0.1.0'
+  s.licenses = ['Apache License (2.0)']
+  s.summary = "This is a CEF parsing filter. It takes an existing field which contains CEF and expands it into an actual data structure within the Logstash event."
+  s.description = "This gem is a logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/plugin install gemname. This gem is not a stand-alone program"
+  s.authors = ["Domingo Kiser"]
+  s.email = 'domingo.kiser@gmail.com'
+  s.homepage = "https://github.com/dkiser/logstash-filter-cef"
+  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", ">= 2.0.0", "< 3.0.0"
+  s.add_development_dependency 'logstash-devutils'
+end

data/spec/filters/cef_spec.rb

@@ -0,0 +1,43 @@
+# encoding: utf-8
+
+require 'logstash/devutils/rspec/spec_helper'
+require 'logstash/filters/cef'
+require 'logstash/timestamp'
+
+describe LogStash::Filters::CEF do
+    describe 'parse message into the event' do
+        config <<-CONFIG
+      filter {
+        cef {
+          # Parse message as CEF string
+          source => "message"
+        }
+      }
+    CONFIG
+
+        sample 'CEF: 0|Figgity Foo Bar Inc.|ThingyThang|1.0.0|Firewall|Something Bad Happened|Informative|foo=bar baz=ah Hellz Nah' do
+            insist { subject['cef_version'] } == '0'
+            insist { subject['cef_vendor'] } == 'Figgity Foo Bar Inc.'
+            insist { subject['cef_product'] } == 'ThingyThang'
+            insist { subject['cef_device_version'] } == '1.0.0'
+            insist { subject['cef_sigid'] } == 'Firewall'
+            insist { subject['cef_name'] } == 'Something Bad Happened'
+            insist { subject['cef_syslog'] } == "CEF:"
+            insist { subject['cef_severity'] } == 'Informative'
+            insist { subject['cef_ext']['foo'] } == 'bar'
+            insist { subject['cef_ext']['baz'] } == 'ah Hellz Nah'
+        end
+    end
+
+    context 'using message field source' do
+        subject(:filter) { LogStash::Filters::CEF.new(config) }
+
+        let(:config) { { 'source' => 'message' } }
+        let(:event) { LogStash::Event.new('message' => message) }
+
+        before(:each) do
+            filter.register
+            filter.filter(event)
+        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,92 @@
+--- !ruby/object:Gem::Specification
+name: logstash-filter-cef
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Domingo Kiser
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2016-04-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  name: logstash-core
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !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 required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/plugin install gemname. This gem is not a stand-alone program
+email: domingo.kiser@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTORS
+- DEVELOPER.md
+- Gemfile
+- LICENSE
+- NOTICE.TXT
+- README.md
+- lib/logstash/filters/cef.rb
+- logstash-filter-cef.gemspec
+- spec/filters/cef_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/dkiser/logstash-filter-cef
+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.4.5
+signing_key:
+specification_version: 4
+summary: This is a CEF parsing filter. It takes an existing field which contains CEF and expands it into an actual data structure within the Logstash event.
+test_files:
+- spec/filters/cef_spec.rb
+- spec/spec_helper.rb