fluent-plugin-redaction 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3e4231227b1e13f09203ea14b382bc7291a0deb1
+  data.tar.gz: edfca6249b080274c4aa6b577938c75a38a4a5e6
+SHA512:
+  metadata.gz: 7e476f6f06ee54bbdb503176cd84963185042d5ef27b201bfae62ba8c66bae877b0555ebcd44c74a072f25498680a80e4caf35e45d0e5813757edbf229515132
+  data.tar.gz: 23f7daf93b3887c49098914b10cbabf2a2f580968bd172d1517cd05427920dd19c14e963ce8a37907190c934bed012529e2e985240e57f266f2781174b3dd581

data/.gitignore

@@ -0,0 +1,57 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+
+rvm:
+  - 2.4
+
+gemfile:
+ - Gemfile
+
+branches:
+  only:
+    - master
+
+script: bundle exec rake test

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Olivér Sz,
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/Makefile

@@ -0,0 +1,13 @@
+gem:
+	rm -f fluent-plugin-redaction*.gem
+	gem build fluent-plugin-redaction.gemspec
+
+install: gem
+	gem install fluent-plugin-redaction*.gem
+
+push: gem
+	gem push fluent-plugin-redaction*.gem
+
+tag:
+	git tag "v$$(cat VERSION)" $(RELEASE_COMMIT)
+	git push origin "v$$(cat VERSION)"

data/README.md

@@ -0,0 +1,31 @@
+# Fluentd Filter Redaction Plugin
+
+[![Build Status](https://travis-ci.org/oleewere/fluent-plugin-redaction.svg?branch=master)](https://travis-ci.org/oleewere/fluent-plugin-redaction)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Gem Version](https://badge.fury.io/rb/fluent-plugin-redaction.svg)](http://badge.fury.io/rb/fluent-plugin-redaction)
+![](https://ruby-gem-downloads-badge.herokuapp.com/fluent-plugin-redaction?type=total&metric=true)
+
+## Requirements
+
+| fluent-plugin-redaction | fluentd | ruby |
+|------------------------|---------|------|
+| >= 0.1.0 | >= v0.14.0 | >= 2.4 |
+
+## Overview
+
+## Installation
+
+Install from RubyGems:
+```
+$ gem install fluent-plugin-redaction
+```
+
+## Configuration
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,14 @@
+
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.test_files = FileList['test/plugin/test_*.rb']
+  test.verbose = true
+end
+
+task :default => [:build]
+

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/fluent-plugin-redaction.gemspec

@@ -0,0 +1,23 @@
+# encoding: utf-8
+$:.push File.expand_path('../lib', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name = "fluent-plugin-redaction"
+  gem.description = "Fluentd redaction filter plugin for anonymize specific strings in text data."
+  gem.license = "MIT License"
+  gem.homepage = "https://github.com/oleewere/fluent-plugin-redaction"
+  gem.summary = gem.description
+  gem.version = File.read("VERSION").strip
+  gem.authors = ["Oliver Szabo"]
+  gem.email = ["oleewere@gmail.com"]
+  #gem.platform    = Gem::Platform::RUBY
+  gem.files = `git ls-files`.split("\n")
+  gem.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.executables = `git ls-files -- bin/*`.split("\n").map {|f| File.basename(f)}
+  gem.require_paths = ['lib']
+
+  gem.add_runtime_dependency 'fluentd', ['>= 1.0', '< 2']
+  gem.add_development_dependency "rake",      ["~> 11.0"]
+  gem.add_development_dependency 'test-unit', '~> 3.3', '>= 3.3.3'
+  gem.add_development_dependency 'test-unit-rr', '~> 1.0', '>= 1.0.5'
+end

data/lib/fluent/plugin/filter_redaction.rb

@@ -0,0 +1,68 @@
+require 'json'
+
+module Fluent
+    module Plugin
+        class RedactionFilter < Fluent::Plugin::Filter
+            Fluent::Plugin.register_filter("redaction", self)
+
+            helpers :record_accessor
+
+            config_section :rule, param_name: :rule_config_list, required: true, multi: true do
+                config_param :key, :string, default: nil
+                config_param :value, :string, default: nil
+                config_param :pattern, :regexp, default: nil
+                config_param :replacement, :string, default: "[REDACTED]"
+            end
+
+            def initialize
+                @pattern_rules_map = {}
+                @accessors = {}
+                super
+            end
+          
+            def configure(conf)
+                super
+
+                @rule_config_list.each do |c|
+                    unless c.key
+                        key_missing = true
+                    end
+                    if key_missing
+                        raise Fluent::ConfigError, "Field 'key' is missing from rule section. #{c}"
+                    end
+                    unless c.value || c.pattern
+                        value_missing = true
+                    end
+                    if value_missing
+                        raise Fluent::ConfigError, "Field 'value' or 'pattern' is missing from rule section for key: #{c.key}."
+                    end
+                    record_accessor = record_accessor_create(c.key)
+                    @accessors["#{c.key}"] = record_accessor
+                    list = []
+                    if @pattern_rules_map.key?(c.key)
+                        list = @pattern_rules_map[c.key]
+                    end
+                    list << [c.value, c.pattern, c.replacement]
+                    @pattern_rules_map[c.key] = list
+                end
+            end
+
+            def filter(tag, time, record)
+                @pattern_rules_map.each do |key, rules|
+                    record_value = @accessors[key].call(record)
+                    if record_value
+                        rules.each do | rule |
+                            if rule[0]
+                                record_value = record_value.gsub(rule[0], rule[2])
+                            else
+                                record_value = record_value.gsub(rule[1], rule[3])
+                            end
+                        end
+                        record[key] = record_value
+                    end
+                end
+                record
+            end
+        end
+    end
+end

data/test/helper.rb

@@ -0,0 +1,8 @@
+$LOAD_PATH.unshift(File.expand_path("../../", __FILE__))
+require "test-unit"
+require "fluent/test"
+require "fluent/test/driver/output"
+require "fluent/test/helpers"
+
+Test::Unit::TestCase.include(Fluent::Test::Helpers)
+Test::Unit::TestCase.extend(Fluent::Test::Helpers)

data/test/plugin/test_filter_redaction.rb

@@ -0,0 +1,57 @@
+require 'bundler/setup'
+require 'test/unit'
+require 'fluent/log'
+require 'fluent/test'
+require 'fluent/test/driver/filter'
+require 'fluent/plugin/filter_redaction'
+
+class RubyFilterTest < Test::Unit::TestCase
+  include Fluent
+
+  CONFIG = %[
+    key message
+    value hell
+    <rule>
+      key message
+      value hell
+    </rule>
+  ]
+
+  PATTERN_CONFIG = %[
+    key message
+    pattern /(hell)/
+    <rule>
+      key message
+      value hell
+    </rule>
+  ]
+
+  setup do
+    Fluent::Test.setup
+  end
+
+  def emit(msg, conf='')
+    d = Test::Driver::Filter.new(Plugin::RedactionFilter).configure(conf)
+    d.run(default_tag: 'test') {
+      d.feed(msg)
+    }
+    d.filtered
+  end
+
+  sub_test_case 'filter' do
+    test 'Filter hell from hello messages with simple value' do
+      msg = {'message' => 'hello hello'}
+      es  = emit(msg, CONFIG)
+      assert_equal("[REDACTED]o [REDACTED]o", "#{es[0][1]["message"]}")
+    end
+  end
+
+  sub_test_case 'filter' do
+    test 'Filter hell from hello messages with pattern' do
+      msg = {'message' => 'hello hello'}
+      es  = emit(msg, PATTERN_CONFIG)
+      assert_equal("[REDACTED]o [REDACTED]o", "#{es[0][1]["message"]}")
+    end
+  end
+
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-redaction
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Oliver Szabo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-01-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.3
+- !ruby/object:Gem::Dependency
+  name: test-unit-rr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+description: Fluentd redaction filter plugin for anonymize specific strings in text
+  data.
+email:
+- oleewere@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- Makefile
+- README.md
+- Rakefile
+- VERSION
+- fluent-plugin-redaction.gemspec
+- lib/fluent/plugin/filter_redaction.rb
+- test/helper.rb
+- test/plugin/test_filter_redaction.rb
+homepage: https://github.com/oleewere/fluent-plugin-redaction
+licenses:
+- MIT License
+metadata: {}
+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.1
+signing_key: 
+specification_version: 4
+summary: Fluentd redaction filter plugin for anonymize specific strings in text data.
+test_files:
+- test/helper.rb
+- test/plugin/test_filter_redaction.rb