rails-request-signing 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ec42a4e43d44e4ba59ddc7e9757476e64be78d02
+  data.tar.gz: 8a9cd4b084cbe675e937d5fbde25a25f9674e5e0
+SHA512:
+  metadata.gz: e483b0cc8bb46c53a3a9b0320c08fd00b409a0e916ef6e8a45a4deadd9649e5bfbb2ac75b1274fd20934fd43fb13fdaaf9908e5d322cc79a1e45515a6467dfdb
+  data.tar.gz: fffc082d74fa9854e9625486ed4c10a1cd24eb1d31ffdb027f472b7b1e11e6ab3ea293b06d0aac570ff082313e7ccb7c4f279b3c536b14424c7a88647ccbe2b4

data/.gitignore

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

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,51 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :bundler do
+  watch('Gemfile')
+  watch(/^.+\.gemspec/)
+end
+
+guard 'pow' do
+  watch('.powrc')
+  watch('.powenv')
+  watch('.rvmrc')
+  watch('.ruby-version')
+  watch('Gemfile')
+  watch('Gemfile.lock')
+  watch('config/application.rb')
+  watch('config/environment.rb')
+  watch(%r{^config/environments/.*\.rb$})
+  watch(%r{^config/initializers/.*\.rb$})
+end
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rsspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separetly)
+#  * 'just' rspec: 'rspec'
+guard :rspec, cmd: 'bundle exec rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml|\.slim)$})          { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+  watch('spec/rails_helper.rb')                       { "spec" }
+
+  # Capybara features specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml|slim)$})     { |m| "spec/features/#{m[1]}_spec.rb" }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Vlad Verestiuc
+
+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,29 @@
+# Rails::Request::Signing
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rails-request-signing'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rails-request-signing
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/rails-request-signing/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/rails/request/signing/validator.rb

@@ -0,0 +1,76 @@
+module Rails::Request::Signing
+
+  class SigningError < StandardError
+  end
+
+  class MissingSignatureKey < SigningError
+  end
+
+  class MissingSignatureChecksum < SigningError
+  end
+
+  class BadSignatureError < SigningError
+  end
+
+
+  class Validator
+
+    delegate :env, :headers, to: :@request
+
+    def initialize(credentials, request)
+      @credentials = credentials
+      @request = request
+    end
+
+
+    def validate!
+
+      error = if missing_access_key?
+        Rails::Request::Signing::MissingSignatureKey.new("missing X-Signature-ID header")
+      elsif missing_signature?
+        Rails::Request::Signing::MissingSignatureChecksum.new("missing X-Signature header")
+      elsif invalid_signature?
+        Rails::Request::Signing::BadSignatureError.new("Bad signature #{provided_signature} expected #{expected_signature}")
+      end
+
+      raise error if error
+
+    end
+
+    def signer_identityfier
+      headers["HTTP_X_SIGNATURE_ID"]
+    end
+
+    protected
+    def missing_access_key?
+      ! headers.key?("HTTP_X_SIGNATURE_ID")
+    end
+
+
+    def missing_signature?
+      ! headers.key?("HTTP_X_SIGNATURE")
+    end
+
+
+    def invalid_signature?
+      provided_signature.blank? or secret_key.blank? or expected_signature != provided_signature
+    end
+
+    def expected_signature
+      @expected_signature ||= begin
+        buffer = "#{secret_key}#{env["QUERY_STRING"]}#{env["RAW_POST_DATA"]}"
+        checksum = Digest::SHA2.hexdigest(buffer)
+      end if secret_key
+    end
+
+    def secret_key
+      @credentials[:secret_key]
+    end
+
+    def provided_signature
+      @provided_signature ||= headers["HTTP_X_SIGNATURE"]
+    end
+
+
+  end
+end

data/lib/rails/request/signing/version.rb

@@ -0,0 +1,7 @@
+module Rails
+  module Request
+    module Signing
+      VERSION = "0.0.1"
+    end
+  end
+end

data/lib/rails/request/signing.rb

@@ -0,0 +1,45 @@
+require "rails/request/signing/version"
+module Rails
+  module Request
+    module Signing
+
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        def requires_signed_request_by!(signer, options={})
+          process_signed_request! signer, true, options
+        end
+
+        def maybe_signed_request_by!(signer, options={})
+          process_signed_request! signer, false, options
+        end
+
+        def process_signed_request!(signer, required = true, options={})
+
+          prepend_before_filter(options) do
+            break unless required
+            helper = method(signer)
+
+            signing_entity = helper.arity.zero? ? helper.call :  helper.call(request.headers["HTTP_X_SIGNATURE_ID"])
+
+            credentials = {}
+            credentials = signing_entity.to_credentials if signing_entity.respond_to? :to_credentials
+
+            validator = Validator.new(credentials, request)
+            validator.validate!
+
+          end
+
+        end
+
+      end
+
+    end
+  end
+end
+
+
+
+require 'rails/request/signing/validator'
+
+

data/rails-request-signing.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rails/request/signing/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rails-request-signing"
+  spec.version       = Rails::Request::Signing::VERSION
+  spec.authors       = ["Vlad Verestiuc"]
+  spec.email         = ["verestiuc.vlad@gmail.com"]
+  spec.summary       = %q{Request signing for rails}
+  spec.description   = %q{Request signing for rails}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rails"
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'guard'
+  spec.add_development_dependency 'guard-bundler'
+  spec.add_development_dependency 'guard-pow'
+  spec.add_development_dependency 'guard-rspec'
+  spec.add_development_dependency 'rspec-rails'
+  spec.add_development_dependency "timecop"
+  spec.add_development_dependency "sqlite3"
+
+end

data/spec/lib/rails/request/signing/validator_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe Rails::Request::Signing::Validator do
+
+  let(:request) {
+    double({
+      headers: {
+        "HTTP_X_SIGNATURE_ID" => "1234",
+        "HTTP_X_SIGNATURE" => "153de60c0f481f16a4e229806afa87b27c8b8e8dd62406569d6172f5a7c86cce"
+      },
+      env: {
+        "QUERY_STRING" => "example_param=example_value",
+        "RAW_POST_DATA" => "request body"
+      }
+    })
+  }
+  subject{ Rails::Request::Signing::Validator.new({secret_key: "1234", access_key: "1234" }, request) }
+
+  it "should be valid" do
+    expect{subject.validate!}.not_to raise_error
+  end
+
+  it "should raise MissingSignatureKey" do
+    request.headers.delete "HTTP_X_SIGNATURE_ID"
+    expect{subject.validate!}.to raise_error Rails::Request::Signing::MissingSignatureKey
+  end
+
+  it "should raise MissingSignature" do
+    request.headers.delete "HTTP_X_SIGNATURE"
+    expect{subject.validate!}.to raise_error Rails::Request::Signing::MissingSignatureChecksum
+  end
+
+
+end

data/spec/lib/rails/request/signing_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+
+
+describe Rails::Request::Signing do
+
+  include RSpec::Rails::ControllerExampleGroup
+
+  controller(ActionController::Base) do
+    include Rails::Request::Signing
+    include Rails.application.routes.url_helpers
+
+    requires_signed_request_by! :api_client
+
+    def index
+      head :ok
+    end
+
+    rescue_from Rails::Request::Signing::SigningError do |e|
+      head :unauthorized
+    end
+
+    private
+    def api_client(access_key)
+      keys = {
+        '12345' => OpenStruct.new({
+          to_credentials: {
+            secret_key: '1234'
+          }
+        })
+      }[access_key]
+    end
+
+  end
+
+  before do
+    routes.draw do
+      get '/index', to: "anonymous#index"
+    end
+  end
+
+
+  it "should be success" do
+    request.headers["HTTP_X_SIGNATURE_ID"] = "12345"
+    request.headers["HTTP_X_SIGNATURE"] = "03ac674216f3e15c761ee1a5e255f067953623c8b388b4459e13f978d7c846f4"
+    expect(get :index).to be_success
+  end
+
+  it "should not be success" do
+    expect(get :index).not_to be_success
+  end
+
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,41 @@
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+$: << File.expand_path("../../lib", __FILE__)
+ENV["RAILS_ENV"] ||= 'test'
+
+require 'rails/all'
+require 'rspec/rails'
+
+require 'rails/request/signing'
+
+ActiveRecord::Base.establish_connection adapter: "sqlite3", database: ":memory:"
+
+module Rails::Request::Signing
+  class Application < Rails::Application
+
+    config.action_controller.action_on_unpermitted_parameters = :raise
+    config.secret_key_base = 'a-secret-key'
+
+  end
+end
+
+RSpec.configure do |config|
+
+
+
+  config.mock_with :rspec
+  config.infer_base_class_for_anonymous_controllers = false
+  config.order = "random"
+
+  config.filter_run focus: true
+  config.run_all_when_everything_filtered = true
+
+end
+
+ActionView::TestCase::TestController.instance_eval do
+  helper Rails.application.routes.url_helpers#, (append other helpers you need)
+end
+ActionView::TestCase::TestController.class_eval do
+  def _routes
+    Rails.application.routes
+  end
+end

metadata

@@ -0,0 +1,200 @@
+--- !ruby/object:Gem::Specification
+name: rails-request-signing
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Vlad Verestiuc
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: 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-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: guard-pow
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  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: timecop
+  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: sqlite3
+  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: Request signing for rails
+email:
+- verestiuc.vlad@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rails/request/signing.rb
+- lib/rails/request/signing/validator.rb
+- lib/rails/request/signing/version.rb
+- rails-request-signing.gemspec
+- spec/lib/rails/request/signing/validator_spec.rb
+- spec/lib/rails/request/signing_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Request signing for rails
+test_files:
+- spec/lib/rails/request/signing/validator_spec.rb
+- spec/lib/rails/request/signing_spec.rb
+- spec/spec_helper.rb