Skip to main content

Hot Chocolate GraphQL Custom Authentication Series Using Pure Code First Technique - Part1 - User Registration

About The Series:

Using Pure Code First Technique In Hot Chocolate GraphQL, Custom Authentication Series:
  • Part1 User Registration Resolver
  • Part2 Generating JWT Access Token For User Authentication.
  • Part3 Validating JWT Access Token And Different Authorization Techniques
  • Part4 Generating Refresh Token.

So this our Part-1 of the series where we are going to create a sample in GraphQL for user registration.

SQL Tables:

Create 2 tables like 'User' and 'UserRoles'.

User Table:
CREATE TABLE [dbo].[User](
	[UserId] [int] IDENTITY(1,1) NOT NULL,
	[FirstName] [varchar](192) NULL,
	[LastName] [varchar](192) NULL,
	[EmailAddress] [varchar](192) NOT NULL,
	[Password] [varchar](640) NOT NULL,
	[RefreshToken] [varchar](640) NULL,
	[RefershTokenExpiration] [datetime] NULL,
 CONSTRAINT [PK_User] PRIMARY KEY CLUSTERED 
(
	[UserId] ASC
)WITH (PAD_INDEX = OFF, STATISTICS_NORECOMPUTE = OFF, IGNORE_DUP_KEY = OFF, ALLOW_ROW_LOCKS = ON, ALLOW_PAGE_LOCKS = ON) ON [PRIMARY]
) ON [PRIMARY]
UserRoles Table: 
CREATE TABLE [dbo].[UserRoles](
	[RoleId] [int] IDENTITY(1,1) NOT NULL,
	[UserId] [int] NOT NULL,
	[Name] [varchar](192) NOT NULL,
 CONSTRAINT [PK_UserRoles] PRIMARY KEY CLUSTERED 
(
	[RoleId] ASC
)WITH (PAD_INDEX = OFF, STATISTICS_NORECOMPUTE = OFF, IGNORE_DUP_KEY = OFF, ALLOW_ROW_LOCKS = ON, ALLOW_PAGE_LOCKS = ON) ON [PRIMARY]
) ON [PRIMARY]

Create A .Net5 Web API Application:

So to start our journey we have to create .Net5 Web API application. For development, any type of IDE can be used, but the most recommended IDE's like Visual Studio 2019(Version 16.8.* supports .Net5 Apps), Visual Studio Code.

Install Hot Chocolate GraphQL NuGet:

Package Manager Command:
Install-Package HotChocolate.AspNetCore -Version 11.0.9

.Net CLI Command:
dotnet add package HotChocolate.AspNetCore --version 11.0.9

Register GraphQL Server And  Endpoint:

In 'Startup.cs' register Hot Chocolate GraphQL server.
Startup.cs:(ConfigureService)
services.AddGraphQLServer();
Now configure GraphQL endpoint. By default GraphQL provide default path like '/graphql'. If needed we can override the default endpoint path.
Startup.cs:(Configure)
app.UseEndpoints(endpoints =>
{
	endpoints.MapGraphQL();
	endpoints.MapControllers();
});

Configure EntityFrameworkCore Database Context:

Now we have to configure the entity framework core database context into our sample.

Install entity framework core NuGet.
Package Manager Command:
Install-Package Microsoft.EntityFrameworkCore -Version 5.0.4

.Net CLI Command:
dotnet add package Microsoft.EntityFrameworkCore --version 5.0.4
Install SQL extension of entity framework core NuGet. 
Package Manager Command:
Install-Package Microsoft.EntityFrameworkCore.SqlServer -Version 5.0.4

.Net CLI Command:
dotnet add package Microsoft.EntityFrameworkCore.SqlServer --version 5.0.4
Let's use code first with the existing database technique in our application. Now our goals are to create a Database context class and then 2 more classes to represent our tables like 'User.cs', 'UserRoles.cs'.

So let's create a folder like 'Data/Entities and then add our table classes like 'User.cs', 'UserRoles.cs'.
Data/Entities/User.cs:
using System.ComponentModel.DataAnnotations;

namespace GraphQL.PureCodeFirst.Auth.Data.Entities
{
    public class User
    {
        [Key]
        public int UserId { get; set; }
        public string FirstName { get; set; }
        public string LastName { get; set; }
        public string EmailAddress { get; set; }
        public string Password { get; set; }
        public string RefreshToken { get; set; }
        public string RefershTokenExpiration { get; set; }
    }
}
Data/Entities/UserRoles.cs: 
using System.ComponentModel.DataAnnotations;

namespace GraphQL.PureCodeFirst.Auth.Data.Entities
{
    public class UserRoles
    {
        [Key]
        public int RoleId { get; set; }
        public int UserId { get; set; }
        public string Name { get; set; }
    }
}
In the 'Data' folder add a new class for Database context.
Data/AuthContext.cs:
using GraphQL.PureCodeFirst.Auth.Data.Entities;
using Microsoft.EntityFrameworkCore;

namespace GraphQL.PureCodeFirst.Auth.Data
{
    public class AuthContext : DbContext
    {
        public AuthContext(DbContextOptions<AuthContext> options) : base(options)
        {

        }

        public DbSet<User> User { get; set; }
        public DbSet<UserRoles> UserRoles { get; set; }
    }
}
Add our SQL database connection string.
appsettings.Development.json:

"ConnectionStrings": {
	"AuthContext":"Your_ConnectionString"
}
Register the 'AuthContext' in 'Startup.cs' file.
Startup.cs:
services.AddDbContext<AuthContext>(options =>
{
	options.UseSqlServer(Configuration.GetConnectionString("AuthContext"));
});

User Registration Logic:

Let's create a payload object for the user registration. Create a new folder like 'InputTypes' and add a new file like 'RegisterInputType.cs'.
InputTypes/RegisterInputType.cs:
namespace GraphQL.PureCodeFirst.InputTypes
{
    public class RegisterInputType
    {
        public string FirstName { get; set; }
        public string LastName { get; set; }
        public string EmailAddress { get; set; }
        public string Password { get; set; }
        public string ConfirmPassword { get; set; }
    }
}
Now we have to implement user registration logic. Let's create a folder like 'Logics', add a class 'AuthLogic.cs', and add an interface like 'IAuthLogic.cs'.

While register users we should have a validation against the payload from the client. So here we will implement validations on 'EamilAddress' and 'Password' like below.
Logics/AuthLogic.cs:
private string ResigstrationValidations(RegisterInputType registerInput)
{
	if (string.IsNullOrEmpty(registerInput.EmailAddress))
	{
		return "Eamil can't be empty";
	}

	if (string.IsNullOrEmpty(registerInput.Password)
		|| string.IsNullOrEmpty(registerInput.ConfirmPassword))
	{
		return "Password Or ConfirmPasswor Can't be empty";
	}

	if (registerInput.Password != registerInput.ConfirmPassword)
	{
		return "Invalid confirm password";
	}

	string emailRules = @"[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-z0-9!#$%&'*+/=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?";
	if (!Regex.IsMatch(registerInput.EmailAddress, emailRules))
	{
		return "Not a valid email";
	}

	// atleast one lower case letter
	// atleast one upper case letter
	// atleast one special character
	// atleast one number
	// atleast 8 character length
	string passwordRules = @"^.*(?=.{8,})(?=.*\d)(?=.*[a-z])(?=.*[A-Z])(?=.*[!*@#$%^&+=]).*$";
	if (!Regex.IsMatch(registerInput.Password, passwordRules))
	{
		return "Not a valid password";
	}

	return string.Empty;
}
We never save raw passwords directly into the database. Always need to save the encrypted password. The most preferred is one-way encryption, that means can't be decrypted.
Logics/AuthLogic.cs:
private string PasswordHash(string password)
{
	byte[] salt;
	new RNGCryptoServiceProvider().GetBytes(salt = new byte[16]);

	var pbkdf2 = new Rfc2898DeriveBytes(password, salt, 1000);
	byte[] hash = pbkdf2.GetBytes(20);

	byte[] hashBytes = new byte[36];
	Array.Copy(salt, 0, hashBytes, 0, 16);
	Array.Copy(hash, 0, hashBytes, 16, 20);

	return Convert.ToBase64String(hashBytes);
}
  • (Line: 3-4)  The 'System.Security.Cryptography.RNGCryptoServiceProvide' used to get a random array of byte data which will be used as a salt key for password encryption.
  • (Line: 6-7) The 'System.Security.Cryptography.Rfc2898DeriveBytes' uses our user password and salt and generates a byte array of data. After the specified number of iteration(our sample we specified 1000, same iteration count should be used for validating password), the final encrypted byte array will be generated.
  • (Line: 9-11)Our max encrypted password length has specified as 36 bytes. The first 16 bytes are our salt key so that we can use this salt for validating passwords for user authentication. The remaining 20 bytes is our encrypted password.
  • (Line: 13) The final byte array converted as a string and this string result will be saved in the database.
Now let's write user registration method that will uses this 'ResigstrationValidations()' and 'PasswordHash()' methods. Finally adds new records to 'User' table and also in 'UserRoles' table(with default roles).
Logics/AuthLogic.cs:
public string Register(RegisterInputType registerInput)
{
	string errorMessage = ResigstrationValidations(registerInput);
	if (!string.IsNullOrEmpty(errorMessage))
	{
		return errorMessage;
	}

	var newUser = new User
	{
		EmailAddress = registerInput.EmailAddress,
		FirstName = registerInput.FirstName,
		LastName = registerInput.LastName,
		Password = PasswordHash(registerInput.ConfirmPassword)
	};

	_authContext.User.Add(newUser);
	_authContext.SaveChanges();

	// default role on registration
	var newUserRoles = new UserRoles
	{
		Name = "admin",
		UserId = newUser.UserId
	};

	_authContext.UserRoles.Add(newUserRoles);
	_authContext.SaveChanges();

	return "Registration success";
}
  • (Line: 3-7) Validating registration payload. If the payload invalid then returns the error message.
  • (Line: 9-18) Saving new users to the 'User' table. Password encrypted before saving the user.
  • (Line: 20-28) After saving user, also saving user default roles.
Now define our abstract method in 'IAuthLogic.cs'.
Logics/IAuthLogic.cs:
using GraphQL.PureCodeFirst.InputTypes;

namespace GraphQL.PureCodeFirst.Auth.Logics
{
    public interface IAuthLogic
    {
        string Register(RegisterInputType registerInput);
    }
}
Now in 'Sartup.cs' file register 'IAuthLogic' and 'AuthLogic'.
Startup.cs:
services.AddScoped<IAuthLogic, AuthLogic>();

Create A Simple Query Resolver:

User registration means saving data, which means we only need a Mutation resolver for this article. But GraphQL server expects a query resolver as well. If we don't create a Query resolver our application will throw an exception on runtime. So to avoid the exception here we will create a simple resolver query.

Now create a folder like 'Resolvers', then add a new file like 'QueryResolver.cs'.
Resolvers/QueryResolver.cs:
using GraphQL.PureCodeFirst.Auth.Logics;
using GraphQL.PureCodeFirst.InputTypes;
using HotChocolate;

namespace GraphQL.PureCodeFirst.Auth.Resolvers
{
    public class QueryResolver
    {
        public string Welcome()
        {
            return "Welcome To Custom Authentication Servies In GraphQL In Pure Code First";
        }
    }
}
Now register 'QueryResolver' in Starup.cs file.
Startup.cs:
services.AddGraphQLServer()
.AddQueryType<QueryResolver>();

Create Mutation Resolver:

Now we have to create a registration resolver to create the new users. So let's create a new file like 'MutationResolver.cs' in the 'Resolver' folder.
Resolver/MutationResolver.cs:
using GraphQL.PureCodeFirst.Auth.Logics;
using GraphQL.PureCodeFirst.InputTypes;
using HotChocolate;

namespace GraphQL.PureCodeFirst.Auth.Resolvers
{
    public class MutationResolver
    {
        public string Register([Service] IAuthLogic authLogic, RegisterInputType registerInput)
        {
            return authLogic.Register(registerInput);
        }
    }
}
  • Using the 'HotChocolae.Service' attribute used to inject our service into the 'Register' resolver.
Now register 'MutationResolver' in the 'startup.cs' file.
Startup.cs:
services.AddGraphQLServer()
.AddQueryType<QueryResolver>()
.AddMutationType<MutationResolver>();
Let's frame GraphQL endpoint mutation for user registration. (Click here to know more about Hot Chocolate GraphQL Code First Technique)
Mutation:
mutation ($Registraion:RegisterInputTypeInput){
  register(registerInput:$Registraion)
}
Variable: 
{
  "Registraion":{
    "firstName":"Naveen",
    "lastName":"Bommidi",
    "emailAddress":"bommidi@test.com",
    "password":"Test@1234",
    "confirmPassword":"Test@1234"
  }
}

So that all about part-1 of the GraphQL authentication series.

Video Session:

Support Me!
Buy Me A Coffee PayPal Me

Wrapping Up:

Hopefully, I think this article delivered some useful information on the user registration in Pure Code First technique in Hot Chocolate GraphQL. I love to have your feedback, suggestions, and better techniques in the comment section below.

Refer:

Follow Me:

Labels:

Comments

  1. AnonymousDecember 15, 2021 at 10:53 AM

    why refreshToken on the same user table? if you login from another device, the RefreshToken will only work on the one that was generated last. Is it intentional?

    ReplyDelete

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'
3 comments
Read more

.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
3 comments
Read more

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
3 comments
Read more

.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
6 comments
Read more

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
8 comments
Read more

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
5 comments
Read more

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
7 comments
Read more

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
Post a Comment
Read more

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
Post a Comment
Read more

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
8 comments
Read more