scrub_params 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 35978ee0837fbe0f7e929ad8e46be76ac8697d75
+  data.tar.gz: e2b14a8966c868c509aea60827906d34d8fa2e4d
+SHA512:
+  metadata.gz: ae5d80fff8ac67b82929bffd90ce1471184400b8b9bc37d7ae0ab8d13bc2d2598e0d43fe5d81f3061475781726cba465ee26f4a8d9014d37df200be807a89244
+  data.tar.gz: 10fdfb8269ffd57d6bdf1d63c159d3c6671d4dd19dcf397ba4a81b7f18a639d46516dbbfb82beb9a55824ce71e2aa9bd008a40c5d49b0332f8e78c8a707698a8

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in scrub_params.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Andrew Kane
+
+MIT License
+
+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.md

@@ -0,0 +1,59 @@
+# Scrub Params
+
+:lock: Secure Rails parameters by default
+
+> Insecure by default is insecure
+
+HTML has no business in most parameters. Take the **whitelist approach** and remove it by default.
+
+## Get Started
+
+Add this line to your application’s Gemfile:
+
+```ruby
+gem 'scrub_params'
+```
+
+You now have another line of defense against [cross-site scripting (XSS)](http://en.wikipedia.org/wiki/Cross-site_scripting).
+
+### Test It
+
+Submit HTML in one of your forms.
+
+```html
+Hello <script>alert('World')</script>
+```
+
+This becomes:
+
+```
+Hello alert('World')
+```
+
+And you should see this in your logs:
+
+```
+Scrubbed parameters: name
+```
+
+### Whitelist Actions
+
+To prevent certain actions from being scrubbed, use:
+
+```ruby
+skip_before_filter :scrub_params, only: [:create, :update]
+```
+
+## TODO
+
+- whitelist parameters
+- whitelist tags
+
+## Contributing
+
+Everyone is encouraged to help improve this project. Here are a few ways you can help:
+
+- [Report bugs](https://github.com/ankane/scrub_params/issues)
+- Fix bugs and [submit pull requests](https://github.com/ankane/scrub_params/pulls)
+- Write, clarify, or fix documentation
+- Suggest or add new features

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+task :default => :test
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+end

data/lib/scrub_params/log_subscriber.rb

@@ -0,0 +1,14 @@
+module ScrubParams
+  class LogSubscriber < ActiveSupport::LogSubscriber
+    def scrubbed_parameters(event)
+      scrubbed_keys = event.payload[:keys]
+      debug("Scrubbed parameters: #{scrubbed_keys.join(", ")}")
+    end
+
+    def logger
+      ActionController::Base.logger
+    end
+  end
+end
+
+ScrubParams::LogSubscriber.attach_to :action_controller

data/lib/scrub_params/version.rb

@@ -0,0 +1,3 @@
+module ScrubParams
+  VERSION = "0.0.1"
+end

data/lib/scrub_params.rb

@@ -0,0 +1,57 @@
+require "scrub_params/version"
+require "action_controller"
+require "sanitize"
+require "scrub_params/log_subscriber"
+
+module ActionController
+  class Parameters < ActiveSupport::HashWithIndifferentAccess
+    attr_accessor :scrubbed_keys
+
+    def scrub!
+      self.scrubbed_keys = []
+      each_pair do |k, v|
+        self[k] = scrub_value(k, v)
+      end
+      if scrubbed_keys.any?
+        ActiveSupport::Notifications.instrument("scrubbed_parameters.action_controller", keys: scrubbed_keys)
+      end
+      self
+    end
+
+    protected
+
+    def scrub_value(key, value)
+      case value
+      when Hash
+        h = {}
+        value.each do |k, v|
+          h[k] = scrub_value(k, v)
+        end
+        h
+      when Array
+        value.map{|v| scrub_value(key, v) }
+      when String
+        scrubbed_value = Sanitize.clean(value)
+        if scrubbed_value != value
+          self.scrubbed_keys << key unless scrubbed_keys.include?(key)
+        end
+        scrubbed_value
+      else
+        value
+      end
+    end
+
+  end
+end
+
+module ActionController
+  class Base
+    protected
+
+    before_filter :scrub_params
+
+    def scrub_params
+      params.scrub!
+    end
+  end
+end

data/scrub_params.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'scrub_params/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "scrub_params"
+  spec.version       = ScrubParams::VERSION
+  spec.authors       = ["Andrew Kane"]
+  spec.email         = ["andrew@chartkick.com"]
+  spec.summary       = %q{Secure Rails parameters by default}
+  spec.description   = %q{Secure Rails parameters by default}
+  spec.homepage      = "https://github.com/ankane/scrub_params"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport"
+  spec.add_dependency "actionpack"
+  spec.add_dependency "sanitize"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+end

data/test/scrub_params_test.rb

@@ -0,0 +1,25 @@
+require_relative "test_helper"
+
+class TestScrubParams < Minitest::Test
+
+  def test_scrub
+    params =
+      ActionController::Parameters.new({
+        "name" => "Hello <script>alert('World')</script>",
+        "tags" => ["<b>awesome</b>", "<a href='javascript:void();'>hack</a>"],
+        "car" => {
+          "make" => "<blink>Tesla</blink>"
+        }
+      })
+    params.scrub!
+    expected = {
+      "name" => "Hello alert('World')",
+      "tags" => ["awesome", "hack"],
+      "car" => {
+        "make" => "Tesla"
+      }
+    }
+    assert_equal expected, params
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require "bundler/setup"
+Bundler.require(:default)
+require "minitest/autorun"
+require "minitest/pride"

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: scrub_params
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andrew Kane
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sanitize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Secure Rails parameters by default
+email:
+- andrew@chartkick.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/scrub_params.rb
+- lib/scrub_params/log_subscriber.rb
+- lib/scrub_params/version.rb
+- scrub_params.gemspec
+- test/scrub_params_test.rb
+- test/test_helper.rb
+homepage: https://github.com/ankane/scrub_params
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Secure Rails parameters by default
+test_files:
+- test/scrub_params_test.rb
+- test/test_helper.rb