cerber 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d6ac4737932be54cfd41bd26988d676958d6c23699cdcf1d8605c24eaaf3cb01
+  data.tar.gz: 91ea2db3722302c6dc08c5d6679fa49df5bc1c7cea8d4dc5b90931b830fc20c0
+SHA512:
+  metadata.gz: 8414d8b2b3531b82e7d4eb414aa0fc73c742dfcdd3263a566a061b226299bd89d777ab3e1a9b30ee7e36449fa5604b757cba4056f681d557ee6163386c781f5d
+  data.tar.gz: 6658bcc5f259d5befd6c4b9757c2477a7d4878953bf0cb9caed3376e7a2cc6d92d8414be51d44875da611806dc4a54e78043cec39d6b64e23d838a0e5cbbeeb7

data/.github/workflows/gempush.yml

@@ -0,0 +1,36 @@
+name: Run tests and build the Ruby Gem
+
+on:
+  push:
+    tags:
+      - v*
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@master
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+
+    - name: Run RSpec Tests
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+        bundle exec rspec
+
+    - name: Publish to GPR
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:github: Bearer ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem
+      env:
+        GEM_HOST_API_KEY: ${{secrets.GPR_AUTH_TOKEN}}
+        OWNER: username

data/.github/workflows/test.yml

@@ -0,0 +1,22 @@
+name: Run RSpec Tests
+
+on: [push]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v1
+
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+
+    - name: Run RSpec Tests
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+        bundle exec rspec

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.3
+before_install: gem install bundler -v 2.0.2

data/Gemfile

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in cerberus.gemspec
+gemspec
+
+group :development, :test do
+  gem "rack"
+  gem "rack-test"
+  gem "rspec-its"
+end

data/Gemfile.lock

@@ -0,0 +1,46 @@
+PATH
+  remote: .
+  specs:
+    cerberus (0.1.2)
+      jwt (= 2.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    jwt (2.1.0)
+    rack (2.0.7)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rake (10.5.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-its (1.3.0)
+      rspec-core (>= 3.0.0)
+      rspec-expectations (>= 3.0.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  cerberus!
+  rack
+  rack-test
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rspec-its
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 krzyczak
+
+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,67 @@
+# Cerberus
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/cerberus`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+![](https://github.com/krzyczak/cerberus/workflows/Run%20RSpec%20Tests/badge.svg)
+![](https://github.com/krzyczak/cerberus/workflows/Run%20tests%20and%20build%20the%20Ruby%20Gem/badge.svg)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "cerberus"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cerberus
+
+## Usage
+
+Configure Cerberus with required information:
+
+```ruby
+Cerberus.configure do |config|
+  config.jwt = {
+    rsa_public: ENV["JWT_RSA_PUBLIC"],
+    algorithm: "RS256",
+    issuer: "org.website.project",
+    enabled: ->(env) { Rails.env.production? }
+  }.freeze
+
+  config.basic = {
+    username_digest: ::Digest::SHA256.hexdigest("test"),
+    password_digest: ::Digest::SHA256.hexdigest("test"),
+    enabled: ->(env) { env["PATH_INFO"].start_with?("/protected") }
+  }.freeze
+end
+
+require "cerberus/jwt"
+require "cerberus/basic"
+```
+
+And then just inject a middleware:
+
+```ruby
+config.middleware.use Cerberus::Jwt
+config.middleware.use Cerberus::Basic
+```
+
+## 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/[USERNAME]/cerberus.
+
+## 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,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 "cerberus"
+
+# 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/cerberus.gemspec

@@ -0,0 +1,36 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "cerberus/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "cerber"
+  spec.version       = Cerberus::VERSION
+  spec.authors       = ["krzyczak"]
+  spec.email         = ["krzyczak@users.noreply.github.com"]
+
+  spec.summary       = %q{Various authentication rack middlewares}
+  spec.description   = %q{A collection of easily plugable rack authentication middlewares}
+  spec.homepage      = "https://github.com/krzyczak/cerberus"
+  spec.license       = "MIT"
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/krzyczak/cerberus"
+  spec.metadata["changelog_uri"] = "https://github.com/krzyczak/cerberus/CHANGELOG.md"
+
+  # 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_dependency "jwt", "= 2.1.0"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/cerberus.rb

@@ -0,0 +1,29 @@
+require "ostruct"
+require "jwt"
+# Bundler.require(:default, :development)
+require "cerberus/version"
+
+module Cerberus
+  class Error < StandardError; end
+  # Your code goes here...
+
+  class << self
+    attr_accessor :config
+  end
+
+  def self.configure
+    self.config ||= Config.new
+    yield(config)
+    self.config.jwt = OpenStruct.new(self.config.jwt || {})
+    self.config.jwt.skip_middleware_unless ||= -> { false }
+
+    self.config.basic = OpenStruct.new(self.config.basic || {})
+    self.config.basic.enabled ||= -> { true }
+  end
+
+  class Config
+    attr_accessor(:jwt, :basic)
+  end
+
+  self.configure {}
+end

data/lib/cerberus/basic.rb

@@ -0,0 +1,31 @@
+require "cerberus"
+
+module Cerberus
+  class Basic
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      if Cerberus.config.basic.enabled.call(env)
+        auth = Rack::Auth::Basic.new(@app) do |username, password|
+          username_digest = Cerberus.config.basic.username_digest
+          password_digest = Cerberus.config.basic.password_digest
+
+          eql?(username, username_digest) & eql?(password, password_digest)
+        end
+
+        auth.call(env)
+      else
+        @app.call(env)
+      end
+    end
+
+    private
+
+    def eql?(value, comparable)
+      Rack::Utils.secure_compare(::Digest::SHA256.hexdigest(value), comparable)
+    end
+  end
+end
+

data/lib/cerberus/jwt.rb

@@ -0,0 +1,66 @@
+require "cerberus"
+
+module Cerberus
+  class Jwt
+    JWT_OPTIONS = {
+      algorithm: Cerberus.config.jwt.algorithm || ENV["JWT_ALGORITHM"],
+      iss: Cerberus.config.jwt.issuer || ENV["JWT_ISSUER"],
+      verify_iss: true,
+      verify_iat: true
+    }.freeze
+
+    JWT_ERRORS = {
+      JWT::ExpiredSignature => {
+        status: 403, body: "The token has expired."
+      },
+      JWT::InvalidIssuerError => {
+        status: 403, body: "The token does not have a valid issuer."
+      },
+      JWT::InvalidIatError => {
+        status: 403, body: "The token does not have a valid 'issued at' time."
+      },
+      JWT::DecodeError => {
+        status: 401, body: "A valid token must be passed."
+      },
+      KeyError => {
+        status: 401, body: "HTTP_AUTHORIZATION header must be present."
+      }
+    }.freeze
+
+    class EmptyJWT < StandardError
+      DEFAULT_ERROR_MESSAGE = "Cerberus CONFIG: config.jwt.rsa_public option needs to be set."
+
+      def initialize(error_message = DEFAULT_ERROR_MESSAGE)
+        super(error_message)
+      end
+    end
+
+    raise EmptyJWT("Cerberus CONFIG: config.jwt is empty.") if Cerberus.config.jwt.empty?
+    raise EmptyJWT if Cerberus.config.jwt.rsa_public.to_s.strip.empty?
+
+    JWT_RSA_PUBLIC = OpenSSL::PKey::RSA.new(Base64.decode64(Cerberus.config.jwt.rsa_public))
+
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      if Cerberus.config.jwt.enabled.call(env)
+        auth_token = env.fetch("HTTP_AUTHORIZATION").gsub(/bearer /i, "")
+        _payload, _header = JWT.decode(auth_token, JWT_RSA_PUBLIC, true, JWT_OPTIONS)
+      end
+
+      @app.call(env)
+    rescue StandardError => error
+      if JWT_ERRORS.keys.include?(error.class)
+        self.class.respond_with(*JWT_ERRORS.fetch(error.class).values)
+      else
+        raise error
+      end
+    end
+
+    def self.respond_with(status_code, message)
+      [status_code, { "Content-Type" => "text/plain" }, [message]]
+    end
+  end
+end

data/lib/cerberus/version.rb

@@ -0,0 +1,3 @@
+module Cerberus
+  VERSION = "0.1.2"
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: cerber
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- krzyczak
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-10-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !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'
+description: A collection of easily plugable rack authentication middlewares
+email:
+- krzyczak@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/gempush.yml"
+- ".github/workflows/test.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cerberus.gemspec
+- lib/cerberus.rb
+- lib/cerberus/basic.rb
+- lib/cerberus/jwt.rb
+- lib/cerberus/version.rb
+homepage: https://github.com/krzyczak/cerberus
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/krzyczak/cerberus
+  source_code_uri: https://github.com/krzyczak/cerberus
+  changelog_uri: https://github.com/krzyczak/cerberus/CHANGELOG.md
+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.4
+signing_key: 
+specification_version: 4
+summary: Various authentication rack middlewares
+test_files: []