omniauth-protect 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7b0f8ee48965b74bb3934bdb0b2fc9e1bb7944880223c36620547f0395b806f5
+  data.tar.gz: f35833309948e6e37da51fc8e3f288c961d9bd39d19b0d20d228b39c98eebc7c
+SHA512:
+  metadata.gz: cf78c3c787274ac00d679295ae64f96e9ec6c84355511a90929e9cc4bc0b0e405fbcfdfe5266b4cd0ce07ecf6917f7553b7484dc38401293ed40b6d8845dc38b
+  data.tar.gz: bdc67f0584057ef2d8240e9e89d761e484040a6100b7be354fe09dbaffa9eae5b4b16d2c42c748b4edab3e9284c910a3865530b18f19e5b7719202481e3df639

data/.circleci/config.yml

@@ -0,0 +1,80 @@
+version: 2
+
+jobs:
+  style_check:
+    docker:
+      - image: rainforestapp/circlemator:latest
+    steps:
+      - checkout
+      - run:
+          name: Style check
+          command: circlemator style-check --base-branch=master
+
+  test:
+    docker:
+      - image: circleci/ruby:2.5.1
+    steps:
+      - checkout
+      - restore_cache:
+          key: v1-omniauth-protect-{{ checksum "Gemfile.lock" }}
+      - run:
+          name: Install Ruby gems
+          command: |
+            bundle check --path=vendor/bundle || bundle install --path=vendor/bundle --jobs=4 --retry=3
+      - save_cache:
+          key: v1-omniauth-protect-{{ checksum "Gemfile.lock" }}
+          paths:
+            - ~/project/vendor/bundle
+      - run:
+          name: Set up test output directory
+          command: sudo install -o circleci -d ~/rspec
+      - run:
+          name: RSpec
+          command: |
+            bundle exec rspec \
+              --color \
+              --require spec_helper \
+              --format documentation \
+              --format RspecJunitFormatter \
+              --out ~/rspec/rspec.xml
+      - store_artifacts:
+          path: ~/rspec
+      - store_test_results:
+          path: ~/rspec
+
+  push_to_rubygems:
+    docker:
+      - image: circleci/ruby:2.5.1
+    steps:
+      - checkout
+      - run:
+          name: Create .gem/credentials file
+          command: |
+            mkdir ~/.gem
+            echo "---
+              :rubygems_api_key: $RUBYGEMS_API_KEY
+            " > ~/.gem/credentials
+            chmod 600 ~/.gem/credentials
+      - run:
+          name: Release omniauth-protect
+          command: |
+            gem build omniauth-protect
+            gem push omniauth-protect-*.gem
+workflows:
+  version: 2
+  gem_release:
+    jobs:
+      - test
+      - style_check:
+          filters:
+            branches:
+              ignore:
+                - master
+      - push_to_rubygems:
+          filters:
+            branches:
+              ignore:
+                - /.*/
+            tags:
+              only:
+                - /^v.*/

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.byebug_history
+.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.5.3
+before_install: gem install bundler -v 2.0.1

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 sdogruyol
+
+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,56 @@
+# Omniauth::Protect
+
+Protects your Rails app from Omniauth request phase CSRF vulnerability
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'omniauth-protect'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install omniauth-protect
+
+## Usage
+
+Add this line to your `config/application.rb`
+
+```ruby
+config.middleware.use Omniauth::Protect::Middleware
+```
+
+## Configuration
+
+You need to create an initiliazer like `config/initializers/omniauth_protect.rb` for configuration
+
+```ruby
+Omniauth::Protect.config[:message] = 'CSRF detected, Access Denied'
+Omniauth::Protect.config[:paths] = ['/auth/twitter', '/auth/google' ,'/auth/github']
+Omniauth::Protect.configure
+```
+
+## 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/rainforestapp/omniauth-protect.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+
+## Thanks
+
+Speacial thanks to [RainforestQA](https://www.rainforestqa.com/)

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,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "omniauth/protect"
+
+# 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(__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/omniauth/protect.rb

@@ -0,0 +1,32 @@
+require 'base64'
+require 'rack'
+
+module Omniauth
+  module Protect
+    class ConfigException < Exception
+    end
+
+    @config = {
+      message: '',
+      paths: []
+    }
+
+    def self.config
+      @config
+    end
+
+    # Adds / to the paths
+    def self.configure
+      raise ConfigException.new('message must be specified') if config[:message].empty?
+      raise ConfigException.new('paths must be specified') if config[:paths].empty?
+
+      config[:paths].each do |path|
+        next if path[-1] == '/'
+
+        config[:paths] << "#{path}/"
+      end
+    end
+  end
+end
+
+require 'omniauth/protect/middleware'

data/lib/omniauth/protect/middleware.rb

@@ -0,0 +1,48 @@
+module Omniauth
+  module Protect
+    class Middleware
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        if !Omniauth::Protect.config[:paths].include?(env['PATH_INFO'])
+          @app.call(env)
+        else
+          access_denied = [403, { 'Content-Type' => 'text/plain'}, [ Omniauth::Protect.config[:message] ] ]
+          return access_denied if env['REQUEST_METHOD'] != 'POST'
+
+          req = Rack::Request.new(env)
+          encoded_masked_token = req.params['authenticity_token']
+
+          return access_denied if !encoded_masked_token
+
+          valid_csrf_token?(env, encoded_masked_token) ? @app.call(env) : access_denied
+        end
+      end
+      # This is mostly taken & adapted from https://github.com/rails/rails/blob/v4.2.0/actionpack/lib/action_controller/metal/request_forgery_protection.rb#L276
+      def valid_csrf_token?(env, encoded_masked_token)
+        begin
+          masked_token = Base64.strict_decode64(encoded_masked_token)
+        rescue ArgumentError # encoded_masked_token is invalid Base64
+          return false
+        end
+
+        token_length = ActionController::RequestForgeryProtection::AUTHENTICITY_TOKEN_LENGTH
+        if masked_token.length == token_length * 2
+          one_time_pad = masked_token[0...token_length]
+          encrypted_csrf_token = masked_token[token_length..-1]
+          csrf_token = one_time_pad.bytes.zip(encrypted_csrf_token.bytes).map { |(c1, c2)| c1 ^ c2 }.pack('c*')
+          session = session(env)
+          session[:_csrf_token] ||= SecureRandom.base64(token_length)
+          real_csrf_token = Base64.strict_decode64(session[:_csrf_token])
+          ActiveSupport::SecurityUtils.secure_compare(csrf_token, real_csrf_token)
+        end
+      end
+
+      def session(env)
+        env['rack.session']
+      end
+    end
+  end
+end

data/lib/omniauth/protect/version.rb

@@ -0,0 +1,5 @@
+module Omniauth
+  module Protect
+    VERSION = '1.0.0'
+  end
+end

data/omniauth-protect.gemspec

@@ -0,0 +1,34 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "omniauth/protect/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "omniauth-protect"
+  spec.version       = Omniauth::Protect::VERSION
+  spec.authors       = ["Serdar Dogruyol"]
+  spec.email         = ["serdar@rainforestqa.com"]
+  spec.license       = "MIT"
+
+  spec.summary       = %q{Protect Omniauth from request phase CSRF}
+  spec.description   = %q{Protects your Rails app from Omniauth request phase CSRF vulnerability.}
+  spec.homepage      = "https://github.com/rainforestapp/omniauth-protect"
+
+  # 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_runtime_dependency 'actionpack'
+  spec.add_runtime_dependency 'rack'
+
+  spec.add_development_dependency "bundler", '~> 1.10'
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'rspec_junit_formatter'
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-protect
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Serdar Dogruyol
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-05-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  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'
+- !ruby/object:Gem::Dependency
+  name: rack
+  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'
+- !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
+  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: byebug
+  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: rspec_junit_formatter
+  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: Protects your Rails app from Omniauth request phase CSRF vulnerability.
+email:
+- serdar@rainforestqa.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/omniauth/protect.rb
+- lib/omniauth/protect/middleware.rb
+- lib/omniauth/protect/version.rb
+- omniauth-protect.gemspec
+homepage: https://github.com/rainforestapp/omniauth-protect
+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.7.7
+signing_key: 
+specification_version: 4
+summary: Protect Omniauth from request phase CSRF
+test_files: []