rack-tls_tools 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 142ab0d969273c9be4f7f457aab4e2407f926493
+  data.tar.gz: 25df1c6e73c1c9a2aa85e14ebb54a6ada3218ec1
+SHA512:
+  metadata.gz: 788fe7f194feb7bb7663becb4b9cdd8ec4f2de9c32e57d229b830a1a9a4481f6d2b9067323b6c3826e1c0b596fd673c88924fe0cfb5fcea254923b3369276dc2
+  data.tar.gz: ba1d9dfd34301a50f59928a143253571b9b8345fcf45fd369a05a528c3b134a07280a0b6da672e190d26e059c551af4f08c9e6d4725c8d6b94870429565fdcc2

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.2.2
+  - ruby-head
+  - jruby

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rack-tls_tools.gemspec
+gemspec
+
+group :test do
+  gem 'minitest'
+  gem 'rack-test'
+  gem 'pry-nav'
+end
+

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Jens Kraemer
+
+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,132 @@
+# Rack::TlsTools [![Build Status](https://travis-ci.org/jkraemer/rack-tls_tools.png?branch=master)](https://travis-ci.org/jkraemer/rack-tls_tools)
+
+A bunch of rack middlewares to enforce secure cookies and add HSTS and HPKP
+headers to your app's responses.
+
+## Caution
+
+By mis-using HSTS and HPKP it's very easy to lock out your clients from your
+site.
+
+Please make sure you understand what they do and how they work before trying
+this out on a production site. While experimenting it might be a good idea to
+use short `max_age` values so any effects of a possible mis-configuration don't
+last until next year.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rack-tls_tools'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-tls_tools
+
+
+## Usage
+
+### SecureCookies
+
+To mark any cookie you set over HTTPS as *secure*, just add
+`Rack::TlsTools::SecureCookies` to your middleware stack. For Rails that means
+adding
+
+```ruby
+config.middleware.use Rack::TlsTools::SecureCookies
+```
+
+to your `config/application.rb`.
+
+
+### HSTS
+
+HTTP Strict Transport Security is a security feature that lets your web site
+tell browsers that it should only be communicated with using HTTPS.
+
+Basically it's a simple HTTP header sent by the server, indicating that the
+current site must only be accessed over HTTPS.
+
+- [Mozilla Developer Network](https://developer.mozilla.org/en-US/docs/Web/Security/HTTP_strict_transport_security)
+- [RFC 6797](https://tools.ietf.org/html/rfc6797)
+
+```ruby
+config.middleware.use Rack::TlsTools::Hsts, max_age: 1.year, subdomains: false
+```
+
+### HPKP
+
+HPKP aka Public Key Pinning is used to tell clients to associate a specific
+cryptographic public key with your site. The goal is to prevent MITM attacks
+with forged certificates in the future.
+
+- [Mozilla Developer Network](https://developer.mozilla.org/en-US/docs/Web/Security/Public_Key_Pinning)
+- [RFC7469](https://tools.ietf.org/html/rfc7469)
+
+In order to add HPKP headers to your site you have to specify a set of
+configurations, each consisting of a number of host names (which are all
+using the same SSL certificates) and a number of hashes identifying these
+certificates. So if your app serves different domains using different SSL
+certificates, use a separate hash in the `hosts` array for each of them.
+
+```ruby
+config.middleware.use Rack::TlsTools::Hpkp, {
+  max_age: 3.months,
+  subdomains: false,
+  hosts: [
+    {
+      names: %w(test.com www.test.com),
+      sha256: %w(TjqopKw/ZnhQVuSJcigTYFZzyzcV4meL4ukoThbkr0E= IXx7fkhrahUAGPqxiGyXvQ0aACvZiT0GqELG5X+Irlc=),
+      report_uri: 'https://hpkp-reports.test.com/',
+    },
+    {
+      names: %w(example.com),
+      sha256: %w(cw67ZLBJG8VBdPwhnpAWV9hn65+ETjdJ80N7QaKPq4Q= /OO9h4ETSyxhCj11N+52iPXCkZY1hoWSye9Xb3AkbZ0=),
+      subdomains: true,
+      max_age: 30000,
+    },
+  ]
+}
+```
+
+The top level `max_age` and `subdomains` values serve as defaults which can be
+overridden in each of the `hosts` hashes. If omitted these default to the
+values shown above. `report_uri` is optional, if set, browsers should `POST`
+some useful information there once they detect a certificate mismatch according
+to the [RFC](https://tools.ietf.org/html/rfc7469).
+
+**Always** add at least two hashes for each domain - one for the current key, and
+one for a backup key you will be using in case the current one is lost,
+compromised or simply expires.
+
+#### Generating the relevant hashes
+
+You can generate these hashes from your private key, your server certificate
+and even the Certificate Signing Request ([Source](https://developer.mozilla.org/en-US/docs/Web/Security/Public_Key_Pinning)):
+
+    openssl rsa -in my-key-file.key -outform der -pubout | openssl dgst -sha256 -binary | openssl enc -base64
+    openssl req -in my-signing-request.csr -pubkey -noout | openssl rsa -pubin -outform der | openssl dgst -sha256 -binary | openssl enc -base64
+    openssl x509 -in my-certificate.crt -pubkey -noout | openssl rsa -pubin -outform der | openssl dgst -sha256 -binary | openssl enc -base64
+
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/jkraemer/rack-tls_tools/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,11 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+task default: :test
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rack/tls_tools"
+
+# 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

data/bin/setup

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

data/lib/rack-tls_tools.rb

@@ -0,0 +1 @@
+require 'rack/tls_tools'

data/lib/rack/tls_tools.rb

@@ -0,0 +1,8 @@
+require "rack/tls_tools/hpkp"
+require "rack/tls_tools/hsts"
+require "rack/tls_tools/secure_cookies"
+
+module Rack
+  module TlsTools
+  end
+end

data/lib/rack/tls_tools/hpkp.rb

@@ -0,0 +1,55 @@
+module Rack
+  module TlsTools
+
+    # https://developer.mozilla.org/en-US/docs/Web/Security/Public_Key_Pinning
+    class Hpkp
+
+      # three months
+      DEFAULT_MAX_AGE = 3600 * 24 * 60
+
+      def initialize(app, options = {})
+        @app = app
+        @options = {
+          enable: true,
+          max_age: DEFAULT_MAX_AGE,
+          subdomains: false,
+          hosts: [],
+        }.merge(options)
+        @config_by_hostname = flatten_host_config @options[:hosts]
+      end
+
+      def call(env)
+        @app.call(env).tap do |response|
+          @request = Rack::Request.new env
+          if @request.ssl? and config = @config_by_hostname[@request.host] and config[:enable]
+            add_hpkp_header! response[1], config
+          end
+        end
+      end
+
+      private
+
+      def add_hpkp_header!(headers, config)
+        val = config[:sha256].map{|h|%{pin-sha256="#{h}"}}.join('; ')
+        val << %{; max-age=#{config[:max_age]}}         if config[:max_age]
+        val << %{; includeSubDomains}                   if config[:subdomains]
+        val << %{; report-uri="#{config[:report_uri]}"} if config[:report_uri]
+        headers['Public-Key-Pins'] = val
+      end
+
+      def flatten_host_config(hosts)
+        {}.tap do |config_by_hostname|
+          hosts.each do |host_config|
+            host_config[:names].each do |hostname|
+              cfg = @options.merge host_config
+              cfg.delete :names
+              cfg.delete :hosts
+              config_by_hostname[hostname] = cfg
+            end
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/rack/tls_tools/hsts.rb

@@ -0,0 +1,38 @@
+module Rack
+  module TlsTools
+
+    # http://en.wikipedia.org/wiki/Strict_Transport_Security
+    class Hsts
+
+      # a year
+      DEFAULT_MAX_AGE = 3600 * 24 * 365
+
+      def initialize(app, options = {})
+        @app = app
+        @options = {
+          enable: true,
+          max_age: DEFAULT_MAX_AGE,
+          subdomains: false,
+        }.merge(options)
+      end
+
+      def call(env)
+        @app.call(env).tap do |response|
+          @request = Rack::Request.new env
+          if @request.ssl? && @options[:enable]
+            add_hsts_header! response[1]
+          end
+        end
+      end
+
+      private
+
+      def add_hsts_header!(headers)
+        val = "max-age=#{@options[:max_age]}"
+        val += "; includeSubDomains" if @options[:subdomains]
+        headers['Strict-Transport-Security'] = val
+      end
+
+    end
+  end
+end

data/lib/rack/tls_tools/secure_cookies.rb

@@ -0,0 +1,34 @@
+module Rack
+  module TlsTools
+
+    class SecureCookies
+
+      def initialize(app, *args)
+        @app = app
+      end
+
+      def call(env)
+        @app.call(env).tap do |response|
+          @request = Rack::Request.new env
+          if @request.ssl?
+            secure_cookies! response[1]
+          end
+        end
+      end
+
+      private
+
+      def secure_cookies!(headers)
+        if cookies = headers['Set-Cookie']
+          headers['Set-Cookie'] = cookies.split("\n").map do |cookie|
+            cookie =~ /(^|;\s*)secure($|\s*;)/ ? cookie : cookie + '; secure'
+          end.join("\n")
+        end
+      end
+
+    end
+
+  end
+end
+
+

data/lib/rack/tls_tools/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  module TlsTools
+    VERSION = "0.1.0"
+  end
+end

data/rack-tls_tools.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack/tls_tools/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rack-tls_tools"
+  spec.version       = Rack::TlsTools::VERSION
+  spec.authors       = ["Jens Kraemer"]
+  spec.email         = ["jk@jkraemer.net"]
+
+  spec.summary       = %q{Secure cookies, HSTS and HPKP for any Rack app}
+  spec.description   = %q{A bunch of rack middlewares to enforce secure cookies and add HSTS (Strict Transport Security) and HPKP (Public Key Pinning) headers to your Rack application.}
+  spec.homepage      = "https://github.com/jkraemer/rack-tls_tools"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'rack', '>= 1.4.0'
+  spec.add_development_dependency "bundler", ">= 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: rack-tls_tools
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jens Kraemer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-05-18 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.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+- !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: A bunch of rack middlewares to enforce secure cookies and add HSTS (Strict
+  Transport Security) and HPKP (Public Key Pinning) headers to your Rack application.
+email:
+- jk@jkraemer.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rack-tls_tools.rb
+- lib/rack/tls_tools.rb
+- lib/rack/tls_tools/hpkp.rb
+- lib/rack/tls_tools/hsts.rb
+- lib/rack/tls_tools/secure_cookies.rb
+- lib/rack/tls_tools/version.rb
+- rack-tls_tools.gemspec
+homepage: https://github.com/jkraemer/rack-tls_tools
+licenses: []
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Secure cookies, HSTS and HPKP for any Rack app
+test_files: []