Skip to main content

Part-2 VueJS JWT(JSON Web Token) Authentication(Refresh Token Implementation)

In the Part-1 we have learned steps to build a VueJS application authentication by using an access token(Jwt token). This is the continuation article, here we are going to understand the steps for implementing refresh token and using access token in the request header to call secured API.

NestJS(Nodejs) Todos API:

In Part-1 we discussed steps to set up the Nestjs API. In that API we have a secured endpoint called 'Todos'. In the next step, we are going to consume this 'Todo' API from our angular application.
http://localhost:3000/todos

Access Token Authorization To Access Secured Endpoint:

Now let's try to access the secured endpoint 'todos' mentioned above in our 'Dashboard' page.

Now for this todos, we are going to create another module file like 'todo.js'.
src/store/modules/todo.js:
import axios from 'axios';

const state = () => ({
  todos :[]
});

const getters = {
  getAlltodos(state){
   state.todos;
  }
};

const actions = {
  async getAllTodos({commit}){
	var response = await axios.get('http://localhost:3000/todos');
	if(response && response.data){
	  commit('setTodos', response.data);
	}
  }
};

const mutations = {
  setTodos(state, payload){
   state.todos = payload;
  }
};

export default{
  namespaced: true,
  state,
  getters,
  actions,
  mutations
}
  • (Line: 3-5) The 'state' object will store our 'todos' object.
  • (Line: 7-11) In 'getters' object defined a function 'getAllTodos' that return our collection of  'todos'.
  • (Line: 13-20) In 'actions' object defined 'getAllTodos' that will call our secured endpoint and save the response data using mutation object.
Let's register the todo.js module into the vuex store.
src/store/index.js:
import { createStore } from "vuex";
import authModule from './modules/auth';
import todoModule from './modules/todo';

const store = createStore({
    modules:{
        auth:authModule,
        todo: todoModule
    }
});
export default store;
Now update the 'Dashboard' page to trigger the 'actions' in the todo.js store module to invoke the API call.
src/components/Dashboard.vue:(Html Part)
<template>
  <div>
    <h1>Dashboard Page</h1>
    <div>UserName -- {{ gettersAuthData.userName }}</div>
    <div>Id -- {{ gettersAuthData.userId }}</div>
    <div>
        <h6>My Todos</h6>
        <button type="button" class="btn btn-primary" @click="show()">Show Todos</button>
        <ul>
            <li v-for="(t, index) in gettersAllTodos" :key="index">
                {{t}}
            </li>
        </ul>
    </div>
  </div>
</template>
  • (Line: 8) Create a button registered with the callback method 'show' which will invoke the todos API.
  • (Line: 10-12) Binding the todos data.
src/components/Dashboard.vue:(Script Part)
<script>
import { mapGetters, mapActions } from "vuex";
export default {
  computed: {
    ...mapGetters("todo",{
        gettersAllTodos:"getAlltodos"
    }),
    ...mapGetters("auth", {
      gettersAuthData: "getAuthData",
    }),
  },
  methods:{
      ...mapActions("todo",{
          actionsGetAllTodos:'getAllTodos'
      }),
      async show(){
          await this.actionsGetAllTodos();
      }
  }
};
</script>
  • (Line: 5-7) The 'mapGetters' registered for todo.js module getters were registered with 'getAlltodos' getter that returns all collection of  'todos'.
  • (Line: 16-18) The 'mapActions' registered for todos.js module actions. Here registered 'getAllTodos' action method that will trigger todos API endpoint.
Now let's try to access 'todos' endpoint without any authorization headers, we will receive a response as unauthorized as shown below.
Now to fix this issue we need to add our access token value as an authorization header. So to add the authorization request for the required secured endpoint we are going to create a custom Axios instance with interceptor configuration.
src/shared/jwtInterceptor.js:
import axios from "axios";
import store from '../store/index';

const jwtInterceptor = axios.create({});

jwtInterceptor.interceptors.request.use((config) => {
  const authData = store.getters["auth/getAuthData"];
  config.headers.common["Authorization"] = `bearer ${authData.token}`;
  return config;
});
export default jwtInterceptor;
  • (Line: 4) Creating an instance of Axios and assigned to variable 'jwtInterceptor'. Now, 'jwtInterceptor' works exactly as 'Axios'.
  • (Line: 6) Configuring interceptor for the 'jwtInterceptor' instance.
  • (Line: 7) Fetching token data from the store.
  • (Line: 8) Adding an authorization header. So if we make calls using 'jwtInterceptor' the authorization header will be added to the request.
Now in our todo.js module replace the instance of Axios with 'jwtInterceptor' instance.
src/store/modules/jwtInterceptor.js:
import jwtInterceptor  from '../../shared/jwtInterceptor';

const actions = {
    async getAllTodos({commit}){
        var response = await jwtInterceptor.get('http://localhost:3000/todos');
        if(response && response.data){
            commit('setTodos', response.data);
        }
    }
};
  • Since we are using our custom Axios instance that is 'jwtInterceptor', so for the request authorization header added automatically.

Refresh Token Flow:

  • Refresh Token is a random string key that will be created along with the JWT access token and return to the valid client on successful logging in.
  • Now for all subsequent requests will use the access token, but the access token is a short-lived token whereas the refresh token lives more time than the access token.
  • On the expiration of the access token, the user instead of authenticating himself again passing his user name and password, the user can send the refresh token.
  • The server on receiving a refresh token first validates against the storage(database, cache, etc).
  • For a valid refresh token server will create a new access token and refresh token(like when authenticate using user name and password) return it to the user.

Integrate Refresh Token Endpoint:

Now in our interceptor we need to update logic in such a way that if the access token expires then we need to invoke the refresh token endpoint after receiving new 'access' and 'refresh' tokens we need to update them in browser local storage and also need to restore our vuex state management after that we need to invoke our secured endpoint with a valid access token as its authorization header.
NestJS API Refresh Token Endpoint
URL:- http://localhost:3000/auth/refreshtoken
Payload:{
"access_token":"",
"refresh_token":""
}
Now let's update our interceptor to call the refresh token endpoint if our access token expires.
src/shared/jwtInterceptor.js:
import axios from "axios";
import store from '../store/index';

const jwtInterceptor = axios.create({});


jwtInterceptor.interceptors.request.use((config) => {
    const authData = store.getters["auth/getAuthData"];
    if (authData == null) {
      return config;
    }
  
    config.headers.common["Authorization"] = `bearer ${authData.token}`;
    return config;
  });
  
  jwtInterceptor.interceptors.response.use(
    (response) => {
      return response;
    },
    async (error) => {
      if (error.response.status === 401) {
        const authData = store.getters["auth/getAuthData"];
        const payload = {
          access_token: authData.token,
          refresh_token: authData.refreshToken,
        };
  
        var response = await axios.post(
          "http://localhost:3000/auth/refreshtoken",
          payload
        );
        await store.dispatch("auth/saveTokensToStorage", response.data);
        error.config.headers[
          "Authorization"
        ] = `bearer ${response.data.access_token}`;
        return axios(error.config);
      } else {
        return Promise.reject(error);
      }
    }
  );
  
  export default jwtInterceptor;

  • (Line: 7-15)In the interceptor request, we have implemented a code to add an authorization header to every request which will use this interceptor.
  • (Line: 17-42) Here we capture the response of each request. If the request is good we don't interrupt the flow. If the request has failed then we are implementing some of our application logic.
  • (Line: 22) Checking that the error response is 401(unauthorized) means either we haven't added any authorization header or our access token might have expired.
  • So on token expiration, we will invoke the refresh token endpoint. On receiving a successful response we will store new token data to browser local storage and update our vuex state token data. Using the new access token as an authorization header and reinvoke the failed request.
That's all about the steps for implementing the refresh token functionality.

Support Me!
Buy Me A Coffee PayPal Me

Wrapping Up:

Hopefully, I think this article delivered some useful information on refresh token implementation in VueJS 3.0 application. I love to have your feedback, suggestions, and better techniques in the comment section below.

Refer:

Follow Me:

Comments

  1. sir once access token expired, then if we refresh the page it going to login page,how can refresh token there,simply how can we use interceptor and refresh the token at page loading( i mean like in facebook, in facebook if we login and close browser after sometime ,and if we reopen the same page next day it will not take us to login page we are authenticated using refresh token. how can we implement this please add this too it will help us a lot, in this application it access token is expired and we refresh page it just going to login page but access token expired and if we click button in dashboard then refresh token works, please add refreshing token at page refresh too )

    ReplyDelete
    Replies
    1. Hi moses

      To resolve this issue we need to call refresh token endpoint in the router.js file in 'beforeach' method. Interceptor main goal to add authorization header, so here in this case no need to use interceptor you can use directly axios to invoke the refresh token endpoint.

      I have updated git repo for calling refresh token in router.js file check the link below
      https://github.com/Naveen512/VueJS3.0-JWT-Authentication/blob/master/src/appRouter.js

      Delete
    2. i don't know how to express my gratitude,it helped me a lot.god will always with you,thank you

      Delete
  2. hi sir i have one more doubt ,how can i add "Content-Type : application/json" and
    Accept : application/json" to the interceptor, please help me

    ReplyDelete
  3. thanks a lot
    it was a great help ♥

    ReplyDelete

  4. Because when the token expires it is showing 401 on the network and if I refresh it on the page to give the 401 to each request?

    ReplyDelete
  5. Hi, I cannot find saveTokensToStorage function in store.Please help

    ReplyDelete

Post a Comment

Popular posts from this blog

.NET6 Web API CRUD Operation With Entity Framework Core

In this article, we are going to do a small demo on AspNetCore 6 Web API CRUD operations. What Is Web API: Web API is a framework for building HTTP services that can be accessed from any client like browser, mobile devices, desktop apps. In simple terminology API(Application Programming Interface) means an interface module that contains a programming function that can be requested via HTTP calls to save or fetch the data for their respective clients. Some of the key characteristics of API: Supports HTTP verbs like 'GET', 'POST', 'PUT', 'DELETE', etc. Supports default responses like 'XML' and 'JSON'. Also can define custom responses. Supports self-hosting or individual hosting, so that all different kinds of apps can consume it. Authentication and Authorization are easy to implement. The ideal platform to build REST full services. Create A .NET6 Web API Application: Let's create a .Net6 Web API sample application to accomplish our

Blazor WebAssembly Custom Authentication From Scratch

In this article, we are going to explore and implement custom authentication from the scratch. In this sample, we will use JWT authentication for user authentication. Main Building Blocks Of Blazor WebAssembly Authentication: The core concepts of blazor webassembly authentication are: AuthenticationStateProvider Service AuthorizeView Component Task<AuthenticationState> Cascading Property CascadingAuthenticationState Component AuthorizeRouteView Component AuthenticationStateProvider Service - this provider holds the authentication information about the login user. The 'GetAuthenticationStateAsync()' method in the Authentication state provider returns user AuthenticationState. The 'NotifyAuthenticationStateChaged()' to notify the latest user information within the components which using this AuthenticationStateProvider. AuthorizeView Component - displays different content depending on the user authorization state. This component uses the AuthenticationStateProvider

How Response Caching Works In Asp.Net Core

What Is Response Caching?: Response Caching means storing of response output and using stored response until it's under it's the expiration time. Response Caching approach cuts down some requests to the server and also reduces some workload on the server. Response Caching Headers: Response Caching carried out by the few Http based headers information between client and server. Main Response Caching Headers are like below Cache-Control Pragma Vary Cache-Control Header: Cache-Control header is the main header type for the response caching. Cache-Control will be decorated with the following directives. public - this directive indicates any cache may store the response. private - this directive allows to store response with respect to a single user and can't be stored with shared cache stores. max-age - this directive represents a time to hold a response in the cache. no-cache - this directive represents no storing of response and always fetch the fr

A Small Guide On NestJS Queues

NestJS Application Queues helps to deal with application scaling and performance challenges. When To Use Queues?: API request that mostly involves in time taking operations like CPU bound operation, doing them synchronously which will result in thread blocking. So to avoid these issues, it is an appropriate way to make the CPU-bound operation separate background job.  In nestjs one of the best solutions for these kinds of tasks is to implement the Queues. For queueing mechanism in the nestjs application most recommended library is '@nestjs/bull'(Bull is nodejs queue library). The 'Bull' depends on Redis cache for data storage like a job. So in this queueing technique, we will create services like 'Producer' and 'Consumer'. The 'Producer' is used to push our jobs into the Redis stores. The consumer will read those jobs(eg: CPU Bound Operations) and process them. So by using this queues technique user requests processed very fastly because actually

Usage Of CancellationToken In Asp.Net Core Applications

When To Use CancellationToken?: In a web application request abortion or orphan, requests are quite common. On users disconnected by network interruption or navigating between multiple pages before proper response or closing of the browser, tabs make the request aborted or orphan. An orphan request can't deliver a response to the client, but it will execute all steps(like database calls, HTTP calls, etc) at the server. Complete execution of an orphan request at the server might not be a problem generally if at all requests need to work on time taking a job at the server in those cases might be nice to terminate the execution immediately. So CancellationToken can be used to terminate a request execution at the server immediately once the request is aborted or orphan. Here we are going to see some sample code snippets about implementing a CancellationToken for Entity FrameworkCore, Dapper ORM, and HttpClient calls in Asp.NetCore MVC application. Note: The sample codes I will show in

.Net5 Web API Managing Files Using Azure Blob Storage

In this article, we are going to understand the different file operations like uploading, reading, downloading, and deleting in .Net5 Web API application using Azure Blob Storage. Azure Blob Storage: Azure blob storage is Microsoft cloud storage. Blob storage can store a massive amount of file data as unstructured data. The unstructured data means not belong to any specific type, which means text or binary data. So something like images or pdf or videos to store in the cloud, then the most recommended is to use the blob store. The key component to creating azure blob storage resource: Storage Account:- A Storage account gives a unique namespace in Azure for all the data we will save. Every object that we store in Azure Storage has an address. The address is nothing but the unique name of our Storage Account name. The combination of the account name and the Azure Storage blob endpoint forms the base address for each object in our Storage account. For example, if our Storage Account is n

.Net5 Web API Redis Cache Using StackExchange.Redis.Extensions.AspNetCore Library

In this article, we are going to explore the integration of Redis cache in .Net5 Web API application using the 'StackExchange.Redis.Exntensions' library. Note:- Microsoft has introduced an 'IDistributedCache' interface in dotnet core which supports different cache stores like In-Memory, Redis, NCache, etc. It is simple and easy to work with  'IDistributedCache', for the Redis store with limited features but if we want more features of the Redis store we can choose to use 'StackExchange.Redis.Extensions'.  Click here for Redis Cache Integration Using IDistributedCache Interface . Overview On StackExchange.Redis.Extnesions Library: The 'StackExchange.Redis.Extension' library extended from the main library 'StackExchange.Redis'. Some of the key features of this library like: Default serialization and deserialization. Easy to save and fetch complex objects. Search key. Multiple Database Access Setup Redis Docker Instance: For this sampl

Part-1 Angular JWT Authentication Using HTTP Only Cookie[Angular V13]

In this article, we are going to implement a sample angular application authentication using HTTP only cookie that contains a JWT token. HTTP Only JWT Cookie: In a SPA(Single Page Application) Authentication JWT token either can be stored in browser 'LocalStorage' or in 'Cookie'. Storing JWT token inside of the cookie then the cookie should be HTTP Only. The HTTP-Only cookie nature is that it will be only accessible by the server application. Client apps like javascript-based apps can't access the HTTP-Only cookie. So if we use authentication with HTTP only JWT cookie then we no need to implement custom logic like adding authorization header or storing token data, etc at our client application. Because once the user authenticated cookie will be automatically sent to the server by the browser on every API call. Authentication API: To implement JWT cookie authentication we need to set up an API. For that, I had created a mock authentication API(Using the NestJS Se

Endpoint Routing In Asp.Net Core

How Routing Works In  Core 2.1 And Below Versions?: In Asp.Net Core routing is configured using app.UseRouter() or app.UseMvc() middleware. app.UseMvc(routes => { routes.MapRoute( name: "default", template: "{controller=Home}/{action=Index}/{id?}"); }); Here in Dotnet Core version 2.1 or below versions on the execution of route middleware request will be navigated appropriate controller matched to the route. An operation or functionality which is dependent on route URL or route values and that need to be implemented before the execution of route middleware can be done by accessing the route path from the current request context as below app.Use(async (context, next) => { if(context.Request.Path.Value.IndexOf("oldvehicle") != -1) { context.Response.Redirect("vehicle"); } else { await next(); } }); app.UseMvc(routes => { routes.MapRoute( name: "vehicleRoute", template: "vehicle", defaul

Unit Testing Asp.NetCore Web API Using xUnit[.NET6]

In this article, we are going to write test cases to an Asp.NetCore Web API(.NET6) application using the xUnit. xUnit For .NET: The xUnit for .Net is a free, open-source, community-focused unit testing tool for .NET applications. By default .Net also provides a xUnit project template to implement test cases. Unit test cases build upon the 'AAA' formula that means 'Arrange', 'Act' and 'Assert' Arrange - Declaring variables, objects, instantiating mocks, etc. Act - Calling or invoking the method that needs to be tested. Assert - The assert ensures that code behaves as expected means yielding expected output. Create An API And Unit Test Projects: Let's create a .Net6 Web API and xUnit sample applications to accomplish our demo. We can use either Visual Studio 2022 or Visual Studio Code(using .NET CLI commands) to create any.Net6 application. For this demo, I'm using the 'Visual Studio Code'(using the .NET CLI command) editor. Create a fo