rails_session_key_rotator 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0a7eb6c3e04ebdb47b6059cfb51c3d01d6ea0920
+  data.tar.gz: 64b730a193e4c8a609d59410d7a5015fbf189c65
+SHA512:
+  metadata.gz: 134dec9d2af666fb1df4b20d5c093af6a010112b8ee3cb2ce510fccb2eec55eeccf39fbffb3fc8956a83943041285661497d68c9f1275494ecfd134f20150c3e
+  data.tar.gz: 4b7d677acecad2ad011ace32d918d3d10971746992a96dabcc75ffc56e1f2c85498a768dfba56246a2ad4545f72b87ec4728927bae47b4ee48794e8ed46cd818

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Envato & Steve Hodgkiss
+
+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,34 @@
+# RailsSessionKeyRotator
+
+Graceful secret key rotation for the signed cookie store in Rails. Use this when you'd rather not sign everyone out to rotate your session secret.
+
+This gem provides a Rack middleware which will regenerate the session cookie with one generated by the new secret if it was written with the old secret. This way we don't have to monkey patch Rails internals and Rails only has to know about the new session key.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rails_session_key_rotator'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+In config/application.rb:
+
+```ruby
+config.middleware.insert_before(ActionDispatch::Session::CookieStore, RailsSessionKeyRotator,
+                               :old_secret => Secrets.old_session_secret,
+                               :new_secret => Secrets.session_secret,
+                               :key => 'myapp_session')
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/envato/rails_session_key_rotator/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/lib/rails_session_key_rotator.rb

@@ -0,0 +1,32 @@
+require 'rack'
+require 'action_dispatch'
+
+class RailsSessionKeyRotator
+  def initialize(app, options = {})
+    @app = app
+    @session_cookie_key = options.fetch(:key)
+    old_secret = options.fetch(:old_secret)
+    new_secret = options.fetch(:new_secret)
+    @old_verifier = ActiveSupport::MessageVerifier.new(old_secret)
+    @new_verifier = ActiveSupport::MessageVerifier.new(new_secret)
+  end
+
+  def call(env)
+    request = Rack::Request.new(env)
+    session_cookie = request.cookies[@session_cookie_key]
+    session_data = verify_old_session_data(session_cookie) if session_cookie.present?
+    if session_data.present?
+      request.cookies[@session_cookie_key] = @new_verifier.generate(session_data)
+      ActiveSupport::Notifications.instrument('rails_session_key_rotator.upgraded', request)
+    end
+    @app.call(env)
+  end
+
+  private
+
+  def verify_old_session_data(cookie)
+    @old_verifier.verify(cookie)
+  rescue ActiveSupport::MessageVerifier::InvalidSignature
+    nil
+  end
+end

data/rails_session_key_rotator.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "rails_session_key_rotator"
+  spec.version       = "0.0.2"
+  spec.authors       = ["Steve Hodgkiss"]
+  spec.email         = ["steve@hodgkiss.me"]
+  spec.summary       = %q{Graceful session key rotation for the signed cookie store in Rails 3.}
+  spec.description   = %q{}
+  spec.homepage      = "https://github.com/envato/rails_session_key_rotator"
+  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 "rack", "~> 1.4.5"
+  spec.add_dependency "actionpack", "> 3.0"
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rack-test"
+  spec.add_development_dependency "activesupport", "~> 3.2"
+  spec.add_development_dependency "pry"
+end

data/test/rails_session_key_rotator_test.rb

@@ -0,0 +1,71 @@
+require 'test_helper'
+
+describe RailsSessionKeyRotator do
+  include Rack::Test::Methods
+
+  let(:session_data) { { user_id: 1 } }
+  let(:old_secret) { "8aa8356b662857587b23adf45e742dc4ff99c0254da89e983b491b103911b2bbbc5494a9bd5e2b420ae4bd00029dc1f9959b8b70ec1c278cd3ccb758e6fd4aa5" }
+  let(:new_secret) { "bd5dc20f2a7f7af27c137abde10ecaf0294eaa0a91e8c4c20995ae03d655cda7060b6ed178601a2eff8bf08f9423e4ebc08f2c3a077dba5647fb22f3f88c4090" }
+  let(:key) { 'myapp_session' }
+  let(:old_verifier) { ActiveSupport::MessageVerifier.new(old_secret) }
+  let(:new_verifier) { ActiveSupport::MessageVerifier.new(new_secret) }
+  let(:the_apps_session) { Marshal.load(last_response.body) }
+
+  def app
+    @app ||= begin
+               builder = Rack::Builder.new
+               builder.use RailsSessionKeyRotator, old_secret: old_secret, new_secret: new_secret, key: key
+               builder.use ActionDispatch::Session::CookieStore, secret: new_secret, key: key
+               builder.run proc { |env|
+                 env["action_dispatch.secret_token"] = new_secret
+                 request = ActionDispatch::Request.new(env)
+                 cookie = request.cookie_jar.signed[key]
+                 [200, {}, Marshal.dump(cookie) ]
+               }
+               builder.to_app
+             end
+  end
+
+  context 'with a session cookie signed with the old secret' do
+    before do
+      rack_mock_session.cookie_jar[key] = old_verifier.generate(session_data)
+    end
+
+    it 're-writes the session cookie to be readable with the new secret by the app' do
+      get '/'
+      the_apps_session.must_equal(session_data)
+    end
+
+    it 'instruments upgrades with activesupport notifications' do
+      called = false
+      subscription = ActiveSupport::Notifications.subscribe('rails_session_key_rotator.upgraded') do |name, start, finish, request_id, req|
+        called = true
+      end
+      get '/'
+      called.must_equal true
+      ActiveSupport::Notifications.unsubscribe(subscription)
+    end
+  end
+
+  context 'with a session cookie signed with the new secret' do
+    before do
+      rack_mock_session.cookie_jar[key] = new_verifier.generate(session_data)
+    end
+
+    it 'does nothing (is still readable by the app)' do
+      get '/'
+      the_apps_session.must_equal(session_data)
+    end
+  end
+
+  context 'with no session cookie' do
+    before do
+      rack_mock_session.cookie_jar[key] = nil
+    end
+
+    it 'does nothing (is read as nil by the app)' do
+      get '/'
+      the_apps_session.must_be_nil
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'minitest/autorun'
+$:.unshift 'lib'
+
+require 'rails_session_key_rotator'
+require 'rack/test'
+require 'pry'
+
+class MiniTest::Spec
+  class << self
+    alias context describe
+  end
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: rails_session_key_rotator
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Steve Hodgkiss
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.5
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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: rack-test
+  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: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: ''
+email:
+- steve@hodgkiss.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rails_session_key_rotator.rb
+- rails_session_key_rotator.gemspec
+- test/rails_session_key_rotator_test.rb
+- test/test_helper.rb
+homepage: https://github.com/envato/rails_session_key_rotator
+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: Graceful session key rotation for the signed cookie store in Rails 3.
+test_files:
+- test/rails_session_key_rotator_test.rb
+- test/test_helper.rb