Skip to main content

Part-2 Hot Chocolate GraphQL Validate JWT Access Token And Different Authorization Techniques

Part-1 completely discussed the steps to generate the access token in the GraphQL endpoint. Now in this article, our main goals are to validate the JWT access token and also we try to understand authorization techniques in GraphQL.

Install JwtBearer Authentication NuGet:

Let's install JwtBearer Authentication NuGet to configure JwtBearer services.
.Net CLI Command:

dotnet add package Microsoft.AspNetCore.Authentication.JwtBearer
Package Manager Command:

Install-Package Microsoft.AspNetCore.Authentication.JwtBearer

Register JWT Validation Service:

Now we need to register the JwtBearer service to validate our access token on the user sending the access token as an authorization header.
Startup.cs:
using Microsoft.AspNetCore.Authentication.JwtBearer;
using Microsoft.IdentityModel.Tokens;

services.AddAuthentication(JwtBearerDefaults.AuthenticationScheme)
.AddJwtBearer(options =>
{
	options.TokenValidationParameters = new TokenValidationParameters
	{
		ValidIssuer = Configuration.GetSection("TokenSettings").GetValue<string>("Issuer"),
		ValidateIssuer = true,
		ValidAudience = Configuration.GetSection("TokenSettings").GetValue<string>("Audience"),
		ValidateAudience = true,
		IssuerSigningKey = new SymmetricSecurityKey(Encoding.UTF8.GetBytes(Configuration.GetSection("TokenSettings").GetValue<string>("Key"))),
		ValidateIssuerSigningKey = true
	};
});
  • Here in the validation service, we can observe all the configurations that are used to create JWT access tokens are used here as well to validating our access token.

Register Authentication Middleware:

Now we need to configure authentication middleware just about the authorization middleware.
Startup.cs:
app.UseAuthentication();
app.UseAuthorization();

Install GraphQL Authorization Nuget:

Package Manager Command:

Install-Package HotChocolate.AspNetCore.Authorization
.Net CLI Command:
donet add package HotChocolate.AspNetCore.Authorization

Register GraphQL Authorization Service:

Now let's add an authorization service to the GraphQL service in the startup file.
Startup.cs:
services.AddGraphQLServer()
.AddQueryType<QueryObjectType>()
.AddMutationType<MutationObjectType>()
.AddAuthorization();

Implement Basic Authorization On GraphQL Resolver Method:

In GraphQL authorization need to be added as an extension method on registering each resolver method as a field. If we recall Part-1, we have created 'Welcome' query, so now we are going to implement authorization for that 'Welcome' resolver method.
GraphQLModel/ObjectType/QueryObjectType.cs:
descriptor.Field(_ => _.Welcome())
.Name("Welcome").Type<StringType>()
.Authorize();
  • Here added 'Authorized' as an extension method.
Now first try to access the 'Welcome' query resolver without using the access token as authorization header and check the output.
So from the image, we can observe the server responding with an unauthorized message.

Now test again by added the authorization header by providing our access token as its value.

Roles Based Authorization:

Role-based authorization is quite a common implementation to restrict the user or allow any particular set of users to consume the server resource. Roles are also claims of the user but its key name will be 'Role'.

First, let's add some roles to access tokens by updating the token generation method.
GraphQLCore/Mutation.cs:(UserLogin Method)
var claims = new Claim[] {
	new Claim(ClaimTypes.Role, "user")
};

var jwtToken = new JwtSecurityToken(
	issuer: tokenSettings.Value.Issuer,
	audience: tokenSettings.Value.Audience,
	expires: DateTime.Now.AddMinutes(20),
	signingCredentials: credentials,
	claims: claims
);
  • Here will generating jwt token I'm updating the code to add a role called "user". Here I added static role value in a real-time application we need to fetch role data from the database.
Now update our resolver field 'Authorize' extension method with roles to it.
GraphQLModel/ObjectType/QueryObjectType.cs:
descriptor.Field(_ => _.Welcome()).Name("Welcome")
.Type<StringType>()
.Authorize(new[]{"user","admin"});
  • Here our 'Welcome' method can be consumed by users who had at least one of the roles specified in the 'Authorize' method.

Policy-Based Roles Authorization:

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.

Let's add the roles policy in the startup file.
Startup.cs:
services.AddAuthorization(options =>
{
	options.AddPolicy("user-policy", policy =>
	{
		policy.RequireRole(new[] { "user", "admin" });
	});
});
Now update our resolver method to use the policy-based authorization.
GraphQLModel/ObjectType/QueryObjectType.cs:
descriptor.Field(_ => _.Welcome())
.Name("Welcome").Type<StringType>()
.Authorize("user-policy");
  • Here now we are passing the "user-policy" name as the input parameter to the 'Authorize' extension method.

Policy-Based Claims 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 the 'UserLogin' resolver method with the following claims.
GraphQLCore/Mutation.cs:(UserLogin Method)
 var claims = new Claim[] {
	new Claim(ClaimTypes.Role, "user"),
	new Claim("usercountry","India")
};

var jwtToken = new JwtSecurityToken(
	issuer: tokenSettings.Value.Issuer,
	audience: tokenSettings.Value.Audience,
	expires: DateTime.Now.AddMinutes(20),
	signingCredentials: credentials,
	claims: claims
);
  • Here we added claims like "usercountry" and its value as "India".
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 the value of the claim
Startup.cs:
services.AddAuthorization(options =>
{
	options.AddPolicy("country-policy", policy =>
	{
		policy.RequireClaim("usercountry");
	});
});
  • In this policy we are checking only "usercountry" claim is possessed by the user or not. Here we are not checking the value of the claim.
Now update the 'Authorize' extension method with our claims policy name.
GraphQLModel/ObjectType/QueryObjectType.cs:
descriptor.Field(_ => _.Welcome())
.Name("Welcome").Type<StringType>()
.Authorize("country-policy");
Another way of writing a claims policy is by defining the values of the claim and then the user should have at least one claim value registered under the policy.
Startup.cs:
services.AddAuthorization(options =>
{
	options.AddPolicy("country-policy", policy =>
	{
		policy.RequireClaim("usercountry","india","usa","japan");
	});
});
That's all about different Authorization techniques in GraphQL.

Video Session:

 

Support Me!
Buy Me A Coffee PayPal Me

Wrapping Up:

Hopefully, I think this article delivered some useful information on the authorization techniques in the Hot Chocolate GraphQL endpoint. I love to have your feedback, suggestions, and better techniques in the comment section below.

Refer:

Follow Me:

Comments

Popular posts from this blog

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

Asp.Net Core MVC Form Validation Techniques

Introduction: Form validations in any applications are like assures that a valid data is storing on servers. All programing frameworks have their own individual implementations for form validations. In Dotnet Core MVC application server-side validations carried on by the models with the help of Data Annotations and the client-side validations carried by the plugin jQuery Unobtrusive Validation. jQuery Unobtrusive Validation is a custom library developed by Microsoft based on the popular library  jQuery Validate . In this article, we are going to learn how the model validation and client-side validation works in Asp.Net Core MVC Application with sample examples. Getting Started: Let's create an Asp.Net Core MVC application project using preferred editors like Microsoft Visual Studio or Microsoft Visual Studio Code. Here I'm using Visual Studio. Let's create an MVC controller and name it as 'PersonController.cs' and add an action method as bel

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

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

.NET Core MVC Application File Upload To Physical Location With Buffered Technique

Buffering Technique In File Upload: The server will use its Memory(RAM) or Disk Storage to save the files on receiving a file upload request from the client.  Usage of Memory(RAM) or Disk depends on the number of file requests and the size of the file.  Any single buffered file exceeding 64KB is moved from Memory to a temp file on disk.  If an application receives heavy traffic of uploading files there might be a chance of out of Disk or RAM memory which leads to crash application. So this Buffer technique used for small files uploading. In the following article, we create a sample for the file uploading using .NET Core MVC application. Create The .NET Core MVC Project: Let's create a .NET Core MVC project, here for this sample I'm using Visual Studio Code as below.   Check the link to use the Visual Studio Code for .NET Core Application . IFormFile: Microsoft.AspNetCore.Http.IFormFile used for file upload with buffered technique. On uploading files f

Ionic Picker Sample Code In Angular

Introduction: Ionic Picker(ion-picker) is a popup slides up from the bottom of the device screen, which contains rows with selectable column separated items. The main building block of ion-picker as follows: PickerController PickerOptions PickerController: PickerController object helps in creating an ion-picker overlay. create(opts?: Opts): Promise<Overlay> PickerController create method helps in create the picker overlay with the picker options PickerOptions: PickerOptions is a configuration object used by PickerController to display ion-picker. Single Column Ionic Picker: single.item.picker.ts: import { Component } from "@angular/core"; import { PickerController } from "@ionic/angular"; import { PickerOptions } from "@ionic/core"; @Component({ selector: "single-column-picker", templateUrl:"single.item.picker.html" }) export class SingleItemPicker { animals: string[] = ["Tiger&quo

GraphQL API Integration In Asp.Net Core Application

Introduction: GraphQL is a query language for your API and a server-side runtime for executing queries by using a type system you define for your data. GraphQL can be integrated into any framework like ASP.NET, Java, NestJs, etc and it isn't tied to any specific database or storage engine and is instead backed by your existing code and data. How GraphQL API Different From Rest API: GraphQL exposes a single end-point or route for the entire application, regardless of its responses or actions. HTTP-POST is the only Http verb recommended by the GraphQL. The client applications (consumers of API) can give instructions to GraphQL API about what type of properties to be returned in the response. Building Blocks Of GraphQL API: The main building blocks of GraphQL API is Schemas and Types.  A 'Schema' in GrpahQL API describes the functionality available to the clients connect to API. Schema mostly consists of GraphQL Object Types, Queries, Mutations, etc. T

.Net Core HttpClient JSON Extension Methods Using System.Net.Http.Json Package

.Net Core 3.0 onwards Microsoft brought up a new package called System.Net.Http.Json. This new package provides JSON extension methods for HttpClient. These JSON extension methods will have a prebuild mechanism for serializing or deserializing response data or payload of HttpClient call. System.Net.Http.Json extension methods that are provided to HttpClient, few of them are mentioned below. GetFromJsonAsync PostAsJsonAsync PutAsJsonAsync ReadFromJsonAsync In this article, we understand System.Net.Http.Json package by implementing the HttpClient samples by with and without JSON extension methods and compare them. Create A .Net Core Web API Sample Application: Let's create a .Net Core sample Web API application, from this application we will consume another Web API by implementing HttpClient calls. We can create a Web API sample application using IDE like Visual Studio 2019(Supports .Net Core 3.0 plus) or  Visual Studio Code . Create A Typed Client: In .Net Core using the Http

ASP.NET Core Web API Versioning

Introduction: An iteration and evolutionary changes of an ASP.NET Core Web API is handled by Versioning. Versioning of an API gives confidence to the clients which consumes API for a long time. Any changes or development of an API will be accessible using the new version and it won't cause issues to the clients consuming the old version of API. When To Use Versioning: Any API response changes. Developing an API by implementing testing levels like 'Alpha', 'Beta', and 'RC' versions before releasing Production. Deprecating an API which means API going to be removed or upgraded by a version within a short period. Versioning Types: Query String Versioning Url Path Versioning Media Type Versioning API Version Nuget: To Configure versioning to AspNet Core Web API Microsoft provided a library(Microsoft.AspNetCore.Mvc.Versioning). So to use the versioning library please install NuGet below.              Install-Package Microsoft.A

Blazor Server CRUD Operations

Introduction: Blazor Server is a web framework to develop server-side single-page applications. Blazor is made up of components with the combinations on C#, Html, CSS.  Blazor Server is production-ready from the .Net Core 3.0.  Blazor Server Working Mechanism: Blazor Server is a very light-weight web development framework.  In Blazor Server, not all code gets downloaded to the client browsers. Blazor Server made of components these components can be a block of code or page with respective navigation.  Blazor server application communicates with the server with a SignalR background connection which is inbuilt functionality. Application click,  form submission, change events, application page navigation every operation is carried out by the SignalR connection by communicating with the server.  Blazor updates the Html DOM very gently on every data update without any overhead. Blazor Server application maintains a nice intelligent tree structure to update the required inform