logstash-codec-cef 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 87b1c006ad2c6b9f408a1916584c8395aaa1055e
+  data.tar.gz: 3be4bfb1d8b3b2ef05cb22a35adb2f734bfe57a4
+SHA512:
+  metadata.gz: cdde709159e93287bdfa22bb4b233d2e5d044132ea29c1a4610e260f3cc5b9a3c6b3b6095bffb8a82cba4dead39eba9553106b2da1d22dbe0ed97da482238697
+  data.tar.gz: cc9f48c5c29e2f922fbe291b50e0ec907e96fcbe47ec32bd8f5e82c3b597e63c4419a3f2dfb9ffef0a81baa003e6aa737c2583cb16b0486749e47f894d8b1e7b

data/DEVELOPER.md

@@ -0,0 +1,49 @@
+logstash-CEF
+============
+
+Logstash Codec to handle CEF encoded data
+
+Build
+=====
+
+Run 'make tarball' to build the project. A tarball will end up in ./build. Extract the file over top of your logstash directory. 
+(Hint: or, just copy the ./lib and ./vendor directories to your logstash folder)
+
+
+Config
+======
+
+This is an example input config. 
+
+```
+input {
+    generator {
+	message => "TODO"
+	count => 1
+	codec => cef
+    }
+}
+
+output {
+    stdout { 
+	codec => "rubydebug"
+    }
+}
+```
+
+This is an example output config. 
+
+```
+input {
+    generator {
+	message => "TODO"
+	count => 1
+    }
+}
+
+output {
+    stdout { 
+	codec => cef
+    }
+}
+```

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+gemspec
+gem "logstash", :github => "elasticsearch/logstash", :branch => "1.5"

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2012-2015 Elasticsearch <http://www.elasticsearch.org>
+
+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,95 @@
+# Logstash Plugin
+
+This is a plugin for [Logstash](https://github.com/elasticsearch/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.elasticsearch.org/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/elasticsearch/docs#asciidoc-guide
+
+## Need Help?
+
+Need help? Try #logstash on freenode IRC or the logstash-users@googlegroups.com mailing list.
+
+## 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.
+
+- Install dependencies
+```sh
+bundle install
+```
+
+#### Test
+
+```sh
+bundle exec rspec
+```
+
+The Logstash code required to run the tests/specs is specified in the `Gemfile` by the line similar to:
+```ruby
+gem "logstash", :github => "elasticsearch/logstash", :branch => "1.5"
+```
+To test against another version or a local Logstash, edit the `Gemfile` to specify an alternative location, for example:
+```ruby
+gem "logstash", :github => "elasticsearch/logstash", :ref => "master"
+```
+```ruby
+gem "logstash", :path => "/your/local/logstash"
+```
+
+Then update your dependencies and run your tests:
+
+```sh
+bundle install
+bundle exec rspec
+```
+
+### 2. Running your unpublished Plugin in Logstash
+
+#### 2.1 Run in a local Logstash clone
+
+- Edit Logstash `tools/Gemfile` and add the local plugin path, for example:
+```ruby
+gem "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome"
+```
+- Update Logstash dependencies
+```sh
+rake vendor:gems
+```
+- 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
+
+- 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 me that you are able to contribute.
+
+For more information about contributing, see the [CONTRIBUTING](https://github.com/elasticsearch/logstash/blob/master/CONTRIBUTING.md) file.

data/Rakefile

@@ -0,0 +1,7 @@
+@files=[]
+
+task :default do
+  system("rake -T")
+end
+
+require "logstash/devutils/rake"

data/lib/logstash/codecs/cef.rb

@@ -0,0 +1,64 @@
+require "logstash/codecs/base"
+
+class LogStash::Codecs::CEF < LogStash::Codecs::Base
+  config_name "cef"
+
+
+  # Specify if the Syslog header will be expected
+  config :syslog, :validate => :boolean, :default => false
+
+  config :signature, :validate => :string, :default => "Logstash"
+  config :name, :validate => :string, :default => "Logstash"
+  config :sev, :validate => :number, :default => 6
+
+  config :fields, :validate => :array
+
+  public
+  def initialize(params={})
+    super(params)
+  end
+
+  public
+  def decode(data)
+    # Need to break out the headers, then return the headers as individual fields, and the extension to be processed by a filter (ie: KV)
+    # %{SYSLOGDATE} %{HOST} CEF:Version|Device Vendor|Device Product|Device Version|SignatureID|Name|Severity|Extension
+    event = LogStash::Event.new()
+    if @syslog
+        @logger.debug("Expecting SYSLOG headers")
+        event['syslog'], data = data.split('CEF:', 1)
+        # Since we have the syslog headers, lets pull them out first and put them into their own field to be handled
+    else 
+        # We don't have syslog headers, so we just need to remove CEF:
+        data.sub! /^CEF:/, ''
+    end #if @syslog
+    # Now, break out the rest of the headers
+    event['cef_version'], event['cef_vendor'], event['cef_product'], event['cef_device_version'], event['cef_sigid'], event['cef_name'], event['cef_severity'], event['message'] =  data.scan /(?:[^\|\\]|\\.)+/
+    yield event
+  end
+
+  public
+  def encode(data)
+	# "CEF:0|Elasticsearch|Logstash|1.0|Signature|Name|Sev|"
+
+	# TODO: Need to check that fields are set!
+
+	# Signature, Name, and Sev should be set in the config, with ref to fields
+	# Should also probably set the fields sent
+	header = ["CEF:0", "Elasticsearch", "Logstash", "1.0", @signature, @name, @sev].join("|")
+	values = @fields.map {|name| get_value(name, data)}.join(" ")
+	# values = values.map {|k,v| "#{k}=#{v}"}.join(" ")
+	@on_event.call(header + " " + values + "\n")
+  end
+
+  private
+  def get_value(name, event)
+    val = event[name]
+    case val
+      when Hash
+        return name + "=" + val.to_json
+      else
+        return name + "=" + val
+    end
+  end
+
+end

data/lib/logstash/version.rb

@@ -0,0 +1,6 @@
+# encoding: utf-8
+# The version of logstash.
+LOGSTASH_VERSION = "1.4.1.dev"
+
+# Note to authors: this should not include dashes because 'gem' barfs if
+# you include a dash in the version string.

data/logstash-codec-cef.gemspec

@@ -0,0 +1,27 @@
+Gem::Specification.new do |s|
+
+  s.name            = 'logstash-codec-cef'
+  s.version         = '0.1.1'
+  s.licenses        = ['Apache License (2.0)']
+  s.summary         = "CEF codec to parse CEF formated logs"
+  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         = ["Elasticsearch"]
+  s.email           = 'info@elasticsearch.com'
+  s.homepage        = "http://www.elasticsearch.org/guide/en/logstash/current/index.html"
+  s.require_paths = ["lib"]
+
+  # Files
+  s.files = `git ls-files`.split($\)
+
+  # 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" => "codec" }
+
+  # Gem dependencies
+  s.add_runtime_dependency 'logstash', '>= 1.4.0', '< 2.0.0'
+
+  s.add_development_dependency 'logstash-devutils'
+end
+

data/spec/codecs/cef_spec.rb

@@ -0,0 +1,37 @@
+# encoding: utf-8
+
+require "logstash/devutils/rspec/spec_helper"
+require "logstash/codecs/cef"
+require "logstash/event"
+
+describe LogStash::Codecs::CEF do
+  subject do
+    next LogStash::Codecs::CEF.new
+  end
+
+  context "#encode" do
+    it "should assert all header fields are present"
+  end
+
+  context "#decode" do
+    let (:message) { "CEF:0|security|threatmanager|1.0|100|trojan successfully stopped|10|src=10.0.0.192 dst=12.121.122.82 spt=1232" }
+
+    it "should parse the cef header" do
+      subject.decode(message) do |e|
+        insist { e.is_a?(LogStash::Event) }
+        insist { e["cef_version"] } == "0"
+        insist { e["cef_vendor"] } == "security"
+        insist { e["cef_product"] } == "threatmanager"
+        insist { e["cef_device_version"] } == "1.0"
+        insist { e["cef_sigid"] } == "100"
+        insist { e["cef_name"] } == "trojan successfully stopped"
+        insist { e["cef_severity"] } == "10"
+        insist { e["message"] } == "src=10.0.0.192 dst=12.121.122.82 spt=1232"
+      end
+    end
+
+    it "should parse the cef body"
+    it "should handle values in the body that contain spaces"
+  end
+
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: logstash-codec-cef
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Elasticsearch
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2015-01-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: logstash
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: logstash-devutils
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :development
+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: info@elasticsearch.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- DEVELOPER.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/logstash/codecs/cef.rb
+- lib/logstash/version.rb
+- logstash-codec-cef.gemspec
+- spec/codecs/cef_spec.rb
+homepage: http://www.elasticsearch.org/guide/en/logstash/current/index.html
+licenses:
+- Apache License (2.0)
+metadata:
+  logstash_plugin: 'true'
+  logstash_group: codec
+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.1.9
+signing_key:
+specification_version: 4
+summary: CEF codec to parse CEF formated logs
+test_files:
+- spec/codecs/cef_spec.rb