ripple_token 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c2c8ced1eec1151d4485a3614d3876b9a8941bbf5bad79f05919c1876d067f7c
+  data.tar.gz: 34f24e9079b2c04e436d4482d8aa0409f4793b002eae580404ac6ed579eadcb2
+SHA512:
+  metadata.gz: 72c955c3fe7d11d8e92663677099ed8319e46f12955fb2e2672a54d66f7b8a00dbaad6a615efe1353deb7cc69156372f3c95df4418f2c095b9d268ac89f6a48a
+  data.tar.gz: 1569009de54f65d7c37cf9c3abf2edf38f06aae6f691bcdc5dbcf17f89af7ed075bcca0814eb5d1b687150b2dec0ac63363328c8237c9e18101b9d4e4d56a159

data/.github/workflows/gem-push.yml

@@ -0,0 +1,29 @@
+name: Ruby Gem
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.7.1
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.7.1
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${RUBYGEMS_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        RUBYGEMS_API_KEY: ${{secrets.RUBYGEMS_API_KEY}}

data/.github/workflows/lint-and-test.yml

@@ -0,0 +1,34 @@
+name: Lint and test
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+    name: Lint + Test
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.7.1
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.7.1
+    - name: Restore cache
+      uses: actions/cache@v2
+      with:
+        path: vendor/bundle
+        key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-gems-
+    - name: Install dependencies
+      run: |
+        bundle config path vendor/bundle
+        bundle install --jobs 4 --retry 3
+    - name: Run Rubocop
+      run: bundle exec rubocop
+    - name: Run rspec
+      run: bundle exec rspec

data/.gitignore

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

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,41 @@
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+Lint/RaiseException:
+  Enabled: true
+Lint/StructNewOverride:
+  Enabled: true
+Style/ExponentialNotation:
+  Enabled: true
+Style/HashEachMethods:
+  Enabled: true
+Style/HashTransformKeys:
+  Enabled: true
+Style/HashTransformValues:
+  Enabled: true
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+Style/RedundantRegexpEscape:
+  Enabled: true
+Style/SlicingWithRange:
+  Enabled: true
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/**
+
+AllCops:
+  Exclude:
+    - bin/**
+    - vendor/**/**
+
+Lint/ScriptPermission:
+  Enabled: false

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 ollie@nyemail.co.uk. 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,9 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ripple_token.gemspec
+gemspec
+
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Hex Event Solutions Limited
+
+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,85 @@
+# Ripple Token
+
+![Lint and test](https://github.com/hex-event-solutions/ripple_token/workflows/Lint%20and%20test/badge.svg)
+
+Validates supplied JWT tokens against Keycloak's public key
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ripple_token'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install ripple_token
+
+## Usage
+
+The client must be configured before usage
+
+```ruby
+RippleKeycloak::Client.configure do |c|
+  c.base_url = <keycloak_url>
+  c.realm = <keycloak_realm>
+  c.client_id = <client_id>
+  c.client_secret = <client_secret>
+end
+```
+
+The supplied client must be of 'confidential' type, and allow service account login.
+
+After configuring, use the supplied interfaces to query, create, update or delete resources in Keycloak.
+
+### Standard methods
+
+The below methods are available on `RippleKeycloak::User`, `RippleKeycloak::Group` and `RippleKeycloak::Role`.
+
+- find(id) - returns the resource with the given id
+- find_by(field:, value:) - searches the resource type for an exact match against field and value
+- search(value) - searches the resource type for a match in any field
+- all - returns all resources
+- delete(id) - deletes the resource with the given id
+
+### RippleKeycloak::User
+
+- create(payload) - posts given payload to user create
+- add_to_group(user_id, group_id) - adds given user to given group
+- remove_from_group(user_id, group_id) - removes given user from given group
+- add_role(user_id, role_name) - adds given role to user
+- remove_role(user_id, role_name) - removes given role from user
+
+### RippleKeycloak::Group
+
+- create(name:, parent: false) - creates a group with the given name, optionally under the given parent
+- add_role(group_id, role_name) - adds given role to group
+- remove_role(group_id, role_name) - removes given role from group
+
+### RippleKeycloak::Role
+
+- create(name:) - creates a role with the given name
+
+## 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/hex-event-solutions/ripple_keycloak. 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/hex-event-solutions/ripple_keycloak/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 RippleKeycloak project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/hex-event-solutions/ripple_keycloak/blob/master/CODE_OF_CONDUCT.md).

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,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'ripple_token'
+
+# 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/ripple_token.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'jwt'
+
+require 'ripple_token/version'
+require 'ripple_token/client'
+require 'ripple_token/middleware'
+require 'ripple_token/token'
+require 'ripple_token/railtie' if defined?(Rails)
+
+module RippleToken
+  class Error < StandardError; end
+  class ExpiredTokenError < Error; end
+  class TokenDecodeError < Error; end
+  class MissingTokenError < Error; end
+end

data/lib/ripple_token/client.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'httparty'
+require 'json'
+require 'active_support/core_ext/module/delegation'
+
+require 'ripple_token/configuration'
+
+module RippleToken
+  class Client
+    include HTTParty
+
+    class << self
+      delegate :public_paths, to: :configuration
+
+      def configure
+        @configuration = Configuration.new
+        yield(configuration)
+        fetch_public_key
+        'Public key retrieved successfully'
+      end
+
+      def public_key
+        fetch_public_key if (last_update_at + public_key_ttl) < Time.now
+
+        @public_key
+      end
+
+      private
+
+      delegate :base_url, :realm, :public_key_ttl, to: :configuration
+
+      attr_accessor :last_update_at, :configuration
+
+      def fetch_public_key
+        response = get("#{base_url}/auth/realms/#{realm}")
+        raw_public_key = "-----BEGIN PUBLIC KEY-----\n" \
+                      "#{response['public_key']}\n" \
+                      '-----END PUBLIC KEY-----'
+        @public_key = OpenSSL::PKey::RSA.new raw_public_key
+        @last_update_at = Time.now
+      end
+    end
+  end
+end

data/lib/ripple_token/configuration.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module RippleToken
+  class Configuration
+    attr_accessor :base_url,
+                  :realm,
+                  :public_key_ttl,
+                  :public_paths
+  end
+end

data/lib/ripple_token/middleware.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module RippleToken
+  class Middleware
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      dup._call env
+    end
+
+    def _call(env)
+      method = env['REQUEST_METHOD']
+      path = env['PATH_INFO']
+
+      unless token.public_path? method, path
+        encoded_token = env['HTTP_AUTHORIZATION']&.gsub(/^Bearer /, '') || ''
+        decoded_token = token.decode(encoded_token)
+        store_user_details(decoded_token, env)
+      end
+      @app.call(env)
+    end
+
+    private
+
+    def store_user_details(decoded_token, env)
+      env['keycloak.token'] = decoded_token
+      env['keycloak.user_id'] = decoded_token['sub']
+      env['keycloak.user_roles'] = decoded_token['realm_access']['roles']
+      env['keycloak.user_email'] = decoded_token['email']
+      env['keycloak.user_name'] = decoded_token['name']
+      env['keycloak.user_first_name'] = decoded_token['given_name']
+      env['keycloak.user_last_name'] = decoded_token['family_name']
+      env['keycloak.user_phone'] = decoded_token['phone']
+      env['keycloak.user_email_verified'] = decoded_token['email_verified']
+      env['keycloak.user_groups'] = decoded_token['groups']
+    end
+
+    def token
+      Token.new(Client.public_key)
+    end
+  end
+end

data/lib/ripple_token/railtie.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module RippleToken
+  class Railtie < Rails::Railtie
+    railtie_name :ripple_token
+
+    initializer 'ripple_token.insert_middleware' do |app|
+      app.config.middleware.use(RippleToken::Middleware)
+    end
+  end
+end

data/lib/ripple_token/token.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module RippleToken
+  class Token
+    def initialize(public_key)
+      @public_key = public_key
+    end
+
+    def decode(token)
+      raise MissingTokenError if token.nil? || token&.empty?
+
+      begin
+        decoded_token = JWT.decode(token, public_key, true, { algorithm: 'RS256' })[0]
+        raise ExpiredTokenError if expired? decoded_token
+
+        decoded_token
+      rescue JWT::DecodeError => e
+        raise TokenDecodeError, e.message
+      rescue JWT::ExpiredSignature => e
+        raise ExpiredTokenError, e.message
+      end
+    end
+
+    def public_path?(method, path)
+      return false if Client.public_paths.nil? || Client.public_paths.empty?
+
+      return true if Client.public_paths[method]&.include? path
+
+      false
+    end
+
+    private
+
+    attr_reader :public_key
+
+    def expired?(token)
+      expiration = Time.at(token['exp'])
+      expiration < Time.now
+    end
+  end
+end

data/lib/ripple_token/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RippleToken
+  VERSION = '0.1.0'
+end

data/print_version.rb

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative 'lib/ripple_token/version'
+puts RippleToken::VERSION

data/ripple_token.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative 'lib/ripple_token/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ripple_token'
+  spec.version       = RippleToken::VERSION
+  spec.authors       = ['Hex Event Solutions Limited']
+  spec.email         = ['ruby@hexes.co.uk']
+
+  spec.summary       = 'Keycloak token validator'
+  spec.homepage      = 'https://rubygems.org/gems/ripple_token'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.7.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/hex-event-solutions/ripple_token'
+
+  # 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(__dir__)) 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('activesupport', '6.0.3.1')
+  spec.add_dependency('httparty', '0.18.1')
+  spec.add_dependency('jwt', '2.2.1')
+
+  spec.add_development_dependency('rspec', '3.9.0')
+  spec.add_development_dependency('rubocop', '0.85.1')
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: ripple_token
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Hex Event Solutions Limited
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-06-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 6.0.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 6.0.3.1
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.2.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.85.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.85.1
+description: 
+email:
+- ruby@hexes.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/gem-push.yml"
+- ".github/workflows/lint-and-test.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/ripple_token.rb
+- lib/ripple_token/client.rb
+- lib/ripple_token/configuration.rb
+- lib/ripple_token/middleware.rb
+- lib/ripple_token/railtie.rb
+- lib/ripple_token/token.rb
+- lib/ripple_token/version.rb
+- print_version.rb
+- ripple_token.gemspec
+homepage: https://rubygems.org/gems/ripple_token
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://rubygems.org/gems/ripple_token
+  source_code_uri: https://github.com/hex-event-solutions/ripple_token
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Keycloak token validator
+test_files: []