rack-esa_webhooks 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2beb7922f4a8e682a8ae3517e89c355f30af7725
+  data.tar.gz: 86869a9571045e3ef074e45df3c20408909e5cb2
+SHA512:
+  metadata.gz: adc8594d9367dff7bd32afe6d0c05f6c927e8b29e1156d41cc0103021913c30f568794cf089cf7345dfd972632c8a5f1283afb6ca7c527a7e8ea5809566a5587
+  data.tar.gz: 890f3dc879a1e252e98ceb1ab176bf94a8cd7f0c10f8a0846d6f977c542f2f33bb8f0761e83410d963ee4407f1a5a9698bd82be53124d98354a590592ebe977d

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+cache: bundler
+rvm:
+  - 2.1.9
+  - 2.2.4
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Chris Mytton
+
+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,44 @@
+# Rack::EsaWebhooks [![Build Status](https://travis-ci.org/ppworks/rack-esa_webhooks.svg?branch=master)](https://travis-ci.org/ppworks/rack-esa_webhooks)
+
+Rack middleware for validating esa.io webhooks.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rack-esa_webhooks'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-esa_webhooks
+
+## Usage
+
+Use it in your `config.ru` file, in your Sinatra app or in Rails' `config/routes.rb` file as you would any other Rack middleware. You need to provide a `secret` option which is the webhook secret you supplied when creating your esa.io webhook.
+
+```ruby
+require 'rack/esa_webhooks'
+
+use Rack::EsaWebhooks, secret: 's3cret'
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/ppworks/rack-esa_webhooks.
+
+
+## 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,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'rack/esa_webhooks'
+
+# 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.
+
+require 'pry'
+Pry.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/esa_webhooks.rb

@@ -0,0 +1,48 @@
+require 'rack/esa_webhooks/version'
+require 'openssl'
+require 'json'
+
+module Rack
+  class EsaWebhooks
+    class Signature
+      HMAC_DIGEST = OpenSSL::Digest.new('sha256')
+
+      def initialize(secret, signature_in_header, payload_body)
+        @secret = secret
+        @signature_in_header = signature_in_header
+        @signature = "sha256=#{OpenSSL::HMAC.hexdigest(HMAC_DIGEST, secret, payload_body)}"
+      end
+
+      def valid?
+        return true unless @secret
+        return false unless @signature_in_header
+        Rack::Utils.secure_compare(@signature, @signature_in_header)
+      end
+    end
+
+    def initialize(app, opts = {})
+      @app = app
+      @secret = opts[:secret]
+    end
+
+    def call(env)
+      rewind_body(env)
+      signature = Signature.new(
+        @secret,
+        env['HTTP_X_ESA_SIGNATURE'],
+        env['rack.input'].read
+      )
+      return [400, {}, ["Signatures didn't match!"]] unless signature.valid?
+
+      rewind_body(env)
+      @app.call(env)
+    end
+
+    private
+
+    def rewind_body(env)
+      env['rack.input'].rewind if env['rack.input'].respond_to?(:rewind)
+    rescue Errno::ESPIPE
+    end
+  end
+end

data/lib/rack/esa_webhooks/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  class EsaWebhooks
+    VERSION = '1.0.0'
+  end
+end

data/rack-esa_webhooks.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack/esa_webhooks/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rack-esa_webhooks'
+  spec.version       = Rack::EsaWebhooks::VERSION
+  spec.authors       = ['Koshikawa']
+  spec.email         = ['koshikawa@ppworks.jp']
+
+  spec.summary       = 'Rack middleware to check esa webhooks are authentic'
+  spec.homepage      = 'https://github.com/ppworks/rack-esa_webhook'
+  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 'minitest'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rack-test'
+  spec.add_development_dependency 'simplecov'
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: rack-esa_webhooks
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Koshikawa
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-17 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: minitest
+  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: pry
+  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: rack-test
+  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'
+description: 
+email:
+- koshikawa@ppworks.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rack/esa_webhooks.rb
+- lib/rack/esa_webhooks/version.rb
+- rack-esa_webhooks.gemspec
+homepage: https://github.com/ppworks/rack-esa_webhook
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Rack middleware to check esa webhooks are authentic
+test_files: []