logasm 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 440665fe491c115f43c411822de433ead259e193
-  data.tar.gz: 06568509dacd084a9607ac545b3cfd03447947db
+  metadata.gz: 84be42eae2bfa1a843ae47eddbc3108c4737af01
+  data.tar.gz: 98b03a785863f5d3b5de1f12034c92b021f405c6
 SHA512:
-  metadata.gz: 380b1118c988bbf141b9c03a63ca3c68d33f1f8873709bd92d5e52188dfb3adf980edf7d040eca62c2bdbc66fb4a142e0906e2272aa278cceb4109d6c88e52a2
-  data.tar.gz: b93a280171c1123d5559ac630a5db52710cd429a7f5bbaddbb73885f7aa75d287d21b117ca3a8fe75b6a2399667c05bcb1631ce889795f2b493036f664742992
+  metadata.gz: 9070dfcd0b7cc887010692cd9bcee48d45410299681e5a6ca5ab8a967a55f5f5c41700b7e0b8880f7d434c0768ff12892faaa4db7f10df494e1c0cc4e5538faa
+  data.tar.gz: b62a0781c1be451843cb9ae2f6f668540555135f0159f808468d9237ad136490c085307a662c08c9e0b7d6af6c2d5eb9058ea9a477d20dde28cc9d9dd5fed11a

data/README.md

@@ -108,13 +108,14 @@ Received request {"info":{"phone":"************"}}
 
 Masks all the fields except those whitelisted in the configuration using [JSON Pointer](https://tools.ietf.org/html/rfc6901).
 Only simple values(`string`, `number`, `boolean`) can be whitelisted.
+Whitelisting array elements can be done using wildcard symbol `~`.
 
 #### Configuration
 
 ```yaml
 preprocessors:
   whitelist:
-    pointers: ['/info/phone']
+    pointers: ['/info/phone', '/addresses/~/host']
 ```
 
 #### Usage
@@ -122,7 +123,7 @@ preprocessors:
 ```ruby
 logger = Logasm.build(application_name, logger_config, preprocessors)
 
-input = {password: 'password', info: {phone: '+12055555555'}}
+input = {password: 'password', info: {phone: '+12055555555'}, addresses: [{host: 'example.com', path: 'info'}]}
 
 logger.debug("Received request", input)
 ```
@@ -130,5 +131,5 @@ logger.debug("Received request", input)
 Logger output:
 
 ```
-Received request {password: "********", "info":{"phone":"+12055555555"}}
+Received request {password: "********", "info": {"phone": "+12055555555"}, "addresses": [{"host": "example.com","path": "****"}]}
 ```

data/lib/logasm/preprocessors/whitelist.rb

@@ -4,16 +4,24 @@ class Logasm
 
       DEFAULT_WHITELIST = %w(/id /message /correlation_id /queue)
       MASK_SYMBOL = '*'
+      WILDCARD = '~'
 
       class InvalidPointerFormatException < Exception
       end
 
       def initialize(config = {})
         pointers = (config[:pointers] || []) + DEFAULT_WHITELIST
-        @fields_to_include = pointers.inject({}) do |mem, pointer|
-          validate_pointer(pointer)
-          mem.merge(decode(pointer) => true)
+        decoded_pointers = pointers
+          .each(&method(:validate_pointer))
+          .map(&method(:decode))
+        @fields_to_include = decoded_pointers.inject({}) do |mem, pointer|
+          mem.merge(pointer => true)
         end
+        @wildcards = decoded_pointers
+          .select(&method(:has_wildcard?))
+          .inject({}) do |mem, pointer|
+            mem.merge(get_wildcard_roots_of(pointer))
+          end
       end
 
       def process(data)
@@ -22,6 +30,34 @@ class Logasm
 
       private
 
+
+      def has_wildcard?(pointer)
+        pointer.include?("/#{WILDCARD}/") || pointer.end_with?("/#{WILDCARD}")
+      end
+
+      # From a pointer with wildcards builds a hash with roots that contains a wildcard. Hash is used to easily match
+      # find if hash element matches the pointer while processing the log.
+      #
+      # Example:
+      #
+      # Input:
+      #   "/array/~/nested_array/~/fields"
+      #
+      # Output:
+      # {
+      #   "/array/~/nested_array/~" => true,
+      #   "/array/~" => true
+      # }
+      #
+      def get_wildcard_roots_of(pointer)
+        if (index = pointer.rindex("/#{WILDCARD}/"))
+          wildcard_root = pointer.slice(0, index + 2)
+          get_wildcard_roots_of(wildcard_root).merge(wildcard_root => true)
+        else
+          {pointer => true}
+        end
+      end
+
       def validate_pointer(pointer)
         if pointer.slice(-1) == '/'
           raise InvalidPointerFormatException.new('Pointer should not contain trailing slash')
@@ -30,8 +66,8 @@ class Logasm
 
       def decode(pointer)
         pointer
-          .gsub('~0', '~')
           .gsub('~1', '/')
+          .gsub('~0', '~')
       end
 
       def process_data(parent_pointer, data)
@@ -57,8 +93,14 @@ class Logasm
       end
 
       def process_array(parent_pointer, array)
+        create_child_pointer =
+          if @wildcards["#{parent_pointer}/~"]
+            lambda { |_| "#{parent_pointer}/~" }
+          else
+            lambda { |index| "#{parent_pointer}/#{index}" }
+          end
         array.each_with_index.inject([]) do |mem, (value, index)|
-          pointer = "#{parent_pointer}/#{index}"
+          pointer = create_child_pointer.call(index)
           processed_value = process_data(pointer, value)
           mem + [processed_value]
         end

data/logasm.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |gem|
   gem.name          = "logasm"
-  gem.version       = '0.3.0'
+  gem.version       = '0.4.0'
   gem.authors       = ["Salemove"]
   gem.email         = ["support@salemove.com"]
   gem.description   = %q{It's logasmic}

data/spec/preprocessors/whitelist_spec.rb

@@ -74,6 +74,30 @@ describe Logasm::Preprocessors::Whitelist do
     end
   end
 
+  context 'with whitelisted array elements field with wildcard' do
+    let(:data) {{
+      array: [{field: 'data1', secret: 'secret1'}, {field: 'data2', secret: 'secret2'}]
+    }}
+    let(:pointers) { ['/array/~/field'] }
+
+    it 'includes array elements field' do
+      expect(processed_data).to include(
+        array: [{field: 'data1', secret: '*******'}, {field: 'data2', secret: '*******'}]
+      )
+    end
+  end
+
+  context 'with whitelisted string array elements with wildcard' do
+    let(:data) {{
+      array: ['secret', 'secret']
+    }}
+    let(:pointers) { ['/array/~'] }
+
+    it 'includes array elements' do
+      expect(processed_data).to include(array: ['secret', 'secret'])
+    end
+  end
+
   context 'with whitelisted array element' do
     let(:pointers) { ['/array/0'] }
 
@@ -149,4 +173,15 @@ describe Logasm::Preprocessors::Whitelist do
       expect(processed_data).to include('field_with_~'=> 'secret')
     end
   end
+  
+  context 'when field has tilde and 1' do
+    let(:data) {{
+      'field_with_~1' => 'secret'
+    }}
+    let(:pointers) { ['/field_with_~01'] }
+
+    it 'includes field' do
+      expect(processed_data).to include('field_with_~1'=> 'secret')
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logasm
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Salemove
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-18 00:00:00.000000000 Z
+date: 2016-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: inflecto
@@ -124,7 +124,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: What description said