better_newrelic_sql_obfuscator 1.0.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "minitest", ">= 0"
+  gem "yard", "~> 0.6.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,22 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    minitest (2.10.0)
+    rake (0.9.2.2)
+    rcov (0.9.11)
+    yard (0.6.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.4)
+  minitest
+  rcov
+  yard (~> 0.6.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Renewable Funding, LLC
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,19 @@
+= better_newrelic_sql_obfuscator
+
+Description goes here.
+
+== Contributing to better_newrelic_sql_obfuscator
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2012 Renewable Funding, LLC. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,46 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "better_newrelic_sql_obfuscator"
+  gem.homepage = "http://github.com/projectdx/better_newrelic_sql_obfuscator"
+  gem.license = "MIT"
+  gem.summary = %Q{Obfuscate SQL in NewRelic in a way that doesn't suck}
+  gem.description = %Q{see Summary}
+  gem.email = "devteam@renewfund.com"
+  gem.authors = ["Renewable Funding, LLC"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/better_newrelic_sql_obfuscator.gemspec

@@ -0,0 +1,62 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{better_newrelic_sql_obfuscator}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Renewable Funding, LLC"]
+  s.date = %q{2012-01-11}
+  s.description = %q{see Summary}
+  s.email = %q{devteam@renewfund.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "better_newrelic_sql_obfuscator.gemspec",
+    "lib/better_newrelic_sql_obfuscator.rb",
+    "test/helper.rb"
+  ]
+  s.homepage = %q{http://github.com/projectdx/better_newrelic_sql_obfuscator}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Obfuscate SQL in NewRelic in a way that doesn't suck}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<minitest>, [">= 0"])
+      s.add_development_dependency(%q<yard>, ["~> 0.6.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<minitest>, [">= 0"])
+      s.add_dependency(%q<yard>, ["~> 0.6.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<minitest>, [">= 0"])
+    s.add_dependency(%q<yard>, ["~> 0.6.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/lib/better_newrelic_sql_obfuscator.rb

@@ -0,0 +1,74 @@
+# Include this with an initializer similar to the one below.
+#
+# whitelisted_fields = %w[
+#   cached_cms_responses.filename
+#   cached_cms_responses.site
+#   customers.hostname
+#   sessions.session_id
+# ]
+# whitelisted_fields.each { |field| BetterNewrelicSqlObfuscator.whitelist(field) }
+# 
+# BetterNewrelicSqlObfuscator.dont_obfuscate_table_and_field do |table, field|
+#   %w[created_at updated_at nickname].include?(field)
+# end
+# 
+# NewRelic::Agent.set_sql_obfuscator(:replace) do |sql|
+#   BetterNewrelicSqlObfuscator.obfuscate(sql)
+# end
+#
+
+
+module BetterNewrelicSqlObfuscator
+  module_function
+
+  # Provide a facility for whitelisting certain fields
+  WhitelistHash = Hash.new(false)
+  def whitelist(field_expression)
+    WhitelistHash[field_expression] = true
+  end
+  def whitelisted?(field_expression)
+    WhitelistHash[field_expression]
+  end
+
+  DontObfuscateProcs = []
+  # Provides a facility for *not* obfuscating if the field meets some arbitrary criteria.
+  # Takes blocks, calls them on expressions for which a table and field can be found.
+  # Blocks should take two arguments, table and field, and return TRUE if the value should NOT be obfuscated.
+  def dont_obfuscate_table_and_field(&proc)
+    DontObfuscateProcs << proc
+  end
+
+  # Should match:
+  #   f_table_name = 'sensitive data'
+  #   "some_table"."some_field" = 'sensitive data'
+  #   "some_table"."some_field" somehow_matches 'sensitive data'
+  # ...but see also test/unit/lib/sql_obfuscator_unit_test.rb
+  ComparisonExpression = /(?:("\w+"\."\w+")([^"']+)?)?'([^'\\]*((?:\\.|'')[^'\\]+)*)'/
+
+  # Actually do the obfuscation
+  def obfuscate(sql)
+    sql.gsub(ComparisonExpression) do |match|
+      field_expression, comparison, sensitive_data = $1, $2, $3
+
+      # Obfuscate by default
+      obfuscated_sql = [field_expression, comparison, obfuscate_value(sensitive_data)].compact.join
+
+      # Don't obfuscate if we have a field expression that's on the whitelist or is on a 'nickname' field
+      if field_expression.present?
+        table_name, field_name = field_expression.to_s.gsub('"', '').split('.')
+        case
+        when whitelisted?('%s.%s' % [table_name, field_name])
+          obfuscated_sql = match
+        when DontObfuscateProcs.any? { |proc| proc.call(table_name, field_name) }
+          obfuscated_sql = match
+        end
+      end
+
+      obfuscated_sql
+    end
+  end
+
+  def obfuscate_value(value)
+    "'%s'" % Digest::MD5.hexdigest("%d:%s" % [value.to_s.length, value.to_s])
+  end
+end

data/test/helper.rb

@@ -0,0 +1,19 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'minitest/unit'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'better_newrelic_sql_obfuscator'
+
+class MiniTest::Unit::TestCase
+end
+
+MiniTest::Unit.autorun

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification 
+name: better_newrelic_sql_obfuscator
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Renewable Funding, LLC
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-01-11 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: minitest
+  requirement: *id001
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 0
+        - 6
+        - 0
+        version: 0.6.0
+  name: yard
+  requirement: *id002
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  name: bundler
+  requirement: *id003
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 6
+        - 4
+        version: 1.6.4
+  name: jeweler
+  requirement: *id004
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: rcov
+  requirement: *id005
+  type: :development
+description: see Summary
+email: devteam@renewfund.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- better_newrelic_sql_obfuscator.gemspec
+- lib/better_newrelic_sql_obfuscator.rb
+- test/helper.rb
+has_rdoc: true
+homepage: http://github.com/projectdx/better_newrelic_sql_obfuscator
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Obfuscate SQL in NewRelic in a way that doesn't suck
+test_files: []
+