pii_scrubber 0.1.0

data/lib/pii_scrubber/vault.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require "securerandom"
+require_relative "vault/session"
+
+module PiiScrubber
+  class Vault
+    attr_reader :config
+
+    def initialize(config = PiiScrubber.configuration)
+      @config = config
+    end
+
+    def self.anonymize(data, **options)
+      new.anonymize(data, **options)
+    end
+
+    def anonymize(data, **override_options)
+      mappings = {}
+      anonymized_data = anonymize_node(data, mappings: mappings, options: override_options)
+      Session.new(text: anonymized_data, mappings: mappings)
+    end
+
+    private
+
+    def anonymize_node(data, mappings:, options:)
+      case data
+      when String
+        anonymize_string(data, mappings: mappings, options: options)
+      when Hash
+        data.each_with_object({}) do |(key, value), acc|
+          acc[key] = anonymize_node(value, mappings: mappings, options: options)
+        end
+      when Array
+        data.map { |item| anonymize_node(item, mappings: mappings, options: options) }
+      else
+        data
+      end
+    end
+
+    def anonymize_string(str, mappings:, options:)
+      return str if str.nil? || str.empty?
+
+      result = str.dup
+      scrubber = Scrubber.new(config)
+      detectors = scrubber.send(:build_detectors)
+
+      detectors.each do |detector|
+        detector.patterns.each do |pattern|
+          result.gsub!(pattern) do |match|
+            if detector.valid?(match)
+              placeholder = generate_placeholder(detector.name)
+              mappings[placeholder] = match
+              placeholder
+            else
+              match
+            end
+          end
+        end
+      end
+
+      result
+    end
+
+    def generate_placeholder(detector_name)
+      short_id = SecureRandom.hex(4)
+      "[PII_VAULT_#{detector_name.to_s.upcase}_#{short_id}]"
+    end
+  end
+end

data/lib/pii_scrubber/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module PiiScrubber
+  VERSION = "0.1.0"
+end

data/lib/pii_scrubber.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require_relative "pii_scrubber/version"
+require_relative "pii_scrubber/configuration"
+require_relative "pii_scrubber/detectors/base"
+require_relative "pii_scrubber/detectors/email"
+require_relative "pii_scrubber/detectors/phone"
+require_relative "pii_scrubber/detectors/credit_card"
+require_relative "pii_scrubber/detectors/ssn"
+require_relative "pii_scrubber/detectors/api_key"
+require_relative "pii_scrubber/detectors/ip_address"
+require_relative "pii_scrubber/detectors/iban"
+require_relative "pii_scrubber/detectors/uk_nino"
+require_relative "pii_scrubber/detectors/canadian_sin"
+require_relative "pii_scrubber/detectors/indian_pan"
+require_relative "pii_scrubber/detectors/indian_aadhaar"
+require_relative "pii_scrubber/detectors/database_url"
+require_relative "pii_scrubber/scrubber"
+require_relative "pii_scrubber/integrations/logger_formatter"
+require_relative "pii_scrubber/integrations/faraday_middleware"
+require_relative "pii_scrubber/integrations/rack_middleware"
+require_relative "pii_scrubber/vault"
+
+module PiiScrubber
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+
+    def reset_configuration!
+      @configuration = Configuration.new
+    end
+
+    def scrub(data, **options)
+      Scrubber.new(configuration).scrub(data, **options)
+    end
+
+    def anonymize(data, **options)
+      Vault.new(configuration).anonymize(data, **options)
+    end
+
+    def restore(data, session:)
+      session.restore(data)
+    end
+  end
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: pii_scrubber
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pruthviraj Rathod
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.50'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.50'
+description: Detects and sanitizes Personally Identifiable Information (emails, phone
+  numbers, credit cards, SSNs, IP addresses, IBANs, UK NINOs, Canadian SINs, Indian
+  PAN & Aadhaar) and API secrets / Database connection strings in strings, hashes,
+  logs, Faraday HTTP requests, and Rack. Features a bidirectional Vault for LLM prompt
+  anonymization and response restoration.
+executables:
+- pii_scrubber
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- exe/pii_scrubber
+- lib/pii_scrubber.rb
+- lib/pii_scrubber/configuration.rb
+- lib/pii_scrubber/detectors/api_key.rb
+- lib/pii_scrubber/detectors/base.rb
+- lib/pii_scrubber/detectors/canadian_sin.rb
+- lib/pii_scrubber/detectors/credit_card.rb
+- lib/pii_scrubber/detectors/database_url.rb
+- lib/pii_scrubber/detectors/email.rb
+- lib/pii_scrubber/detectors/iban.rb
+- lib/pii_scrubber/detectors/indian_aadhaar.rb
+- lib/pii_scrubber/detectors/indian_pan.rb
+- lib/pii_scrubber/detectors/ip_address.rb
+- lib/pii_scrubber/detectors/phone.rb
+- lib/pii_scrubber/detectors/ssn.rb
+- lib/pii_scrubber/detectors/uk_nino.rb
+- lib/pii_scrubber/integrations/faraday_middleware.rb
+- lib/pii_scrubber/integrations/logger_formatter.rb
+- lib/pii_scrubber/integrations/rack_middleware.rb
+- lib/pii_scrubber/scrubber.rb
+- lib/pii_scrubber/vault.rb
+- lib/pii_scrubber/vault/session.rb
+- lib/pii_scrubber/version.rb
+homepage: https://github.com/pruthvirajrathod/pii_scrubber
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/pruthvirajrathod/pii_scrubber
+  source_code_uri: https://github.com/pruthvirajrathod/pii_scrubber
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.18
+specification_version: 4
+summary: Fast, flexible international PII & secret redaction and reversible LLM anonymization
+  for Ruby and Rails.
+test_files: []