Garage::Jwt

Garage extension to use JWT as authentication strategy.

Add this line to your application's Gemfile:

gem 'garage-jwt'

And then execute:

$ bundle

Or install it yourself as:

$ gem install garage-jwt

In config/initializer/garage.rb:

Garage.configuration.strategy = Garage::Strategy::Jwt

Garage::Jwt.configure do |c|
  c.algorithm = Garage::Jwt::Algorithm.hs256
  c.common_key = "secret key"

  # c.private_key = OpenSSL::PKey::RSA.generate 2048
  # c.public_key = c.private_key.public_key
end

The following cryptographic signing algorithms are available:

• NONE
  • Garage::Jwt::Algorithm.none
• HMAC
  • Garage::Jwt::Algorithm.hs256 - HMAC using SHA-256 hash algorithm
  • Garage::Jwt::Algorithm.hs384 - HMAC using SHA-384 hash algorithm
  • Garage::Jwt::Algorithm.hs512 - HMAC using SHA-512 hash algorithm
• RSA
  • Garage::Jwt::Algorithm.rs256 - RSA using SHA-256 hash algorithm
  • Garage::Jwt::Algorithm.rs384 - RSA using SHA-384 hash algorithm
  • Garage::Jwt::Algorithm.rs512 - RSA using SHA-512 hash algorithm
• ECDSA
  • Garage::Jwt::Algorithm.rs256 - ECDSA using SHA-256 hash algorithm
  • Garage::Jwt::Algorithm.rs384 - ECDSA using SHA-384 hash algorithm
  • Garage::Jwt::Algorithm.rs512 - ECDSA using SHA-512 hash algorithm

You can encode token with the following method:

Garage::Jwt.encode_token(
  resource_owner_id: user.id,
  application_id: 128,
  scope: "read write",
  expired_at: Time.zone.now + 15.minutes
)

Or if you use Garage::ControllerHelper, you can use encode_token method.

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.

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

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