fluent-plugin-masking 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: '08a7033570c7aaca9dc0a4830f4550ef5e353b9e5195dc3cfcc79eb68880fcae'
-  data.tar.gz: '0845c7ee9ae72c13652cd9a517a71f0289c88f2144cf2afcad18370c1f1fa358'
+SHA1:
+  metadata.gz: 1c38cb2f6e5f95c87452557e16ccaeedafd724eb
+  data.tar.gz: 3a0e9de85b4ffef48c6760a7071595e0897ed597
 SHA512:
-  metadata.gz: 61a8a367ec559746eee72fd7e33a4d62b6f38777a18b3d5560c82dffcee5c65332ef8fbfd39e018b5dec34930e8a13cdbfa41356a796b4afc9c858eac7ce13d2
-  data.tar.gz: 92b95fad73c342b281ce44d451ce0d52ddcce490d1b0753498671320b38ffb840840b02a44a2ab184d7be0fc636aa2f78ba6dbed6e1a3e8c32f4ebcd71ebe3dd
+  metadata.gz: 29c779485680fde08dd0e5fbe02899380c5002492e191760b4bbd6ca47638dc5dd1bdff19a901bf519b8673bacf1cdb8a63694466aa09a6f36bab981345db112
+  data.tar.gz: 1cdb78f278775ac82204d904669ac67a8b534d56b4ca7d62f5590c01440800f615dfae348a585379494362c6121377c9d6790348e82d2dfba20e52178c22f873

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    fluent-plugin-masking (1.1.0)
+    fluent-plugin-masking (1.1.1)
       fluentd (>= 0.14.0)
 
 GEM
@@ -10,7 +10,7 @@ GEM
     concurrent-ruby (1.1.5)
     cool.io (1.5.4)
     dig_rb (1.0.1)
-    fluentd (1.7.4)
+    fluentd (1.8.0)
       cool.io (>= 1.4.5, < 2.0.0)
       dig_rb (~> 1.0.0)
       http_parser.rb (>= 0.5.1, < 0.7.0)
@@ -18,7 +18,7 @@ GEM
       serverengine (>= 2.0.4, < 3.0.0)
       sigdump (~> 0.2.2)
       strptime (>= 0.2.2, < 1.0.0)
-      tzinfo (~> 2.0)
+      tzinfo (>= 1.0, < 3.0)
       tzinfo-data (~> 1.0)
       yajl-ruby (~> 1.0)
     http_parser.rb (0.6.0)
@@ -45,11 +45,11 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler
+  bundler (= 1.17.3)
   fluent-plugin-masking!
   rake (~> 12.0)
   test-unit (>= 3.1.0)
   test-unit-rr
 
 BUNDLED WITH
-   2.0.2
+   1.17.3

data/fluent-plugin-masking.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.1'
   
   spec.add_runtime_dependency "fluentd", ">= 0.14.0"
-  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "bundler", "1.17.3"
   spec.add_development_dependency "rake", "~> 12.0"
   spec.add_development_dependency "test-unit", ">= 3.1.0"
   spec.add_development_dependency "test-unit-rr"

data/lib/fluent/plugin/filter_masking.rb

@@ -1,8 +1,10 @@
 require 'fluent/filter'
+require './lib/fluent/plugin/helpers.rb'
 
 module Fluent
   module Plugin
     class MaskingFilter < Filter
+      include Helpers
       Fluent::Plugin.register_filter("masking", self) # for "@type masking" in configuration
 
       MASK_STRING = "*******"
@@ -16,13 +18,17 @@ module Fluent
       def maskRecord(record)
         maskedRecord = record
         excludedFields = []
-        @fieldsToExcludeJSONPathsArray.each do | field |
-          field_value = record.dig(*field)
-          if  field_value != nil
-            excludedFields = excludedFields + field_value.split(',')
+        begin
+          @fieldsToExcludeJSONPathsArray.each do | field |
+            field_value = myDig(record, field)
+            if field_value != nil
+              excludedFields = excludedFields + field_value.split(',')
+            end
           end
+        rescue Exception => e
+          $log.error "Failed to find mask exclude record: #{e}"
         end
-        begin 
+        begin
           recordStr = record.to_s
           @fields_to_mask_regex.each do | fieldToMaskRegex, fieldToMaskRegexStringReplacement |
             if !(excludedFields.include? @fields_to_mask_keys[fieldToMaskRegex])

data/lib/fluent/plugin/helpers.rb

@@ -0,0 +1,17 @@
+module Helpers
+  def myDig(input, path)
+    curr = input
+    for segment in path do
+      if curr != nil && curr.is_a?(Hash)
+        if curr[segment] == nil # segment is not a symbol
+          curr = curr[segment.to_s] # segment as string
+        else
+          curr = curr[segment] # segment as symbol
+        end
+      else
+        return nil
+      end
+    end
+    curr
+  end
+end

data/lib/fluent/plugin/version.rb

@@ -1,3 +1,3 @@
 module FilterMasking
-    VERSION = "1.1.0"
+    VERSION = "1.1.1"
 end 

data/test/test_filter_masking.rb

@@ -132,5 +132,16 @@ class YourOwnFilterTest < Test::Unit::TestCase
       filtered_records = filter(conf, messages)
       assert_equal(expected, filtered_records)
     end
+    test 'mask field in json string with exclude' do
+      conf = CONFIG
+      messages = [
+        { :body => "{\"first_name\":\"mickey\",\"last_name\":\"the-dog\", \"type\":\"puggle\"}", :excludedField=>"first_name" }
+      ]
+      expected = [
+        { :body => "{\"first_name\":\"mickey\",\"last_name\":\"*******\", \"type\":\"puggle\"}", :excludedField=>"first_name" }
+      ]
+      filtered_records = filter(conf, messages)
+      assert_equal(expected, filtered_records)
+    end
   end
 end

data/test/test_helpers.rb

@@ -0,0 +1,42 @@
+require "test/unit"
+require "./lib/fluent/plugin/helpers.rb"
+
+class HelpersTest < Test::Unit::TestCase
+  m = Class.new do
+    include Helpers 
+  end.new
+  sub_test_case "myDig function" do
+    test "Call function with nil" do
+      t = m.myDig(nil ,[:a])
+      assert_equal(t, nil)
+    end
+    test "Not found" do
+      t = m.myDig({:b => "t"},[:a])
+      assert_equal(t, nil)
+    end
+    test "Found symbol" do
+      t = m.myDig({:a => "t"},[:a])
+      assert_equal(t, "t")
+    end
+    test "Found string when given symbol" do
+      t = m.myDig({"a" => "t"},[:a])
+      assert_equal(t, "t")
+    end
+    test "Found symbol nested" do
+      t = m.myDig({:a => {:b => "t"}},[:a, :b])
+      assert_equal(t, "t")
+    end
+    test "Found string when given symbol nested" do
+      t = m.myDig({"a" => {"b" => "t"}},[:a, :b])
+      assert_equal(t, "t")
+    end
+    test "Found hybrid string/symbol when given symbol nested" do
+      t = m.myDig({"a" => {:b => "t"}},[:a, :b])
+      assert_equal(t, "t")
+    end
+    test "Does not dig in string" do
+      t = m.myDig({"a" => {:b => "t"}},[:a, :b, :c])
+      assert_equal(t, nil)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-masking
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Shai Moria
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-11 00:00:00.000000000 Z
+date: 2019-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd
@@ -29,16 +29,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.17.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.17.3
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -97,9 +97,11 @@ files:
 - Rakefile
 - fluent-plugin-masking.gemspec
 - lib/fluent/plugin/filter_masking.rb
+- lib/fluent/plugin/helpers.rb
 - lib/fluent/plugin/version.rb
 - test/fields-to-mask
 - test/test_filter_masking.rb
+- test/test_helpers.rb
 homepage: https://github.com/PayU/fluent-plugin-masking
 licenses:
 - Apache-2.0
@@ -119,7 +121,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubyforge_project: 
+rubygems_version: 2.5.2.3
 signing_key: 
 specification_version: 4
 summary: Fluentd filter plugin to mask sensitive or privacy records with `*******`
@@ -128,3 +131,4 @@ summary: Fluentd filter plugin to mask sensitive or privacy records with `******
 test_files:
 - test/fields-to-mask
 - test/test_filter_masking.rb
+- test/test_helpers.rb