x-signature 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6f1d3f9f8bffd4aee0038f5151d573e1c7ba7e81
+  data.tar.gz: a4d0d93ddf55eb587a9f3bbc6ed93ddd8ed32a6a
+SHA512:
+  metadata.gz: cffca84f57a29654d303046bbd17bc380a236a1b6e7373d7e40be49a95d42abd43c17c214bddf0dbb32ded47a4c4a5ba76b7d0b557e47f18b6d64f7f4a52fb57
+  data.tar.gz: 113f54fee2427a91cb33ed554d2512d2ce1314a7b95717bab18a41ca9405c8e9adb3435ec1dd4c1a9cd3b403d3e4b9898e246d32fe857e8569bb77ba8945b01a

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 2.2.2
+gemfile:
+  - gemfiles/rails_4.2.3.gemfile
+services:
+  - redis-server
+before_install: gem install bundler -v 1.10.6
+install: bin/setup
+script: rake

data/Appraisals

@@ -0,0 +1,3 @@
+appraise 'rails-4.2.3' do
+  gem 'rails', '4.2.3'
+end

data/Gemfile

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

data/README.md

@@ -0,0 +1,51 @@
+# XSignature
+
+This gem allows to cryptographically sign and verify API requests.
+
+[![Build Status](https://travis-ci.org/MyceliumGear/x-signature.svg)](https://travis-ci.org/MyceliumGear/x-signature)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'x-signature'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install x-signature
+
+## Usage
+
+### Rails
+
+In the controller:
+
+```ruby
+user = User.find(env['HTTP_X_CLIENT'])
+if XSignature::RailsRequestValidator.new.valid?(request: request, secret: user.api_secret)
+  # proceed
+else
+  # 401 error
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake` to run the tests. You can also 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`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/MyceliumGear/x-signature.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'appraisal'
+
+RSpec::Core::RakeTask.new(:spec)
+
+if !ENV['APPRAISAL_INITIALIZED'] && !ENV['TRAVIS']
+  task :default => :appraisal
+else
+  task :default => :spec
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "x-signature"
+
+# 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/gemfiles/rails_4.2.3.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "4.2.3"
+
+gemspec :path => "../"

data/lib/x-signature.rb

@@ -0,0 +1,22 @@
+require 'x-signature/version'
+
+module XSignature
+
+  Data = Struct.new(:secret, :signature, :client, :nonce, :method, :request_uri, :body)
+
+  XSignatureError  = Class.new(StandardError)
+  InvalidNonce     = Class.new(XSignatureError)
+  InvalidSignature = Class.new(XSignatureError)
+
+  autoload :RequestValidator, File.expand_path('../x-signature/request_validator', __FILE__)
+  autoload :RailsRequestValidator, File.expand_path('../x-signature/rails_request_validator', __FILE__)
+
+  autoload :NonceValidator, File.expand_path('../x-signature/nonce_validator', __FILE__)
+  autoload :RedisNonceValidator, File.expand_path('../x-signature/redis_nonce_validator', __FILE__)
+
+  autoload :SignatureValidator, File.expand_path('../x-signature/signature_validator', __FILE__)
+  autoload :SignatureMultiValidator, File.expand_path('../x-signature/signature_multi_validator', __FILE__)
+  autoload :Base64SignatureValidator, File.expand_path('../x-signature/base64_signature_validator', __FILE__)
+  autoload :HexSignatureValidator, File.expand_path('../x-signature/hex_signature_validator', __FILE__)
+
+end

data/lib/x-signature/base64_signature_validator.rb

@@ -0,0 +1,14 @@
+require 'openssl'
+require 'base64'
+
+module XSignature
+  class Base64SignatureValidator < SignatureValidator
+
+    def self.signature(secret:, nonce:, body:, method:, request_uri:)
+      sha512    = OpenSSL::Digest::SHA512.new
+      request   = "#{method.to_s.upcase}#{request_uri}#{sha512.digest("#{nonce}#{body}")}"
+      signature = OpenSSL::HMAC.digest(sha512, secret.to_s, request)
+      Base64.strict_encode64(signature)
+    end
+  end
+end

data/lib/x-signature/hex_signature_validator.rb

@@ -0,0 +1,12 @@
+require 'openssl'
+
+module XSignature
+  class HexSignatureValidator < SignatureValidator
+
+    def self.signature(secret:, nonce:, body:, method:, request_uri:)
+      sha512  = OpenSSL::Digest::SHA512.new
+      request = "#{method.to_s.upcase}#{request_uri}#{sha512.hexdigest("#{nonce}#{body}")}"
+      OpenSSL::HMAC.hexdigest(sha512, secret.to_s, request)
+    end
+  end
+end

data/lib/x-signature/nonce_validator.rb

@@ -0,0 +1,11 @@
+module XSignature
+  class NonceValidator
+
+    # Some state should be maintained in order to protect API from replay attack
+    # https://en.wikipedia.org/wiki/Cryptographic_nonce
+    # @param [XSignature::Data] data
+    def valid?(data)
+      fail NotImplementedError
+    end
+  end
+end

data/lib/x-signature/rails_request_validator.rb

@@ -0,0 +1,25 @@
+require 'uri'
+
+module XSignature
+  class RailsRequestValidator < RequestValidator
+
+    def validate(secret:, request:)
+      env  = request.env
+      body = request.body
+      if body.kind_of?(StringIO)
+        body = body.string
+      end
+      request_uri = (URI(env['REQUEST_URI']).request_uri rescue env['REQUEST_URI'])
+      params      = {
+        secret:      secret,
+        signature:   env['HTTP_X_SIGNATURE'],
+        client:      env['HTTP_X_CLIENT'],
+        nonce:       env['HTTP_X_NONCE'],
+        method:      request.method,
+        request_uri: request_uri,
+        body:        body,
+      }
+      super params
+    end
+  end
+end

data/lib/x-signature/redis_nonce_validator.rb

@@ -0,0 +1,31 @@
+require 'redis'
+
+module XSignature
+  class RedisNonceValidator < NonceValidator
+
+    attr_accessor :redis_connection, :keys_prefix
+
+    def initialize(redis_connection: nil, keys_prefix: 'XSignature:LastNonce:')
+      @redis_connection = redis_connection || Redis.current
+      @keys_prefix      = keys_prefix
+    end
+
+    def valid?(data)
+      key = "#{keys_prefix}#{data.client}"
+      loop do
+        redis_connection.watch key do
+          last_nonce = redis_connection.get(key).to_i
+          if last_nonce < data.nonce
+            result = redis_connection.multi do |multi|
+              multi.set key, data.nonce
+            end
+            return true if result[0] == 'OK'
+          else
+            redis_connection.unwatch
+            return false
+          end
+        end
+      end
+    end
+  end
+end

data/lib/x-signature/request_validator.rb

@@ -0,0 +1,28 @@
+module XSignature
+  class RequestValidator
+
+    attr_accessor :signature_validator, :nonce_validator
+
+    def initialize(signature_validator: nil, nonce_validator: nil)
+      @signature_validator = signature_validator || SignatureMultiValidator.new(HexSignatureValidator.new, Base64SignatureValidator.new)
+      @nonce_validator     = nonce_validator || RedisNonceValidator.new
+    end
+
+    # :secret, :signature, :client, :nonce, :method, :request_uri, :body
+    def validate(**args)
+      data = Data.new
+      args.each do |k, v|
+        data[k] = v
+      end
+      fail InvalidNonce unless @nonce_validator.valid?(data)
+      fail InvalidSignature unless @signature_validator.valid?(data)
+      true
+    end
+
+    def valid?(**args)
+      validate(**args)
+    rescue XSignatureError
+      false
+    end
+  end
+end

data/lib/x-signature/signature_multi_validator.rb

@@ -0,0 +1,14 @@
+module XSignature
+  class SignatureMultiValidator
+
+    attr_accessor :validators
+
+    def initialize(*validators)
+      @validators = validators.flatten
+    end
+
+    def valid?(data)
+      validators.any? { |validator| validator.valid?(data) }
+    end
+  end
+end

data/lib/x-signature/signature_validator.rb

@@ -0,0 +1,12 @@
+module XSignature
+  class SignatureValidator
+
+    # @param [XSignature::Data] data
+    def valid?(data)
+      params = self.class.method(:signature).parameters.map(&:last).each_with_object({}) do |param, hash|
+        hash[param] = data[param]
+      end
+      data.signature == self.class.signature(**params)
+    end
+  end
+end

data/lib/x-signature/version.rb

@@ -0,0 +1,3 @@
+module XSignature
+  VERSION = '0.1.0'
+end

data/x-signature.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'x-signature/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "x-signature"
+  spec.version       = XSignature::VERSION
+  spec.authors       = ["AlexanderPavlenko"]
+  spec.email         = ["alerticus@gmail.com"]
+
+  spec.summary       = %q{API requests signing and signature validation}
+  spec.description   = %q{Allows to create and validate cryptographic signatures on API requests}
+  spec.homepage      = "https://github.com/MyceliumGear/x-signature"
+  spec.license       = "MIT"
+
+  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_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec-rails"
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'appraisal', ">= 2.1"
+
+  spec.add_dependency 'redis'
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: x-signature
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- AlexanderPavlenko
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-10-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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'
+- !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: 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: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: redis
+  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'
+description: Allows to create and validate cryptographic signatures on API requests
+email:
+- alerticus@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Appraisals
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- gemfiles/rails_4.2.3.gemfile
+- lib/x-signature.rb
+- lib/x-signature/base64_signature_validator.rb
+- lib/x-signature/hex_signature_validator.rb
+- lib/x-signature/nonce_validator.rb
+- lib/x-signature/rails_request_validator.rb
+- lib/x-signature/redis_nonce_validator.rb
+- lib/x-signature/request_validator.rb
+- lib/x-signature/signature_multi_validator.rb
+- lib/x-signature/signature_validator.rb
+- lib/x-signature/version.rb
+- x-signature.gemspec
+homepage: https://github.com/MyceliumGear/x-signature
+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.4.8
+signing_key: 
+specification_version: 4
+summary: API requests signing and signature validation
+test_files: []