Skip to main content

Configuring Ninject, Asp.Net Identity UserManager, DataProtectorTokenProvider with Owin

It can be bit tricky to configure both Ninject and Asp.Net Identity UserManager if some value is expected from DI to configure UserManager. We will look into configuring both and also use OwinContext to get UserManager.

As usual, all configuration need to be done on Startup.cs. It is just a convention but can be used with different name, the important thing is to decorate class with following attribute to make it Owin start-up:

 [assembly: OwinStartup(typeof(MyProject.Web.Startup))]  

Ninject configuration

Configuring Ninject kernel through method which would be used to register under Owin.

Startup.cs
     public IKernel CreateKernel()  
     {  
       var kernel = new StandardKernel();  
       try  
       {  
         //kernel.Bind<IHttpModule>().To<HttpApplicationInitializationHttpModule>();  
         // TODO: Put any other injection which are required.
         return kernel;  
       }  
       catch  
       {  
         kernel.Dispose();  
         throw;  
       }  
     }  

To register with Owin we need to have Ninject.Web.Common.OwinHost package which would provide an extension method for configuration with AppBuilder.

Startup.cs
     private IKernel kernel = null;  
     public void Configuration(IAppBuilder app)  
     {  
       kernel = CreateKernel();  
       app.UseNinjectMiddleware(() => kernel);
     }  

The kernel variable is created to save the Ninject configuration which can be used to get value from it.
Ex:

       var service = kernel.Get<IServiceLocater>();  
       setting = service.SystemService.GetSystemSetting();  


Asp.Net Identity User Manager Configuration

There is actually two way do configure it. The first to register Ninject with CreatePerOwinContext and retrieve kernel through Owin context parameter.

 app.CreatePerOwinContext(CreateKernel);  

and then

 app.CreatePerOwinContext<MyUserManager>((option, context) =>  
       {  
         var kernl = context.Get<IKernel>();  
         var setting = service.SystemService.GetSystemSetting();  
         var userStore = kernel.Get<IUserStore<MyUserDomain>>();  
         return new MyUserManager(userStore);  
       });  

The above is standard approach but while performance profiling I find issue on CreateKernel which gets keep disposing and calling multiple times even if we try to do in this way.

  app.CreatePerOwinContext(() => kernel); // using above variable but kept getting disposed.  

So, the best option is to create kernel variable like we did under Ninject Configuration section and utilizing same to get setting out of Ninject kernel.

MyUserManager.cs
  public static MyUserManager Create(IdentityFactoryOptions<MyUserManager> options,  
       IUserStore<MyUserDomain> userStore, UserPolicy userPolicy)  
     {  
       var manager = new MyUserManager(userStore);  

       // Settings that we want to have based on implementation of Manager class
       manager.UserPolicy = userPolicy; // Custom defined  
       manager.PasswordValidator = new CustomPasswordValidator(userPolicy);  
       manager.UserLockoutEnabledByDefault = false;  
       manager.DefaultAccountLockoutTimeSpan = TimeSpan.FromMinutes(userPolicy.DefaultAccountLockoutTimeSpan);  
       manager.MaxFailedAccessAttemptsBeforeLockout = userPolicy.FailedAttemptLockCount; 
 
       manager.UserTokenProvider = new DataProtectorTokenProvider<MyUserDomain, string>(  
         options.DataProtectionProvider.Create("Asp.Net Identity"))  
       {  
         TokenLifespan = TimeSpan.FromDays(userPolicy.TokenExpiryInDays)  
       };  

       return manager;  
     }  

Then simply register the context on Startup.cs

Startup.cs
 app.CreatePerOwinContext<MyUserManager>((options, context) =>  
       {  
         var userStore = kernel.Get<IUserStore<MyUserDomain>>();  
         return MyUserManager.Create(options, userStore, setting.UserPolicy);  
       });  

One general thing that I had not explained is to have proper initialization of DataProtectorTokenProvider. It is generally need to be initialized on Owin Startup, with IdentityFactoryOptions<MyUserManager> we are able to create data protection provider.

Consuming Asp.Net Identity User Manager

Now, we are all set to consume User Manager. Since, we have set it on Owin context, it can be used throughout of application by following approach:

 HttpContext.GetOwinContext().GetUserManager<MyUserManager>()  


Quick glance of entire Startup.cs
   public sealed class Startup  
   {  
     /// <summary>  
     /// Application level settings.  
     /// </summary>  
     private Setting setting;  

     /// <summary>  
     /// Ninject kernel for injection.  
     /// </summary>  
     private IKernel kernel = null;  

     /// <summary>  
     /// Configurations of the application.  
     /// </summary>  
     /// <param name="app">The application.</param>  
     public void Configuration(IAppBuilder app)  
     {  
       kernel = CreateKernel();  
       app.UseNinjectMiddleware(() => kernel);  

       // Populate setting from services.  
       var service = kernel.Get<IServiceLocater>();  
       setting = service.SystemService.GetSystemSetting();  

       app.CreatePerOwinContext<MyUserManager>(CreateUserManager);  
       ConfigureAuthentication(app);  
     }  

     /// <summary>  
     /// Creates the user manager.  
     /// </summary>  
     /// <param name="options">The options.</param>  
     /// <param name="context">The context.</param>  
     /// <returns>User manager instance.</returns>  
     private MyUserManager CreateUserManager(IdentityFactoryOptions<MyUserManager> options, IOwinContext context)  
     {  
       var userStore = kernel.Get<IUserStore<MyUserDomain>>();  
       return MyUserManager.Create(options, userStore, setting.UserPolicy);  
     }  

     /// <summary>  
     /// Configures the authentication.  
     /// </summary>  
     /// <param name="app">The application builder.</param>  
     private void ConfigureAuthentication(IAppBuilder app)  
     {  
       app.UseCookieAuthentication(new CookieAuthenticationOptions  
       {  
         AuthenticationType = DefaultAuthenticationTypes.ApplicationCookie,  
         LoginPath = new PathString("/Account/Login"),  
         SlidingExpiration = true,  
         ExpireTimeSpan = TimeSpan.FromMinutes(setting.System.Session.SessionTimeoutInMinutes)  
       });  
     }  

     /// <summary>  
     /// Creates the kernel.  
     /// </summary>  
     /// <returns></returns>  
     public IKernel CreateKernel()  
     {  
       var kernel = new StandardKernel();  
       try  
       {  
         //kernel.Bind<Func<IKernel>>().ToMethod(ctx => () => new Bootstrapper().Kernel);  
         //kernel.Bind<IHttpModule>().To<HttpApplicationInitializationHttpModule>();  
         // TODO: Put any other injection which are required.  
         return kernel;  
       }  
       catch  
       {  
         kernel.Dispose();  
         throw;  
       }  
     }  
   }  

Comments

Popular posts from this blog

Getting started with Raspberry Pi

Raspberry Pi is a small, low powered motherboard contains 512 RAM, combined CPU and GPU. It has LAN, 2 USB, HDMI input, Audio Out, SD Card reader and S-Video connectors. We can have many Linux distribution OS on it. To configure, we just need to attach SD Card to it. SD Card could range from class 4 to class 10. In some cases Raspberry Pi could support less then class 4 cards too. It could be powered through mini USB mobile charger. Let's get started with installing OS on SD Card. There are various ways to install OS. Like we can download OSes through  http://www.raspberrypi.org/downloads  and follow the instructions given on it. There is something BerryBoot multi-boot loader through which we can have more then one OS on Raspberry Pi and boot OS according to our need.  http://www.berryterminal.com/doku.php/berryboot  instructions could be followed to install OS with very simple steps. You need to have internet connection on Raspberry Pi to install OS. It coul...

Kendo MVC Grid DataSourceRequest with AutoMapper - Advance

The actual process to make DataSourceRequest compatible with AutoMapper was explained in my previous post  Kendo MVC Grid DataSourceRequest with AutoMapper , where we had created custom model binder attribute and in that property names were changed as data models. In this post we will be looking into using AutoMapper's Queryable extension to retrieve the results based on selected columns. When  Mapper.Map<RoleViewModel>(data)  is called it retrieves all column values from table. The Queryable extension provides a way to retrieve only selected columns from table. In this particular case based on properties of  RoleViewModel . The previous approach that we implemented is perfect as far as this article ( 3 Tips for Using Telerik Data Access and AutoMapper ) is concern about performance where it states: While this functionality allows you avoid writing explicit projection in to your LINQ query it has the same fatal flaw as doing so - it prevents the qu...

Trim text in MVC Core through Model Binder

Trimming text can be done on client side codes, but I believe it is most suitable on MVC Model Binder since it would be at one place on infrastructure level which would be free from any manual intervention of developer. This would allow every post request to be processed and converted to a trimmed string. Let us start by creating Model binder using Microsoft.AspNetCore.Mvc.ModelBinding; using System; using System.Threading.Tasks; public class TrimmingModelBinder : IModelBinder { private readonly IModelBinder FallbackBinder; public TrimmingModelBinder(IModelBinder fallbackBinder) { FallbackBinder = fallbackBinder ?? throw new ArgumentNullException(nameof(fallbackBinder)); } public Task BindModelAsync(ModelBindingContext bindingContext) { if (bindingContext == null) { throw new ArgumentNullException(nameof(bindingContext)); } var valueProviderResult = bindingContext.ValueProvider.GetValue(bin...

Using Redis distributed cache in dotnet core with helper extension methods

Redis cache is out process cache provider for a distributed environment. It is popular in Azure Cloud solution, but it also has a standalone application to operate upon in case of small enterprises application. How to install Redis Cache on a local machine? Redis can be used as a local cache server too on our local machines. At first install, Chocolatey https://chocolatey.org/ , to make installation of Redis easy. Also, the version under Chocolatey supports more commands and compatible with Official Cache package from Microsoft. After Chocolatey installation hit choco install redis-64 . Once the installation is done, we can start the server by running redis-server . Distributed Cache package and registration dotnet core provides IDistributedCache interface which can be overrided with our own implementation. That is one of the beauties of dotnet core, having DI implementation at heart of framework. There is already nuget package available to override IDistributedCache i...

C# Response files

Response files are similar to batch files, having some specific instruction. On execution they perform some predefined task based on instruction. Response file contains instruction to compile programs. If we have to build complex program through command line then response files are really helpful in development process. rsp is an extension for response files. By default, csc.rsp file exists under "Framework" folder Ex: C:\Windows\Microsoft.NET\Framework\v4.0.30319. csc.rsp contains long list of system references (dlls). Some contents under csc.rsp # Reference the common Framework libraries /r:Accessibility.dll /r:Microsoft.CSharp.dll /r:System.Configuration.dll /r:System.Configuration.Install.dll /r:System.Core.dll /r:System.Data.dll /r:System.Data.DataSetExtensions.dll /r:System.Data.Linq.dll .......... In same way we can have our own response file defined which might include some third party dll. Let's see an example. Suppose we have to create an appli...

OpenId Authentication with AspNet Identity Core

This is a very simple trick to make AspNet Identity work with OpenId Authentication. More of all both approach is completely separate to each other, there is no any connecting point. I am using  Microsoft.AspNetCore.Authentication.OpenIdConnect  package to configure but it should work with any other. Configuring under Startup.cs with IAppBuilder app.UseCookieAuthentication(new CookieAuthenticationOptions { AuthenticationScheme = CookieAuthenticationDefaults.AuthenticationScheme, LoginPath = new PathString("/Account/Login"), CookieName = "MyProjectName", }) .UseIdentity() .UseOpenIdConnectAuthentication(new OpenIdConnectOptions { ClientId = "<AzureAdClientId>", Authority = String.Format("https://login.microsoftonline.com/{0}", "<AzureAdTenant>"), ResponseType = OpenIdConnectResponseType.IdToken, PostLogoutRedirectUri = "<my website url>", ...

Centralized model validation both for MVC/WebApi and SPA client-side validation using FluentValidation

Validation is one of the crucial parts of any application. It has to validate on both client side and server side requests. What are target features or implementation from this article? Model validation for any given model. Centralized/One code for validation on both server-side and client-side. Automatic validation of model without writing any extra codes on/under actions for validation.  NO EXTRA/ANY codes on client-side to validate any form. Compatible with SPA. Can be compatible with any client-side validation framework/library. Like Angular Reactive form validation or any jquery validation libraries. Tools used in the implementation? FluentValidation : I feel DataAnnotation validation are excellent and simple to use, but in case of complex validation or writing any custom validations are always tricker and need to write a lot of codes to achieve whereas FluentValidations are simple even in case of complex validation. Generally, we need to validate inc...

Implementing/Automating audit logs in Telerik Data Access

Audit logs can be tedious task if done manually, also developer might miss to update audit log implementation on certain level. The codes would be repeated on all places if not centralized. There are many approach available to maintain change history of model/table. Like having single history table and manage all changes of all models in same table. We may maintain in same table with some flags and JSON data for change list. We will look for maintaining history table based on each required data models with minimum effort and performance. To reduce code, I am going to use T4 to generate history models automatically based on original model. Also we are going to take care of Artificial type values. Step 1 - Create a custom attribute to mark model that history need to be maintained. /// <summary> /// Attribute to maintain history table /// </summary> [AttributeUsage(AttributeTargets.Class)] public class ManageHistoryAttribute : Attribute ...

main method return value

Mainly we used to write "static void main" for entry point in console application. Placement of void denotes return type. In main function we could have "int" too but what does it really mean. "int main" signifies return type as integer. The return type of main function tells about execution status of application. Even if we have specified void as return type then it would be marked as successful program execution. If we mark int as return type then we are able to control the execution status. Now, what is the benefit of making main function as int. Windows OS saves result in  %ERRORLEVEL% environment variable of OS. If we create batch file and execute application through it then we will able to get status and based on result we can trigger something else through batch file. Let's suppose we have created program called TEST.EXE. Batch file script: @echo off REM Execute main program REM TEST.EXE @if  "%ERRORLEVEL%" == "0...

Elegantly dealing with TimeZones in MVC Core / WebApi

In any new application handling TimeZone/DateTime is mostly least priority and generally, if someone is concerned then it would be handled by using DateTime.UtcNow on codes while creating current dates and converting incoming Date to UTC to save on servers. Basically, the process is followed by saving DateTime to UTC format in a database and keep converting data to native format based on user region or single region in the application's presentation layer. The above is tedious work and have to be followed religiously. If any developer misses out the manual conversion, then that area of code/view would not work. With newer frameworks, there are flexible ways to deal/intercept incoming or outgoing calls to simplify conversion of TimeZones. These are steps/process to achieve it. 1. Central code for storing user's state about TimeZone. Also, central code for conversion logic based on TimeZones. 2. Dependency injection for the above class to ...