Skip to main content

Authorization In Blazor WebAssembly

In this article, we are going to understand the authorization flow using user roles and claims in the blazor webassembly application.

Create A Sample Blazor WebAssembly Application:

Let's create a sample blazor webassembly application for our demo. We can use any IDE for the application development but the most recommended is Visual Studio 2019(version 16.8.*) and Visual Studio Code.

Authentication Setup:

To implement authorization first user need to be authenticated. So here we will implement some fake user authentication with some roles and claims. For complete authentication, implementation checks my blogs like Access Token and Refresh Token.
Package Manager
Install-Package Microsoft.AspNetCore.Components.Authorization -Version 5.0.1
.Net CLI
dotnet add package Microsoft.AspNetCore.Components.Authorization --Version 5.0.1
A core component of blazor authentication is 'Microsoft.AspNetCore.Components.Authorization.AuthenticationStateProvider', here we going to implement it by customizing it.
Auth/CustomAuthStateProvider.cs:
using System.Security.Claims;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Components.Authorization;

namespace BW.Auth.Auth
{
  public class CustomAuthStateProvider : AuthenticationStateProvider
  {
   public override async Task<AuthenticationState> GetAuthenticationStateAsync()
   {
	var identity = new ClaimsIdentity(new []{
	 new Claim(ClaimTypes.Name,"Naveen"),
	 new Claim(ClaimTypes.Role, "user"),
	 new Claim(ClaimTypes.Role, "admin")
	},"Fake Auth");

	var user = new ClaimsPrincipal(identity);
	return await Task.FromResult(new AuthenticationState(user));
   }
  }
}
  • Here we added roles like 'user' and 'admin' to my authentication.
Now let's import required namespaces into the _Import.razor file.
_Import.razor:
@using BW.Auth.Shared
@using Microsoft.AspNetCore.Components.Authorization
@using Microsoft.AspNetCore.Authorization
Now register the required service in Program.cs file
Program.cs:
builder.Services.AddScoped<AuthenticationStateProvider,CustomAuthStateProvider>();
builder.Services.AddOptions();
builder.Services.AddAuthorizationCore();
Now add the 'CascadingAuthenticationState' and 'AuthorizeRouteView' components in the App.razor file.
App.razor:
<CascadingAuthenticationState>
<Router AppAssembly="@typeof(Program).Assembly">
  <Found Context="routeData">
	<AuthorizeRouteView RouteData="@routeData" DefaultLayout="@typeof(MainLayout)" />
  </Found>
  <NotFound>
	<LayoutView Layout="@typeof(MainLayout)">
		<p>Sorry, there's nothing at this address.</p>
	</LayoutView>
  </NotFound>
</Router>
</CascadingAuthenticationState>

Roles Authorization On AuthorizeView Component:

The AuthorizeView component supports roles based authorization base on the role we can render the content inside of it.
Index.razor:
@page "/"

<AuthorizeView Roles="superadmin">
    <Authorized >
        <div>Hi @(context.User.Identity.Name), hurray you have 'super admin' role, you can claim this offer</div>
    </Authorized>
</AuthorizeView>
<AuthorizeView Roles="admin">
    <Authorized >
        <div>Hi @(context.User.Identity.Name), hurray you have 'admin' role, you can claim this offer</div>
    </Authorized>
</AuthorizeView>
<AuthorizeView Roles="user">
     <Authorized>
        <div>Hi @(context.User.Identity.Name), hurray you have 'user' role ,Claim your user offers  </div>
    </Authorized>
</AuthorizeView>
Here we rendered 3 AuthorizeView components with respective roles to them. For my fake authentication, I have only roles like 'admin' and 'user'. So if run the application for me content inside of the 'superadmin' will not render.

We can also configure multiple roles on the AuthorizeView component with comma separation. So in this process, if we have at least one role then AuthorizeView renders.
Index.razor:
@page "/"

<AuthorizeView Roles="superadmin, admin">
    <Authorized >
        <div>Hi @(context.User.Identity.Name), this offer can claim by users with role either 'superadmin' or'admin'
        </div>
    </Authorized>
</AuthorizeView>
  • Here we configure multiple roles with comma separation, so to render this AuthorizeView component user should have at least one role.

Policy-Based Roles Authorization On AuthorizeView Component:

The policy is a set of rules. In the case of roles the policy will group the set of roles, so the user at least one role in the policy group then the user satisfied that policy, and then the AuthorizeView component renders.
Program.cs:
builder.Services.AddAuthorizationCore(options => {
	options.AddPolicy("mypolicy", policy => {
		policy.RequireRole("admin","superadmin");
	});
});
  • Here we grouped our roles under a policy named 'mypolicy'. Now we can use this policy name to authorize the user.
Pages/Index.razor:
@page "/"

<AuthorizeView Policy="mypolicy">
    <Authorized >
        <div>Hi @(context.User.Identity.Name), this offer can claim by users with role either 'superadmin' or'admin'
        </div>
    </Authorized>
</AuthorizeView>
  • Here AuthorizeView component renders the users who matched with at least one role that is grouped under the policy.

Roles Authorize Attribute To Page Components:

The Authorize attribute will be used on Page components. One thing to remember this will not work for normal components.  Based on the user role using the authorize attribute we can deny or allow the page access to the user.
Index.razor:
@page "/"
@attribute [Authorize(Roles="admin")]
  • Here our Index page component only accessed by the users who have an 'admin' role.
We can pass multiple roles with command separation, in this case, the user that matches at least one role can access the page.
Index.razor:
@page "/"
@attribute [Authorize(Roles="admin,superadmin")]
We can set multiple Authorize attributes on our Page Component, in this case, the user should have match the roles specified in each attribute.
Index.razor:
@page "/"
@attribute [Authorize(Roles="admin")]
@attribute [Authorize(Roles="user")]
  • User's having both roles only can access the Index page component.
we can also use the roles policy with this authorized attribute.
Index.razor:
@page "/"
@attribute [Authorize(Policy="admin")]
  • Here users that match at least one role under the policy group will access this page.

Claims-Based Authorization:

The Claims mean key-value pair of data which something like user information. To use claims-based authorization we need to write the policy for it, which means we can't use claims directly like we do in the case of roles.

Let's update some claims to my login.
Auth/CustomAuthStateProvider.cs:
var identity = new ClaimsIdentity(new []{
	new Claim(ClaimTypes.Name,"Naveen"),
	new Claim("PageAccesskey", "1"),
	new Claim("PageAccesskey", "2")
},"Fake Auth");
  • Here I have claims like 'PageAccessKey' with 2 different values like '1' and '2'.
In claims-based authorization, we need to write a policy for authorization. So policy can be written in such a way to check whether a user is having a specific claim or not that is independent of value to that claim.
Program.cs:
builder.Services.AddAuthorizationCore(options => {
	options.AddPolicy("myAccessPolicy", policy => {
		policy.RequireClaim("PageAccesskey");
	});
});
  • Here we check a claims policy where users must have the claim to satisfy this policy. One more thing if we observe here we are not checking the value of the cliams.
Now we can use this claims policy on AuthorizeViewComponent
Pages/Index.razor:
<AuthorizeView Policy="myAccessPolicy" >
    <Authorized >
        <div>Hi @(context.User.Identity.Name)
        </div>
    </Authorized>
</AuthorizeView>
  • So here claims policy check whether the user has the registered claim or not.
Another way of writing claims policy is by defining the values of the claim and then the user should at least have one claim value registered under the policy.
Program.cs:
options.AddPolicy("myAccessPolicy", policy => {
	policy.RequireClaim("PageAccesskey","1","2","3");
});
  • Here now claims policy registered values of the claims as well. So in this case users should have this claim and also should match with at least one of the values of the claim.
We can also use the Authorize attribute with the claim policy to protect the page component like we did use the roles policy.

So that's all about the authorization in the blazor webassembly application.

Support Me!
Buy Me A Coffee PayPal Me

Wrapping Up:

Hopefully, I think this article delivered some useful information about Authorization in the Blazor WebAssembly Application. I love to have your feedback, suggestions, and better techniques in the comment section below.

Refer:

Follow Me:

Comments

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

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

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

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

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

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

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'

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

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