![grape-jwt-authentication](doc/assets/project.svg)

[![Continuous Integration](https://github.com/hausgold/grape-jwt-authentication/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/hausgold/grape-jwt-authentication/actions/workflows/test.yml)
[![Gem Version](https://badge.fury.io/rb/grape-jwt-authentication.svg)](https://badge.fury.io/rb/grape-jwt-authentication)
[![Test Coverage](https://automate-api.hausgold.de/v1/coverage_reports/grape-jwt-authentication/coverage.svg)](https://knowledge.hausgold.de/coverage)
[![Test Ratio](https://automate-api.hausgold.de/v1/coverage_reports/grape-jwt-authentication/ratio.svg)](https://knowledge.hausgold.de/coverage)
[![API docs](https://automate-api.hausgold.de/v1/coverage_reports/grape-jwt-authentication/documentation.svg)](https://www.rubydoc.info/gems/grape-jwt-authentication)

This gem is dedicated to easily integrate a JWT authentication to your
[Grape](https://github.com/ruby-grape/grape) API. The real authentication
functionality must be provided by the user and this makes this gem highly
flexible on the JWT verification level.

- [Installation](#installation)
- [Usage](#usage)
  - [Grape API](#grape-api)
    - [Helpers](#helpers)
  - [Configuration](#configuration)
    - [Authenticator](#authenticator)
    - [Malformed token handling](#malformed-token-handling)
    - [Failed authentication handling](#failed-authentication-handling)
    - [RSA public key helper](#rsa-public-key-helper)
      - [RSA public key location (URL)](#rsa-public-key-location-url)
      - [RSA public key caching](#rsa-public-key-caching)
      - [RSA public key cache expiration](#rsa-public-key-cache-expiration)
    - [JWT instance helper](#jwt-instance-helper)
      - [Issuer verification](#issuer-verification)
      - [Beholder (audience) verification](#beholder-audience-verification)
      - [Custom JWT verification options](#custom-jwt-verification-options)
      - [Custom JWT verification key](#custom-jwt-verification-key)
  - [Per-API configuration](#per-api-configuration)
  - [Full RSA256 example](#full-rsa256-example)
- [Development](#development)
- [Code of Conduct](#code-of-conduct)
- [Contributing](#contributing)
- [Releasing](#releasing)

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'grape-jwt-authentication'
```

And then execute:

```bash
$ bundle
```

Or install it yourself as:

```bash
$ gem install grape-jwt-authentication
```

## Usage

### Grape API

You can enable the JWT authentication on any Grape API you like. This includes
specific endpoints or a whole API. Just include the
`Grape::Jwt::Authentication` module and configure it the way you like.

```ruby
module UserApi
  class ApiV1 < Grape::API
    # All your fancy Grape API stuff [..]
    version 'v1', using: :path

    # Enable JWT authentication on this API
    include Grape::Jwt::Authentication
    auth :jwt
  end
end
```

#### Helpers

The inclusion of the `Grape::Jwt::Authentication` inserts some helpers to
access the parsed and original JWT. This can be handy when you need to work
with the JWT payload or perform some extra calculations with the expiration
date of it.  The following example demonstrated the usage of the helpers.

```ruby
module UserApi
  class ApiV1 < Grape::API
    # All your fancy Grape API stuff [..]
    version 'v1', using: :path

    resource :payload do
      desc 'A JWT payload echo service.'
      get do
        # The parsed JWT which has an accessible payload (RecursiveOpenStruct)
        { payload: request_jwt.payload.to_h }
      end
    end

    resource :token do
      desc 'A JWT echo service.'
      get do
        # The original JWT parsed from the HTTP authorization header
        { token: original_request_jwt }
      end
    end

    # Enable JWT authentication on this API
    include Grape::Jwt::Authentication
    auth :jwt
  end
end
```

### Configuration

This gem is quite customizable and flexible to fulfill your needs. You can make
use of some parts and leave other if you do not care about them. We are not
going to force the way how to verify JWT or work with them. Here comes a
overview of the configurations you can do.

#### Authenticator

The authenticator function which must be defined by the user to verify the
given JSON Web Token. Here comes all your logic to lookup the related user on
your database, the token claim verification and/or the token cryptographic
signing. The function must return true or false to indicate the validity of the
token.

```ruby
Grape::Jwt::Authentication.configure do |conf|
  conf.authenticator = proc do |token|
    # Verify the token the way you like. (true, false)
  end
end
```

#### Malformed token handling

Whenever the given value on the `Authorization` header is not a valid Bearer
authentication scheme or the token itself is not a valid JSON Web Token, this
user defined function will be called. You can add custom handling of this
situations, like responding a different HTTP status code, or a more detailed
response body. By default the Rack stack will be interrupted and a response
with the `400 Bad Request` status code will be send to the client. The raw
token (value of the `Authorization` header) and the Rack app will be injected
to your function for maximum flexibility.

```ruby
Grape::Jwt::Authentication.configure do |conf|
  conf.malformed_auth_handler = proc do |raw_token, app|
    # Do your own error handling. (Rack interface)
  end
end
```

#### Failed authentication handling

When the client sends a correctly formatted JSON Web Token with the Bearer
authentication scheme within the `Authorization` header and your authenticator
fails for some reason (token claims, wrong audience, bad subject, expired
token, wrong cryptographic signing etc), this function is called to handle the
bad authentication. By default the Rack stack will be interrupted and a
response with the `401 Unauthorized` status code will be send to the client.
You can customize this the way you like and send different error codes, or
handle the error completely different. The parsed JSON Web Token and the Rack
app will be injected to your function to allow any customized error handling.

```ruby
Grape::Jwt::Authentication.configure do |conf|
  conf.failed_auth_handler = proc do |token, app|
    # Do your own error handling. (Rack interface)
  end
end
```

#### RSA public key helper

We provide a straightforward solution to deal with the provision of RSA public
keys.  Sometimes you want to distribute them by file to each machine and have
a local access, and sometimes you provide an endpoint on your identity
provider to fetch the RSA public key via HTTP/HTTPS.  The `RsaPublicKey` class
helps you to fulfill this task easily.

**Heads up!** You can skip this if you do not care about RSA verification or
have your own mechanism.

```ruby
# Get your public key, by using the global configuration
public_key = Keyless::RsaPublicKey.fetch
# => OpenSSL::PKey::RSA

# Using a local configuration
fetcher = Keyless::RsaPublicKey.instance
fetcher.url = 'https://your.identity.provider/rsa_public_key'
public_key = fetcher.fetch
# => OpenSSL::PKey::RSA
```

The following examples show you how to configure the
`Keyless::RsaPublicKey` class the global way. This is useful
for a shared initializer place.

##### RSA public key location (URL)

Whenever you want to use the `RsaPublicKey` class you configure the default URL
on the singleton instance, or use the gem configure method and set it up
accordingly.  We allow the fetch of the public key from a remote server
(HTTP/HTTPS) or from a local file which is accessible by the ruby process.
Specify the URL or the local path here. Not specified by default.

```ruby
Grape::Jwt::Authentication.configure do |conf|
  # Local file
  conf.rsa_public_key_url = '/tmp/jwt_rsa.pub'
  # Remote URL
  conf.rsa_public_key_url = 'https://your.identity.provider/rsa_public_key'
end
```

##### RSA public key caching

You can configure the `RsaPublickey` class to enable/disable caching. For a
remote public key location it is handy to cache the result for some time to
keep the traffic low to the resource server.  For a local file you can skip
this. Disabled by default.

```ruby
Grape::Jwt::Authentication.configure do |conf|
  conf.rsa_public_key_caching = true
end
```

##### RSA public key cache expiration

When you make use of the cache of the `RsaPublicKey` class you can fine tune
the expiration time. The RSA public key from your identity
provider should not change this frequent, so a cache for at least one hour is
fine. You should not set it lower than one minute. Keep this setting in mind
when you change keys. Your infrastructure could be inoperable for this
configured time.  One hour by default.

```ruby
Grape::Jwt::Authentication.configure do |conf|
  conf.rsa_public_key_expiration = 1.hour
end
```

#### JWT instance helper

We ship a little wrapper class to ease the validation of JSON Web Tokens with
the help of the great [ruby-jwt](https://github.com/jwt/ruby-jwt) library. This
wrapper class provides some helpers like `#access_token?`, `#refresh_token?` or
`#expires_at` which returns a ActiveSupport time-zoned representation of the
token expiration timestamp. It is initially opinionated to RSA verification,
but can be tuned to verify HMAC or ECDSA signed tokens. It integrated well with
the `RsaPublicKey` fetcher class. (by default)

**Heads up!** You can skip this if you have your own JWT verification mechanism.

```ruby
# A raw JWT (no signing, payload: {test: true})
raw_token = 'eyJ0eXAiOiJKV1QifQ.eyJ0ZXN0Ijp0cnVlfQ.'

# Parse the raw token and create a instance of it
token = Keyless::Jwt.new(raw_token)

# Access the payload easily (recursive-open-struct)
token.payload.test
# => true

# Validate the token (we assume you configured the verification key, an/or
# you own custom JWT verification options here)
token.valid?
# => true
```

The following examples show you how to configure the
`Keyless::Jwt` class the global way. This is useful for a
shared initializer place.

##### Issuer verification

The JSON Web Token issuer which should be used for verification. When `nil` we
also turn off the verification by default. (See the default JWT options)

```ruby
Grape::Jwt::Authentication.configure do |conf|
  conf.jwt_issuer = 'your-identity-provider'
end
```

##### Beholder (audience) verification

The resource server (namely the one which configures this right now)
which MUST be present on the JSON Web Token audience claim. When `nil` we
also turn off the verification by default. (See the default JWT options)

```ruby
Grape::Jwt::Authentication.configure do |conf|
  conf.jwt_beholder = 'your-resource-server'
end
```

##### Custom JWT verification options

You can configure a different JSON Web Token verification option hash if your
algorithm differs or you want some extra/different options.  Just watch out
that you have to pass a proc to this configuration property. On the
`Keyless::Jwt` class it has to be a simple hash. The default
is here the `RS256` algorithm with enabled expiration check, and issuer+audience
check when the `jwt_issuer` / `jwt_beholder` are configured accordingly.

```ruby
Grape::Jwt::Authentication.configure do |conf|
  conf.jwt_options = proc do
    # See: https://github.com/jwt/ruby-jwt
    { algorithm: 'HS256' }
  end
end
```

##### Custom JWT verification key

You can configure your own verification key on the `Jwt` wrapper class.  This
way you can pass your HMAC secret or your ECDSA public key to the JSON Web
Token validation method. Here you need to pass a proc, on the
`Keyless::Jwt` class it has to be a scalar value. By default
we use the `RsaPublicKey` class to retrieve the RSA public key.

```ruby
Grape::Jwt::Authentication.configure do |conf|
  conf.jwt_verification_key = proc do
    # Retrieve your verification key (RSA, ECDSA, HMAC secret)
    # the way you like, and pass it back here.
  end
end
```

### Per-API configuration

Imagine the migration of your API (say v2) and also the JSON Web Token payload
changes in a way you need to handle. Maybe you want to be more strict on
version 2 than on your old version 1. For this you can make use of the local
configuration of the JWT authenticator, on your specific Grape API declaration.
Here comes an example usage:

```ruby
module UserApi
  class ApiV2 < Grape::API
    v2_auth_malformed = proc { |raw_token, app| [400, {}, ['Malformed!']] }
    v2_auth_failed = proc { |token, app| [401, {}, ['Go away!']] }

    # Enable JWT authentication on this API
    include Grape::Jwt::Authentication
    auth(:jwt, malformed: v2_auth_malformed,
               failed: v2_auth_failed) do |token|
      # Your new stricter v2 authenticator.
      false
    end
  end
end
```

### Full RSA256 example

Here comes a full example of the opinionated `RSA256` algorithm usage with a
remote RSA public key location, enabled caching and a full token payload
verification.

```ruby
# On an initializer ..
Grape::Jwt::Authentication.configure do |conf|
  # The remote RSA public key location and enabled caching to limit the
  # traffic on the remote server.
  conf.rsa_public_key_url = 'https://your.identity.provider/rsa_public_key'
  conf.rsa_public_key_caching = true
  conf.rsa_public_key_expiration = 10.minutes

  # Configure the JWT wrapper.
  conf.jwt_issuer = 'The Identity Provider'
  conf.jwt_beholder = 'example-api'

  # Let Grape handle the malformed error with correct response formatting.
  # (XML, JSON)
  conf.malformed_auth_handler = proc do |raw_token, app|
    raise ArgumentError, 'Authorization header is malformed.'
  end

  # The same procedure for failed verifications. (XML, JSON formatting handled
  # external by Grape)
  conf.failed_auth_handler = proc do |token, app|
    raise ArgumentError, 'Access denied.'
  end

  # Custom verification logic.
  conf.authenticator = proc do |token|
    # Parse and instantiate a JWT verification instance
    jwt = Keyless::Jwt.new(token)

    # We just allow valid access tokens
    jwt.access_token? && jwt.valid?
  end
end

# On your Grape API ..
module UserApi
  class ApiV1 < Grape::API
    # Enable JWT authentication on this API
    include Grape::Jwt::Authentication
    auth :jwt
  end
end
```

## Development

After checking out the repo, run `make install` to install dependencies. Then,
run `make test` to run the tests. You can also run `make shell-irb` for an
interactive prompt that will allow you to experiment.

## Code of Conduct

Everyone interacting in the project codebase, issue tracker, chat
rooms and mailing lists is expected to follow the [code of
conduct](./CODE_OF_CONDUCT.md).

## Contributing

Bug reports and pull requests are welcome on GitHub at
https://github.com/hausgold/grape-jwt-authentication. Make sure that every pull request adds
a bullet point to the [changelog](./CHANGELOG.md) file with a reference to the
actual pull request.

## Releasing

The release process of this Gem is fully automated. You just need to open the
Github Actions [Release
Workflow](https://github.com/hausgold/grape-jwt-authentication/actions/workflows/release.yml)
and trigger a new run via the **Run workflow** button. Insert the new version
number (check the [changelog](./CHANGELOG.md) first for the latest release) and
you're done.