Skip to main content

Dotnet Core MVC Cookie Login Sample Role-based Authorization (Part 2)

Introduction:


Authorization means an authenticated user having permission to access specific protected resources. In general, Authorization can be called special permissions. For example in an application, an admin user has all permission to modify the application, a non-admin user might have permission likes read-only content in the application.
In the first article, we have discussed the Cookie-Based login mechanism. This will be a continuation article, here we discuss Authorization.
Note: Before reading this article, read Dotnet Core Cookie Login Sample (Part 1).

Pages Controller:

Now add a new controller name as 'PagesController.cs' and to this controller add 3-action methods to show 3 pages in the application.
PagesController.cs:
namespace CookieAuth.Web.Controllers
{
    [Route("pages")]
    public class PagesController : Controller
    {
        [Route("admin")]
        [HttpGet]
        public IActionResult Admin()
        {
            return View();
        }

        [Route("viewer")]
        [HttpGet]
        public IActionResult Viewer()
        {
            return View();
        }

        [Route("guest")]
        [HttpGet]
        public IActionResult Guest()
        {
            return View();
        }
    }
}
In 'view' folder, add 'Pages' folder in that add 'admin.cshtml', 'viewer.cshtml' and 'guest.cshtml'.

Update Menu With New Page Links:

In '_Layout.cshtml' page update the menu links with new 'PagesController' action method routes

Now run the application and see the menu looks as below

Add Authorization Filter:

Now add Authorization attribute filter to "admin" and "view" action methods in 'PagesController'
Now run the application and try to access either admin or viewer page, we are automatically redirecting to the login page. Because simple authorization attribute checks for a user is authenticated or not. If the user did not authenticate the authorization filter blocks the user from accessing resources.
Once the user authenticated, the user can able access both "admin" and "viewer" pages. Now based on User Roles we are going to restrict like admin users can access all the pages, viewer users can access viewer page but not admin pages. We do this by using ASP.NET Core Role-based authorization.

Update Roles Table:

Now add few user roles like 'admin', 'viewer' into the roles table

Update UserRole Table:

Now map the User and Roles tables by inserting their Id's into the UserRole Table

Role-based Authorization:

ASP.NET Core has provided a rich variety of ways to implement Authorization like 'Role-based Authorization', 'Claims-based Authorization', 'Policy-based Authorization', etc. We are going to use Role-based Authorization in this sample. An authenticated user to access or deny a protected resource based on his roles and permissions that can be configured with Role-based Authorization in ASP.NET Core. 

Update Login Action To Add Roles Into Login Cookie:

Now we need to get the user roles and add them as claims to the ASP.NET Sign-In Context.
Now update the 'Login' action method 'AccountController' as below.

[Route("login")]
[HttpPost]
public async Task<IActionResult> Login(LoginViewModel viewModel)
{
 if (ModelState.IsValid)
 {
  // note : real time we save password with encryption into the database
  // so to check that viewModel.Password also need to encrypt with same algorithm 
  // and then that encrypted password value need compare with database password value
  Models.User user = _userContext.User.Where(_ => _.Email.ToLower() == viewModel.Email.ToLower() && _.Password == viewModel.Password).FirstOrDefault();
  if (user != null)
  {
   user.LastLoginTime = DateTime.Now;
   _userContext.SaveChanges();



   var claims = new List<Claim>
    {
     new Claim(ClaimTypes.Name, user.Email),
     new Claim("FirstName",user.FirstName),

    };
   var userRoles = _userContext.UserRole.Join(
        _userContext.Roles,
        ur => ur.RoleId,
        r => r.Id,
        (ur, r) => new
        {
         ur.RoleId,
         r.RoleName,
         ur.UserId
        }).Where(_ => _.UserId == user.Id).ToList();
   foreach (var ur in userRoles)
   {
    var roleClaim = new Claim(ClaimTypes.Role, ur.RoleName);
    claims.Add(roleClaim);
   }

   var claimsIdentity = new ClaimsIdentity(claims, CookieAuthenticationDefaults.AuthenticationScheme);
   var authProperties = new AuthenticationProperties() { IsPersistent = viewModel.IsPersistant };
   await HttpContext.SignInAsync(CookieAuthenticationDefaults.AuthenticationScheme, new ClaimsPrincipal(claimsIdentity), authProperties);
   return Redirect("/");
  }
  else
  {
   ModelState.AddModelError("InvalidCredentials", "Either username or password is not correct");
  }
 }
 return View(viewModel);
}
. Linq to Join UseRole and Role table and finally filter the data by current UserId in UserRole table and get the collection of roles related to the user.
. Create 'Claim' instances for all the roles of the user. Overloaded Claim constructor expecting two parameters, one is a type (any name) but for adding roles to the claim we alway pass type name as 'System.Security.Claims.ClaimType.Role' and the second parameter, here we have to pass our role name.
Now we have successfully added our roles to login user context.

 Update Authorization Filters In PagesController:

To Role-based Authorization filter, we need to pass the role as an input parameter to the attributes.
                   [Authorize(Role="RoleName")]
If the resource needs to be accessed by multiple role users then role names are passed as a parameter but separate ','
                  [Authorize(Role="RoleNaem1, RoleName2")]
Update 'Admin' action method in 'PagesController':

[Route("admin")]
[HttpGet]
[Authorize(Roles = "Admin")]
public IActionResult Admin()
{
 return View();
}
Here this 'admin' page is only accessed by users having role 'Admin'.
Update 'Viewer' action method in 'PagesController'
[Route("viewer")]
[HttpGet]
[Authorize(Roles = "Admin, Viewer")]
public IActionResult Viewer()
{
 return View();
}
Here this 'viewer' page can be accessed by users having a role either 'Viewer' or 'Admin'.

Test Our Sample Application:

Now run the application, for testing purpose create 2 users and one user assign role 'admin' and another user assign 'viewer'. To do this mapping add the records into 'UserRole' table as shown in the image above steps

Now login to the application as 'Admin' role user:
Navigate to admin page "https://localhost:44318/pages/admin"
Now navigate to the viewer page "https://localhost:44318/pages/viewer"
This show our admin has the ability to access both the pages

Now logout of application, and log in as the user who is having 'Viewer' Role
Navigate to viewer page "https://localhost:44318/pages/viewer"
Now try to navigate to the admin page "https://localhost:44318/pages/admin"
If we observe we are redirected to URL 'access-denied' since we didn't create any 404 not found page it showing a general error. For you, production deployment creates 404 with that access denied URL.
It shows how Role-based Authorization works and it is very easy to understand and simple to implement.

Summary:

In Part 1 we implement Cookie-based Authentication, now we have implemented Role-based Authorization. By understanding this approach we can understand that ASP.NET Core has given a lot of flexibility to implement Authentication and Authorization very simple and easy way without any Login Library.
😊

Refer:

Comments

  1. Thanks for this excellent post. I got a question, once that the user is authenticated, is there an easy way to get his user roles from the HttpContext?

    ReplyDelete
  2. how do i display the role name of the logged in user in layout after login

    ReplyDelete
  3. hi . naveen, still my authorization is not working. [Athorize (Roles="Administrator")] and i am login in as john with role Administrator,, the error is this localhost page cant be found, no web page was found for the web address,,, the same error as above

    ReplyDelete
    Replies
    1. hi . naveen,I am using visual studio 2022,, .net 6, still my authorization is not working. [Athorize (Roles="Administrator")] and i am login in as john with role Administrator,, the error is this localhost page cant be found, no web page was found for the web address,,, the same error as above

      REPLY

      Delete

Post a Comment

Popular posts from this blog

Angular 14 Reactive Forms Example

In this article, we will explore the Angular(14) reactive forms with an example. Reactive Forms: Angular reactive forms support model-driven techniques to handle the form's input values. The reactive forms state is immutable, any form filed change creates a new state for the form. Reactive forms are built around observable streams, where form inputs and values are provided as streams of input values, which can be accessed synchronously. Some key notations that involve in reactive forms are like: FormControl - each input element in the form is 'FormControl'. The 'FormControl' tracks the value and validation status of form fields. FormGroup - Track the value and validate the state of the group of 'FormControl'. FormBuilder - Angular service which can be used to create the 'FormGroup' or FormControl instance quickly. Form Array - That can hold infinite form control, this helps to create dynamic forms. Create An Angular(14) Application: Let'

.NET 7 Web API CRUD Using Entity Framework Core

In this article, we are going to implement a sample .NET 7 Web API CRUD using the Entity Framework Core. Web API: Web API is a framework for building HTTP services that can be accessed from any client like browser, mobile devices, and desktop apps. In simple terminology API(Application Programming Interface) means an interface module that contains programming functions that can be requested via HTTP calls either to fetch or update 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 the REST full services. Install The SQL Server And SQL Management Studio: Let's install the SQL server on our l

ReactJS(v18) JWT Authentication Using HTTP Only Cookie

In this article, we will implement the ReactJS application authentication using the HTTP-only cookie. HTTP Only Cookie: In a SPA(Single Page Application) Authentication JWT token either can be stored in browser 'LocalStorage' or in 'Cookie'. Storing the 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 the authentication with HTTP-only JWT cookie then we no need to implement the 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 authenticate our client application with JWT HTTP-only cookie, I developed a NetJS(which is a node) Mock API. Check the GitHub link and read the document on G

.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

Angular 14 State Management CRUD Example With NgRx(14)

In this article, we are going to implement the Angular(14) state management CRUD example with NgRx(14) NgRx Store For State Management: In an angular application to share consistent data between multiple components, we use NgRx state management. Using NgRx state helps to avoid unwanted API calls, easy to maintain consistent data, etc. The main building blocks for the NgRx store are: Actions - NgRx actions represents event to trigger the reducers to save the data into the stores. Reducer - Reducer's pure function, which is used to create a new state on data change. Store - The store is the model or entity that holds the data. Selector - Selector to fetch the slices of data from the store to angular components. Effects - Effects deals with external network calls like API. The effect gets executed based the action performed Ngrx State Management flow: The angular component needs data for binding.  So angular component calls an action that is responsible for invoking the API call.  Aft

Angular 14 Crud Example

In this article, we will implement CRUD operation in the Angular 14 application. Angular: Angular is a framework that can be used to build a single-page application. Angular applications are built with components that make our code simple and clean. Angular components compose of 3 files like TypeScript File(*.ts), Html File(*.html), CSS File(*.cs) Components typescript file and HTML file support 2-way binding which means data flow is bi-directional Component typescript file listens for all HTML events from the HTML file. Create Angular(14) Application: Let's create an Angular(14) application to begin our sample. Make sure to install the Angular CLI tool into our local machine because it provides easy CLI commands to play with the angular application. Command To Install Angular CLI npm install -g @angular/cli Run the below command to create the angular application. Command To Create Angular Application ng new name_of_your_app Note: While creating the app, you will see a noti

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

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

ReactJS(v18) Authentication With JWT AccessToken And Refresh Token

In this article, we are going to do ReactJS(v18) application authentication using the JWT Access Token and Refresh Token. JSON Web Token(JWT): JSON Web Token is a digitally signed and secured token for user validation. The JWT is constructed with 3 important parts: Header Payload Signature Create ReactJS Application: Let's create a ReactJS application to accomplish our demo. npx create-react-app name-of-your-app Configure React Bootstrap Library: Let's install the React Bootstrap library npm install react-bootstrap bootstrap Now add the bootstrap CSS reference in 'index.js'. src/index.js: import 'bootstrap/dist/css/bootstrap.min.css' Create A React Component 'Layout': Let's add a React component like 'Layout' in 'components/shared' folders(new folders). src/components/shared/Layout.js: import Navbar from "react-bootstrap/Navbar"; import { Container } from "react-bootstrap"; import Nav from "react-boot

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