Skip to main content

Part-1 Ionic Angular JWT(JSON Web Token) Authentication(Access Token Implementation)

In this article, we are going to understand the implementation steps on Jwt authentication in Ionic5 angular application. Here we mainly concentrate on authenticated user access token.

What is JSON Web Token?:

JSON Web Token is a digitally signed and secured token for user validation. The jwt is constructed with 3 informative parts:
  • Header
  • Payload
  • Signature

Create A Sample Ionic Angular Application:

Let's begin our journey by creating a sample Ionic Angular application where we are going to implement our JWT authentication.
Command To Install Ionic CLI:
npm install -g @ionic/cli
Command To Create Ionic Tabs Structure APP:
ionic start your_application_name tabs
Command To Run Application:
ionic serve

Ionic Storage:

The access token on receiving to our Ionic application we need to store it to use it in a subsequent request, the ideal choice for it to use Ionic Storage.

Ionic storage provides an easy way to store key/value pairs and JSON objects. It has the capability of picking the storage medium based on the operating system application installed. For example, for native mobile its highest priority of storage will occur in SQLite, For a progressive web application, its preference will be given to IndexDB, WebSQL, LocalStorage, etc.
Command To Run Ionic Storage:
npm install --save @ionic/storage

Angular JWT Library:

The JWT token contains user payload, to decrypt the user info and use inside of our Ionic application we need to install an angular jwt library.
Command To Run Angular JWT Library:
npm install @auth0/angular-jwt

Create A Login Page:

Let's create a user login page, here instead of creating a file manually let's use the Ionic command to create a page that will create a separate module with routing file and with login page automatically.
Command To Create Login Page
ionic g page login
src/app/login/login.page.html:
<ion-header>
  <ion-toolbar>
    <ion-title>login</ion-title>
  </ion-toolbar>
</ion-header>

<ion-content>
  <ion-card>
    <ion-card-content>
      <div>
        <ion-label>Email/User Name</ion-label>
        <ion-input type="email" placeholder="Email/User Name" [(ngModel)]="loginForm.email"></ion-input>
      </div>
      <div>
        <ion-label>Password</ion-label>
        <ion-input type="password" placeholder="Password" [(ngModel)]="loginForm.password" ></ion-input>
      </div>
      <ion-button (click)="login()" expand="block">Login</ion-button>
    </ion-card-content>
  </ion-card>
</ion-content>
  • (Line: 12-16)Login form with email and password input fields and enabled model binding for them.
  • (Line: 18) Login button configures with form submission method.
src/app/login/login.page.ts:
import { Component, OnInit } from '@angular/core';

@Component({
  selector: 'app-login',
  templateUrl: './login.page.html',
  styleUrls: ['./login.page.scss'],
})
export class LoginPage implements OnInit {

  loginForm = {
    email:'',
    password:''
  };
  constructor() { }

  ngOnInit() {
  }
 
  login(){
    console.log('login clicked')
  }
}

Mock JWT Access Token:

As a front end developer no need to spend more time onto work on JWT authentication API (using nodejs, .net, java server programs). So let's use a sample JWT token by mocking it in a constant variable in our application, latter we will make a dynamic API call for fetching the Jwt token at the end section of this article.
A sample jwt token:
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6IlRlc3QiLCJzdWIiOjIsImlhdCI6MTYwNDMwOTc0OSwiZXhwIjoxNjA0MzA5ODA5fQ.jHez9kegJ7GT1AO5A2fQp6Dg9A6PBmeiDW1YPaCQoYs

Create AuthService:

Now let's create an AuthService file, which contains all login/logout API calls of our application.

let's add the AuthService file with basic configuration variables to store info like 'user information', 'JwtHelper service', etc.
src/app/service/auth.service.ts:
import { Injectable } from "@angular/core";
import { BehaviorSubject, Observable, from, of, throwError } from "rxjs";
import { map } from "rxjs/operators";
import { JwtHelperService } from "@auth0/angular-jwt";
import {Storage} from '@ionic/storage';

@Injectable({
  providedIn: "root",
})
export class AuthService {
  userInfo = new BehaviorSubject(null);
  jwtHelper = new JwtHelperService();
  constructor(
    private readonly storage:Storage
  ) {}
}
  • (Line: 11) Initialize 'BehaviourSubject' to store the decrypted user information from the access token.
  • (Line: 12) Initialize 'JwtHelperService' from '@autho/angular-jwt' library.
  • (Line: 14) Injected Ionic storage from the '@ionic/storage' library.
Now let's implement a login logic using the mock jwt access toke(later part of the article we will use jwt API).
src/app/services/auth.service.ts:
useLogin(login: any): Observable<boolean> {
 if (login && login.email && login.password) {
  var sampleJwt =
	"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6IlRlc3QiLCJzdWIiOjIsImlhdCI6MTYwNDMwOTc0OSwiZXhwIjoxNjA0MzA5ODA5fQ.jHez9kegJ7GT1AO5A2fQp6Dg9A6PBmeiDW1YPaCQoYs";

  return of(sampleJwt).pipe(
	map((token) => {
	  if (!token) {
		return false;
	  }
	  this.storage.set('access_token',token);
	  var decodedUser = this.jwtHelper.decodeToken(token);
	  this.userInfo.next(decodedUser);
	  console.log(decodedUser);
	  return true;
	})
  );
 }
 return of(false);
}
  • (Line: 3) Assigned mock jwt token to a variable.
  • The reason here we used 'of' rxjs operator to return normal values as observable outputs. When we change this method to a normal API call then the signature of the method and structure don't need more changes that is the reason for mock logic we are using rxjs observable operators.
  • (Line: 11) Using Ionic storage service saving the access token.
  • (Line: 12) Decrypting the access token payload to fetch the user information.
  • (Line: 13)User information adding to BehaviourSubject observable.
Now in the login.module.ts file add the 'AuthService' reference into the provider's array.
src/app/login/login.module.ts:
import { AuthService } from '../services/auth.service';
// code hidden for display purpose
@NgModule({
  providers:[AuthService]
})
export class LoginPageModule {
 
}
Now consume the 'AuthService Method' into our Login page.
src/app/login/login.page.ts:
import { Component, OnInit } from '@angular/core';

import {AuthService} from '../services/auth.service';

@Component({
  selector: 'app-login',
  templateUrl: './login.page.html',
  styleUrls: ['./login.page.scss'],
})
export class LoginPage implements OnInit {

  loginForm = {
    email:'',
    password:''
  };
  constructor(private authService:AuthService) { }

  ngOnInit() {
  }
 
  login(){
     this.authService.useLogin(this.loginForm)
     .subscribe(value => {
       if(value){
         alert('login success');
       }
       else{
         alert('login fails')
       }
     },error => {
       alert('login fails')
     })
  }
}
Now run the application and login with any fake credentials as below.


Create User Dashboard Page:

Let's create the 'Dashboard' page where we navigate the user after logging in.
Command To Create Dashboard Page
ionic g page dashboard
Now fetch 'username' into the 'dashboard.page.ts' file
src/app/dashboard/dashboard.page.ts:
import { Component, OnInit } from '@angular/core';
import { AuthService } from '../services/auth.service';

@Component({
  selector: 'app-dashboard',
  templateUrl: './dashboard.page.html',
  styleUrls: ['./dashboard.page.scss'],
})
export class DashboardPage implements OnInit {

  userName = ''
  constructor(private authService:AuthService) { }

  ngOnInit() {
    this.authService.userInfo.subscribe(user => {
      alert(user)
      if(user){
        this.userName = user.username;
      }
    })
  }
}
  • Uses AuthService to fetch user information.
src/app/dashboard/dashboard.page.html:
<ion-header>
  <ion-toolbar>
    <ion-title>{{userName}} - Dashboard</ion-title>
  </ion-toolbar>
</ion-header>

<ion-content>
<h1>Welcome!</h1>
</ion-content>
We have to share info in the AuthService file in the entire application. So in the previous step, we have added AuthService in LoginModule providers array, now please remove that reference from there. Now we configure AuthService globally adding into the AppModule file.
src/app/app.module.ts:
import { NgModule } from "@angular/core";

import {AuthService} from './services/auth.service';
// code hidden for display purpose
@NgModule({
  providers: [
    AuthService
  ]
})
export class AppModule {}

Create Route Guard:

Now we need to protect our routes using the angular guards like user not logged in then only show login page and if the user logged in then we can show the dashboard page.

Now in the 'AuthService' file, we have a behavior subject variable that stores the user information. We can think to use this variable to check the user in the guard, this works fine when the user is actively or continuously using our application. For suppose if the user logged in and closes the application and then opens after some time, in that case, this behaviour subject variable will be empty, so in this case, the user will see login page again despite he is a logged-in user.

So to solve this problem need to check the user info in the constructor of the 'AuthService' file. The guards also expect returns boolean of observable, so we will also create a new observable variable in the AuthSevice.
src/app/auth/auth.service.ts:
import { Injectable } from "@angular/core";
import { BehaviorSubject, Observable, from, of, throwError } from "rxjs";
import { map, switchMap } from "rxjs/operators";
import { JwtHelperService } from "@auth0/angular-jwt";
import {Storage} from '@ionic/storage';
import { Platform } from '@ionic/angular';

@Injectable({
  providedIn: "root",
})
export class AuthService {
  userInfo = new BehaviorSubject(null);
  jwtHelper = new JwtHelperService();
  checkUserObs:Observable<any>;
  constructor(
    private readonly storage:Storage,
    private readonly platform:Platform
  ) {
    this.loadUserInfo();
  }

  loadUserInfo() {
    let readyPlatformObs = from(this.platform.ready());

    this.checkUserObs = readyPlatformObs.pipe(
      switchMap(() => {
          return from(this.getAccessToke());
      }),
      map((token) => {
        if(!token){
          return null;
        }
          var decodedUser = this.jwtHelper.decodeToken(token);
          this.userInfo.next(decodedUser);
          return true;
      }));
    
  }

  getAccessToke(){
    return this.storage.get("access_token");
  }
  
  // code hidden for display purpose
}
  • (Line: 14) The 'checkUserObs' variable is the observable type, this variable will be used by the guard(will create in next steps) for protected routes.
  • (Line: 17) Injected the 'Platform' from '@ionic/angular'.
  • (Line: 19) In the constructor invoking 'loadUserInfo()'
  • (Line: 23) The 'ready()' method from the 'Platform' instance to check the application is in a ready state based on the device which helps to check accuracy.
  • (Line: 27) Fetching the token from the storage.
src/app/guards/auth.guards.ts:
import { Injectable } from "@angular/core";
import {
  CanActivate,
  ActivatedRouteSnapshot,
  RouterStateSnapshot,
  UrlTree,
  Router,
} from "@angular/router";
import { Observable } from "rxjs";
import { AuthService } from "../services/auth.service";
import { take, map } from "rxjs/operators";

@Injectable({
  providedIn: "root",
})
export class AuthGuard implements CanActivate {
  constructor(private authService: AuthService, private router: Router) {}
  canActivate(
    next: ActivatedRouteSnapshot,
    state: RouterStateSnapshot
  ):
    | Observable<boolean | UrlTree>
    | Promise<boolean | UrlTree>
    | boolean
    | UrlTree {
    return this.authService.checkUserObs.pipe(
      take(1),
      map((user) => {
        if (!user) {
          if (state.url.indexOf("login") != -1) {
            return true;
          } else {
            this.router.navigateByUrl("/login");
            return false;
          }
        } else {
          if(state.url.indexOf("login") != -1){
            this.router.navigateByUrl("/dashboard");
            return false;
          }else{
             return true;
          }
        }
      })
    );
  }
}
  • If the 'checkUserObs' observable value returns true means the user is logged-in, in that case, if the user tries to access the 'login' URL then we redirect to the dashboard route. If the 'chekUserObs' returns value false then the user can only see a login page.
Now configure our AuthGuard in AppModule as below.
src/app/app.module.ts:
import { AuthGuard } from './guards/auth.guard';

const routes: Routes = [
  {
    path: '',
    loadChildren: () => import('./tabs/tabs.module').then(m => m.TabsPageModule)
  },
  {
    path: 'login',
    loadChildren: () => import('./login/login.module').then( m => m.LoginPageModule),
    canActivate:[AuthGuard]
  },
  {
    path: 'dashboard',
    loadChildren: () => import('./dashboard/dashboard.module').then( m => m.DashboardPageModule),
    canActivate:[AuthGuard]
  }
];

Nestjs(Node.js) Jwt API:

Command To Install NestJS CLI:
npm i -g @nestjs/cli
Next, go to the root folder of the repo and run the command to install all the package
Command To Install ALL Packages In our Repository application:
npm install
That's all we have set up a JWT API in our local system for testing, now run the following command to start the application.
Command To Start NestJS APP:
npm run start:dev
Our jwt token endpoint
Url:- http://localhost:3000/auth/login
Payload:-
{
	"username":"test",
	"password":"1234"
}

note:- payload should be same as above, variable name 'username' and 'password'
don't change them, they are even case sensitive. credentials also use as above

Use Authentication Endpoint In AuthService:

First import 'HttpClientModule' into the AppModule before the routing module.
src/app/app.module.ts:
import {HttpClientModule} from '@angular/common/http';
// code hidden for display purpose
@NgModule({
  imports: [BrowserModule, 
    HttpClientModule,

    IonicModule.forRoot(), 
    AppRoutingModule,
    IonicStorageModule.forRoot()
  ],
})
export class AppModule {}
  • The 'HttpClientModule' must declare above the 'AppRoutingModule'.
Now inject the'HttpClient' instance from '@angular/common/http' into the AuthService file, then update the 'userLogin()' method to use jwt API.
src/app/services/auth.service.ts:
useLogin(login: any): Observable<boolean> {
if(login && login.email && login.password){
  var payload={
	username:login.email,
	password:login.password
  };
  return this.http.post("http://localhost:3000/auth/login",payload).pipe(
	map((response:any)=>{
	  console.log(response);
	  this.storage.set('access_token',response.access_token);
	  var decodedUser = this.jwtHelper.decodeToken(response.access_token);
	  this.userInfo.next(decodedUser);
	  console.log(decodedUser);
	  return true;
	})
  )
}

return of(false);
}
  • Here mocked jwt token replaced with jwt endpoint API
That's all about the steps to implement the Jwt authentication in Ionic5 angular application. In the next article, we implement the steps to use the refresh token.

Support Me!
Buy Me A Coffee PayPal Me

Wrapping Up:

Hopefully, I think this article delivered some useful information on the JWT authentication in Ionic5 angular application. I love to have your feedback, suggestions, and better techniques in the comment section below.

Refer:

Follow Me:

Comments

  1. Thanks for share, You really help me.

    ReplyDelete
  2. I am getting Database not created. Must call create() first for login.page.ts in chrome console logs and unable to login "login fails"

    ReplyDelete
    Replies
    1. i don't know this is the best option, but when i put this.storage.create(); before this.storage.set('access_token', token); in auth.service.ts, the error was gone

      Delete
  3. Thank you for the tutorial, and forget about the above issue I have solved it.
    can you please let me know how to send user id in return this.http.get("http://localhost:3000/todos"+userid);

    ReplyDelete
  4. I'm getting "database not created" too, to solve this put ´´´this.storage.create()´´´ in AuthService constructor and works fine, but I don't know if this solution is the correct

    ReplyDelete
  5. if you guys have some error while using @ionic/storage. try to use import { Storage } from '@ionic/storage-angular'; and before use it, istall npm install @ionic/storage-angular
    see documentation about this change for angular ionic use https://github.com/ionic-team/ionic-storage

    ReplyDelete
  6. I dont see the form to login at the begining

    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

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

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

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

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

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

Different HttpClient Techniques To Consume API Calls In Minimal API[.NET6]

In this article, we are going to implement different HttpClient techniques to consume API calls in minimal API. The different HttpClient techniques that we are going to explore are like: Register HttpClient Object Explicitly In DI(Dependency Injection Service) Named Client Type Client HttpRequestMessage Object Create A .NET6 Minimal API Project: Let's create a .Net6 Minimal API sample project 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. CLI command For Minimal API Project dotnet new webapi -minimal -o Your_Project_Name Create A Third Party API Response Model: Here I'm going to use a free third-party rest API that is "https://jsonplaceholder.typicode.com/posts". So to receive the response let's create a response model like 'Post.cs'. Program.cs:(Add Post.cs c

.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