fluent-plugin-sanitizer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b4955af12965cbeeb185d2d62e6049804e063d679a64f6aabf392ec2413b3545
+  data.tar.gz: 961c45840adf34d58080f978e71b4dd9b562fa87e76766d439fe2f8088377c71
+SHA512:
+  metadata.gz: 9895d0a3cdaa2524affac2ccd33411964948dbc7faefa34d3295d2d8d86bfea36e744615a62de51f24da9519b20fefe3f95155320eb058ad4c4b372c20f09578
+  data.tar.gz: 553c62ebcf205ff05d405ddf054fe36b04adac50236744d1a044b50d50a9cde1f791d5a4812d68fd205b4a4da7b82f3dc0f7f1f3a913d8ede2f7c22a2fb53594

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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,155 @@
+# Overview of fluent-plugin-sanitizer
+The fluent-plugin-sanitzer is [Fluentd](https://fluentd.org/) filter plugin to sanitize sensitive information with custom rules. The fluent-plugin-sanitzer provides not only options to sanitize values with custom regular expression and keywords but also build-in options which allows users to easily sanitize IP addresses and hostnames in complex messages.
+
+## Installation
+When you are using OSS Fluentd :
+```
+fluent-gem install fluent-plugin-sanitizer
+```
+When you are using td-agent :
+```
+td-agent-gem install fluent-plugin-sanitizer
+```
+
+## Configuration
+### Parameters
+- hash_salt : specify hash salt used to sanitize original information (:string, default: nil)
+- rule options
+  - keys : Name of keys whose values are to be sanitized. You can specify multiple keys. When keys are nested, you can use {parent key}.{child key} like "kubernetes.master_url". (:array, default:[])
+  - pattern_ipv4 : sanitize if values contain IPv4. (:bool, default: false)
+  - pattern_fqdn : sanitize if values contain hostname in FQDN style. (:bool, default: false)
+  - pattern_regex : Sanitize if value mactchs custom regular expression (:regexp, default: /^$/)
+  - pattern_keywords : Sanitize if values match custom keywords. You can specify multiple keywords. (:array, default:[])
+
+You can specify multiple options in a single rule like following sample configuration.
+  
+```
+<filter **>
+  @type sanitizer
+  hash_salt mysalt
+  <rule>
+    keys source, kubernetes.master_url
+    pattern_ipv4 true
+  </rule>
+  <rule>
+    keys hostname, host
+    pattern_fqdn true
+  </rule>
+  <rule>
+    keys message, system.log
+    pattern_regex /^Hello World!$/
+    pattern_keywords password, passwd
+  </rule>
+</filter>
+```
+
+## Use cases
+
+### Sanitize IP address and hostname
+Sample rule #1
+```
+<rule>
+  keys ip
+  pattern_ipv4 true
+</rule>
+<rule>
+  keys host
+  pattern_fqdn true
+</rule>
+```
+Sample input #1
+```
+{
+  "ip":"192.168.10.10",
+  "host":"test01.demo.com"
+} 
+```
+Sample output #1
+```
+{
+  "ip":"IPv4_94712b06963e277fe28469388323665d",
+  "host":"FQDN_37de34e3d799de477c742d8d7bb35550"
+}
+```
+
+### Sanitize IP addresses and hostnames in between URL and messages
+You may sanitize IP addresses and hostnames in URL and messages. The "pattern_ipv4" and "pattern_fqdn" options can help you easily to sanitize information in such cases.
+
+Sample rule #2
+```
+<rule>
+  keys system.url, system.log
+  pattern_ipv4 true
+  pattern_fqdn true
+</rule>
+```
+Sample input #2
+```
+{
+  "tag":"test", 
+  "system" : 
+  {
+    "url":"https://test02.demo.com:8000/event", 
+    "log":"access from 192.168.10.100 was blocked"
+  }
+}
+```
+Sample output #3
+```
+{
+  "tag":"test",
+  "system":{
+    "url":"https://FQDN_e9a59624f555d02f06209c9942dded19:8000/event",
+    "log":"access from IPv4_f7374d61e6d21dc1105f70358a5f8e8f was blocked"
+  }
+}
+```
+### Sanitize keywords in between messages
+When "pattern_keywords" option is selected, fluent-plugin-sanitizer splits messages and sanitizes blocks which match keywords.
+Sample rule#3
+```
+<rule>
+  keys message
+  pattern_keywords user1, application1
+</rule>
+```
+Sample input #3
+```
+{
+  "message":"user1 failed to login application1"
+}
+```
+Sample output #3
+```
+{
+  "message":"Keyword_321865df6f0ce6bdf3ea16f74623534a failed to login Keyword_49006ff9b2ab584795e4cbb7636bd17c"
+}
+```
+### Sanitize all messages
+Sample rule #4
+```
+<rule>
+  keys message
+  pattern_regex /^.*$/
+</rule>
+```
+Sample input#4
+```
+{
+  "message":"user1 failed to login application1"
+}
+```
+Sample output #4
+```
+{
+  "message":"Regex_70e9b833f5f00a4b0ab9fcf74af81f26"
+}
+```
+## Contribute
+Contribution to fluent-plugin-sanitizer is always welcomed.
+
+
+## Copyright
+* Copyright(c) 2021- TK Kubota
+* License
+  * Apache License, Version 2.0

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler"
+Bundler::GemHelper.install_tasks
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs.push("lib", "test")
+  t.test_files = FileList["test/**/test_*.rb"]
+  t.verbose = true
+  t.warning = true
+end
+
+task default: [:test]

data/fluent-plugin-sanitizer.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name    = "fluent-plugin-sanitizer"
+  spec.version = "0.1.0"
+  spec.authors = ["TK Kubota"]
+  spec.email   = ["tkubota@ctc-america.com"]
+
+  spec.summary       = %q{Filter plugin of Fluentd which sanitize sensitive information.}
+  spec.description   = %q{The fluent-plugin-sanitzer is Fluentd filter plugin to sanitize sensitive information with custom rules. The fluent-plugin-sanitzer provides not only options to sanitize values with custom regular expression and keywords but also build-in options which allows users to easily sanitize IP addresses and hostnames in complex messages.}
+  spec.homepage      = "https://github.com/fluent/fluent-plugin-sanitizer"
+  spec.license       = "Apache-2.0"
+
+  test_files, files  = `git ls-files -z`.split("\x0").partition do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.files         = files
+  spec.executables   = files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = test_files
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "test-unit", "~> 3.0"
+  spec.add_runtime_dependency "fluentd", [">= 0.14.10", "< 2"]
+end

data/lib/fluent/plugin/filter_sanitizer.rb

@@ -0,0 +1,311 @@
+#
+# Copyright 2021- TK Kubota
+#
+# 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.
+
+require "fluent/plugin/filter"
+require "digest"
+
+module Fluent
+  module Plugin
+    class SanitizerFilter < Fluent::Plugin::Filter
+      Fluent::Plugin.register_filter("sanitizer", self)
+
+      helpers :event_emitter, :record_accessor
+
+      desc "Hash salt to be used to generate hash values with MD5(optional)"
+      config_param :hash_salt, :string, default: nil
+      
+      config_section :rule, param_name: :rules, multi: true do 
+        desc "Name of keys whose valuse are to be sanitized"
+        config_param :keys, :array, default: []
+        desc "Sanitize if values contain IPv4 (optional)"
+        config_param :pattern_ipv4, :bool, default: false
+        desc "Sanitize if values contain Hostname in FQDN style (ptional)"
+        config_param :pattern_fqdn, :bool, default: false
+        desc "Sanitize if values mactch custom regular expression (optional)"
+        config_param :pattern_regex, :regexp, default: /^$/
+        desc "Sanitize if values mactch custom keywords (optional)"
+        config_param :pattern_keywords, :array, default: []
+      end
+
+      def configure(conf)
+        super
+      
+        @salt = ""
+        @salt = conf['hash_salt'] if conf['hash_salt'] != nil
+ 
+        @sanitizerules = []
+        @rules.each do |rule|
+          if rule.keys.empty?
+            raise Fluent::ConfigError, "You need to specify at least one key in rule statement."
+          else
+            keys = rule.keys
+          end
+          
+          if rule.pattern_ipv4 == true || rule.pattern_ipv4 == false
+            pattern_ipv4 = rule.pattern_ipv4
+          else
+            raise Fluent::ConfigError, "true or false is available for pattern_ipv4 option."
+          end
+ 
+          if rule.pattern_fqdn == true || rule.pattern_fqdn == false
+            pattern_fqdn = rule.pattern_fqdn
+          else
+            raise Fluent::ConfigError, "true or false is available for pattern_fqdn option."
+          end
+        
+          pattern_regex = rule.pattern_regex
+          pattern_keywords = rule.pattern_keywords
+
+          case [pattern_ipv4, pattern_fqdn, pattern_regex, pattern_keywords.empty?]
+          when [false, false, /^$/, true]
+            raise Fluent::ConfigError, "You need to specify at least one pattern option in the rule statement." 
+          end
+          @sanitizerules.push([keys, pattern_ipv4, pattern_fqdn, pattern_regex, pattern_keywords])
+        end
+      end
+
+      def filter(tag, time, record)
+        @sanitizerules.each do |keys, pattern_ipv4, pattern_fqdn, pattern_regex, pattern_keywords|  
+          keys.each do |key|
+            if key.include?(".")
+              nkey = key.split(".")
+              if nkey.length ==2
+                if record[nkey[0]].key?(nkey[1])
+                  v = record[nkey[0]][nkey[1]]
+                  record[nkey[0]][nkey[1]] = sanitize_ipv4_val(@salt, record[nkey[0]][nkey[1]]) if pattern_ipv4 == true
+                  record[nkey[0]][nkey[1]] = sanitize_fqdn_val(@salt, record[nkey[0]][nkey[1]]) if pattern_fqdn == true
+                  record[nkey[0]][nkey[1]] = sanitize_regex(@salt, record[nkey[0]][nkey[1]]) if is_regex?(pattern_regex) && !!(pattern_regex =~ record[nkey[0]][nkey[1]])
+                  record[nkey[0]][nkey[1]] = sanitize_keyword(@salt, pattern_keywords, record[nkey[0]][nkey[1]]) if pattern_keywords.empty? == false
+                else
+                  $log.error "no such nested key found : key name = #{key}" 
+                end
+              elsif nkey.length ==3
+                if record[nkey[0]][nkey[1]].key?(nkey[2])
+                  v = record[nkey[0]][nkey[1]][nkey[2]]
+                  record[nkey[0]][nkey[1]][nkey[2]] = sanitize_ipv4_val(@salt, record[nkey[0]][nkey[1]][nkey[2]]) if pattern_ipv4 == true
+                  record[nkey[0]][nkey[1]][nkey[2]] = sanitize_fqdn_val(@salt, record[nkey[0]][nkey[1]][nkey[2]]) if pattern_fqdn == true
+                  record[nkey[0]][nkey[1]][nkey[2]] = sanitize_regex(@salt, record[nkey[0]][nkey[1]][nkey[2]]) if is_regex?(pattern_regex) && !!(pattern_regex =~ record[nkey[0]][nkey[1]][nkey[2]])
+                  record[nkey[0]][nkey[1]][nkey[2]] = sanitize_keyword(@salt, pattern_keywords, record[nkey[0]][nkey[1]][nkey[2]]) if pattern_keywords.empty? == false
+                else
+                  $log.error "no such nested key found : key name = #{key}"
+                end
+              end
+            else
+              if record.key?(key)
+                v = record[key]
+                record[key] = sanitize_ipv4_val(@salt, record[key]) if pattern_ipv4 == true
+                record[key] = sanitize_fqdn_val(@salt, record[key]) if pattern_fqdn == true
+                record[key] = sanitize_regex(@salt, v) if is_regex?(pattern_regex) && !!(pattern_regex =~ record[key])
+                record[key] = sanitize_keyword_val(@salt, pattern_keywords, v) if pattern_keywords.empty? == false
+              else
+                $log.error "no such key found : key name = #{key}"
+              end
+            end
+          end
+        end
+        record
+      end
+
+      def include_ipv4?(str)
+        !!(str =~ /^.*\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}.*$/)
+      end
+
+      def is_ipv4?(str)
+        !!(str =~ /^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$/)
+      end
+
+      def is_ipv4_port?(str)
+        !!(str =~ /^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}:[0-9]{1,5}$/)
+      end
+
+      def include_fqdn?(str)
+        !!(str =~ /^.*\b(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.){2,}([A-Za-z]|[A-Za-z][A-Za-z\-]*[A-Za-z]){2,}.*$/)
+      end
+
+      def is_fqdn?(str)
+        !!(str =~ /^\b(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.){2,}([A-Za-z]|[A-Za-z][A-Za-z\-]*[A-Za-z]){2,}$/)
+      end
+
+      def is_fqdn_port?(str)
+        !!(str =~ /^\b(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.){2,}([A-Za-z]|[A-Za-z][A-Za-z\-]*[A-Za-z]){2,}:[0-9]{1,5}$/)
+      end
+
+      def is_url?(str)
+        !!(str =~ /^[a-zA-Z0-9]{2,}:\/\/.*$/)
+      end
+
+      def is_regex?(regex)
+        return regex.class == Regexp
+      end
+
+      def subtract_quotations(str)
+        return str.gsub(/\\\"|\'|\"|\\\'/,'')
+      end
+
+      def sanitize_ipv4(salt, str)
+        return str, "IPv4_"+Digest::MD5.hexdigest(salt + str)
+      end
+
+      def sanitize_fqdn(salt, str)
+        return str, "FQDN_"+Digest::MD5.hexdigest(salt + str)
+      end
+
+      def sanitize_regex(salt, str)
+        return "Regex_"+Digest::MD5.hexdigest(salt + str)
+      end
+      
+      def sanitize_keyword(salt, str)
+        return "Keyword_"+Digest::MD5.hexdigest(salt + str)
+      end
+
+      def sanitize_ipv4_port(salt, str)
+        ip_port = []
+        str.split(":").each do |s|
+          b, s =  sanitize_ipv4(salt, s) if is_ipv4?(s)
+          ip_port.push(s)
+        end
+        return str, ip_port.join(":")
+      end
+
+      def sanitize_fqdn_port(salt, str)
+        fqdn_port = []
+        str.split(":").each do |s|
+          b, s =  sanitize_fqdn(salt, s) if is_fqdn?(s)
+          fqdn_port.push(s)
+        end
+        return str, fqdn_port.join(":")
+      end
+
+      def sanitize_ipv4_url(salt, str)
+        ip_url = []
+        str.split("://").each do |s|
+          if s.include?("/")
+            url_slash = []
+            s.split("/").each do |ss|
+              b, ss = sanitize_ipv4(salt, ss) if is_ipv4?(ss)
+              b, ss = sanitize_ipv4_port(salt, ss) if is_ipv4_port?(ss)
+              url_slash.push(ss)
+            end
+            s = url_slash.join("/")
+          else
+            b, s = sanitize_ipv4(salt, s) if is_ipv4?(s)
+            b, s = sanitize_ipv4_port(salt, s) if is_ipv4_port?(s)
+          end
+          ip_url.push(s)
+        end
+        return str, ip_url.join("://")
+      end
+
+      def sanitize_fqdn_url(salt, str)
+        fqdn_url = []
+        str.split("://").each do |s|
+          if s.include?("/")
+            url_slash = []
+            s.split("/").each do |ss|
+              b, ss = sanitize_fqdn(salt, ss) if is_fqdn?(ss)
+              b, ss = sanitize_fqdn_port(salt, ss) if is_fqdn_port?(ss)
+              url_slash.push(ss)
+            end
+            s = url_slash.join("/")
+          else
+            b, s = sanitize_fqdn(salt, s) if is_fqdn?(s)
+            b, s = sanitize_fqdn_port(salt, s) if is_fqdn_port?(s)
+          end
+          fqdn_url.push(s)
+        end
+        return str, fqdn_url.join("://")
+      end
+
+      def sanitize_ipv4_val(salt, v)
+        line = []
+        if v.include?(",")
+          v.split(",").each do |s|
+            s = subtract_quotations(s)
+            if include_ipv4?(s)
+              if is_url?(s)
+                b, s = sanitize_ipv4_url(salt, s)
+              else
+                b, s = sanitize_ipv4(salt, s) if is_ipv4?(s)
+                b, s = sanitize_ipv4_port(salt, s) if is_ipv4_port?(s)
+              end
+            end
+            line.push(s)
+          end
+          return line.join(",")
+        else
+          v.split().each do |s|
+            s = subtract_quotations(s)
+            if include_ipv4?(s)
+              if is_url?(s)
+                b, s = sanitize_ipv4_url(salt, s)
+              else
+                b, s = sanitize_ipv4(salt, s) if is_ipv4?(s)
+                b, s = sanitize_ipv4_port(salt, s) if is_ipv4_port?(s)
+              end
+            end
+            line.push(s)
+          end
+          return line.join(" ")
+        end
+      end
+
+      def sanitize_fqdn_val(salt, v)
+        line = []
+        if v.include?(",")
+          v.split(",").each do |s|
+            s = subtract_quotations(s)
+            if include_fqdn?(s)
+              if is_url?(s)
+                b, s = sanitize_fqdn_url(salt, s)
+              else
+                b, s = sanitize_fqdn(salt, s) if is_fqdn?(s)
+                b, s = sanitize_fqdn_port(salt, s) if is_fqdn_port?(s)
+              end
+            end
+            line.push(s)
+          end
+          return line.join(",")
+        else
+          v.split().each do |s|
+            s = subtract_quotations(s)
+            if include_fqdn?(s)
+              if is_url?(s)
+                b, s = sanitize_fqdn_url(salt, s)
+              else
+                b, s = sanitize_fqdn(salt, s) if is_fqdn?(s)
+                b, s = sanitize_fqdn_port(salt, s) if is_fqdn_port?(s)
+              end
+            end
+            line.push(s)
+          end
+          return line.join(" ")
+        end
+      end
+
+      def sanitize_keyword_val(salt, keywords, v)
+        line = []
+        v.split().each do |vv|
+          if keywords.include?(vv)
+            line.push(sanitize_keyword(salt, vv))
+          else
+            line.push(vv)
+           end
+        end
+        return line.join(" ")
+      end
+
+    end
+  end
+end

data/test/Gemfile

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

data/test/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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/test/README.md

@@ -0,0 +1,43 @@
+# fluent-plugin-sanitizer
+
+[Fluentd](https://fluentd.org/) filter plugin to do something.
+
+TODO: write description for you plugin.
+
+## Installation
+
+### RubyGems
+
+```
+$ gem install fluent-plugin-sanitizer
+```
+
+### Bundler
+
+Add following line to your Gemfile:
+
+```ruby
+gem "fluent-plugin-sanitizer"
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+## Configuration
+
+You can generate configuration template:
+
+```
+$ fluent-plugin-config-format filter sanitizer
+```
+
+You can copy and paste generated documents here.
+
+## Copyright
+
+* Copyright(c) 2021- TODO: Write your name
+* License
+  * Apache License, Version 2.0

data/test/Rakefile

@@ -0,0 +1,13 @@
+require "bundler"
+Bundler::GemHelper.install_tasks
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs.push("lib", "test")
+  t.test_files = FileList["test/**/test_*.rb"]
+  t.verbose = true
+  t.warning = true
+end
+
+task default: [:test]

data/test/fluent-plugin-sanitizer.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name    = "fluent-plugin-sanitizer"
+  spec.version = "0.1.0"
+  spec.authors = ["TODO: Write your name"]
+  spec.email   = ["TODO: Write your email"]
+
+  spec.summary       = %q{TODO: Write a short summary, because Rubygems requires one.}
+  spec.description   = %q{TODO: Write a longer description or delete this line.}
+  spec.homepage      = "TODO: Put your gem's website or public repo URL here."
+  spec.license       = "Apache-2.0"
+
+  test_files, files  = `git ls-files -z`.split("\x0").partition do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.files         = files
+  spec.executables   = files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = test_files
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "test-unit", "~> 3.0"
+  spec.add_runtime_dependency "fluentd", [">= 0.14.10", "< 2"]
+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/filter"
+require "fluent/test/helpers"
+
+Test::Unit::TestCase.include(Fluent::Test::Helpers)
+Test::Unit::TestCase.extend(Fluent::Test::Helpers)

data/test/lib/fluent/plugin/filter_sanitizer.rb

@@ -0,0 +1,27 @@
+#
+# Copyright 2021- TODO: Write your name
+#
+# 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.
+
+require "fluent/plugin/filter"
+
+module Fluent
+  module Plugin
+    class SanitizerFilter < Fluent::Plugin::Filter
+      Fluent::Plugin.register_filter("sanitizer", self)
+
+      def filter(tag, time, record)
+      end
+    end
+  end
+end

data/test/plugin/test_filter_sanitizer.rb

@@ -0,0 +1,18 @@
+require "helper"
+require "fluent/plugin/filter_sanitizer.rb"
+
+class SanitizerFilterTest < Test::Unit::TestCase
+  setup do
+    Fluent::Test.setup
+  end
+
+  test "failure" do
+    flunk
+  end
+
+  private
+
+  def create_driver(conf)
+    Fluent::Test::Driver::Filter.new(Fluent::Plugin::SanitizerFilter).configure(conf)
+  end
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-sanitizer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- TK Kubota
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-01-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.10
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.10
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+description: The fluent-plugin-sanitzer is Fluentd filter plugin to sanitize sensitive
+  information with custom rules. The fluent-plugin-sanitzer provides not only options
+  to sanitize values with custom regular expression and keywords but also build-in
+  options which allows users to easily sanitize IP addresses and hostnames in complex
+  messages.
+email:
+- tkubota@ctc-america.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- fluent-plugin-sanitizer.gemspec
+- lib/fluent/plugin/filter_sanitizer.rb
+- test/Gemfile
+- test/LICENSE
+- test/README.md
+- test/Rakefile
+- test/fluent-plugin-sanitizer.gemspec
+- test/helper.rb
+- test/lib/fluent/plugin/filter_sanitizer.rb
+- test/plugin/test_filter_sanitizer.rb
+homepage: https://github.com/fluent/fluent-plugin-sanitizer
+licenses:
+- Apache-2.0
+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.7.6.2
+signing_key: 
+specification_version: 4
+summary: Filter plugin of Fluentd which sanitize sensitive information.
+test_files:
+- test/Gemfile
+- test/LICENSE
+- test/README.md
+- test/Rakefile
+- test/fluent-plugin-sanitizer.gemspec
+- test/helper.rb
+- test/lib/fluent/plugin/filter_sanitizer.rb
+- test/plugin/test_filter_sanitizer.rb