TokenValidator

This gem is used to validate OAuth2 authentication tokens returned from a provided issuer (for example, the Ario Identity Provider). This allows other components/services to verify that the user who presents the token is authenticated and authorized to access the requested resource.

Usage

Initialization

Something like the following should be included in an initializer in your Rails project:

TokenValidator::ValidatorConfig.configure(
  client_id: ENV['client_id'],
  client_secret: ENV['client_secret'],
  requested_scope: ENV['scope'],
  issuer_url: ENV['issuer_url'],
  audience: ENV['audience']
)

Installation

Add this line to your application's Gemfile:

gem 'token_validator'

And then execute:

$ bundle

Or install it yourself as:

$ gem install token_validator

Development

Development on this project should occur on separate feature branches and pull requests should be submitted. When submitting a pull request, the pull request comment template should be filled out as much as possible to ensure a quick review and increase the likelihood of the pull request being accepted.

Ruby

This application requires:

• Ruby version: 2.7.1

Ruby 2.7.1 and greater requires OpenSSL 1.1+. To link to Homebrew's upgraded version of OpenSSL, add the following to your bash profile

export RUBY_CONFIGURE_OPTS="--with-openssl-dir=$(brew --prefix openssl@1.1)"

If you do not have Ruby installed, it is recommended you use ruby-install and chruby to manage Ruby versions.

brew install ruby-install chruby
ruby-install ruby 2.7.1

Add the following lines to ~/.bash_profile:

source /usr/local/opt/chruby/share/chruby/chruby.sh
source /usr/local/opt/chruby/share/chruby/auto.sh

Set Ruby version to 2.7.1:

source ~/.bash_profile
chruby 2.7.1

Running Tests

rspec # Without code coverage
COVERAGE=true rspec # with code coverage

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/Zetatango/token_validator