hestia 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b3380572d332563a5ed975221d56004cdfc3a64d
+  data.tar.gz: 81129fa82814411368a4bedb26dff30adfba7176
+SHA512:
+  metadata.gz: e8336da91bca46b66e53de4cce6ed0950095bb0786e8a524ef97cec8757422db3a4bffbd121f34ab4fa3ca38fe7a39701562dba571290765d70a1f1da4e2c206
+  data.tar.gz: e258c450198f9a30b3a84097b0f4fa55ab8bb85b374539c91ba8c89be2182c21fff48a2c3fbbc2559f6bd2c5a0362dae46719e7396ec7ad4615d6cdf6d5daf02

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2014 FreeAgent Central
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,64 @@
+# Hestia
+
+Add support for deprecating/rotating the signed cookie secret token in rails. Out of the box if you change `config.secret_token` in rails, as soon as you deploy the change all your existing signed cookies are rendered invalid with lovely side effects such as all of your users being logged out. Thing is, it would be nice to rotate the secret token occasionally, without that side effect.
+
+Enter hestia! You can now change your `config.secret_token`, and move the old value to `config.deprecated_secret_token` to allow existing cookies to be read in as valid cookies, but all cookies being sent out of the app are signed using the new secret token value. After a while all your users that have been active since the change will have cookies signed by the new token, and you can remove the old token from `config.deprecated_secret_token`. Hey presto, you just changed your `config.secret_token` without logging anyone out or losing any existing cookies.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "hestia", :require => "hestia/railtie"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hestia
+
+And then require the railtie during your application boot process somewhere:
+
+```ruby
+require "hestia/railtie"
+```
+
+## Usage
+
+### Rails 3.2
+
+You should already have `Rails.application.config.secret_token` set to a value (usually in `config/initializers/secret_token.rb`). To rotate to a new value, you need to:
+
+1. Install hestia into your app as instructed in the "Installation" section.
+
+2. Update your config file so the old secret token is considered deprecated and you've set a new secret token value *(Use `rake secret` to generate one)*
+
+        Rails.application.config.secret_token = "new token (from rake secret output)"
+        Rails.application.config.deprecated_secret_token = "old secret token value (previously on line above)"
+
+3. Deploy. Your existing cookies will Just Work™, but any outgoing cookies are signed with new token.
+
+4. A while later (couple of weeks?), remove the `config.deprecated_secret_token` line. (Any existing cookies that haven't been sent to the webserver are now rendered invalid.)
+
+5. Be happy you've changed your cookie secret without logging anyone out.
+
+*You can also set `config.deprecated_secret_token` to an array of strings to allow incoming cookies to be valid when signed with any of the secrets.*
+
+### Rails 4
+
+Untested thus far. Pull requests welcome! ;-)
+
+### Outside rails
+
+If you're using `ActiveSupport::MessageVerifier` anywhere and you'd like to be able to rotate the secrets, you could use `Hestia::MessageMultiVerifier` instead to gain the ability to rotate secrets. See the documentation in the class for more information about how to use it.
+
+## Contributing
+
+1. Fork it ( https://github.com/fac/hestia/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 a new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new("spec") do |t|
+  t.test_files = Dir.glob("spec/**/*_spec.rb")
+end
+
+task(:default => :spec)

data/TODO.md

@@ -0,0 +1,6 @@
+# TODO
+
+* Rails 4 support? Has anything changed there?
+
+* Technically ActionDispatch::Cookie is just middleware, I wonder if we replace it entirely to do our work in subclasses.
+* We'd have to get `config.deprecated_secret_token` into the env if we wrote our own middleware. `Rails::Application#env_config` could be the answer?

data/hestia.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hestia/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hestia"
+  spec.version       = Hestia::VERSION
+  spec.authors       = ["Caius Durling"]
+  spec.email         = ["caius@freeagent.com"]
+  spec.summary       = %{Support for deprecating/rotating signed cookie secret tokens in rails}
+  spec.description   = %{#{spec.summary}.\nHandles silently accepting cookies signed with different secrets and sending back cookies signed with new secret.}
+  spec.homepage      = "https://github.com/fac/hestia"
+  spec.license       = "Apache License, Version 2.0"
+
+  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.required_ruby_version = '>= 2.0'
+
+  spec.add_runtime_dependency "rack"
+  spec.add_runtime_dependency "actionpack", "~> 3.2", ">= 3.2.21"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/hestia.rb

@@ -0,0 +1,5 @@
+module Hestia
+  autoload :MessageMultiVerifier, "hestia/message_multi_verifier"
+  autoload :SignedCookieJarExtension, "hestia/signed_cookie_jar_extension"
+  autoload :VERSION, "hestia/version"
+end

data/lib/hestia/message_multi_verifier.rb

@@ -0,0 +1,71 @@
+require "active_support/message_verifier"
+
+module Hestia
+  class MessageMultiVerifier
+
+    # Public: creates a verifier for verifying against multiple secrets
+    #
+    # API compatible with ActiveSupport::MessageVerifier once created. (initializer arguments are different.)
+    #
+    # current_secret: [String] The current secret token, used for signing *and* verifying cookies
+    # deprecated_secrets: [String, Array] The previous secret token(s), used for verifying cookies only
+    # options [Hash] options to be passed to the verifiers - see ActiveSupport::MessageVerifier#initialze for details
+    #
+    def initialize(current_secret:, deprecated_secrets: [], options: {})
+      @current_verifier = build_verifier(current_secret, options)
+      @deprecated_verifiers = Array(deprecated_secrets).map { |secret| build_verifier(secret, options) }.freeze
+
+      # Generate these here so they are static when accessed in #verify
+      @verifiers = [current_verifier, *deprecated_verifiers].freeze
+
+      # Don't need to change any attributes, so why stay mutable?
+      freeze
+    end
+
+    # Public: generate a signed message
+    #
+    # Uses only the `current_secret` to generate this.
+    #
+    # See ActiveSupport::MessageVerifier#generate for more information
+    #
+    # Returns String
+    def generate(value)
+      current_verifier.generate(value)
+    end
+
+    # Public: verify a signed message and convert back to original form
+    #
+    # See ActiveSupport::MessageVerifier#verify for more information
+    #
+    # Returns deserialized value
+    # Raises ActiveSupport::MessageVerifier::InvalidSignature
+    def verify(signed_message)
+      errored_verifier_count = 0
+
+      # Make sure we check *all* verifiers, every time we're called, to prevent timing attacks.
+      # We run in a consistent amount of time no matter which (or if any) verifiers return a valid result
+      results = verifiers.each_with_object([]) do |verifier, values|
+        begin
+          values << verifier.verify(signed_message)
+        rescue ActiveSupport::MessageVerifier::InvalidSignature
+          errored_verifier_count += 1
+        end
+      end
+
+      # If all the verifiers errored, then none of them thought the message was valid
+      if errored_verifier_count == verifiers.size
+        raise(ActiveSupport::MessageVerifier::InvalidSignature)
+      else
+        results.first
+      end
+    end
+
+    private
+
+    attr_reader :current_verifier, :deprecated_verifiers, :verifiers
+
+    def build_verifier(secret, options)
+      ActiveSupport::MessageVerifier.new(secret, options)
+    end
+  end
+end

data/lib/hestia/railtie.rb

@@ -0,0 +1,13 @@
+require "hestia"
+
+module Hestia
+  class Railtie < ::Rails::Railtie
+    # Hooks into ActionDispatch::Session::SignedCookieJar to allow rotating secret tokens in signed cookies.
+    #
+    # See README.md for how to configure this in your application.
+    #
+    initializer "hestia.signed_cookie_jar_extension", before: :load_config_initializers do
+      ActionDispatch::Cookies::SignedCookieJar.prepend(Hestia::SignedCookieJarExtension)
+    end
+  end
+end

data/lib/hestia/signed_cookie_jar_extension.rb

@@ -0,0 +1,30 @@
+module Hestia
+  module SignedCookieJarExtension
+    # Public: overridden #initialize method
+    #
+    # In rails, `secrets' will be given the value of `Rails.application.config.secret_token'. That's the current secret token.
+    # This also reads from `Rails.application.config.deprecated_secret_token` for deprecated token(s) to use. It can be undefined, a
+    # string or an array of string.
+    #
+    # parent_jar [ActionDispatch::Cookies] the parent jar creating this signed cookie jar
+    # secret [String] current secret token. Used to verify & sign cookies.
+    #
+    def initialize(parent_jar, secret)
+      super
+
+      # Find the deprecated secrets, if there are any
+      deprecated_secrets = if Rails.application.config.respond_to?(:deprecated_secret_token)
+        # This could be a single string!
+        Array(Rails.application.config.deprecated_secret_token)
+      else
+        []
+      end
+
+      # Ensure all the deprecated secret tokens are considered secure (__original_initalize__ checked the current secret for this)
+      deprecated_secrets.each { |secret| ensure_secret_secure(secret) }
+
+      # Finally, override @verifier with our own multi verifier containing all the secrets
+      @verifier = Hestia::MessageMultiVerifier.new(current_secret: secret, deprecated_secrets: deprecated_secrets)
+    end
+  end
+end

data/lib/hestia/version.rb

@@ -0,0 +1,3 @@
+module Hestia
+  VERSION = "0.0.2"
+end

data/spec/hestia/message_multi_verifier_spec.rb

@@ -0,0 +1,136 @@
+require_relative "../spec_helper"
+
+module Hestia
+  describe MessageMultiVerifier do
+    InvalidSignature = ActiveSupport::MessageVerifier::InvalidSignature
+
+    let(:message_verifier) { ActiveSupport::MessageVerifier.new("secret") }
+    let(:singular_verifier) { MessageMultiVerifier.new(current_secret: "secret") }
+    let(:multi_verifier) { MessageMultiVerifier.new(current_secret: "secret", deprecated_secrets: %w(previous_secret)) }
+
+    describe "creation" do
+      it "requires a current secret" do
+        -> { MessageMultiVerifier.new }.must_raise(ArgumentError, /current_secret/)
+      end
+
+      it "can be created with current & deprecated secrets" do
+        MessageMultiVerifier.new(current_secret: "secret", deprecated_secrets: %w(previous_secret legacy_secret))
+      end
+
+      it "can be created with current secret & options only" do
+        MessageMultiVerifier.new(current_secret: "secret", options: {digest: "MD5"})
+      end
+
+      it "can be created with array of secrets and options for the verifiers" do
+        MessageMultiVerifier.new(current_secret: "secret", deprecated_secrets: %w(previous_secret), options: {digest: "MD5"})
+      end
+
+      it "is immutable after creation" do
+        multi_verifier.must_be :frozen?
+      end
+    end
+
+    describe "generating messages with one secret set" do
+      it "is generated using first secret" do
+        singular_verifier.generate("cookie dough").must_equal message_verifier.generate("cookie dough")
+      end
+    end
+
+    describe "generating messages with multiple secrets set" do
+      it "is generated using first secret" do
+        multi_verifier.generate("cookie dough").must_equal message_verifier.generate("cookie dough")
+      end
+    end
+
+    describe "verify behaviour" do
+      let(:legacy_message_verifier) { ActiveSupport::MessageVerifier.new("previous_secret") }
+
+      let(:current_cookie) { message_verifier.generate("cookie dough") }
+      let(:legacy_cookie) { legacy_message_verifier.generate("cookie dough") }
+
+      it "errors when given blank message" do
+        -> { multi_verifier.verify(nil) }.must_raise(InvalidSignature)
+        -> { singular_verifier.verify("") }.must_raise(InvalidSignature)
+
+        -> { multi_verifier.verify(nil) }.must_raise(InvalidSignature)
+        -> { multi_verifier.verify("") }.must_raise(InvalidSignature)
+      end
+
+      it "errors without -- delimited data/digest" do
+        invalid_cookie = current_cookie.gsub("--", "-")
+        -> { singular_verifier.verify(invalid_cookie) }.must_raise(InvalidSignature)
+        -> { multi_verifier.verify(invalid_cookie) }.must_raise(InvalidSignature)
+      end
+
+      it "errors without data being present" do
+        invalid_cookie = current_cookie.gsub(/\A.+--/, "")
+        -> { singular_verifier.verify(invalid_cookie) }.must_raise(InvalidSignature)
+        -> { multi_verifier.verify(invalid_cookie) }.must_raise(InvalidSignature)
+      end
+
+      it "errors without digest being present" do
+        invalid_cookie = current_cookie.gsub(/--.+\z/, "")
+        -> { singular_verifier.verify(invalid_cookie) }.must_raise(InvalidSignature)
+        -> { multi_verifier.verify(invalid_cookie) }.must_raise(InvalidSignature)
+      end
+
+      it "errors without passed in digest matching computed digest" do
+        invalid_cookie = current_cookie.gsub(/^.+--/, "lol_error_not_a_digest_zomg")
+        -> { singular_verifier.verify(invalid_cookie) }.must_raise(InvalidSignature)
+        -> { multi_verifier.verify(invalid_cookie) }.must_raise(InvalidSignature)
+      end
+
+      it "errors with cookie signed using unknown secret" do
+        -> { singular_verifier.verify(legacy_cookie) }.must_raise(InvalidSignature)
+      end
+
+      it "verifies successfully with correct payload for any valid secret" do
+        singular_verifier.verify(current_cookie).must_equal "cookie dough"
+
+        multi_verifier.verify(current_cookie).must_equal "cookie dough"
+        multi_verifier.verify(legacy_cookie).must_equal "cookie dough"
+      end
+
+      it "verifies a message of `nil' successfully" do
+        nil_cookie = singular_verifier.generate(nil)
+
+        singular_verifier.verify(nil_cookie).must_equal(nil)
+        multi_verifier.verify(nil_cookie).must_equal(nil)
+      end
+
+      it "verifies successfully when using custom digest" do
+        multi_singular_secret = MessageMultiVerifier.new(current_secret: "secret", options: {digest: "MD5"})
+        multi_multiple_secret = MessageMultiVerifier.new(current_secret: "secret", deprecated_secrets: %w(previous_secret), options: {digest: "MD5"})
+
+        current_cookie = ActiveSupport::MessageVerifier.new("secret", :digest => "MD5").generate("cookie dough")
+        previous_cookie = ActiveSupport::MessageVerifier.new("previous_secret", :digest => "MD5").generate("cookie dough")
+
+        multi_singular_secret.verify(current_cookie).must_equal "cookie dough"
+        multi_multiple_secret.verify(current_cookie).must_equal "cookie dough"
+        multi_multiple_secret.verify(previous_cookie).must_equal "cookie dough"
+      end
+
+      it "verifies successfully when using custom serializer" do
+        reverser = Module.new do
+          extend self
+
+          def dump(string)
+            string.reverse
+          end
+
+          alias_method :load, :dump
+        end
+
+        multi_singular_secret = MessageMultiVerifier.new(current_secret: "secret", options: {serializer: reverser})
+        multi_multiple_secret = MessageMultiVerifier.new(current_secret: "secret", deprecated_secrets: %w(previous_secret), options: {serializer: reverser})
+
+        current_cookie = ActiveSupport::MessageVerifier.new("secret", :serializer => reverser).generate("cookie dough")
+        previous_cookie = ActiveSupport::MessageVerifier.new("previous_secret", :serializer => reverser).generate("cookie dough")
+
+        multi_singular_secret.verify(current_cookie).must_equal "cookie dough"
+        multi_multiple_secret.verify(current_cookie).must_equal "cookie dough"
+        multi_multiple_secret.verify(previous_cookie).must_equal "cookie dough"
+      end
+    end
+  end
+end

data/spec/hestia/railtie_spec.rb

@@ -0,0 +1,31 @@
+require_relative "../spec_helper"
+require_relative "../support/fake_rails"
+
+require "hestia/railtie"
+
+module Hestia
+  describe Railtie do
+    before do
+      @name, @arguments, @block = Rails::Railtie.initializers.first
+    end
+
+    describe "initializer" do
+      it "adds an initializer" do
+        Rails::Railtie.initializers.wont_be_empty
+      end
+
+      it "has a name" do
+        @name.must_equal "hestia.signed_cookie_jar_extension"
+      end
+
+      it "is run before config initializers are loaded" do
+        @arguments[:before].must_equal :load_config_initializers
+      end
+
+      it "has a block to do some work" do
+        # The block itself is tested in the SignedCookieJarExtension spec
+        refute_nil @block
+      end
+    end
+  end
+end

data/spec/hestia/signed_cookie_jar_extension_spec.rb

@@ -0,0 +1,88 @@
+require_relative "../spec_helper"
+require_relative "../support/fake_rails"
+
+# Call our railtie block to setup the initializers array
+require "hestia/railtie"
+
+module Hestia
+  describe SignedCookieJarExtension do
+    before do
+      Rails.clean
+      load_railtie
+    end
+
+    it "is prepended into signed cookie jar ancestors" do
+      ActionDispatch::Cookies::SignedCookieJar.ancestors.first.must_equal SignedCookieJarExtension
+    end
+
+    it "defines initialize" do
+      # #initialize doesn't show up in {instance_,}methods({false,true}) for some reason, so do this instead
+      # This will throw a NameError if we don't define it
+      SignedCookieJarExtension.instance_method(:initialize)
+    end
+
+    describe "signed cookie jar instance with no deprecated token" do
+      before do
+        @parent_jar = Object.new
+        @secret = "a" * 30
+        @jar = ActionDispatch::Cookies::SignedCookieJar.new(@parent_jar, @secret)
+      end
+
+      it "calls the original initialize method" do
+        @jar.instance_variable_get(:@parent_jar).must_equal @parent_jar
+      end
+
+      describe "validator" do
+        before do
+          @verifier = @jar.instance_variable_get(:@verifier)
+        end
+        it "is a multi message validator" do
+          @verifier.must_be_kind_of(MessageMultiVerifier)
+        end
+
+        it "has the correct secrets stored" do
+          secrets = @verifier.instance_variable_get(:@verifiers).map { |x| x.instance_variable_get(:@secret) }
+          secrets.must_equal [@secret]
+        end
+      end
+    end
+
+    describe "signed cookie jar instance with deprecated token" do
+      before do
+        @parent_jar = Object.new
+        @secret = "a" * 30
+        @deprecated_secret = "b" * 30
+        Rails.application.config[:deprecated_secret_token] = @deprecated_secret
+        @jar = ActionDispatch::Cookies::SignedCookieJar.new(@parent_jar, @secret)
+      end
+
+      it "calls the original initialize method" do
+        @jar.instance_variable_get(:@parent_jar).must_equal @parent_jar
+      end
+
+      describe "validator" do
+        before do
+          @verifier = @jar.instance_variable_get(:@verifier)
+        end
+        it "is a multi message validator" do
+          @verifier.must_be_kind_of(MessageMultiVerifier)
+        end
+
+        it "has the correct secrets stored" do
+          secrets = @verifier.instance_variable_get(:@verifiers).map { |x| x.instance_variable_get(:@secret) }
+          secrets.must_equal [@secret, @deprecated_secret]
+        end
+      end
+    end
+
+    private
+
+    def load_railtie
+      if (init = Rails::Railtie.initializers.first)
+        _, _, block = init
+        block.call
+      end
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require "minitest/autorun"
+require "minitest/pride"
+require "minitest/spec"
+
+require "hestia"

data/spec/support/fake_rails.rb

@@ -0,0 +1,30 @@
+require "rack"
+require "action_dispatch/middleware/cookies"
+
+# Guard in case we're accidentally loaded when rails is
+unless defined?(Rails)
+
+  # Fake out rails for testing Hestia::Railtie
+  class Rails
+    def self.clean
+      # Reset everything
+      @application = nil
+    end
+
+    def self.application
+      @application ||= OpenStruct.new(:config => OpenStruct.new)
+    end
+
+    # Hestia::Railtie will subclass this
+    class Railtie
+      def self.initializers
+        # Class variable to share with all subclasses
+        @@initializers ||= []
+      end
+
+      def self.initializer(*args, &block)
+        initializers << (args + [block])
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: hestia
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Caius Durling
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  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: '3.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.21
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.21
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: |-
+  Support for deprecating/rotating signed cookie secret tokens in rails.
+  Handles silently accepting cookies signed with different secrets and sending back cookies signed with new secret.
+email:
+- caius@freeagent.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- TODO.md
+- hestia.gemspec
+- lib/hestia.rb
+- lib/hestia/message_multi_verifier.rb
+- lib/hestia/railtie.rb
+- lib/hestia/signed_cookie_jar_extension.rb
+- lib/hestia/version.rb
+- spec/hestia/message_multi_verifier_spec.rb
+- spec/hestia/railtie_spec.rb
+- spec/hestia/signed_cookie_jar_extension_spec.rb
+- spec/spec_helper.rb
+- spec/support/fake_rails.rb
+homepage: https://github.com/fac/hestia
+licenses:
+- Apache License, Version 2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Support for deprecating/rotating signed cookie secret tokens in rails
+test_files:
+- spec/hestia/message_multi_verifier_spec.rb
+- spec/hestia/railtie_spec.rb
+- spec/hestia/signed_cookie_jar_extension_spec.rb
+- spec/spec_helper.rb
+- spec/support/fake_rails.rb