fluent-plugin-masking 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eac8728e8ab2116246c15dc8b97352fb317b0c774d4cbd19e2578f2d426fd5de
-  data.tar.gz: a9dc09d8ed9b0d72285e1bd9c10bbcc825e33b097090a7afb286a8841a0b4d28
+  metadata.gz: 3af98b34958dbe69aded48cc35ea83ebeada5e020773f041dcf0f787ce70dfdf
+  data.tar.gz: 7a19b3898868e5bc8d6118419287c59f777be1d56cf177aa059df29c4d13edaa
 SHA512:
-  metadata.gz: effefbecab3678855e6ca8e903c9eac426a5d27b62be6e3931c625a7abd40c9c4aafcdded96b6b28dcdaa2b905228e6f5705b62c5d81ce5c9a15970a24c4fe58
-  data.tar.gz: f17f1fd48b7484668a8210994a26cdc73c603a9106d3e1f4a4fb8f793029496458e962f9e2fe2462fb607d54c1526655402271054e43fbd1df7135469f7b5d1b
+  metadata.gz: 874630b83c4dc1131521af3444c3f3bc1d1638a929e73049817cfdacfb55353587c8d1bfa424ebee4b3669d3c488ee38a5ae74b88ec545ef1e64d92a963ffd5f
+  data.tar.gz: 8574105ab4603323527e4d5d000043dd0c201990530afec23634f3195b815cacd6853748d60c0855eadbf26baafd718a0f3239b5289e0b906353c6be06063b86

data/.gitignore

@@ -1,3 +1,4 @@
 .bundle/
 vendor/
-*.gem
+*.gem
+.idea/

data/.gitlab-ci.yml

@@ -11,24 +11,24 @@ before_script:
   - bundle install -j $(nproc) --path vendor  # Install dependencies into ./vendor/ruby
 
 stages:
-- test
-- release
+  - test
+  - release
 
 variables:
   DOCKER_TLS_CERTDIR: ""
 
 unit-test:
   tags:
-  - dcos-multi-runner
+    - dcos-multi-runner
   stage: test
   script:
-  - bundle exec rake test
+    - bundle exec rake test
   except:
-  - tags
+    - tags
 
 .release: &release
   tags:
-  - dcos-multi-runner
+    - dcos-multi-runner
   stage: release
   before_script:
     - echo "Setup ssh inside the runner.."
@@ -45,19 +45,17 @@ unit-test:
     - cd $CI_PROJECT_NAME
     - git reset --hard $CI_COMMIT_SHA
   script: 
-  - mkdir -p ~/.gem
-  - 'echo -e "---\n:rubygems_api_key: $GEM_HOST_API_KEY" > ~/.gem/credentials && echo "created gem credentials"'
-  - chmod 0600 ~/.gem/credentials
-  - gem install gem-release
-  - gem bump fluent-plugin-masking --version $TYPE --file ./lib/fluent/plugin/version.rb --commit --push
-  # - gem release fluent-plugin-masking --push --key rubygems_api_key
-  - gem build fluent-plugin-masking.gemspec
-#  - export VERSION=$(gem bump --pretend --file ./lib/fluent/plugin/version.rb --no-commit | awk '{ print $4 }')
-  - export VERSION=$(cat ./lib/fluent/plugin/version.rb | grep VERSION | sed -ne 's/[^0-9]*\(\([0-9]\.\)\{0,4\}[0-9][^.]\).*/\1/p' | sed 's/"$//')
-  - gem push fluent-plugin-masking-$VERSION.gem
+    - mkdir -p ~/.gem
+    - 'echo -e "---\n:rubygems_api_key: $GEM_HOST_API_KEY" > ~/.gem/credentials && echo "created gem credentials"'
+    - chmod 0600 ~/.gem/credentials
+    - gem install gem-release
+    - gem bump fluent-plugin-masking --version $TYPE --file ./lib/fluent/plugin/version.rb --commit --push --tag
+    - gem build fluent-plugin-masking.gemspec
+    - export VERSION=$(cat ./lib/fluent/plugin/version.rb | grep VERSION | sed -ne 's/[^0-9]*\(\([0-9]\.\)\{0,4\}[0-9][^.]\).*/\1/p' | sed 's/"$//')
+    - gem push fluent-plugin-masking-$VERSION.gem
   when: manual
   only:
-  - master
+    - master
   
 release:patch:
   extends: .release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    fluent-plugin-masking (1.0.2)
+    fluent-plugin-masking (1.0.3)
       fluentd (>= 0.14.0, < 2)
 
 GEM

data/lib/fluent/plugin/filter_masking.rb

@@ -16,12 +16,12 @@ module Fluent
       # the original record is return
       def maskRecord(record)
         maskedRecord = record
-
+        
         begin
           recordStr = record.to_s
-
           @fields_to_mask.each do | fieldToMask |
-            recordStr = recordStr.gsub(/"#{fieldToMask}"=>.+?((?=,\s\")|(?=}{1}$))/m, "\"#{fieldToMask}\"=>\"#{MASK_STRING}\"")
+            recordStr = recordStr.gsub(/(?::#{fieldToMask}=>")(.*?)(?:")/m, ":#{fieldToMask}=>\"#{MASK_STRING}\"") # mask element in hash object
+            recordStr = recordStr.gsub(/\\+"#{fieldToMask}\\+":\\+.+?((?=(}\\+",)|,( *|)(\s|\\+)\")|(?=}"$))/m, "\\\"#{fieldToMask}\\\":\\\"#{MASK_STRING}\\\"") # mask element in json string
           end
 
           maskedRecord = strToHash(recordStr)

data/lib/fluent/plugin/version.rb

@@ -1,3 +1,3 @@
 module FilterMasking
-    VERSION = "1.0.3"
+    VERSION = "1.0.4"
 end 

data/test/fields-to-mask

@@ -1,3 +1,5 @@
 email
 first_name
-last_name
+last_name
+street
+number

data/test/test_filter_masking.rb

@@ -6,6 +6,7 @@ require "fluent/test/driver/filter"
 require "fluent/test/helpers"
 require "./lib/fluent/plugin/filter_masking.rb"
 
+
 MASK_STRING = "*******"
 
 class YourOwnFilterTest < Test::Unit::TestCase
@@ -32,59 +33,53 @@ class YourOwnFilterTest < Test::Unit::TestCase
     d.filtered_records
   end
 
-  # sub_test_case 'configured with invalid configuration' do
-  #   test 'empty configuration' do
-  #     assert_raise(Fluent::ConfigError) do
-  #        create_driver('')
-  #     end
-  #   end
-
-  #   test 'param1 should reject too short string' do
-  #     conf = %[
-  #       param1 a
-  #     ]
-  #     assert_raise(Fluent::ConfigError) do
-  #        create_driver(conf)
-  #     end
-  #   end
-  #   # ...
-  # end
-
   sub_test_case 'plugin will mask all fields that need masking' do
-    test 'mask first_name and last_name' do
+    test 'mask field in hash object' do
+      conf = CONFIG
+      messages = [
+        {:not_masked_field=>"mickey-the-dog", :email=>"mickey-the-dog@zooz.com"}
+      ]
+      expected = [
+        {:not_masked_field=>"mickey-the-dog", :email=>MASK_STRING}
+      ]
+      filtered_records = filter(conf, messages)
+      assert_equal(expected, filtered_records)
+    end
+
+    test 'mask field in json string' do
       conf = CONFIG
       messages = [
-        { "first_name" => "mickey", "last_name" => "the-dog" }
+        { :body => "{\"first_name\":\"mickey\",\"last_name\":\"the-dog\", \"type\":\"puggle\"}" }
       ]
       expected = [
-        { "first_name" => MASK_STRING, "last_name" => MASK_STRING }
+        { :body => "{\"first_name\":\"*******\",\"last_name\":\"*******\", \"type\":\"puggle\"}" }
       ]
       filtered_records = filter(conf, messages)
       assert_equal(expected, filtered_records)
     end
 
-    test 'mask only email' do
+    test 'mask field in nested json string' do
       conf = CONFIG
       messages = [
-        { "not_masked_field" => "mickey-the-dog", "email" => "mickey-the-dog@zooz.com" }
+        { :body => "{\"first_name\":\"mickey\",\"last_name\":\"the-dog\",\"address\":\"{\"street\":\"Austin\",\"number\":\"89\"}\", \"type\":\"puggle\"}" } 
       ]
       expected = [
-        { "not_masked_field" => "mickey-the-dog", "email" => MASK_STRING }
+        { :body => "{\"first_name\":\"*******\",\"last_name\":\"*******\",\"address\":\"{\"street\":\"*******\",\"number\":\"*******\"}\", \"type\":\"puggle\"}" }
       ]
       filtered_records = filter(conf, messages)
       assert_equal(expected, filtered_records)
     end
 
-    test 'mask nothing' do
+    test 'mask field in nested json escaped strubg' do
       conf = CONFIG
       messages = [
-        { "not_masked_field_1" => "mickey-the-dog", "not_masked_field_2" => "nully_the_carpet" }
+        { :body => "{\"first_name\":\"mickey\",\"last_name\":\"the-dog\",\"address\":\"{\\\"street\":\\\"Austin\\\",\\\"number\":\\\"89\\\"}\", \"type\":\"puggle\"}" } 
       ]
       expected = [
-        { "not_masked_field_1" => "mickey-the-dog", "not_masked_field_2" => "nully_the_carpet" }
+        { :body => "{\"first_name\":\"*******\",\"last_name\":\"*******\",\"address\":\"{\"street\":\"*******\",\"number\":\"*******\"}\", \"type\":\"puggle\"}" }
       ]
       filtered_records = filter(conf, messages)
       assert_equal(expected, filtered_records)
     end
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-masking
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Shai Moria
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-17 00:00:00.000000000 Z
+date: 2019-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd