rack-bearer_auth 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 92570ae4c83643cc6f477ec27efd364f87d536dd5951fd6cdfc1dbf2536a2b22
+  data.tar.gz: 407b3cbc08de91012b5f08d614b698d1ca54d4ff1b8562202e0fac9326bf88ec
+SHA512:
+  metadata.gz: 6117026d93c4629e033df09823064489d95decaa305f692e75ae3b941f4e42788325287510f5723722ad2c0684699c9428d2d60e1fd0cfd75ec4b831eaff6c7d
+  data.tar.gz: f5f0db70906d8d82470f5d5952f901d751e5c6926ab4673bc9ea739759c58c2c3f85a726851e4796c3886639fbe371af7c854f6074f5778f80bba9d576779117

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,23 @@
+AllCops:
+  TargetRubyVersion: 2.3
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/RedundantSelf:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/EndOfLine:
+  Enabled: true
+  EnforcedStyle: lf
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*

data/.travis.yml

@@ -0,0 +1,9 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.7
+  - 2.4.4
+  - 2.5.1
+before_install: gem install bundler -v 1.16.1
+script:
+  - bundle exec rake spec

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+## Unreleased
+
+
+## 0.1.0 (2018-05-17)
+
+* Initial release

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in rack-bearer_auth.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Yuji Hanamura
+
+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,84 @@
+# Rack::BearerAuth
+
+Rack::BearerAuth is middleware that make using [RFC 6750](https://tools.ietf.org/html/rfc6750) bearer auth in Rack apps.
+
+[![Build Status](https://travis-ci.org/yujideveloper/rack-bearer_auth.svg?branch=master)](https://travis-ci.org/yujideveloper/rack-bearer_auth)
+[![Maintainability](https://api.codeclimate.com/v1/badges/db47f9a4e48bd30edb98/maintainability)](https://codeclimate.com/github/yujideveloper/rack-bearer_auth/maintainability)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rack-bearer_auth'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-bearer_auth
+
+## Configuration
+
+### Rsils configuration
+
+``` ruby
+module YourApp
+  class Application < Rails::Application
+
+    # ...
+
+    config.middleware.use, Rack::BearerAuth::Middleware do
+      match path: "/foo" do |token|
+        # validate token
+      end
+
+      match via: :all do |token|
+        # validate token
+      end
+
+      match path: "/bar", via: %i[post patch delete], token: "some_token"
+    end
+  end
+end
+```
+
+### Rack configuration
+
+``` ruby
+use Rack::BearerAuth::Middleware do
+  match path: "/foo" do |token|
+    # validate token
+  end
+
+  match via: :all do |token|
+    # validate token
+  end
+
+  match path: "/bar", via: %i[post patch delete], token: "some_token"
+end
+
+```
+
+## Restrictions
+
+* [Form-Encoded Body Parameter(RFC 6750 section 2.2)](https://tools.ietf.org/html/rfc6750#section-2.2) is not supported.
+* [URI Query Parameter(RFC 6750 section 2.3)](https://tools.ietf.org/html/rfc6750#section-2.3) is not supported.
+* `scope` attribute is not supported.
+
+## 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/yujideveloper/rack-bearer_auth.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "rack/bearer_auth"
+require "pry"
+
+Pry.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/bearer_auth.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require "rack/bearer_auth/module"
+require "rack/bearer_auth/version"
+require "rack/bearer_auth/middleware"

data/lib/rack/bearer_auth/match_pattern.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+module Rack
+  module BearerAuth
+    class MatchPattern
+      attr_reader :path, :via, :token
+
+      def initialize(path, via, token)
+        raise ArgumentError, "Token pattern is required" unless token
+
+        @path = Path.new(path)
+        @via = Via.new(via)
+        @token = Token.new(token)
+      end
+
+      def match(req)
+        return :skip unless match_route?(req)
+        return :token_required unless req.token
+        token.match?(req.token) ? :ok : :invalid_token
+      end
+
+      private
+
+      def match_route?(req)
+        path.match?(req.path) && via.match?(req.via)
+      end
+
+      class Base
+        attr_reader :pattern
+
+        def initialize(pattern)
+          @pattern = pattern
+        end
+
+        def match?(*)
+          raise ::NotImplementedError
+        end
+
+        def self.new(*)
+          if self == Base
+            raise ::NotImplementedError,
+                  "#{self} is an abstract class and cannot be instantiated."
+          end
+          super
+        end
+      end
+
+      class Path < Base
+        def match?(path)
+          _match?(self.pattern, path)
+        end
+
+        private
+
+        def _match?(path_pattern, path_value)
+          case path_pattern
+          when nil
+            true
+          when String
+            path_pattern == path_value
+          when Regexp
+            !(path_pattern =~ path_value).nil?
+          when Proc
+            path_pattern.call(path_value)
+          when Array
+            path_pattern.any? { |pattern| _match?(pattern, path_value) }
+          else
+            raise "Unsupported path pattern"
+          end
+        end
+      end
+
+      class Via < Base
+        def match?(via)
+          _match?(self.pattern, via)
+        end
+
+        private
+
+        def _match?(via_pattern, via_value)
+          case via_pattern
+          when nil, :all
+            true
+          when Symbol, String
+            via_pattern.to_sym == via_value
+          when Regexp
+            !(via_pattern =~ via_value).nil?
+          when Proc
+            via_pattern.call(via_value)
+          when Array
+            via_pattern.any? { |pattern| _match?(pattern, via_value) }
+          else
+            raise "Unsupported via pattern"
+          end
+        end
+      end
+
+      class Token < Base
+        def match?(token)
+          _match?(self.pattern, token)
+        end
+
+        private
+
+        def _match?(token_pattern, token_value)
+          case token_pattern
+          when String
+            token_pattern == token_value
+          when Regexp
+            !(token_pattern =~ token_value).nil?
+          when Proc
+            token_pattern.call(token_value)
+          when Array
+            token_pattern.any? { |pattern| _match?(pattern, token_value) }
+          else
+            raise "Unsupported token pattern"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rack/bearer_auth/middleware.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require_relative "request"
+require_relative "match_pattern"
+
+module Rack
+  module BearerAuth
+    class Middleware
+      def initialize(app, &block)
+        raise ArgumentError, "Block argument is required." unless block_given?
+
+        @app = app
+        @match_patterns = []
+
+        instance_exec(&block)
+      end
+
+      def call(env)
+        req = Request.new(env)
+
+        handle(req) || @app.call(env)
+      end
+
+      def match(path: nil, via: nil, token: nil, &block)
+        if block_given?
+          warn "Token paramter is ignored." if token
+          token = block
+        end
+
+        @match_patterns << MatchPattern.new(path, via, token)
+      end
+
+      private
+
+      def handle(req)
+        @match_patterns.each do |pattern|
+          case pattern.match(req)
+          when :ok
+            break
+          when :token_required
+            return [401,
+                    { "WWW-Authenticate" => 'Bearer realm="token_required"',
+                      "Content-Type"     => "text/plain; charset=utf-8",
+                      "Content-Length"   => "0" },
+                    []]
+          when :invalid_token
+            return [401,
+                    { "WWW-Authenticate" => 'Bearer error="invalid_token"',
+                      "Content-Type"     => "text/plain; charset=utf-8",
+                      "Content-Length"   => "0" },
+                    []]
+          else
+            warn "A pattern is ignored."
+          end
+        end
+        nil
+      end
+    end
+  end
+end

data/lib/rack/bearer_auth/module.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Rack
+  module BearerAuth
+  end
+end

data/lib/rack/bearer_auth/request.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Rack
+  module BearerAuth
+    class Request
+      # https://tools.ietf.org/html/rfc6750#section-2.1
+      # b64token    = 1*( ALPHA / DIGIT /
+      #                   "-" / "." / "_" / "~" / "+" / "/" ) *"="
+      # credentials = "Bearer" 1*SP b64token
+      BEARER_TOKEN_REGEXP = %r{\ABearer +([A-Za-z0-9\-._~+/]+=*)\z}
+
+      attr_reader :path, :via, :token
+
+      def initialize(env)
+        @path = env["PATH_INFO"]
+        @via = env["REQUEST_METHOD"].downcase.to_sym
+
+        authz = env["HTTP_AUTHORIZATION"]
+        @token = Regexp.last_match(1) if authz&.match(BEARER_TOKEN_REGEXP)
+      end
+    end
+  end
+end

data/lib/rack/bearer_auth/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Rack
+  module BearerAuth
+    VERSION = "0.1.0"
+  end
+end

data/rack-bearer_auth.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rack/bearer_auth/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rack-bearer_auth"
+  spec.version       = Rack::BearerAuth::VERSION
+  spec.authors       = ["Yuji Hanamura"]
+  spec.email         = ["yuji.developer@gmail.com"]
+
+  spec.summary       = "Middleware for using RFC 6750 bearer auth in Rack apps"
+  spec.description   = "Middleware for using RFC 6750 bearer auth in Rack apps"
+  spec.homepage      = "https://github.com/yujideveloper/rack-bearer_auth"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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.required_ruby_version = ">= 2.3.0"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "pry", ">= 0.10.0"
+  spec.add_development_dependency "pry-byebug", ">= 3.6.0"
+  spec.add_development_dependency "rack-test", "~> 1.0.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop", ">= 0.51.0"
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: rack-bearer_auth
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yuji Hanamura
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-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.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.51.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.51.0
+description: Middleware for using RFC 6750 bearer auth in Rack apps
+email:
+- yuji.developer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rack/bearer_auth.rb
+- lib/rack/bearer_auth/match_pattern.rb
+- lib/rack/bearer_auth/middleware.rb
+- lib/rack/bearer_auth/module.rb
+- lib/rack/bearer_auth/request.rb
+- lib/rack/bearer_auth/version.rb
+- rack-bearer_auth.gemspec
+homepage: https://github.com/yujideveloper/rack-bearer_auth
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Middleware for using RFC 6750 bearer auth in Rack apps
+test_files: []