mhartl-catch_cookie_exception 1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 [name of plugin creator]
+
+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.markdown

@@ -0,0 +1,10 @@
+# CatchCookieException
+
+Implements the plugin from the blog post [A security issue with Rails secret session keys](http://blog.insoshi.com/2008/08/15/a-security-issue-with-rails-secret-session-keys/).
+
+Install this plugin as follows:
+
+    $ script/plugin install git://github.com/mhartl/catch_cookie_exception.git
+
+
+Copyright (c) 2008 Michael Hartl, released under the MIT license

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the catch_cookie_exception plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the catch_cookie_exception plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'CatchCookieException'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/catch_cookie_exception.gemspec

@@ -0,0 +1,11 @@
+spec = Gem::Specification.new do |s| 
+  s.name = "catch_cookie_exception"
+  s.version = "1.0"
+  s.author = "Michael Hartl"
+  s.email = "michael@insoshi.com"
+  s.homepage = "http://insoshi.com/"
+  s.summary = "Catch and handle the CGI::Session::CookieStore::TamperedWithCookie exception that comes from changing the Rails secret string."
+  s.files = ["README.markdown", "Rakefile", "catch_cookie_exception.gemspec",
+             "lib/catch_cookie_exception.rb",
+             "MIT-LICENSE"]
+end

data/lib/catch_cookie_exception.rb

@@ -0,0 +1,21 @@
+require 'cgi'
+require 'cgi/session'
+class CGI::Session::CookieStore
+  # Restore session data from the cookie.
+  # This method overrides the one in 
+  # actionpack/lib/action_controller/session/cookie_store.rb
+  # in order to handle the case of a "tampered" cookie more gracefully.
+  # The issue is that changing the 'secret' in config/environment.rb
+  # breaks all sessions in such a way that everyone gets an error page
+  # the first time they revisit the site.  Catching the exception here
+  # prevents this ugly behavior.
+  # This is in a plugin so that it loads after Rails but before environment.rb.
+  def restore
+    @original = read_cookie
+    @data = unmarshal(@original) || {}
+  rescue CGI::Session::CookieStore::TamperedWithCookie
+    logger = Logger.new("#{RAILS_ROOT}/log/#{RAILS_ENV}.log")
+    logger.warn "Caught TamperedWithCookie exception on #{Time.now}"
+    @data = {}
+  end
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification 
+name: mhartl-catch_cookie_exception
+version: !ruby/object:Gem::Version 
+  version: "1.0"
+platform: ruby
+authors: 
+- Michael Hartl
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-10-27 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: michael@insoshi.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.markdown
+- Rakefile
+- catch_cookie_exception.gemspec
+- lib/catch_cookie_exception.rb
+- MIT-LICENSE
+has_rdoc: false
+homepage: http://insoshi.com/
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Catch and handle the CGI::Session::CookieStore::TamperedWithCookie exception that comes from changing the Rails secret string.
+test_files: []
+