rack-verify-line-bot 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fc2410348e377e5252f08922b141238c78d192ef
+  data.tar.gz: 6bc8dff06c9deb310b70e5e022c5f883d845ad78
+SHA512:
+  metadata.gz: 75bb63b561c7a79a0b6166bad5c465075ef99e9b3b8a33c7fcab1ef60d3a97bf7567878ddb5d9578a4427b283556c84e7e86855670c8e13084bcd2e74ccce946
+  data.tar.gz: 8212a9ad11fe3311e105fe455da399a6928107a44fcef518031648412dac2ffca2c3a96d77f5c3cabf736e8811c920a063ec27c697cac98879ce8b1cf972b087

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 dayflower
+
+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,42 @@
+# Rack::Verify::Line::Bot
+
+[![CircleCI](https://circleci.com/gh/dayflower/rack-verify-line-bot.svg?style=svg)](https://circleci.com/gh/dayflower/rack-verify-line-bot)
+
+Rack middleware which verifies signature of LINE Bot's webhook requests to ensure the hook is invoked from LINE.
+
+## Usage
+
+```ruby
+# config.ru
+require 'rack/verify/line/bot'
+
+use Rack::Verify::Line::Bot :secret => ENV['SECRET'],   # channel secret (mandatory)
+                            :path   => '/hook'          # path of webhook URI
+```
+
+### Options
+
+- `:secret`
+  Specify channel secret.  This option is mandatory.
+- `:path`
+  Specify path component of webhook URL.  If omitted, every POST requests will be examined.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rack-verify-line-bot'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-verify-line-bot
+
+## 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,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rack/verify/line/bot"
+
+# 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,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rack-verify-line-bot.rb

@@ -0,0 +1 @@
+require 'rack/verify/line/bot'

data/lib/rack/verify/line/bot.rb

@@ -0,0 +1,93 @@
+require "rack/verify/line/bot/version"
+require "openssl"
+require "base64"
+
+module Rack
+  module Verify
+    module Line
+      class Bot
+        def initialize(app, options = {})
+          @app = app
+          @options = options
+
+          @secret = @options[:secret]
+          unless @secret
+            raise 'missing secret parameter for ' + self.class.name
+          end
+
+          @buffer_size = @options[:buffer_size] || 65536
+        end
+
+        def call(env)
+          if need_verification?(env)
+            unless verify_signature(env)
+              return [
+                400,
+                {
+                  'Content-Type'   => 'text/plain',
+                  'Content-Length' => '11',
+                },
+                [ 'Bad Request' ]
+              ]
+            end
+          end
+
+          @app.call(env)
+        end
+
+        private
+
+        SIGNATURE_HEADER = 'HTTP_X_LINE_SIGNATURE'
+
+        def need_verification?(env)
+          return false unless env['REQUEST_METHOD'].upcase == 'POST'
+
+          if @options[:path]
+            return false unless env['PATH_INFO'] == @options[:path]
+          end
+
+          return true
+        end
+
+        def verify_signature(env)
+          given_sig = env[SIGNATURE_HEADER]
+          return false unless given_sig
+
+          hmac = OpenSSL::HMAC.new(@secret, OpenSSL::Digest::SHA256.new)
+          update_hmac(hmac, env['rack.input'])
+          sig = Base64.strict_encode64(hmac.digest)
+
+          secure_compare(given_sig, sig)
+        end
+
+        # from https://github.com/rails/rails/blob/master/activesupport/lib/active_support/security_utils.rb
+        # Rails is released under MIT license
+        def secure_compare(a, b)
+          return false unless a.bytesize == b.bytesize
+
+          l = a.unpack "C#{a.bytesize}"
+
+          res = 0
+          b.each_byte { |byte| res |= byte ^ l.shift }
+          res == 0
+        end
+
+        def update_hmac(hmac, handle)
+          return unless handle
+
+          handle.rewind
+          begin
+            buffer = ''
+            while handle.read(@buffer_size, buffer)
+              hmac.update(buffer)
+            end
+
+            hmac
+          ensure
+            handle.rewind
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rack/verify/line/bot/version.rb

@@ -0,0 +1,9 @@
+module Rack
+  module Verify
+    module Line
+      class Bot
+        VERSION = "0.1.0"
+      end
+    end
+  end
+end

data/rack-verify-line-bot.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack/verify/line/bot/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rack-verify-line-bot"
+  spec.version       = Rack::Verify::Line::Bot::VERSION
+  spec.authors       = ["dayflower"]
+  spec.email         = ["daydream.trippers@gmail.com"]
+
+  spec.summary       = %q{Rack middleware for verifying signature of LINE Bot callback}
+  spec.description   = %q{Rack middleware for verifying signature of LINE Bot callback}
+  spec.homepage      = "https://github.com/dayflower/rack-verify-line-bot"
+  spec.license       = "MIT"
+
+  spec.files         = %w[
+    Gemfile
+    LICENSE.txt
+    README.md
+    Rakefile
+    bin/console
+    bin/setup
+    lib/rack-verify-line-bot.rb
+    lib/rack/verify/line/bot.rb
+    lib/rack/verify/line/bot/version.rb
+    rack-verify-line-bot.gemspec
+  ]
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "test-unit", ">= 3.0"
+  spec.add_development_dependency "rack", "~> 1"
+  spec.add_development_dependency "rack-test", "~> 0.6"
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: rack-verify-line-bot
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- dayflower
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  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'
+description: Rack middleware for verifying signature of LINE Bot callback
+email:
+- daydream.trippers@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rack-verify-line-bot.rb
+- lib/rack/verify/line/bot.rb
+- lib/rack/verify/line/bot/version.rb
+- rack-verify-line-bot.gemspec
+homepage: https://github.com/dayflower/rack-verify-line-bot
+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.14.1
+signing_key: 
+specification_version: 4
+summary: Rack middleware for verifying signature of LINE Bot callback
+test_files: []