cookies_and_cream 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b1b68c606da8711313d347a5754b6a59591b2def168085ce40c9a79fee093987
+  data.tar.gz: ea0648da9e6c645f4ef26d9c753d129ad8b83d82810bcfe3175792c483b1f601
+SHA512:
+  metadata.gz: a23eb72521c4e09347a518c5fbfa1de3c7db4b33f1904a58fcafe9a4ae7020c518c923db45fff154b1bafe12478c2f6d1fd7054e4753996a79a8ecfbfdc25b39
+  data.tar.gz: f3ae4bd73ec7c0ba11275d3f41107c7ae145de0db978443fc3750c78ef3c30d6d968d8f96c99ef343ba50b902775931fc94e816706806ce1d6be5ecb5ca28881

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock

data/.rubocop.yml

@@ -0,0 +1,3 @@
+inherit_gem:
+  rubocop-github:
+    - config/default.yml

data/.ruby-version

@@ -0,0 +1 @@
+2.6.1

data/.travis.yml

@@ -0,0 +1,28 @@
+language: ruby
+
+rvm:
+  - ruby-head
+  - 2.6.1
+  - 2.5.0
+  - 2.4.3
+  - jruby-head
+
+env:
+  - SUITE=rspec spec
+  - SUITE=rubocop
+
+script: bundle exec $SUITE
+
+matrix:
+  allow_failures:
+    - rvm: jruby-head
+    - rvm: ruby-head
+
+before_install:
+  - gem update --system
+  - gem --version
+  - gem update bundler
+bundler_args: --without guard -j 3
+
+sudo: false
+cache: bundler

data/Gemfile

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+source "https://rubygems.org"
+
+gemspec
+
+group :test do
+  gem "coveralls"
+  gem "json"
+  gem "pry-nav"
+  gem "rack"
+  gem "rspec"
+  gem "rubocop"
+  gem "rubocop-github"
+  gem "term-ansicolor"
+  gem "tins"
+end
+
+group :guard do
+  gem "growl"
+  gem "guard-rspec"
+  gem "rb-fsevent"
+  gem "terminal-notifier-guard"
+end

data/Guardfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+guard :rspec, cmd: "bundle exec rspec", all_on_start: true, all_after_pass: true do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  watch(%r{^lib/(.+)\.rb$}) { |m| "spec/lib/#{m[1]}_spec.rb" }
+end

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Neil Matatall
+
+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,85 @@
+[![Build Status](https://travis-ci.org/oreoshake/cookies_and_cream.svg?branch=master)](https://travis-ci.org/oreoshake/cookies_and_cream)
+
+# CookiesAndCream
+
+CookiesAndCream is an extract of the cookie functionality from [secure_headers](https://github.com/twitter/secure_headers). Rails has good header support but the cookie support is still lacking. Maybe one day this functionality will be added to rails core.
+
+Note: the railtie currently isn't working (see #1) so there's a bit of manual setup for now.
+
+Gemfile:
+```ruby
+gem "cookies_and_cream"
+```
+
+application.rb:
+```ruby
+require "cookies_and_cream"
+
+module Foo
+  class Application < Rails::Application
+    ...
+    config.middleware.use CookiesAndCream::Middleware
+```
+
+## Configuration
+
+These can be defined in the form of a boolean, or as a Hash for more refined configuration.
+
+#### Defaults
+
+By default, all cookies will get both `Secure`, `HttpOnly`, and `SameSite=Lax`.
+
+```ruby
+CookiesAndCream.config = {
+  secure: true, # defaults to true but will be a no op on non-HTTPS requests
+  httponly: true, # defaults to true
+  samesite: {  # defaults to set `SameSite=Lax`
+    lax: true
+  }
+}
+```
+
+#### Boolean-based configuration
+
+Boolean-based configuration is intended to globally enable or disable a specific cookie attribute. *Note: As of 4.0, you must use OPT_OUT rather than false to opt out of the defaults.*
+
+```ruby
+CookiesAndCream.config = {
+  secure: true, # mark all cookies as Secure
+  httponly: OPT_OUT, # do not mark any cookies as HttpOnly
+}
+```
+
+#### Hash-based configuration
+
+Hash-based configuration allows for fine-grained control.
+
+```ruby
+CookiesAndCream.config = {
+  secure: { except: ['_guest'] }, # mark all but the `_guest` cookie as Secure
+  httponly: { only: ['_rails_session'] }, # only mark the `_rails_session` cookie as HttpOnly
+}
+```
+
+#### SameSite cookie configuration
+
+SameSite cookies permit either `Strict` or `Lax` enforcement mode options.
+
+```ruby
+CookiesAndCream.config = {
+  samesite: {
+    strict: true # mark all cookies as SameSite=Strict
+  }
+}
+```
+
+`Strict` and `Lax` enforcement modes can also be specified using a Hash.
+
+```ruby
+CookiesAndCream.config = {
+  samesite: {
+    strict: { only: ['_rails_session'] },
+    lax: { only: ['_guest'] }
+  }
+}
+```

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "cookies_and_cream"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/cookies_and_cream.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "cookies_and_cream/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "cookies_and_cream"
+  spec.version       = CookiesAndCream::VERSION
+  spec.authors       = ["Neil Matatall"]
+  spec.email         = ["oreoshake@users.noreply.github.com"]
+
+  spec.summary       = %q{Automatically marks all cookies as secure, httponly, and samesite=lax}
+  spec.description   = %q{Secure your cookies with an API for opting out}
+  spec.homepage      = "https://github.com/oreoshake/cookies_and_cream"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/oreoshake/cookies_and_cream"
+    spec.metadata["changelog_uri"] = "https://github.com/oreoshake/cookies_and_cream/CHANGELOG"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path("..", __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/cookies_and_cream/cookie.rb

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+require "cgi"
+
+module CookiesAndCream
+  class CookiesConfigError < StandardError; end
+  class Cookie
+    attr_reader :raw_cookie, :config
+
+    COOKIE_DEFAULTS = {
+      httponly: true,
+      secure: true,
+      samesite: { lax: true },
+    }.freeze
+
+    def initialize(cookie, config)
+      @raw_cookie = cookie
+      unless config == OPT_OUT
+        config ||= {}
+        config = COOKIE_DEFAULTS.merge(config)
+      end
+      @config = config
+      @attributes = {
+        httponly: nil,
+        samesite: nil,
+        secure: nil,
+      }
+
+      parse(cookie)
+    end
+
+    def to_s
+      @raw_cookie.dup.tap do |c|
+        c << "; secure" if secure?
+        c << "; HttpOnly" if httponly?
+        c << "; #{samesite_cookie}" if samesite?
+      end
+    end
+
+    def secure?
+      flag_cookie?(:secure) && !already_flagged?(:secure)
+    end
+
+    def httponly?
+      flag_cookie?(:httponly) && !already_flagged?(:httponly)
+    end
+
+    def samesite?
+      flag_samesite? && !already_flagged?(:samesite)
+    end
+
+    private
+
+    def parsed_cookie
+      @parsed_cookie ||= CGI::Cookie.parse(raw_cookie)
+    end
+
+    def already_flagged?(attribute)
+      @attributes[attribute]
+    end
+
+    def flag_cookie?(attribute)
+      return false if config == OPT_OUT
+      case config[attribute]
+      when TrueClass
+        true
+      when Hash
+        conditionally_flag?(config[attribute])
+      else
+        false
+      end
+    end
+
+    def conditionally_flag?(configuration)
+      if(Array(configuration[:only]).any? && (Array(configuration[:only]) & parsed_cookie.keys).any?)
+        true
+      elsif(Array(configuration[:except]).any? && (Array(configuration[:except]) & parsed_cookie.keys).none?)
+        true
+      else
+        false
+      end
+    end
+
+    def samesite_cookie
+      if flag_samesite_lax?
+        "SameSite=Lax"
+      elsif flag_samesite_strict?
+        "SameSite=Strict"
+      end
+    end
+
+    def flag_samesite?
+      return false if config == OPT_OUT || config[:samesite] == OPT_OUT
+      flag_samesite_lax? || flag_samesite_strict?
+    end
+
+    def flag_samesite_lax?
+      flag_samesite_enforcement?(:lax)
+    end
+
+    def flag_samesite_strict?
+      flag_samesite_enforcement?(:strict)
+    end
+
+    def flag_samesite_enforcement?(mode)
+      return unless config[:samesite]
+
+      if config[:samesite].is_a?(TrueClass) && mode == :lax
+        return true
+      end
+
+      case config[:samesite][mode]
+      when Hash
+        conditionally_flag?(config[:samesite][mode])
+      when TrueClass
+        true
+      else
+        false
+      end
+    end
+
+    def parse(cookie)
+      return unless cookie
+
+      cookie.split(/[;,]\s?/).each do |pairs|
+        name, values = pairs.split("=", 2)
+        name = CGI.unescape(name)
+
+        attribute = name.downcase.to_sym
+        if @attributes.has_key?(attribute)
+          @attributes[attribute] = values || true
+        end
+      end
+    end
+  end
+end

data/lib/cookies_and_cream/middleware.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+module CookiesAndCream
+  class Middleware
+    def initialize(app)
+      @app = app
+    end
+
+    # merges the hash of headers into the current header set.
+    def call(env)
+      req = Rack::Request.new(env)
+      status, headers, response = @app.call(env)
+
+      unless CookiesAndCream.config == OPT_OUT
+        flag_cookies!(headers, override_secure(env, CookiesAndCream.config))
+      end
+
+      [status, headers, response]
+    end
+
+    private
+
+    # inspired by https://github.com/tobmatth/rack-ssl-enforcer/blob/6c014/lib/rack/ssl-enforcer.rb#L183-L194
+    def flag_cookies!(headers, config)
+      if cookies = headers["Set-Cookie"]
+        # Support Rails 2.3 / Rack 1.1 arrays as headers
+        cookies = cookies.split("\n") unless cookies.is_a?(Array)
+
+        headers["Set-Cookie"] = cookies.map do |cookie|
+          CookiesAndCream::Cookie.new(cookie, config).to_s
+        end.join("\n")
+      end
+    end
+
+    # disable cookies and cream for non-https requests
+    def override_secure(env, config = {})
+      if scheme(env) != "https" && config != OPT_OUT
+        config = config.dup
+        config[:secure] = OPT_OUT
+      end
+
+      config
+    end
+
+    # derived from https://github.com/tobmatth/rack-ssl-enforcer/blob/6c014/lib/rack/ssl-enforcer.rb#L119
+    def scheme(env)
+      if env["HTTPS"] == "on" || env["HTTP_X_SSL_REQUEST"] == "on"
+        "https"
+      elsif env["HTTP_X_FORWARDED_PROTO"]
+        env["HTTP_X_FORWARDED_PROTO"].split(",")[0]
+      else
+        env["rack.url_scheme"]
+      end
+    end
+  end
+end

data/lib/cookies_and_cream/railtie.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+# rails 3.1+
+if defined?(Rails::Railtie)
+  module CookiesAndCream
+    class Railtie < Rails::Railtie
+      isolate_namespace CookiesAndCream if defined? isolate_namespace # rails 3.0
+
+      initializer "cookies_and_cream.middleware" do
+        Rails.application.config.middleware.insert_before 0, CookiesAndCream::Middleware
+      end
+    end
+  end
+end

data/lib/cookies_and_cream/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module CookiesAndCream
+  VERSION = "0.1.0"
+end

data/lib/cookies_and_cream.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+require "cookies_and_cream/cookie"
+require "cookies_and_cream/middleware"
+require "cookies_and_cream/railtie"
+require "cookies_and_cream/version"
+
+module CookiesAndCream
+  OPT_OUT = Object.new
+
+  DEFAULT_CONFIG = {
+    secure: true, # defaults to true but will be a no op on non-HTTPS requests
+    httponly: true, # defaults to true
+    samesite: {  # defaults to set `SameSite=Lax`
+      lax: true
+    }
+  }
+
+  class << self
+    def config
+      @config || DEFAULT_CONFIG
+    end
+
+    def config=(configuration)
+      raise RuntimeError, "Already configured" if @config
+      @config = configuration
+      @config.freeze
+      validate!
+    end
+
+    def validate!
+      return if config == OPT_OUT
+      validate_config!
+      validate_secure_config! unless config[:secure].nil?
+      validate_httponly_config! unless config[:httponly].nil?
+      validate_samesite_config! unless config[:samesite].nil?
+    end
+
+    private
+
+    def validate_config!
+      raise CookiesConfigError.new("config must be a hash.") unless is_hash?(config)
+    end
+
+    def validate_secure_config!
+      validate_hash_or_true_or_opt_out!(:secure)
+      validate_exclusive_use_of_hash_constraints!(config[:secure], :secure)
+    end
+
+    def validate_httponly_config!
+      validate_hash_or_true_or_opt_out!(:httponly)
+      validate_exclusive_use_of_hash_constraints!(config[:httponly], :httponly)
+    end
+
+    def validate_samesite_config!
+      return if config[:samesite] == OPT_OUT
+      raise CookiesConfigError.new("samesite cookie config must be a hash") unless is_hash?(config[:samesite])
+
+      validate_samesite_boolean_config!
+      validate_samesite_hash_config!
+    end
+
+    # when configuring with booleans, only one enforcement is permitted
+    def validate_samesite_boolean_config!
+      if config[:samesite].key?(:lax) && config[:samesite][:lax].is_a?(TrueClass) && config[:samesite].key?(:strict)
+        raise CookiesConfigError.new("samesite cookie config is invalid, combination use of booleans and Hash to configure lax and strict enforcement is not permitted.")
+      elsif config[:samesite].key?(:strict) && config[:samesite][:strict].is_a?(TrueClass) && config[:samesite].key?(:lax)
+        raise CookiesConfigError.new("samesite cookie config is invalid, combination use of booleans and Hash to configure lax and strict enforcement is not permitted.")
+      end
+    end
+
+    def validate_samesite_hash_config!
+      # validate Hash-based samesite configuration
+      if is_hash?(config[:samesite][:lax])
+        validate_exclusive_use_of_hash_constraints!(config[:samesite][:lax], "samesite lax")
+
+        if is_hash?(config[:samesite][:strict])
+          validate_exclusive_use_of_hash_constraints!(config[:samesite][:strict], "samesite strict")
+          validate_exclusive_use_of_samesite_enforcement!(:only)
+          validate_exclusive_use_of_samesite_enforcement!(:except)
+        end
+      end
+    end
+
+    def validate_hash_or_true_or_opt_out!(attribute)
+      if !(is_hash?(config[attribute]) || is_true_or_opt_out?(config[attribute]))
+        raise CookiesConfigError.new("#{attribute} cookie config must be a hash, true, or CookiesAndCream::OPT_OUT")
+      end
+    end
+
+    # validate exclusive use of only or except but not both at the same time
+    def validate_exclusive_use_of_hash_constraints!(conf, attribute)
+      return unless is_hash?(conf)
+      if conf.key?(:only) && conf.key?(:except)
+        raise CookiesConfigError.new("#{attribute} cookie config is invalid, simultaneous use of conditional arguments `only` and `except` is not permitted.")
+      end
+    end
+
+    # validate exclusivity of only and except members within strict and lax
+    def validate_exclusive_use_of_samesite_enforcement!(attribute)
+      if (intersection = (config[:samesite][:lax].fetch(attribute, []) & config[:samesite][:strict].fetch(attribute, []))).any?
+        raise CookiesConfigError.new("samesite cookie config is invalid, cookie(s) #{intersection.join(', ')} cannot be enforced as lax and strict")
+      end
+    end
+
+    def is_hash?(obj)
+      obj && obj.is_a?(Hash)
+    end
+
+    def is_true_or_opt_out?(obj)
+      obj && (obj.is_a?(TrueClass) || obj == OPT_OUT)
+    end
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: cookies_and_cream
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Neil Matatall
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-02-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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: Secure your cookies with an API for opting out
+email:
+- oreoshake@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cookies_and_cream.gemspec
+- lib/cookies_and_cream.rb
+- lib/cookies_and_cream/cookie.rb
+- lib/cookies_and_cream/middleware.rb
+- lib/cookies_and_cream/railtie.rb
+- lib/cookies_and_cream/version.rb
+homepage: https://github.com/oreoshake/cookies_and_cream
+licenses: []
+metadata:
+  homepage_uri: https://github.com/oreoshake/cookies_and_cream
+  source_code_uri: https://github.com/oreoshake/cookies_and_cream
+  changelog_uri: https://github.com/oreoshake/cookies_and_cream/CHANGELOG
+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: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Automatically marks all cookies as secure, httponly, and samesite=lax
+test_files: []