rack-contrib-sign 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e063e40cf6ff43aa7ccd9f89e905d4f87a733baf
+  data.tar.gz: 7a20e29567951a4d2908bb5a64aea76820fb4c87
+SHA512:
+  metadata.gz: 7d2255f91a0a46d4f65a26ab6589a1c480ef9caa5fa0a2b27f55900cb90c367f4f1689e06ea836df5552a074f7c3256aa939b0e0a6bd9f41f64d3092461321a2
+  data.tar.gz: e4013973326b23f2f14101a725b775f908409ccefaa313208257460b76e2fafddad8166c4014de3a671d51f50ea73df4947343e83d229f25029f06da19e373ea

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/.rspec

@@ -0,0 +1,2 @@
+--color
+--format=doc

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gemspec
+

data/Guardfile

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+guard :rspec, all_on_start: false, all_after_pass: false, notification: false do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb') { "spec" }
+end
+
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 ZippyKid
+
+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,30 @@
+# Rack::Contrib::Sign
+
+Implement thorough request signing in Rack.
+
+## Installation
+
+
+    gem 'rack-contrib-sign'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-contrib-sign
+
+## Usage
+
+Install in Rack by adding the following to your config.ru:
+
+```ruby
+require 'rack/contrib/sign'
+use Rack::Contrib::Sign::Middleware
+```
+
+## Specific Authentication Details
+
+This gem works by creating a receipt which gets HMAC hashed with a secret.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec
+

data/lib/rack/contrib/sign.rb

@@ -0,0 +1,15 @@
+
+require 'logger'
+
+require "rack/contrib/sign/version"
+require 'rack/contrib/sign/middleware'
+require 'rack/contrib/sign/receipt'
+
+module Rack
+  module Contrib
+    module Sign
+
+    end
+  end
+end
+

data/lib/rack/contrib/sign/middleware.rb

@@ -0,0 +1,109 @@
+
+module Rack
+  module Contrib
+    module Sign
+      class Middleware
+        def initialize app, opts
+
+          @app = app
+          @logger = opts[:logger]
+          @realm = opts[:realm]
+          @credentials = opts[:credentials]
+          @header_prefix = (opts[:prefix] || "").gsub(/-/, '_').downcase
+        end
+
+        def call env
+          creds = extract_credentials env['HTTP_AUTHORIZATION']
+          unless creds
+            @logger.info "Denied: Authorization header not present or invalid."
+            return [401, {}, []]
+          end
+
+          receipt = build_receipt env, creds
+          unless receipt.api_secret
+            @logger.info "Denied: API key not recognized."
+            return [401, {}, []]
+          end
+
+          sign = receipt.to_s
+
+          digest = OpenSSL::Digest::Digest.new('sha1')
+          validation = OpenSSL::HMAC.hexdigest(digest, receipt.api_secret, sign)
+
+          unless validation == creds[:signature]
+            @logger.error "Denied: Authorization signature does not match"
+            @logger.info "Denied: EXPECTED: %s GOT: %s" % [
+              validation,
+              creds[:signature]
+            ]
+            @logger.debug "Generated signing data:"
+            @logger.debug sign
+            return [401, {}, []]
+          end
+
+          @app.call env
+        end
+
+        # Extract environmental data into a Receipt
+        def build_receipt env, credentials
+          receipt = Rack::Contrib::Sign::Receipt.new
+          receipt.uri = env['REQUEST_URI']
+          receipt.request_method = env['REQUEST_METHOD']
+          receipt.body = extract_body env
+
+          extract_headers(env).each { |h,v| receipt.headers[h] = v }
+
+          receipt.api_key = credentials[:key]
+          receipt.api_secret = get_secret(credentials[:key])
+
+          receipt
+        end
+
+        # Extract the body from the environment, ensuring to rewind
+        # the input back to zero, so future access gets the arguments.
+        def extract_body env
+          env['rack.input'].read
+        ensure
+          env['rack.input'].rewind
+        end
+
+        # Extract all the headers with our Prefix from the ENV
+        # and return the hash
+        def extract_headers env
+          headers = {}
+
+          env.sort_by { |k,v| k.to_s.downcase }.each do |key,val|
+            next unless key =~ /^http_#{@header_prefix}/i
+            header = key.sub(/^http_/i, '').gsub(/_/, '-')
+            headers[header] = val
+          end
+
+          headers
+        end
+
+        # Pass in the Authorization header, and get back the key
+        # and signature.
+        def extract_credentials auth_header
+          return false if auth_header.nil?
+
+          pattern = /^(?<realm>.*) (?<api_key>.*):(?<signature>.*)$/
+          matches = auth_header.match(pattern)
+
+          return false if matches.nil?
+          return false unless matches[:realm] == @realm
+
+          {
+            key: matches[:api_key],
+            signature: matches[:signature]
+          }
+        end
+
+        def get_secret api_key
+          return false unless @credentials.has_key? api_key
+
+          return @credentials.fetch(api_key)
+        end
+      end
+    end
+  end
+end

data/lib/rack/contrib/sign/receipt.rb

@@ -0,0 +1,48 @@
+
+module Rack
+  module Contrib
+    module Sign
+      class Receipt
+        attr_reader :request_method
+        attr_reader :headers
+        attr_accessor :api_key
+        attr_accessor :api_secret
+        attr_accessor :body
+        attr_accessor :uri
+
+        def initialize
+          @headers = {}
+        end
+
+        def request_method= s
+          @request_method = s.upcase
+        end
+
+        def to_s
+          preamble + header_text
+        end
+
+        def preamble
+          s = ""
+          s << "%s %s\n" % [request_method, uri]
+          s << "%s\n" % api_key
+          s << "%s\n" % api_secret
+          s << "%s\n" % body
+          s << "--\n"
+          s
+        end
+
+        def header_text
+          s = ""
+
+          headers.sort_by { |k,v| k.downcase }.each do |header, value|
+            s << "%s:%s\n" % [header.downcase, value]
+          end
+
+          s
+        end
+      end
+    end
+  end
+end
+

data/lib/rack/contrib/sign/version.rb

@@ -0,0 +1,7 @@
+module Rack
+  module Contrib
+    module Sign
+      VERSION = "0.0.1"
+    end
+  end
+end

data/rack-contrib-sign.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack/contrib/sign/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rack-contrib-sign"
+  spec.version       = Rack::Contrib::Sign::VERSION
+  spec.authors       = ["Graham Christensen"]
+  spec.email         = ["info@zippykid.com"]
+  spec.description   = %q{Implement secure API request igning.}
+  spec.summary       = %q{Validates headers and API keys in Authorization}
+  spec.homepage      = "https://github.com/zippykid/rack-contrib-sign"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency('guard')
+  spec.add_development_dependency('guard-rspec')
+
+end
+

data/spec/rack/contrib/sign/middleware_spec.rb

@@ -0,0 +1,174 @@
+require 'spec_helper'
+
+describe Rack::Contrib::Sign::Middleware do
+  let (:app) do
+    app = double()
+    app.stub(:call => 'Hello, world!')
+
+    app
+  end
+  let (:log_string) { StringIO.new }
+  let (:logger) do
+    logger = Logger.new(log_string, Logger::DEBUG)
+    logger.formatter = proc do |severity, datetime, progname, msg|
+      "#{severity} - #{msg}\n"
+    end
+
+    logger
+  end
+  let (:cred_provider) { Hash.new }
+  let (:ware) { Rack::Contrib::Sign::Middleware.new(
+    app,
+    logger: logger,
+    realm: "foo-bar",
+    prefix: "HI-",
+    credentials: cred_provider,
+  )}
+
+  describe "#build_receipt" do
+    it "sets various options" do
+      env = {
+        'REQUEST_METHOD' => 'POST',
+        'REQUEST_URI' => 'foo/bar',
+        'HTTP_HI_FOOO' => 'YIPEE',
+        'rack.input' => StringIO.new('foo=bar')
+      }
+      cred_provider['123'] = 'abc'
+      creds = { key: '123', signature: 'foo' }
+
+      receipt = ware.build_receipt(env, creds)
+
+      receipt.uri.should eq('foo/bar')
+      receipt.request_method.should eq('POST')
+      receipt.body.should eq('foo=bar')
+      receipt.api_key.should eq('123')
+      receipt.api_secret.should eq('abc')
+      receipt.headers.should eq({
+        'HI-FOOO' => 'YIPEE',
+      })
+
+    end
+  end
+
+  describe "#extract_body" do
+    it "returns the body of a request from the environment" do
+      env = {
+        'rack.input' => StringIO.new('fooz=baz')
+      }
+
+      ware.extract_body(env).should eq('fooz=baz')
+    end
+
+    it "rewinds the input after reading" do
+      str = StringIO.new('fooz=baz')
+      env = {
+        'rack.input' => str
+      }
+
+      str.pos.should eq(0)
+    end
+  end
+
+
+  describe "#extract_headers" do
+    it "returns headers prefixed with HI-" do
+      headers = {
+        'HTTP_HI_FOO' => ':/',
+        'HTTP_BYE_FOO' => ':(',
+        'HTTP_HI_oentuheou' => ':)'
+      }
+
+      found_headers = ware.extract_headers(headers)
+
+      expected_headers = {
+        'HI-FOO' => ':/',
+        'HI-oentuheou' => ':)'
+      }
+      found_headers.should eq(expected_headers)
+    end
+  end
+
+  describe "#extract_credentials" do
+    it "returns false when nil is provided" do
+      header = nil
+
+      ware.extract_credentials(header).should eq(false)
+    end
+
+    it "returns false when the header is garbled" do
+      header = "LOL WHAT I DON'T EVEN"
+
+      ware.extract_credentials(header).should eq(false)
+    end
+
+    it "returns my key and signature when a formatted string is provided" do
+      header = 'foo-bar mykey:signature'
+
+      ware.extract_credentials(header).should eq(key: 'mykey', signature: 'signature')
+    end
+
+    it "returns false if the realm fails to match" do
+      header = 'foo-bar-baz mykey:signature'
+
+      ware.extract_credentials(header).should eq(false)
+    end
+
+  end
+
+  describe "#call" do
+    context "I have no other tests" do
+      it "abandons ship if there is no authorization header" do
+        env = {}
+
+        returned = ware.call(env)
+
+        returned.should eq([401, {}, []])
+        log_string.string.should eq("INFO - Denied: Authorization header not present or invalid.\n")
+      end
+
+      it "abandons ship if the API key is not known" do
+        env = {
+          'HTTP_AUTHORIZATION' => 'foo-bar 123:foo',
+          'REQUEST_METHOD' => '?',
+          'rack.input' => StringIO.new()
+        }
+
+        returned = ware.call(env)
+
+        returned.should eq([401, {}, []])
+        log_string.string.should eq("INFO - Denied: API key not recognized.\n")
+      end
+
+      it "401s when I don't sign it right" do
+        env = {
+          'HTTP_AUTHORIZATION' => 'foo-bar abc:YABBA DABBA DOOO',
+          'REQUEST_METHOD' => 'POST',
+          'REQUEST_URI' => 'http://foo/bar/baz',
+          'rack.input' => StringIO.new('foo=bar'),
+        }
+
+        returned = ware.call(env)
+
+        returned.should eq([401, {}, []])
+      end
+      it "works when I sign it right" do
+        cred_provider['123'] = 'abc'
+        env = {
+          'HTTP_AUTHORIZATION' => 'foo-bar 123:0d501b6934dc0ec5f1452947a7afd108e41c91af',
+          'REQUEST_METHOD' => 'POST',
+          'REQUEST_URI' => 'http://foo/bar/baz',
+          'rack.input' => StringIO.new('foo=bar'),
+          'HTTP_HI_FOOOO' => 'aoenuoneuh',
+          'HTTP_BYE_FOOO' => 'oeucorgcgc'
+        }
+
+        returned = ware.call(env)
+
+        log_string.string.should eq('')
+        app.should have_received(:call).once.with(env)
+        returned.should eq('Hello, world!')
+      end
+    end
+  end
+end
+

data/spec/rack/contrib/sign/receipt_spec.rb

@@ -0,0 +1,91 @@
+
+require 'spec_helper'
+
+describe Rack::Contrib::Sign::Receipt do
+  let (:receipt) { Rack::Contrib::Sign::Receipt.new }
+  it { should respond_to(:api_key) }
+  it { should respond_to(:api_key=) }
+  it { should respond_to(:api_secret) }
+  it { should respond_to(:api_secret=) }
+  it { should respond_to(:body) }
+  it { should respond_to(:body=) }
+  it { should respond_to(:request_method) }
+  it { should respond_to(:request_method=) }
+  it { should respond_to(:uri) }
+  it { should respond_to(:uri=) }
+  it { should respond_to(:headers) }
+
+  describe "#request_method" do
+    it "upcases the method" do
+      receipt.request_method = 'post'
+      receipt.request_method.should eq('POST')
+    end
+  end
+
+  describe "#headers" do
+    it "defaults to an empty hash" do
+      receipt.headers.should eq({})
+    end
+
+    it "keeps around my headers" do
+      receipt.headers['A-a'] = 'foo'
+      receipt.headers['B-b'] = 'bar'
+
+      headers = receipt.headers
+
+      headers.should eq({
+        'A-a' => 'foo',
+        'B-b' => 'bar'
+      })
+    end
+  end
+
+  describe "#preamble" do
+    it "incorporates all the preamble elements in a string block" do
+      receipt.api_key = 'abc'
+      receipt.api_secret = '123'
+      receipt.body = 'foo=bar'
+      receipt.request_method = 'post'
+      receipt.uri = 'http://example.com/123'
+
+      returned = receipt.preamble
+
+      r = "POST http://example.com/123\n"
+      r << "abc\n"
+      r << "123\n"
+      r << "foo=bar\n"
+      r << "--\n"
+
+      returned.should eq(r)
+    end
+  end
+
+  describe "#header_test" do
+    it "sorts the headers alphabetically and lowercases them" do
+      receipt.headers['B-b'] = 'bar'
+      receipt.headers['A-a'] = 'foo'
+
+      headers = receipt.header_text
+
+      r = ""
+      r << "a-a:foo\n"
+      r << "b-b:bar\n"
+
+      headers.should eq(r)
+    end
+  end
+
+  describe "#to_s" do
+    it "mushes to gether the preamble and headers" do
+      receipt.stub(:preamble => "foo\n--\n")
+      receipt.stub(:header_text=> "bar\n")
+
+      returned = receipt.to_s
+
+      receipt.should have_received(:preamble)
+      receipt.should have_received(:header_text)
+      returned.should eq("foo\n--\nbar\n")
+    end
+  end
+end
+

data/spec/rack/contrib/sign/version_spec.rb

@@ -0,0 +1,11 @@
+
+require "spec_helper"
+
+describe Rack::Contrib::Sign do
+  describe "#VERSION" do
+    it "has a version" do
+      Rack::Contrib::Sign::VERSION.should_not eq('')
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'simplecov'
+require 'stringio'
+
+SimpleCov.start do
+  add_group "Rack Code", "/lib"
+end
+
+require 'rspec'
+require 'rack/contrib/sign'
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+end
+

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: rack-contrib-sign
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Graham Christensen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: 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: rspec
+  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: simplecov
+  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: guard
+  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: guard-rspec
+  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: Implement secure API request igning.
+email:
+- info@zippykid.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rack/contrib/sign.rb
+- lib/rack/contrib/sign/middleware.rb
+- lib/rack/contrib/sign/receipt.rb
+- lib/rack/contrib/sign/version.rb
+- rack-contrib-sign.gemspec
+- spec/rack/contrib/sign/middleware_spec.rb
+- spec/rack/contrib/sign/receipt_spec.rb
+- spec/rack/contrib/sign/version_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/zippykid/rack-contrib-sign
+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.0.5
+signing_key: 
+specification_version: 4
+summary: Validates headers and API keys in Authorization
+test_files:
+- spec/rack/contrib/sign/middleware_spec.rb
+- spec/rack/contrib/sign/receipt_spec.rb
+- spec/rack/contrib/sign/version_spec.rb
+- spec/spec_helper.rb