In this article, we will learn the generation and usage of the refresh token in .NET6 Web API application.
Click here to understand the implementation of the JWT token in .NET6 Web API.
Click here to understand the implementation of the JWT token in .NET6 Web API.
Refresh Token:
When the JWT access token expires to renew it without user credentials we will use the Refresh Token.
Let's understand the flow of Refresh Token.
Let's understand the flow of Refresh Token.
- The user sends valid 'User Name' and 'Password' to the server, then the server will generate JWT Access Token and Refresh Token sent as a response
- The JWT Access Token is a short live token(eg 20 minutes) and Refresh Token is a long live token(eg: 7 days)
- Now client application sends a JWT access token in the request header that makes the user authenticated.
- If the JWT token expires then the server returns 401 unauthorized responses.
- Then the client sends the refresh token to the server to regenerate the JWT Access token. The server validates the refresh token and returns a new JWT Access Token and a new Refresh Token as a response.
RefreshToken Table SQL Script:
In general Refresh, Token value will be saved into the database. Users can logged-in from multiple devices then we shall have the respective token values so let's create a 'RefreshToken' table. In the 'RefreshToken' table a single user can have multiple tokens based on their authentication from the device.
Note: To remove the expired Refresh Tokens it is advised to run a separate background job so that our table contains only active tokens.
Run the below script to create the 'RefreshToken' table.
CREATE TABLE RefreshToken( [Id] [int] IDENTITY(1,1) NOT NULL, [UserId] [int] NOT NULL, [Token] [varchar](1000) NOT NULL, [ExpirationDate] [datetime] NOT NULL, CONSTRAINT [PK_RefreshToken] PRIMARY KEY CLUSTERED ( [Id] ASC )WITH (PAD_INDEX = OFF, STATISTICS_NORECOMPUTE = OFF, IGNORE_DUP_KEY = OFF, ALLOW_ROW_LOCKS = ON, ALLOW_PAGE_LOCKS = ON) ON [PRIMARY] ) ON [PRIMARY]
Create RefreshToken Table Entity And Update DbConte:
Let's create a new class that represents our 'RefreshToken' table.
Data/Entities:
namespace Dot6.Jwt.API.Data.Entities; public class RefreshToken { public int Id { get; set; } public int UserId { get; set; } public string Token { get; set; } public DateTime ExpirationDate { get; set; } }Now register the 'RefreshToken' into our database context class.
Data/MyAuthContext.cs:
Step 2:
Step2:
using Dot6.Jwt.API.Data.Entities; using Microsoft.EntityFrameworkCore; namespace Dot6.Jwt.API.Data; public class MyAuthContext : DbContext { public MyAuthContext(DbContextOptions<MyAuthContext> context) : base(context) { } public DbSet<User> User { get; set; } public DbSet<RefreshToken> RefreshToken { get; set; } }
Create Refresh Token:
Along with JWT Access Token, we also need to generate the Refresh Token whereas the refresh token needs to save into the 'RefreshToken' table.
Let's create a private method in the 'AccountService.cs' file for generating the unique refresh token.
Services/AccountService.cs:
private string CreateRefreshToken() { var tokenBytes = RandomNumberGenerator.GetBytes(64); var refreshtoken = Convert.ToBase64String(tokenBytes); var tokenIsInUser = _myAuthContext.RefreshToken .Any(_ => _.Token == refreshtoken); if (tokenIsInUser) { return CreateRefreshToken(); } return refreshtoken; }
- (Line: 3&4) Creating the Refresh Token value using the 'RandNumberGenerator'.
- (Line: 6&7) Cross-check if the newly created refresh token was already in 'RefreshToken'.
- (Line: 9-12) If the Refresh token already exists in the database then we are going to execute our method(CreateRefreshToken) again.
- (Line: 13) Returns unique newly created Refresh Token.
Services/AccountService.cs:
private async Task InsertRefreshToken(int userId, string refreshtoken) { var newRefreshToken = new RefreshToken { UserId = userId, Token = refreshtoken, ExpirationDate = DateTime.Now.AddDays(7) }; _myAuthContext.RefreshToken.Add(newRefreshToken); await _myAuthContext.SaveChangesAsync(); }
- Here save 'UserId', 'RefreshToken', 'Refresh Token Expiration Date' into the 'RefreshToken' table.
Dtos/TokenDto.cs:
namespace Dot6.Jwt.API.Dtos; public class TokenDto { public string AccessToken { get; set; } public string RefreshToken { get; set; } }
- (Line: 6) Added new property like 'RefreshToken'.
Services/AccountService.cs:
public async Task<TokenDto> GetAuthTokens(LoginDto login) { User user = await _myAuthContext.User .Where(_ => _.Email.ToLower() == login.Email.ToLower() && _.Password == login.Password).FirstOrDefaultAsync(); if (user != null) { var accessToken = CreateJwtToken(user); var refreshToken = CreateRefreshToken(); await InsertRefreshToken(user.Id, refreshToken); return new TokenDto { AccessToken = accessToken, RefreshToken = refreshToken }; } return null; }
- (Line: 10-17) Here along with JWT Access Token, also generating Refresh Token and return in the response
Usage Of Refresh Token:
On JWT Access Token expiration we can use the Refresh Token to renew the JWT Access Token.
Let's create a payload entity like 'RefreshTokenDto.cs'.
Dtos/RefreshTokenDto.cs:
namespace Dot6.Jwt.API.Dtos; public class RefreshTokenDto { public string Token { get; set; } }Let's define the method definition to renew the JWT Access token in the 'IAccountService.cs'.
Services/IAccountService.cs:
Task<TokenDto> RenewTokens(RefreshTokenDto refreshToken);Let's implement the 'RenewTokens' method into the 'AccountService'.
Services/AccountService.cs:
public async Task<TokenDto> RenewTokens(RefreshTokenDto refreshToken) { var userRefreshToken = await _myAuthContext.RefreshToken .Where(_ => _.Token == refreshToken.Token && _.ExpirationDate >= DateTime.Now).FirstOrDefaultAsync(); if (userRefreshToken == null) { return null; } var user = await _myAuthContext.User .Where(_ => _.Id == userRefreshToken.UserId).FirstOrDefaultAsync(); var newJwtToken = CreateJwtToken(user); var newRefreshToken = CreateRefreshToken(); userRefreshToken.Token = newRefreshToken; userRefreshToken.ExpirationDate = DateTime.Now.AddDays(7); await _myAuthContext.SaveChangesAsync(); return new TokenDto { AccessToken = newJwtToken, RefreshToken = newRefreshToken }; }
- (Line: 3-5) Fetching record from the 'RefreshToken' table.
- (Line: 7-10) Return empty response if refresh token is not found in the 'RefreshToken' table
- (Line: 12&13) Fetching the user information from the 'User' table.
- (Line: 17&18) Creating new JWT Access Token and Refresh Token.
- (Line: 20-22) Refresh token need to be used only once, the next new refresh token need to be generated along with the JWT access token. So we have to update our 'RefreshToken' table with the newly generated refresh token value.
- (Line: 24-28) Returns newly created token as a response.
Controllers/AccountController.cs:
[HttpPost] [Route("renew-tokens")] public async Task<IActionResult> RenewTokens(RefreshTokenDto refreshToken) { var tokens = await _accountService.RenewTokens(refreshToken); if (tokens == null) { return ValidationProblem("Invalid Refresh Token"); } return Ok(tokens); }Step 1:
Support Me!
Buy Me A Coffee
PayPal Me
Hi,
ReplyDeletethank you for the article.
I believe in method RenewTokens, you need to add the 7 days to the expiration date on this line:
userRefreshToken.ExpirationDate = DateTime.Now;
Cheers
I think you are missing an important part!
ReplyDeleteThe part missing is how will the RenewTokens' method be called?
This RenewTokens method needs to be called in a systematical way like with every http request made to the web api or via a background service that is calling the RenewTokens method every n minute.