JWT Auth with Refresh Token using Spring Boot

This is a ready to use template code for implementing JWT based authentication with refresh token using Spring Boot.

Documentation and Usage

Authentication API

POST URI: localhost:8080/auth/authenticate

Access User Controller

GET URI: localhost:8080/user/

Access Admin Controller

GET URI: localhost:8080/admin/

Token Expired / Access Denied Example

GET URI: localhost:8080/admin/

Request New Token API

POST URI: localhost:8080/auth/refreshtoken

Refresh Token Expired Example

POST URI: localhost:8080/auth/refreshtoken

User Registration API

POST URI: localhost:8080/user/registerUser

Admin Registration API

Since admin registration is a admin privileged feature, we protected it via /admin/ mapping. So sending authentication header is required with this request.

POST URI: localhost:8080/admin/registerAdmin

Logout from server API

POST URI: localhost:8080/auth/logout

Migrate to MySQL

By default this module uses H2 database. To use MySQL edit the following configuration.

Open pom.xml and configure it as below:

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>
	<parent>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-parent</artifactId>
		<version>2.5.0</version>
		<relativePath/> <!-- lookup parent from repository -->
	</parent>
	<groupId>com.devrezaur</groupId>
	<artifactId>JWT-refresh-token-spring-boot</artifactId>
	<version>v-1.0 alpha</version>
	<name>JWT-refresh-token-spring-boot</name>
	<description>Ready to use implementation of JWT refresh token using Spring Boot</description>
	<properties>
		<java.version>15</java.version>
	</properties>
	<dependencies>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-data-jpa</artifactId>
		</dependency>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-security</artifactId>
		</dependency>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-web</artifactId>
		</dependency>
		<dependency>
			<groupId>io.jsonwebtoken</groupId>
			<artifactId>jjwt</artifactId>
			<version>0.9.1</version>
		</dependency>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-devtools</artifactId>
			<scope>runtime</scope>
			<optional>true</optional>
		</dependency>
		<dependency>
			<groupId>mysql</groupId>
			<artifactId>mysql-connector-java</artifactId>
		</dependency>
		<dependency>
			<groupId>com.fasterxml.jackson.module</groupId>
			<artifactId>jackson-module-kotlin</artifactId>
		</dependency>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-test</artifactId>
			<scope>test</scope>
		</dependency>
		<dependency>
			<groupId>org.springframework.security</groupId>
			<artifactId>spring-security-test</artifactId>
			<scope>test</scope>
		</dependency>
	</dependencies>

	<build>
		<plugins>
			<plugin>
				<groupId>org.springframework.boot</groupId>
				<artifactId>spring-boot-maven-plugin</artifactId>
			</plugin>
		</plugins>
	</build>

</project>

After that open src/main/resources/application.properties and configure like below:

server.port=8080
spring.jpa.open-in-view=false
spring.h2.console.enabled=true
spring.datasource.url=jdbc:mysql://localhost:3306/database_name
spring.datasource.username=username
spring.datasource.password=password
spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.MySQL8Dialect
spring.jpa.show-sql=true
spring.jpa.defer-datasource-initialization=true

# JWT secret key
jwt.secret=secret
# Access token lifespan (5 min)
jwt.jwtExp=300000
# Refresh token lifespan (24 hours)
jwt.refreshExp=86400000

Additional Configuration

src/main/resources/data.sql file is used to insert initial data to the database. This file is not mandatory. Feel free to modify/delete this data.sql file.

INSERT INTO roles
VALUES(1, 'ROLE_ADMIN');

INSERT INTO roles
VALUES(2, 'ROLE_USER');

INSERT INTO users (user_id, fullname, username, password)
VALUES('101', 'Rezaur Rahman', 'DevRezaur', 'iamadmin');

INSERT INTO users (user_id, fullname, username, password)
VALUES('102', 'Sanzida Sultana', 'SanzidaSultana', 'iamuser');

INSERT INTO user_role
VALUES('101', 1);

INSERT INTO user_role
VALUES('101', 2);

INSERT INTO user_role
VALUES('102', 2);

Run the Project

• Clone the repository
• Update maven build (Project > Maven > Update Project)
• Run (Project > Run As > Spring Boot App)

Relevant Projects

JWT Auth with Spring Boot (No Refresh Token)

Feel free to leave a star if you find this helpful 😄