Part-2 A Demo On JWT Access Token And Refresh Token Authentication In .NET6 Web...
source link: https://www.learmoreseekmore.com/2022/06/part2-demo-on-jwt-access-token-and-refresh-token-authentication-in-dotnet6-webapi.html
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.
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.
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:
- 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 Refresh Token:
- 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.
Now let's create a private method to save the newly created Refresh Token value per user into the 'RefreshToken' table.
- 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.
Now let's update the 'TokenDto.cs' entity.
- 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'.
Update the 'GetAuthtokens()' method in the 'AccountService'.
- 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
Step 1:
Step 2:
Usage Of Refresh Token:
- 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'.
Task<TokenDto> RenewTokens(RefreshTokenDto refreshToken);
Let's implement the 'RenewTokens' method into the 'AccountService'.
- 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;
- 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.
Let's add the new endpoint for regenerating tokens.
- [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:
Step2:
Support Me!
Buy Me A Coffee
PayPal Me
Wrapping Up:
Hopefully, I think this article delivered some useful information on generating JWT tokens in .NET6 Web API. I love to have your feedback, suggestions, and better techniques in the comment section below.
Recommend
About Joyk
Aggregate valuable and interesting links.
Joyk means Joy of geeK