logstash-filter-hex_to_ascii 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4cf217f87a64f977f273e73510fa111a13cb08c4
+  data.tar.gz: 2d02b90d2f00d82345061f545d538d04a1684203
+SHA512:
+  metadata.gz: 67e904b72b3d68bd9d56905c46966de57d6a3f0c4bc99449364999cf50cc2809e4f8c016c3fe9f898bc895bcfae40fd05c90c1bb43a7761a5381cff61e46b0ba
+  data.tar.gz: 8bcfebe2a9638ab092298f4a552fdc568464be600b8a55828d8eb153ba49630fcd3553caec3c3fb22610bd710b63deed7791be3687c79f94e1cae9a3fddfabcb

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## 0.2.0
+ - First public release.
+   instead of using Thread.raise on the plugins' threads. Ref: https://github.com/elastic/logstash/pull/3895
+ - Updated for Logstash 5.x
+
+## 0.1.0
+ - Initial release. Internal only.

data/CONTRIBUTORS

@@ -0,0 +1,5 @@
+The following is a list of people who have contributed ideas, code, bug
+reports, or in general have helped this plugin along its way.
+
+Contributors:
+* joe miller (joemiller)

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+gemspec
+
+logstash_path = ENV["LOGSTASH_PATH"] || "../../logstash"
+use_logstash_source = ENV["LOGSTASH_SOURCE"] && ENV["LOGSTASH_SOURCE"].to_s == "1"
+
+if Dir.exist?(logstash_path) && use_logstash_source
+  gem 'logstash-core', :path => "#{logstash_path}/logstash-core"
+  gem 'logstash-core-plugin-api', :path => "#{logstash_path}/logstash-core-plugin-api"
+end

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2017 Pantheon Systems <https://pantheon.io>
+
+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,98 @@
+# Logstash Plugin
+
+[![Travis Build Status](https://travis-ci.org/pantheon-systems/logstash-filter-hex_to_ascii.svg)](https://travis-ci.org/pantheon-systems/logstash-filter-hex_to_ascii)
+
+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
+# Logstash 2.3 and higher
+bin/logstash-plugin install --no-verify
+
+# Prior to Logstash 2.3
+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
+# Logstash 2.3 and higher
+bin/logstash-plugin install --no-verify
+
+# Prior to Logstash 2.3
+bin/plugin install --no-verify
+
+```
+- 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/hex_to_ascii.rb

@@ -0,0 +1,89 @@
+# encoding: utf-8
+
+# Convert hex-encoded strings to their ASCII representations.
+#
+# This plugin was originally intended to assist with auditd logs which sometimes
+# log certain values as hex-encoded pieces of data. It may be useful for other
+# situations where you need to convert hex-encoded strings back to ASCII.
+#
+# The plugin will look for one or more strings in the specified field ('message' by default)
+# and attempt to convert them to Encoding::ASCII_8BIT format. Any string
+# prefixed with `0x` will be considered hex-encoded. The match prefix can be
+# changed with the `prefix` config option.
+#
+# Quick demo:
+#
+#   echo '0x6364202F6F70742F' | logstash -e 'input{stdin{}} filter{hex_to_ascii{}} output{stdout{codec => rubydebug}}'
+#   {
+#       "@timestamp" => 2017-08-02T20:01:52.179Z,
+#       "message" => "cd /opt/"
+#   }
+#
+# Example decoding the 'cmd=' string emitted by auditd:
+#
+#   $ echo '<audit-1123> pid=13334 uid=987 auid=4294967295 ses=4294967295 msg=cwd="/" cmd=2F62696E2F66696E64 terminal=? res=success'  \
+#       | logstash -e 'input{stdin{}} filter{hex_to_ascii{prefix => "cmd="}} output{stdout{codec => rubydebug}}'
+#
+#       {
+#          "@timestamp" => 2017-08-02T20:14:02.267Z,
+#          "message" => "<audit-1123> pid=13334 uid=987 auid=4294967295 ses=4294967295 msg=cwd=\"/\" /bin/find terminal=? res=success"
+#      }
+#
+# Example decoding the 'data=' string emitted by auditd + pam_tty_audit:
+#
+#   $ echo 'tty pid=8106 uid=5520 auid=5520 ses=38 major=136 minor=0 comm="bash" data=6364202F6F70742F' \
+#       | logstash -e 'input{stdin{}} filter{hex_to_ascii{prefix => "data="}} output{stdout{codec => rubydebug}}'
+#
+#
+
+require 'logstash/filters/base'
+
+class LogStash::Filters::HexToAscii < LogStash::Filters::Base
+  config_name 'hex_to_ascii'
+
+  # The field to operate on
+  config :field, :validate => :string, :default => 'message'
+
+  # A hex value may be embedded with other values, some of which may appear to be
+  # hex values but should not be decoded. In order to limit the scope of the search,
+  # set a prefix. The default prefix is `0x`. Other possibilities are `data=` which
+  # is useful for some type of auditd log messages that encode data eg:
+  # `data=654FBAC98C`, which would be converted to `data=df ; ls`
+  config :prefix, :validate => :string, :default => '0x'
+
+  # remove the prefix after successful conversion. default `true`
+  # eg: when true:  `0x6466` => `df`
+  #     when false: `0x6466` => `0xdf`
+  config :remove_prefix, :validate => :boolean, :default => true
+
+  public
+  def register
+    # Nothing to do
+  end #def register
+
+  public
+  def filter(event)
+    return unless filter?(event)
+
+    event.set(@field, hex_to_ascii(event.get(@field), @prefix, @remove_prefix))
+    filter_matched(event)
+  end # def filter
+
+  # unhexlify a hex value. Some values may not convert to printable UTF-8 characters
+  # in which case ruby will return an ASCII-8BIT (binary) encoded value. In this case
+  # we will use .inspect to return an escaped version of the string
+  # in UTF-8 format otherwise Logstash will throw exceptions.
+  private
+  def unhexlify(msg)
+    string = msg.scan(/../).collect { |c| c.to_i(16).chr }.join
+    (string.encoding == Encoding::ASCII_8BIT) ? string.inspect : string
+  end # def unhexlify
+
+  # find all hex values with the given prefix and attempt to convert to ascii
+  private
+  def hex_to_ascii(value, prefix, strip_prefix)
+    value.gsub(/#{prefix}([0-9A-Fa-f]+)/) do |m|
+      strip_prefix ? unhexlify($1) : prefix + unhexlify($1)
+    end
+  end # def hex_to_ascii
+end # class LogStash::Filters::HexToAscii

data/logstash-filter-hex_to_ascii.gemspec

@@ -0,0 +1,23 @@
+Gem::Specification.new do |s|
+  s.name = 'logstash-filter-hex_to_ascii'
+  s.version = '0.2.0'
+  s.licenses = ['Apache-2.0']
+  s.summary = 'Convert hex-encoded string fields to ASCII'
+  s.description = 'Convert hex-encoded string fields to ASCII'
+  s.homepage = 'https://github.com/pantheon-systems/logstash-filter-hex_to_ascii'
+  s.authors = ['Pantheon']
+  s.email = 'joe@pantheon.io'
+  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' => 'input' }
+
+  # Gem dependencies
+  s.add_runtime_dependency 'logstash-core-plugin-api', '>= 1.60', '<= 2.99'
+  s.add_development_dependency 'logstash-devutils', '~> 1.0'
+end

data/spec/filters/hex_to_ascii_spec.rb

@@ -0,0 +1,73 @@
+# encoding: utf-8
+
+require 'logstash/devutils/rspec/spec_helper'
+require 'logstash/filters/hex_to_ascii'
+
+describe 'LogStash::Filters::HexToAscii' do
+
+  describe 'should convert a single hex value to ascii and remove the hex prefix' do
+    config <<-CONFIG
+      filter {
+        hex_to_ascii {
+          field => 'message'
+          prefix => '0x'
+          remove_prefix => 'true'
+        }
+      }
+    CONFIG
+
+    sample '0x666F6F626172' do
+      insist { subject.get('message') } == 'foobar'
+    end
+  end
+
+  describe 'should return an unchanged string if no hex digits found' do
+    config <<-CONFIG
+      filter { hex_to_ascii {} }
+    CONFIG
+
+    sample 'a string with no hex' do
+      insist { subject.get('message') } == 'a string with no hex'
+    end
+  end
+
+  describe 'converts a hex value while leaving the prefix' do
+    config <<-CONFIG
+      filter {
+        hex_to_ascii {
+          prefix => 'data='
+          remove_prefix => 'false'
+        }
+      }
+    CONFIG
+
+    sample 'data=666F6F' do
+      insist { subject.get('message') } == 'data=foo'
+    end
+  end
+
+  describe 'converts multiple hex values' do
+    config <<-CONFIG
+      filter {
+        hex_to_ascii {
+          prefix => 'data='
+          remove_prefix => 'false'
+        }
+      }
+    CONFIG
+
+    sample 'data=666F6F and data=626172' do
+      insist { subject.get('message') } == 'data=foo and data=bar'
+    end
+  end
+
+  describe 'converts unprintable binary characters to printable' do
+    config <<-CONFIG
+    filter { hex_to_ascii {} }
+    CONFIG
+
+    sample '0x66F6F' do
+      insist { subject.get('message') } == '"f\\xF6"'
+    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,91 @@
+--- !ruby/object:Gem::Specification
+name: logstash-filter-hex_to_ascii
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Pantheon
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2017-08-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.60'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '2.99'
+  name: logstash-core-plugin-api
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.60'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '2.99'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  name: logstash-devutils
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Convert hex-encoded string fields to ASCII
+email: joe@pantheon.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTORS
+- Gemfile
+- LICENSE
+- NOTICE.TXT
+- README.md
+- lib/logstash/filters/hex_to_ascii.rb
+- logstash-filter-hex_to_ascii.gemspec
+- spec/filters/hex_to_ascii_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/pantheon-systems/logstash-filter-hex_to_ascii
+licenses:
+- Apache-2.0
+metadata:
+  logstash_plugin: 'true'
+  logstash_group: input
+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.8
+signing_key:
+specification_version: 4
+summary: Convert hex-encoded string fields to ASCII
+test_files:
+- spec/filters/hex_to_ascii_spec.rb
+- spec/spec_helper.rb