rakuna-content-signature 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fa5bcf9c29b084f58b3c08a6facebfe807a7f0de
+  data.tar.gz: 57acc457ca8f943556480ce26caaf0ba7c6dbc7c
+SHA512:
+  metadata.gz: 3f406ce7f48286bd88c7e99231ec1751263b90f9d670c3647f117450ef0895c306e1713d3a561a8f7ac19cf864dc682a2a4d904686352dca15301f49b0e7ea53
+  data.tar.gz: b0e38bdfdaf8c8ad58035456b33605574deefe00eb705332b59fb172759e0f13f9f58124b6152a9c92062660a9017a14d05581743a1d407a2065af9e9936ac97

data/Gemfile

@@ -0,0 +1,24 @@
+source 'https://rubygems.org'
+
+gem 'rakuna-core', '~> 1.0'
+
+platform :ruby do
+  gem 'fast_secure_compare', '~> 1.0'
+end
+
+platform :jruby do
+  gem 'secure_compare', '~> 0.0'
+end
+
+group :development do
+  gem 'bundler', '~> 1.10'
+  gem 'flog', '~> 4.3'
+  gem 'inch', '~> 0.6'
+  gem 'jeweler', '~> 2.0'
+  gem 'reek', '~> 3.1'
+  gem 'roodi', '~> 5.0'
+  gem 'rspec', '~> 3.3'
+  gem 'rubocop', '~> 0.33'
+  gem 'simplecov', '~> 0.10'
+  gem 'yard', '~> 0.8'
+end

data/Gemfile.lock

@@ -0,0 +1,164 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    abstract_type (0.0.7)
+    adamantium (0.2.0)
+      ice_nine (~> 0.11.0)
+      memoizable (~> 0.4.0)
+    addressable (2.3.8)
+    as-notifications (1.0.1)
+    ast (2.1.0)
+    astrolabe (1.3.1)
+      parser (~> 2.2)
+    builder (3.2.2)
+    coderay (1.1.0)
+    concord (0.1.5)
+      adamantium (~> 0.2.0)
+      equalizer (~> 0.0.9)
+    contracts (0.11.0)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    equalizer (0.0.11)
+    faraday (0.9.1)
+      multipart-post (>= 1.2, < 3)
+    fast_secure_compare (1.0.1)
+    flog (4.3.2)
+      ruby_parser (~> 3.1, > 3.1.0)
+      sexp_processor (~> 4.4)
+    git (1.2.9.1)
+    github_api (0.12.4)
+      addressable (~> 2.3)
+      descendants_tracker (~> 0.0.4)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 3.4)
+      multi_json (>= 1.7.5, < 2.0)
+      nokogiri (~> 1.6.6)
+      oauth2
+    hashie (3.4.2)
+    highline (1.7.3)
+    i18n (0.7.0)
+    ice_nine (0.11.1)
+    inch (0.6.4)
+      pry
+      sparkr (>= 0.2.0)
+      term-ansicolor
+      yard (~> 0.8.7.5)
+    jeweler (2.0.1)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+    json (1.8.3)
+    jwt (1.5.1)
+    memoizable (0.4.2)
+      thread_safe (~> 0.3, >= 0.3.1)
+    method_source (0.8.2)
+    mini_portile (0.6.2)
+    multi_json (1.11.2)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nokogiri (1.6.6.2)
+      mini_portile (~> 0.6.0)
+    oauth2 (1.0.0)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    parser (2.2.2.6)
+      ast (>= 1.1, < 3.0)
+    powerpack (0.1.1)
+    private_attr (1.1.0)
+    procto (0.0.2)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rack (1.6.4)
+    rainbow (2.0.0)
+    rake (10.4.2)
+    rakuna-core (1.0.0)
+      contracts (~> 0.11)
+      webmachine (~> 1.4)
+    rdoc (4.2.0)
+    reek (3.3.1)
+      parser (~> 2.2.2.5)
+      private_attr (~> 1.1)
+      rainbow (~> 2.0)
+      unparser (~> 0.2.2)
+    roodi (5.0.0)
+      ruby_parser (~> 3.2, >= 3.2.2)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.2)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    rubocop (0.34.1)
+      astrolabe (~> 1.3)
+      parser (>= 2.2.2.5, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.4)
+    ruby-progressbar (1.7.5)
+    ruby_parser (3.7.1)
+      sexp_processor (~> 4.1)
+    sexp_processor (4.6.0)
+    simplecov (0.10.0)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    slop (3.6.0)
+    sparkr (0.4.1)
+    term-ansicolor (1.3.2)
+      tins (~> 1.0)
+    thread_safe (0.3.5)
+    tins (1.6.0)
+    unparser (0.2.4)
+      abstract_type (~> 0.0.7)
+      adamantium (~> 0.2.0)
+      concord (~> 0.1.5)
+      diff-lcs (~> 1.2.5)
+      equalizer (~> 0.0.9)
+      parser (~> 2.2.2)
+      procto (~> 0.0.2)
+    webmachine (1.4.0)
+      as-notifications (~> 1.0)
+      i18n (>= 0.4.0)
+      multi_json
+    yard (0.8.7.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.10)
+  fast_secure_compare (~> 1.0)
+  flog (~> 4.3)
+  inch (~> 0.6)
+  jeweler (~> 2.0)
+  rakuna-core (~> 1.0)
+  reek (~> 3.1)
+  roodi (~> 5.0)
+  rspec (~> 3.3)
+  rubocop (~> 0.33)
+  secure_compare (~> 0.0)
+  simplecov (~> 0.10)
+  yard (~> 0.8)
+
+BUNDLED WITH
+   1.10.6

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2015 Chris Olstrom
+
+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,62 @@
+# rakuna-content-signature
+
+Content signatures for Rakuna and Webmachine!
+
+# Description
+
+Adds support for HMAC signatures with optional shared secrets to your Webmachine resources.
+
+# Installation
+`gem install rakuna-content-signature`
+
+# Usage
+`require 'rakuna/validation/signature'`
+
+## Examples
+
+### Rejecting a payload with a missing or invalid signature.
+```ruby
+class ExampleResource < Rakuna::Resource::Action
+  include Rakuna::Validation::Signature
+
+  def malformed_request?
+    true unless signature_valid?
+  end
+end
+```
+
+### Validating a GitHub payload
+```ruby
+class ExampleResource < Rakuna::Resource::Action
+  include Rakuna::Validation::Signature
+
+  def signature_secret
+    ENV['GITHUB_SECRET']
+  end
+
+  def content_signature
+    request.headers['X-Hub-Signature']
+  end
+
+  def malformed_request?
+    true unless signature_valid?
+  end
+end
+```
+
+
+
+# Contributing
+  * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+  * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+  * Fork the project.
+  * Start a feature/bugfix branch.
+  * Commit and push until you are happy with your contribution.
+  * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+  * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+# License
+[MIT](https://tldrlegal.com/license/mit-license)
+
+# Contributors
+  * [Chris Olstrom](https://colstrom.github.io/) | [e-mail](mailto:chris@olstrom.com) | [Twitter](https://twitter.com/ChrisOlstrom)

data/Rakefile

@@ -0,0 +1,56 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = 'rakuna-content-signature'
+  gem.homepage = "http://github.com/colstrom/rakuna-content-signature"
+  gem.license = "MIT"
+  gem.summary = %Q{Content signatures for Rakuna and Webmachine}
+  gem.description = %Q{Adds support for HMAC signatures with optional shared secrets to your Webmachine resources}
+  gem.email = "chris@olstrom.com"
+  gem.authors = ["Chris Olstrom"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['spec'].execute
+end
+
+require 'reek/rake/task'
+Reek::Rake::Task.new do |t|
+  t.fail_on_error = true
+  t.verbose = false
+  t.source_files = 'lib/**/*.rb'
+end
+
+require 'roodi'
+require 'roodi_task'
+RoodiTask.new do |t|
+  t.verbose = false
+end
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/rakuna/content/signature.rb

@@ -0,0 +1,43 @@
+require 'contracts'
+require 'openssl'
+
+module Rakuna
+  module Content
+    module Signature
+      include Contracts
+
+      class ContentSignature
+        include Contracts
+
+        Contract String => Any
+        def initialize(secret)
+          @secret = secret
+        end
+
+        Contract None => OpenSSL::Digest
+        def digest
+          @digest ||= OpenSSL::Digest::SHA1.new
+        end
+
+        Contract Maybe[String] => String
+        def generate(content)
+          [
+            digest.name.downcase,
+            '=',
+            OpenSSL::HMAC.hexdigest(digest, @secret, content)
+          ].join ''
+        end
+      end
+
+      Contract None => String
+      def signature_secret
+        ENV.fetch 'CONTENT_SIGNING_SECRET', ''
+      end
+
+      Contract None => ContentSignature
+      def signature
+        @signature ||= ContentSignature.new signature_secret
+      end
+    end
+  end
+end

data/lib/rakuna/validation/signature.rb

@@ -0,0 +1,30 @@
+require 'contracts'
+require 'rakuna/content/signature'
+
+if RUBY_ENGINE == 'jruby'
+  require 'secure_compare'
+  SECURE_COMPARE = SecureCompare
+else
+  require 'fast_secure_compare/fast_secure_compare'
+  SECURE_COMPARE = FastSecureCompare
+end
+
+module Rakuna
+  module Validation
+    module Signature
+      include Contracts
+      include Rakuna::Content::Signature
+
+      Contract None => Maybe[String]
+      def content_signature
+        @content_signature ||= request.headers['X-Content-Signature']
+      end
+
+      Contract None => Bool
+      def signature_valid?
+        return false unless content_signature
+        SECURE_COMPARE.compare content_signature, signature.generate(request.body.to_s)
+      end
+    end
+  end
+end

data/spec/rakuna/content/signature_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe 'RakunaContentSignature' do
+  it 'fails' do
+    fail 'No tests written. Come on dude, you know better.'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,37 @@
+require 'simplecov'
+
+module SimpleCov
+  # SimpleCov configuration
+  module Configuration
+    def clean_filters
+      @filters = []
+    end
+  end
+end
+
+SimpleCov.configure do
+  clean_filters
+  load_profile 'test_frameworks'
+end
+
+ENV['COVERAGE'] && SimpleCov.start do
+  add_filter '/.rvm/'
+  add_filter '/.rubies/'
+  add_filter '/vendor/'
+end
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'rspec'
+require 'rakuna/content/signature'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -0,0 +1,238 @@
+--- !ruby/object:Gem::Specification
+name: rakuna-content-signature
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Chris Olstrom
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rakuna-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: fast_secure_compare
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: secure_compare
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+- !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: flog
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+- !ruby/object:Gem::Dependency
+  name: inch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  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: reek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: roodi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.33'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.33'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: Adds support for HMAC signatures with optional shared secrets to your
+  Webmachine resources
+email: chris@olstrom.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- lib/rakuna/content/signature.rb
+- lib/rakuna/validation/signature.rb
+- spec/rakuna/content/signature_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/colstrom/rakuna-content-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.5.1
+signing_key: 
+specification_version: 4
+summary: Content signatures for Rakuna and Webmachine
+test_files: []