Download the PHP package gesdinet/jwt-refresh-token-bundle without Composer

*JWTRefreshTokenBundle

The purpose of this bundle is manage refresh tokens with JWT (Json Web Tokens) in an easy way. This bundles uses LexikJWTAuthenticationBundle. Supports Doctrine ORM/ODM.

Prerequisites

This bundle requires PHP 8.2 or later and Symfony 6.4, or 7.2+.

For support with older Symfony versions, please use the 1.x release.

Protip: Though the bundle doesn't force you to do so, it is highly recommended to use HTTPS.

Installation

Step 1: Download the Bundle

You must also install either the Doctrine ORM or MongoDB ODM, these packages are not installed automatically with this bundle. Failing to do so may trigger errors on installation.

With Doctrine's ORM

With Doctrine's MongoDB ODM

Alternatively, a custom persistence layer can be used.

For that purpose, you must:

• provide an implementation of Doctrine\Persistence\ObjectManager
• configure the bundle to use your object manager

Step 2: Enable the Bundle

Symfony Flex Application

For an application using Symfony Flex the bundle should be automatically registered, but if not you will need to add it to your config/bundles.php file.

Step 3: Configure the Bundle

Symfony Flex Application

For an application using Symfony Flex, a recipe should have been applied to your application. If not, you will need to make the following changes:

1. Configure the refresh token class. Create the config/packages/gesdinet_jwt_refresh_token.yaml file with the below contents:

2. Create the object class.

If you are using the Doctrine ORM, the below contents should be placed at src/Entity/RefreshToken.php:

If you are using the Doctrine MongoDB ODM, the below contents should be placed at src/Document/RefreshToken.php (remember to update the refresh_token_class configuration above to match):

Step 4

Define the refresh token route

Open your routing configuration file and add the following route to it:

Configure the authenticator

To enable the authenticator, you should add it to your API firewall(s) alongside the json_login and jwt authenticators.

The complete firewall configuration should look similar to the following:

Step 5: Update your database schema

You will need to add the table for the refresh tokens to your application's database.

With migrations:

Without migrations (NOT RECOMMENDED):

Usage

The below options can be configured through the bundle's configuration in the config/packages/gesdinet_jwt_refresh_token.yaml file (make sure to create it if it does not already exist).

Token TTL

You can define the refresh token TTL, this value is set in seconds and defaults to 1 month. You can change this value adding this line to your config:

Update Token TTL

You can configure the bundle to refresh the TTL on a refresh token when it is used, by default this feature is disabled. You can change this value adding this line to your config:

Refresh Token Parameter Name

You can define the parameter name for the refresh token when it is read from the request, the default value is refresh_token. You can change this value adding this line to your config:

Return Expiration Timestamp

If set to true, the expiration Unix timestamp will be added to the response.

The default parameter name is refresh_token_expiration. You can change the parameter name by adding this line to your config and changing it:

Set The User Provider

You can define a user provider to use for the authenticator its configuration.

Note, if your application has multiple user providers, you MUST configure this value for either the firewall or the provider.

By default, when a user provider is not specified, then the user provider for the firewall is used instead.

Set The User Checker

You can define a user checker to use for the firewall as part of the firewall configuration:

Single Use Tokens

You can configure the refresh token so it can only be consumed once. If set to true and the refresh token is consumed, a new refresh token will be provided.

To enable this behavior add this line to your config:

Set the refresh token in a cookie

By default, the refresh token is returned in the body of a JSON response. You can use the following configuration to set it in a HttpOnly cookie instead. The refresh token is automatically extracted from the cookie during refresh.

To allow users to logout when using cookies, you need to configure the LogoutEvent to trigger on a specific route, and call that route during logout.

Invalidate refresh token on logout

This bundle automatically registers an EventListener which triggers on LogoutEvents from a specific firewall (default: api).

The LogoutEventListener automatically invalidates the given refresh token and, if enabled, unsets the cookie. If no refresh token is supplied, an error is returned and the cookie remains untouched. If the supplied refresh token is (already) invalid, the cookie is unset.

All you have to do is make sure the LogoutEvent triggers on a specific route, and call that route during logout:

If you want to configure the LogoutEvent to trigger on a different firewall, the name of the firewall has to be configured:

Doctrine Manager Type

By default, the bundle will try to set the appropriate Doctrine object manager for your application using the following logic to define the manager type:

• If the manager_type configuration key is set to "mongodb", the MongoDB ODM is used
• If the manager_type configuration key is set to "orm" (default), and the ORM is not installed but the MongoDB ODM is installed, the MongoDB ODM is used
• By default, the manager_type is "orm" and the ORM is used

You can customize the manager type using the manager_type configuration:

Use another object manager

You can configure the bundle to use any object manager using the object_manager configuration. Note, an explicitly defined object_manager configuration will override any automatic configuration based on the manager_type.

Use another class for refresh tokens

You can define your own refresh token class for your project by creating a class extending from the classes provided by this bundle. This also allows you to customize the refresh token, i.e. to add extra data to the token.

When using the Doctrine ORM, create a class extending Gesdinet\JWTRefreshTokenBundle\Entity\RefreshToken in your application:

When using the Doctrine MongoDB ODM, create a class extending Gesdinet\JWTRefreshTokenBundle\Document\RefreshToken in your application:

Then declare this class adding this line to your config.yml file:

NOTE If using another object manager, it is recommended your object class extends from Gesdinet\JWTRefreshTokenBundle\Model\AbstractRefreshToken which implements all required methods from Gesdinet\JWTRefreshTokenBundle\Model\RefreshTokenInterface.

Generating Tokens

When you authenticate through /api/login_check with user/password credentials, LexikJWTAuthenticationBundle now returns a JWT Token and a Refresh Token data.

The refresh token is persisted as a RefreshTokenInterface object. When your JWT expires, you have two options:

• Generate a new JWT by re-authenticate with your credentials via /api/login_check. This will also generate a new refresh token.
• Generate a new JWT by POSTing your valid refresh token to /api/token/refresh. This method does not require any user credentials. A refresh token can be used as long as it is not expired - it even can be used multiple times (*). On a successful refresh, the refresh tokens TTL will increase, but the refresh token itself will not change.

*(*) Note that when a refresh token is consumed and the config option single_use is set to true the token will no longer be valid.*

This call returns a new valid JWT token renewing valid datetime of your refresh token.

Useful Commands

Revoke all invalid tokens

If you want to revoke all invalid refresh tokens, where the expiration time has passed, you can run this command:

The command optionally accepts a date argument which will delete all tokens older than the given time. This can be any value that can be parsed by the DateTime class.

You can also specify the batch size used by the command when clearing tokens with the --batch-size option, which defaults to the default_invalid_batch_size config option when not provided.

We recommend executing this command as a cronjob to remove invalid refresh tokens on an interval.

Revoke a token

If you want to revoke a single token you can use this command:

Events

Token Refreshed

When a token is refreshed, the gesdinet.refresh_token event is dispatched with a Gesdinet\JWTRefreshTokenBundle\Event\RefreshEvent object.

Refresh Token Failure

When there is a failure authenticating the refresh token, the gesdinet.refresh_token_failure event is dispatched with a Gesdinet\JWTRefreshTokenBundle\Event\RefreshAuthenticationFailureEvent object.

Refresh Token Not Found

When there is a failure authenticating the refresh token, the gesdinet.refresh_token_not_found event is dispatched with a Gesdinet\JWTRefreshTokenBundle\Event\RefreshTokenNotFoundEvent object.

Token Extractor

The bundle provides a Gesdinet\JWTRefreshTokenBundle\Request\Extractor\ExtractorInterface to define classes which can read the refresh token from the request.

By default, the Gesdinet\JWTRefreshTokenBundle\Request\Extractor\ChainExtractor is used which allows checking multiple aspects of the request for a token. The first token found will be used.

You can create a custom extractor by adding a class to your application implementing the interface. For example, to add an extractor checking for a "X-Refresh-Token" header:

This bundle handles automatically configuring ExtractorInterface objects and will automatically set the gesdinet_jwt_refresh_token.request_extractor container tag when your application uses autoconfiguration (autoconfigure: true in your services.yaml file). If autoconfiguration is not in use, you will need to manually configure the tag:

Prioritizing Extractors

The gesdinet_jwt_refresh_token.request_extractor container tag supports prioritizing extractors, you can use this to set the preferred order for your extractors by adding a priority attribute. The higher the number, the sooner the extractor will be run.

*

Logout Configuration for JWTRefreshTokenBundle

The gesdinet_jwt_refresh_token configuration in your Symfony application's config/packages/gesdinet_jwt_refresh_token.yaml file allows you to customize the logout behavior when using the JWTRefreshTokenBundle. Below is a comprehensive list of the available options for the logout section, which can be used to fine-tune the logout process, including session management, cookie handling, and CSRF protection.

Configuration Options

The logout configuration options can be defined under the gesdinet_jwt_refresh_token.logout key in your YAML configuration file. Below is an explanation of each option, its purpose, and its default value (if applicable).

clear_site_data

• Type: Array or String
• Default: []
• Description: Specifies the types of site data to clear when a user logs out, as part of the Clear-Site-Data HTTP header. This header instructs the browser to clear specific types of data, such as cookies, cache, or storage. Valid values include "cache", "cookies", "storage", or "executionContexts". You can specify one or multiple values as an array. For example, setting clear_site_data: ["cookies", "storage"] will clear cookies and web storage upon logout.
• Example:

csrf_parameter

• Type: String
• Default: _csrf_token
• Description: Defines the name of the CSRF token parameter expected in the logout request (e.g., in a POST form or query string). This is used when CSRF protection is enabled to validate the logout request.
• Example:

csrf_token_id

• Type: String
• Default: logout
• Description: Specifies the identifier for the CSRF token used during logout. This allows the bundle to distinguish the CSRF token for logout from other CSRF tokens in your application. It is used in conjunction with the csrf_token_manager.
• Example:

csrf_token_manager

• Type: String
• Default: security.csrf.token_manager
• Description: References the service ID of the CSRF token manager used to generate and validate CSRF tokens for logout requests. By default, it uses Symfony’s built-in CSRF token manager. You can override this to use a custom CSRF token manager service if needed.
• Example:

delete_cookies

• Type: Array
• Default: []
• Description: Lists the names of cookies to delete during the logout process. This is useful for removing specific cookies, such as those used for authentication or refresh tokens, to ensure a clean logout. Provide an array of cookie names to be deleted.
• Example:

enable_csrf

• Type: Boolean
• Default: false
• Description: Enables or disables CSRF protection for the logout endpoint. When set to true, the bundle requires a valid CSRF token (based on csrf_parameter and csrf_token_id) to process the logout request, enhancing security against cross-site request forgery attacks.
• Example:

invalidate_session

• Type: Boolean
• Default: true
• Description: Determines whether the user’s session should be invalidated during logout. When set to true, the session is destroyed, ensuring that any session-based data is cleared. Set to false if you want to preserve the session for specific use cases.
• Example:

path

• Type: String
• Default: /logout
• Description: Defines the URL path for the logout endpoint. This is the route that handles logout requests. You can customize it to match your application’s routing structure.
• Example:

target

• Type: String
• Default: /
• Description: Specifies the URL to redirect to after a successful logout. This can be a relative path, an absolute URL, or a named route. Use this to direct users to a specific page, such as a login page or homepage, after logging out.
• Example:

Example Configuration

Here’s an example of a complete logout configuration in config/packages/gesdinet_jwt_refresh_token.yaml:

Notes

• Ensure that the logout configuration is placed under the gesdinet_jwt_refresh_token key in your configuration file.
• If you enable CSRF protection (enable_csrf: true), make sure to include the CSRF token in your logout requests, typically via a form field or a query parameter matching the csrf_parameter.
• The clear_site_data and delete_cookies options are particularly useful for ensuring a clean logout in single-page applications (SPAs) or when using HTTP-only cookies for refresh tokens.
• Always test your logout configuration in a development environment to ensure it behaves as expected, especially when customizing CSRF or session settings.

For additional details on configuring the JWTRefreshTokenBundle, refer to the main documentation or other sections of this repository.