qodex-rails 0.1.14 → 0.1.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 33fdd4101a6afdcb2a1379bcb2a832ca25045132668c5c6c156df5645f3965fb
-  data.tar.gz: 9ee4fcd3756c9664006c1c9a628645c0f2197d0e58c85fc165ed63a189ceb08b
+  metadata.gz: e88448baabd3c75fe3d312fe1b58fa9a0ba449d457f5acd4b4727efb1f9dcc5c
+  data.tar.gz: 40239b7f2e897ef1f6ed3ca51f54b4a1af66a3c95c28cf3d3ac1d12090d5004c
 SHA512:
-  metadata.gz: 39a1a63dcd110356ee18edeae01b7b9642946a3beb5d495cf870e28fe080bbfa08eb73ae0354e4ab082c2d7c19e9febe3f01fe8ffba8626a577af0bb01ffa82c
-  data.tar.gz: d50dd079002906880ce5d6344bd28255fc05dece50703ea6bce3c26b79c7a2ffd2f4ea70e973fd7d84e6771d91f2eee5d71b8ef6e459b5f26e330528ed746044
+  metadata.gz: 40233126d4c00ca269c1f04f0038c5222d365496b0eb6d5ee8b9233d8d47d1a34a850fac55022738b69c2b04d6d641bbb19659e011f1a6f097c43fa7e9693a97
+  data.tar.gz: 89246f891ba54b5617b77e1811b53200cec88bbdf097bb80fa9fe254a3d3d4ae50a4d44a2f3123d8a64e9e67394f710b784008819a1305e92121075087b247af

data/README.md

@@ -17,7 +17,7 @@ If bundler is not being used to manage dependencies, install the gem by executin
 ## Configuration
     # config/initializers/qodex_rails.rb
 
-    
+
     QodexRails.configure do |config|
         # Your configuration settings for qodex-rails in the staging environment
         project_name = Rails.application.class.module_parent_name rescue 'qodex'
@@ -25,8 +25,9 @@ If bundler is not being used to manage dependencies, install the gem by executin
         config.allowed_environments = ['staging', 'production']  # Default value is staging if not set. Add production to enable in production
         config.frequency = 'high' #default value is medium. to control the speed of the logs processing
         config.api_key = 'Your API Key'
-    end  
-    
+        config.pii_masking = ['api-key', 'access-token'] # add keys to skip sending actual value to qodex server
+    end
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/qodex-rails. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/qodex-rails/blob/main/CODE_OF_CONDUCT.md).

data/lib/qodex/rails/version.rb

@@ -2,6 +2,6 @@
 
 module Qodex
   module Rails
-    VERSION = "0.1.14"
+    VERSION = "0.1.16"
   end
 end

data/lib/qodex-rails/configuration.rb

@@ -1,6 +1,7 @@
 module QodexRails
   class Configuration
-    attr_accessor :collection_name, :api_key, :allowed_environments, :frequency, :api_host
+    attr_accessor :collection_name, :api_key, :allowed_environments,
+      :frequency, :api_host, :pii_masking
 
     def initialize
       @collection_name = nil
@@ -8,6 +9,7 @@ module QodexRails
       @allowed_environments = ['staging']
       @frequency = 'medium'
       @api_host = nil
+      @pii_masking = nil
     end
   end
 end

data/lib/qodex-rails/masking_util.rb

@@ -0,0 +1,44 @@
+module MaskingUtil
+  extend self
+
+  def mask_data(data, pii_masking)
+    return data if pii_masking.blank?
+
+    # Base case: If data is not a hash or array, return it as is
+    return data unless data.is_a?(Hash) || data.is_a?(Array)
+
+    # If the data is an array, apply the function recursively to each element
+    if data.is_a?(Array)
+      return data.map { |value| MaskingUtil.mask_data(value, pii_masking) }
+    end
+
+    # If the data is a hash, transform each value
+    data.transform_keys! { |k| k.to_s.downcase } # Convert keys to downcase for case-insensitive comparison
+    data.each do |key, value|
+      if pii_masking.include?(key.downcase)  # Check if the key matches PII fields (case-insensitive)
+        data[key] = 'MASKED_' + '{{' + key + '}}'               # Mask the value
+      elsif value.is_a?(Hash) || value.is_a?(Array)
+        data[key] = MaskingUtil.mask_data(value, pii_masking)  # Recurse for nested hashes or arrays
+      end
+    end
+  end
+
+  def mask_query_params(url, pii_masking)
+    return url if pii_masking.blank?
+    uri = URI.parse(url)
+    query_params = CGI.parse(uri.query || '')  # Parse query params into a hash
+
+    # Mask sensitive query params
+    query_params.each do |key, values|
+      if pii_masking.include?(key.downcase)  # Check if key matches PII fields (case-insensitive)
+        query_params[key] = ['{{' + 'MASKED_' + key + '}}']        # Replace value with 'XXXX'
+      end
+    end
+
+    # Reconstruct the query string with masked values
+    uri.query = URI.encode_www_form(query_params)
+
+    uri.to_s  # Return the new URL with masked query params
+  end
+
+end

data/lib/qodex-rails/middleware.rb

@@ -11,6 +11,10 @@ module QodexRails
         @frequency = QodexRails.configuration.frequency || 'low'
       end
 
+      def pii_masking
+        @pii_masking ||= QodexRails.configuration.pii_masking
+      end
+
       def call(env)
 
         # Check if the current environment is allowed
@@ -60,6 +64,17 @@ module QodexRails
         action_name = parsed_route_info[:action]
         additional_info = parsed_route_info.except(:controller, :action)
 
+        request_headers = extract_request_headers(env)
+        response_headers = extract_headers(headers)
+        request_params = request.params.merge(additional_info)
+
+        request_headers = MaskingUtil.mask_data(request_headers, pii_masking)
+        response_headers = MaskingUtil.mask_data(response_headers, pii_masking)
+        request_params = MaskingUtil.mask_data(request_params, pii_masking)
+        response_body = MaskingUtil.mask_data(response_body, pii_masking)
+        request_body = MaskingUtil.mask_data(request_body, pii_masking)
+        request_url = MaskingUtil.mask_query_params(request.url, pii_masking)
+
         # Construct the logs
         logs = {
           collection_name: QodexRails.configuration.collection_name,
@@ -73,11 +88,11 @@ module QodexRails
             body_type: 'none-type',
             request_type: request.request_method,
             timestamp: Time.now.to_i,
-            url: request.url,
+            url: request_url,
             status: status,
-            headers: extract_request_headers(env),
-            response_headers: extract_headers(headers),
-            params: request.params.merge(additional_info)  # Using Rails' parameter filtering
+            headers: request_headers,
+            response_headers: response_headers,
+            params: request_params  # Using Rails' parameter filtering
           }
         }
 

data/lib/qodex-rails/version.rb

@@ -1,3 +1,3 @@
 module QodexRails
-  VERSION = "0.1.14"
+  VERSION = "0.1.16"
 end

data/lib/qodex-rails.rb

@@ -1,4 +1,5 @@
 require "qodex-rails/version"
+require "qodex-rails/masking_util"
 require "qodex-rails/middleware"
 require "qodex-rails/configuration"  # Require the new configuration file
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: qodex-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.14
+  version: 0.1.16
 platform: ruby
 authors:
 - sid
@@ -26,6 +26,7 @@ files:
 - Rakefile
 - lib/qodex-rails.rb
 - lib/qodex-rails/configuration.rb
+- lib/qodex-rails/masking_util.rb
 - lib/qodex-rails/middleware.rb
 - lib/qodex-rails/version.rb
 - lib/qodex/rails.rb