https://github.com/doorkeeper-gem/doorkeeper-jwt
JWT Token support for Doorkeeper
https://github.com/doorkeeper-gem/doorkeeper-jwt
doorkeeper jwt jwt-auth jwt-token
Last synced: about 1 month ago
JSON representation
JWT Token support for Doorkeeper
- Host: GitHub
- URL: https://github.com/doorkeeper-gem/doorkeeper-jwt
- Owner: doorkeeper-gem
- License: mit
- Created: 2015-03-31T17:09:20.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2023-03-22T07:04:05.000Z (about 2 years ago)
- Last Synced: 2024-04-14T17:36:28.713Z (about 1 year ago)
- Topics: doorkeeper, jwt, jwt-auth, jwt-token
- Language: Ruby
- Size: 84 KB
- Stars: 214
- Watchers: 4
- Forks: 44
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
[](https://rubygems.org/gems/doorkeeper-jwt)
[](https://coveralls.io/github/doorkeeper-gem/doorkeeper-jwt?branch=master)
[](https://travis-ci.org/doorkeeper-gem/doorkeeper-jwt)
[](https://codeclimate.com/github/doorkeeper-gem/doorkeeper-jwt/maintainability)
# Doorkeeper::JWT
Doorkeeper JWT adds JWT token support to the Doorkeeper OAuth library. Confirmed to work with Doorkeeper 2.2.x - 4.x.
Untested with later versions of Doorkeeper.
```ruby
gem 'doorkeeper'
```
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'doorkeeper-jwt'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install doorkeeper-jwt
## Usage
In your `doorkeeper.rb` initializer add the follow to the `Doorkeeper.configure` block:
```ruby
access_token_generator '::Doorkeeper::JWT'
```
Then add a `Doorkeeper::JWT.configure` block below the `Doorkeeper.configure` block to set your JWT preferences.
```ruby
Doorkeeper::JWT.configure do
# Set the payload for the JWT token. This should contain unique information
# about the user. Defaults to a randomly generated token in a hash:
# { token: "RANDOM-TOKEN" }
token_payload do |opts|
user = User.find(opts[:resource_owner_id])
{
iss: 'My App',
iat: Time.current.utc.to_i,
aud: opts[:application][:uid],
# @see JWT reserved claims - https://tools.ietf.org/html/draft-jones-json-web-token-07#page-7
jti: SecureRandom.uuid,
sub: user.id,
user: {
id: user.id,
email: user.email
}
}
end
# Optionally set additional headers for the JWT. See
# https://tools.ietf.org/html/rfc7515#section-4.1
# JWK can be used to automatically verify RS* tokens client-side if token's kid matches a public kid in /oauth/discovery/keys
# token_headers do |_opts|
# key = OpenSSL::PKey::RSA.new(File.read(File.join('path', 'to', 'file.pem')))
# { kid: JWT::JWK.new(key)[:kid] }
# end
# Use the application secret specified in the access grant token. Defaults to
# `false`. If you specify `use_application_secret true`, both `secret_key` and
# `secret_key_path` will be ignored.
use_application_secret false
# Set the signing secret. This would be shared with any other applications
# that should be able to verify the authenticity of the token. Defaults to "secret".
secret_key ENV['JWT_SECRET']
# If you want to use RS* algorithms specify the path to the RSA key to use for
# signing. If you specify a `secret_key_path` it will be used instead of
# `secret_key`.
secret_key_path File.join('path', 'to', 'file.pem')
# Specify cryptographic signing algorithm type (https://github.com/progrium/ruby-jwt). Defaults to
# `nil`.
signing_method :hs512
end
```
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git
commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
1. Fork it (https://github.com/[my-github-username]/doorkeeper-jwt/fork)
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request