Vauth

A collection of Ruby objects that can be stitched together to create an OAuth 2.0 flow. Currently only supports the Authorization Code Grant flow.

TODO: Replace UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.

Install the gem and add to the application's Gemfile by executing:

bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG

If bundler is not being used to manage dependencies, install the gem by executing:

gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG

Create a Client:

client = ::Vauth::Client.new(
  "client-id-from-oauth2-provider",
  "client-secret-from-oauth2-provider",
  "https://oauth2-provider.com/authorization-uri",
  "https://oauth2-provider.com/token-uri",
)

Pass it to create an Authorization Request:

request = ::Vauth::AuthorizationRequest.new(client)

Store the request state via request.state to a secure storage, then redirect the Resource Owner (user) via request.url to authorize the application.

When the Resource Owner gets redirected back, recreate the Authorization Request from the stored state:

request = ::Vauth::AuthorizationRequest.new(client, stored_state)

Then you should be able to get the Authorization Code Grant with the re-created request, the received code, and the received state:

grant = ::Vauth::AuthorizationCodeGrant.new(request, code, received_state)

The grant will give you the ID Token:

token = grant.identity_token

The ID Token will give you the issuer via token.issuer, and the subject via token.subject.

After checking out the repo, run bin/setup to install dependencies. Then, run rake test 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 the created tag, and push the .gem file to rubygems.org.

Bug reports and pull requests are welcome on GitHub at https://github.com/radiantshaw/vauth-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

The gem is available as open source under the terms of the MIT License.

Everyone interacting in the Vauth project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.