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.
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.
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.
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.
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