rack-slack_request_verification 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 62381da5d7fb58f307747f07e786e8ab2146a56128e18edcdff142ae007a2896
+  data.tar.gz: cbad6d1cf50520166b7e82e6a9ff13b1346b78a1e5cb55f06d43317b4bab9b93
+SHA512:
+  metadata.gz: 5c9884a7729394cfefcf3dba9550a57d3c92986d1b3e7dba68fa844ef58c3d8105cd005d035fa5f0e29405e7b89221eaf92e5fa6188de574e5d04f64546fe5e4
+  data.tar.gz: 6aa11e0045975efefab53246b074dca2f962cc28c2821ec6743935c76cab7e8c1a4561c5dfbeb00c61944c9da57434a6bb8caf5dae10c0d49c15e169b6498608

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.2
+before_install: gem install bundler -v 2.0.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at pn@trineo.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    rack-slack_request_verification (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rack (2.0.7)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    timecop (0.9.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  rack-slack_request_verification!
+  rack-test
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  timecop
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Pete Nicholls
+
+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,90 @@
+# Rack::SlackRequestVerification
+
+Rack middleware to verify Slack requests made using signed secrets.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rack-slack_request_verification'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-slack_request_verification
+
+## Usage
+
+Inside your `config.ru`:
+
+```ruby
+# Apply signed request verification to every path starting with "/slack/"
+use Rack::SlackRequestVerification, path_pattern: %{^/slack/}
+run MyApp
+```
+
+Will use a `SLACK_SIGNING_KEY` environment variable by default.
+
+You can override this with:
+
+```ruby
+use Rack::SlackRequestVerification, path_pattern: %{^/slack/}, signing_key: '...'
+```
+
+A **401 Not Authorized** is returned in the following circumstances:
+
+* When either or both of the `X-Slack-Request-Timestamp` or `X-Slack-Signature` headers are absent
+* When the timestamp is more than five minutes old (to mitigate replay attacks)
+* When the computed signature of the request does not match the `X-Slack-Signature`
+
+A log message is also generated.
+
+### Full options
+
+```ruby
+use Rack::SlackRequestVerification, {
+    # A regular expression used to determine which requests to verify
+    path_pattern: %r{^/slack/},
+
+    # You can provide a signing key directly, set a SLACK_SIGNING_KEY env var
+    # or customise the env var to something else
+    signing_key: nil,
+    signing_key_env_var: 'SLACK_SIGNING_KEY',
+
+    # Mitigates replay attacks by verifying the request was sent recently –
+    # a better strategy is to record the signature header to ensure you only
+    # process each request once
+    max_staleness_in_secs: 60 * 5,
+
+    # Where to log error messages
+    logger: Logger.new($stdout),
+
+    # Settings as currently in use by Slack
+    signing_version: 'v0',
+    timestamp_header: 'X-Slack-Request-Timestamp',
+    signature_header: 'X-Slack-Signature'
+}
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/Aupajo/rack-slack_request_verification. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Rack::SlackRequestVerification project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/Aupajo/rack-slack_request_verification/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rack/slack_request_verification"
+
+require "irb"
+IRB.start(__FILE__)

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/slack_request_verification.rb

@@ -0,0 +1,12 @@
+module Rack
+  module SlackRequestVerification
+    class Error < StandardError; end
+
+    def self.new(*args)
+      Middleware.new(*args)
+    end
+  end
+end
+
+require "rack/slack_request_verification/version"
+require "rack/slack_request_verification/middleware"

data/lib/rack/slack_request_verification/middleware.rb

@@ -0,0 +1,99 @@
+require 'logger'
+require 'openssl'
+
+module Rack::SlackRequestVerification
+  class Middleware
+    attr_reader *%i(
+      signing_key
+      path_pattern
+      signing_version
+      timestamp_header
+      signature_header
+      logger
+      max_staleness_in_secs
+    )
+
+    def initialize(app,
+      # A regular expression used to determine which requests to verify
+      path_pattern:,
+
+      # You can provide a signing key directly, set a SLACK_SIGNING_KEY env var
+      # or customise the env var to something else
+      signing_key: nil,
+      signing_key_env_var: 'SLACK_SIGNING_KEY',
+
+      # Mitigates replay attacks by verifying the request was sent recently –
+      # a better strategy is to record the signature header to ensure you only
+      # process each request once
+      max_staleness_in_secs: 60 * 5,
+
+      # Where to log error messages
+      logger: Logger.new($stdout),
+
+      signing_version: 'v0',
+      timestamp_header: 'X-Slack-Request-Timestamp',
+      signature_header: 'X-Slack-Signature'
+    )
+      @app = app
+      @path_pattern = path_pattern
+      @signing_version = signing_version
+      @timestamp_header = timestamp_header
+      @signature_header = signature_header
+      @logger = logger
+      @max_staleness_in_secs = max_staleness_in_secs
+
+      @signing_key = signing_key || ENV.fetch(signing_key_env_var) do
+        fail Error, "#{signing_key_env_var} env var not set, please configure a signing key"
+      end
+    end
+
+    def call(env)
+      if !path_pattern.match?(env['PATH_INFO'])
+        @app.call(env)
+      else
+        headers = {
+          signature_header => env["HTTP_" + signature_header.gsub('-', '_').upcase],
+          timestamp_header => env["HTTP_" + timestamp_header.gsub('-', '_').upcase]&.to_i
+        }
+
+        missing_headers = headers.select { |_, value| value.nil? }.keys
+
+        if !missing_headers.empty?
+          logger.error "Slack verification failed: missing #{missing_headers.join(', ')}"
+          return [401, {}, "Not authorized"]
+        end
+
+        timestamp = headers[timestamp_header]
+        signature = headers[signature_header]
+
+        minimum_timestamp = Time.now.to_i - max_staleness_in_secs
+
+        if timestamp < minimum_timestamp
+          logger.error "Slack verification failed: #{timestamp_header} is #{timestamp}, only #{minimum_timestamp} or later is allowed"
+          return [401, {}, "Not authorized"]
+        end
+
+        body = env['rack.input']
+
+        signature_base_string = [
+          signing_version,
+          timestamp,
+          body.read
+        ].join(':')
+
+        body.rewind
+
+        digest = OpenSSL::HMAC.hexdigest("SHA256", signing_key, signature_base_string)
+
+        computed_signature = [signing_version, digest].join('=')
+
+        if computed_signature != signature
+          logger.error "Slack verification failed: #{signature_header} does not match the signature"
+          return [401, {}, "Not authorized"]
+        end
+
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/rack/slack_request_verification/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  module SlackRequestVerification
+    VERSION = "0.1.0"
+  end
+end

data/rack-slack_request_verification.gemspec

@@ -0,0 +1,29 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rack/slack_request_verification/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rack-slack_request_verification"
+  spec.version       = Rack::SlackRequestVerification::VERSION
+  spec.authors       = ["Pete Nicholls"]
+  spec.email         = ["aupajo@gmail.com"]
+
+  spec.summary       = %q{Rack middleware to verify Slack requests made using signed secrets.}
+  spec.homepage      = "https://github.com/Aupajo/rack-slack_request_verification"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rack-test"
+  spec.add_development_dependency "timecop"
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: rack-slack_request_verification
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pete Nicholls
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-04-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: 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
+  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-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: 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'
+description: 
+email:
+- aupajo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rack/slack_request_verification.rb
+- lib/rack/slack_request_verification/middleware.rb
+- lib/rack/slack_request_verification/version.rb
+- rack-slack_request_verification.gemspec
+homepage: https://github.com/Aupajo/rack-slack_request_verification
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Rack middleware to verify Slack requests made using signed secrets.
+test_files: []