jay_doubleu_tee 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2e0f1808e15a6fb71cc47526d3de8484372e5c9f5f32da231fec7219e799e99e
+  data.tar.gz: 7ca92e01391c1eccae6ae8b682ccf8b36e6a0c064f64360659affed49d3922a0
+SHA512:
+  metadata.gz: 9bbe5175ffd3190eb9846b3f660c5a912fda3c22eaaa086d39715b2cabd1336fb2b9e14ece3cc301284e425e995b5c34fcf090f10be0ab256f67034c6c05db1c
+  data.tar.gz: 64b240f9370f3f3489703465ae4ed2c92927234d18be7313cf1b7d5d75ce0bf7dd90996d69f5aa6dc68f80b9fdf339b4dad5d10879b6fd7031894fc640a49256

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,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

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 sebastian@driggl.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 [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,12 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in jay_doubleu_tee.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+
+group :development, :test do
+  gem 'rbnacl'
+  gem 'rack'
+end

data/Gemfile.lock

@@ -0,0 +1,65 @@
+PATH
+  remote: .
+  specs:
+    jay_doubleu_tee (0.1.0)
+      dry-configurable
+      dry-effects
+      dry-monads
+      jwt
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    concurrent-ruby (1.1.9)
+    diff-lcs (1.4.4)
+    dry-configurable (0.13.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.6)
+    dry-container (0.9.0)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.13, >= 0.13.0)
+    dry-core (0.7.1)
+      concurrent-ruby (~> 1.0)
+    dry-effects (0.2.0)
+      concurrent-ruby (~> 1.0)
+      dry-container (~> 0.7, >= 0.7.2)
+      dry-core (~> 0.5, >= 0.5)
+      dry-inflector (~> 0.1, >= 0.1.2)
+      dry-initializer (~> 3.0)
+    dry-inflector (0.2.1)
+    dry-initializer (3.0.4)
+    dry-monads (1.4.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.7)
+    ffi (1.15.4)
+    jwt (2.3.0)
+    rack (2.2.3)
+    rake (12.3.3)
+    rbnacl (7.1.1)
+      ffi
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jay_doubleu_tee!
+  rack
+  rake (~> 12.0)
+  rbnacl
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Sebastian Wilgosz
+
+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,118 @@
+# JayDoubleuTee
+
+A JWT authorization middleware for any web application.
+
+JayDoubleuTee is inspired by [Hanami philosophy](https://hanamirb.org) to build components that are highly reusable, and compatible with any ruby application.
+
+JayDoubleuTee is fully compatible with RACK, so it is with Hanami, Rails, Sinatra, Roda, and whatever else you can think about.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jay_doubleu_tee'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install jay_doubleu_tee
+
+## Usage
+
+### Plain ruby Rack application
+
+```ruby
+require "jay_doubleu_tee"
+
+class App
+  include JayDoubleuTee::Auth
+
+  def call(env)
+    status, body =
+      if auth.success?
+        [200, ["Hello, World!\n#{auth.value!}"]]
+      else
+        [401, [{ error: auth.failure }.to_json]]
+      end
+
+    [status, headers, body]
+  end
+
+  private
+
+  def headers
+    { 'Content-Type' => 'application/json' }
+  end
+end
+
+use JayDoubleuTee::Authentication
+
+run App.new
+```
+
+### Hanami 2.0
+
+```ruby
+# config.ru
+
+require "jay_doubleu_tee"
+use JayDoubleuTee::Authentication
+```
+
+### Rails
+
+```ruby
+# config.ru
+
+require "jay_doubleu_tee"
+use JayDoubleuTee::Authentication
+```
+
+#### Supported algorithms
+
+JayDoubleuTee does not use any encryption algoritym by default. 'none' is set.
+
+Below are listed all supported algoritms at the moment.
+
+```ruby
+%w[none HS256 RS256 prime256v1 ES256 ED25519 PS256]
+```
+
+For more info about each of them refer to [jwt documentation](https://github.com/jwt/ruby-jwt#algorithms-and-usage)
+
+### Configuration
+
+To set encryption algorithm, you can configure
+
+```ruby
+JayDoubleuTee.configure do |config|
+  config.algorithm = 'RS256'
+  config.secret = ENV['PUBLIC_KEY']
+end
+```
+
+Again, for information how to generate private and public keys, [jwt documentation](https://github.com/jwt/ruby-jwt#algorithms-and-usage) or check out the [spec files](https://github.com/hanamimastery/jay_doubleu_tee/tree/master/spec/jay_doubleu_tee/decoder_spec.rb)
+
+## 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/hanamimastery/jay_doubleu_tee. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/hanamimastery/jay_doubleu_tee/blob/master/CODE_OF_CONDUCT.md).
+
+
+## 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 JayDoubleuTee project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/jay_doubleu_tee/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,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "jay_doubleu_tee"
+
+# 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/jay_doubleu_tee.gemspec

@@ -0,0 +1,34 @@
+require_relative 'lib/jay_doubleu_tee/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "jay_doubleu_tee"
+  spec.version       = JayDoubleuTee::VERSION
+  spec.authors       = ["Sebastian Wilgosz"]
+  spec.email         = ["sebastian@hanamimastery.com"]
+
+  spec.summary       = %q{A JWT authorization solution for any ruby web app.}
+  spec.description   = %q{JayDoubleuTee is a simple but powerful middleware for authorising endpoints in any ruby application. Uses dry-effects and jwt under the hood. }
+  spec.homepage      = "https://github.com/hanamimastery/jay_doubleu_tee"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/hanamimastery/jay_doubleu_tee"
+  spec.metadata["changelog_uri"] = "https://github.com/hanamimastery/jay_doubleu_tee/tree/master/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"
+  spec.add_dependency "dry-effects"
+  spec.add_dependency "dry-monads"
+  spec.add_dependency "dry-configurable"
+end

data/lib/jay_doubleu_tee/auth.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module JayDoubleuTee
+  Auth = Dry::Effects.Reader(:auth)
+end

data/lib/jay_doubleu_tee/authorization.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "dry/effects"
+require "jay_doubleu_tee/decoder"
+
+module JayDoubleuTee
+  class Authorization
+    include Dry::Effects::Handler.Reader(:auth)
+
+    attr_reader :decoder
+
+    def initialize(app)
+      @app = app
+      @decoder = Decoder.new
+    end
+
+    def call(env)
+      with_auth(decoder.call(env["HTTP_AUTHORIZATION"])) do
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/jay_doubleu_tee/decoder.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require "jwt"
+require "dry/monads"
+require "jay_doubleu_tee/prepare_signature"
+
+module JayDoubleuTee
+
+  class Decoder
+    include Dry::Monads[:result]
+
+    InvalidTokenError = Class.new(StandardError)
+
+    def call(given)
+      # Set password to nil and validation to false otherwise this won't work
+      token = extract_token(given)
+      res = JWT.decode token, signature, verify?, { algorithm: algorithm }
+      Success(res[0]) # hides information about chosen algorithm and returns only payload
+    rescue JWT::DecodeError
+      Failure(InvalidTokenError.new("Unauthorized. Token invalid"))
+    end
+
+    private
+
+    def algorithm
+      JayDoubleuTee.config.algorithm
+    end
+
+    def verify?
+      algorithm != "none"
+    end
+
+    def signature
+      PrepareSignature.new.call(
+        algorithm: algorithm,
+        secret: JayDoubleuTee.config.secret
+      )
+    end
+
+    def extract_token(given)
+      given.to_s.gsub("Bearer ", "")
+    end
+  end
+end

data/lib/jay_doubleu_tee/prepare_signature.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "jwt"
+
+module JayDoubleuTee
+  class PrepareSignature
+    def call(algorithm:, secret:)
+      return OpenSSL::PKey::RSA.new(secret) if algorithm == "RS256"
+      return OpenSSL::PKey::EC.new(secret) if algorithm == "ES256"
+      return RbNaCl::Signatures::Ed25519::VerifyKey.new(secret) if algorithm == "ED25519"
+      return OpenSSL::PKey::RSA.new(secret) if algorithm == "PS256"
+
+      secret
+    end
+  end
+end

data/lib/jay_doubleu_tee/version.rb

@@ -0,0 +1,3 @@
+module JayDoubleuTee
+  VERSION = "0.1.0"
+end

data/lib/jay_doubleu_tee.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "dry-configurable"
+
+require "jay_doubleu_tee/version"
+require "jay_doubleu_tee/authorization"
+require "jay_doubleu_tee/auth"
+
+module JayDoubleuTee
+  class Error < StandardError; end
+  ConfigurationError = Class.new(Error)
+
+  ALGORITHMS = %w[none HS256 RS256 prime256v1 ES256 ED25519 PS256]
+
+  extend Dry::Configurable
+
+  setting :algorithm, default: 'none' do |value|
+    raise ConfigurationError, "Unsupported algorithm." unless ALGORITHMS.include?(value)
+    value
+  end
+
+  setting :secret, default: nil
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: jay_doubleu_tee
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sebastian Wilgosz
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-12-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jwt
+  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: dry-effects
+  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: dry-monads
+  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: dry-configurable
+  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'
+description: 'JayDoubleuTee is a simple but powerful middleware for authorising endpoints
+  in any ruby application. Uses dry-effects and jwt under the hood. '
+email:
+- sebastian@hanamimastery.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
+- jay_double_uti-0.1.0.gem
+- jay_doubleu_tee.gemspec
+- lib/jay_doubleu_tee.rb
+- lib/jay_doubleu_tee/auth.rb
+- lib/jay_doubleu_tee/authorization.rb
+- lib/jay_doubleu_tee/decoder.rb
+- lib/jay_doubleu_tee/prepare_signature.rb
+- lib/jay_doubleu_tee/version.rb
+homepage: https://github.com/hanamimastery/jay_doubleu_tee
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/hanamimastery/jay_doubleu_tee
+  source_code_uri: https://github.com/hanamimastery/jay_doubleu_tee
+  changelog_uri: https://github.com/hanamimastery/jay_doubleu_tee/tree/master/CHANGELOG.md
+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: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: A JWT authorization solution for any ruby web app.
+test_files: []