Adding ASP.NET Identity 4.5 to an Existing Application

November 12, 2016
ASP.NET IdentityASP.NET

Watching videos about putting ASP.NET websites together, it always looks really nice and straight forward, it demos really well. Back at the office, faced with some real world requirements things never seem that simple. To this end I decided to try to setup the Identity framework from scratch on an existing web application. The following stackoverflow links explain this in detail, but as I implemented it myself on a test app I thought to document it here:

Install Packages

Step 1, install the necessary packages:    Install-Package Microsoft.AspNet.Identity.Owin
Install-Package Microsoft.AspNet.Identity.EntityFramework
Install-Package Microsoft.Owin.Host.SystemWeb

Create Entities

The IdentityDbContext includes entities for Users and Roles but we can customize them by extending the builtin objects.

public class User : IdentityUser
{
}


public class Role : IdentityRole
{
    public Role() : base() { }
    public Role(string name) : base(name) { }
}

Update Application EF Context

The three things to note here are:

  1. The context now extends the IdentityDbContext\<User> context
  2. The OnModelCreatingMethod renames the tables so they're not all prefixed with "AspNet"
  3. The context connection is now passed in through the constructor, else it tries to use DefaultConnection.
public class TimesheetsContext : IdentityDbContext<User> , ITimesheetsContext
{
    public IDbSet<Employee> Employees { get; set; }
    public IDbSet<Department> Departments { get; set; }
    public IDbSet<TimeCode> TimeCodes { get; set; }
    public IDbSet<Timesheet> Timesheets { get; set; }


    public TimesheetsContext()
        : base("TimesheetsContext")
    {


    }


    protected override void OnModelCreating(DbModelBuilder modelBuilder)
    {
        base.OnModelCreating(modelBuilder);


        modelBuilder.Entity<IdentityUser>().ToTable("Users").Property(p => p.Id).HasColumnName("UserId");
        modelBuilder.Entity<User>().ToTable("Users").Property(p => p.Id).HasColumnName("UserId");
        modelBuilder.Entity<IdentityUserRole>().ToTable("UserRoles");
        modelBuilder.Entity<IdentityUserLogin>().ToTable("UserLogins");
        modelBuilder.Entity<IdentityUserClaim>().ToTable("UserClaims");
        modelBuilder.Entity<IdentityRole>().ToTable("Roles");
    }
}

Create a UserManager

Its not required to create a UserManager, but it does provide us with the option to customise the setup:

public class UserManager : UserManager<User>
{
    public UserManager(IUserStore<User> store)
        : base(store)
    {
    }


    // This method is called by Owin therefore best place to configure your User Manager
    public static UserManager Create(
        IdentityFactoryOptions<UserManager> options, IOwinContext context)
    {
        var manager = new UserManager(
            new UserStore<User>(context.Get<TimesheetsContext>()));


        // Configure your manager ...


        return manager;
    }
}

Add Owin Configuration

The Identity classes uses Owin, so we need to setup the configuration for the Identity owing provider.

public class IdentityConfig
{
    public void Configuration(IAppBuilder app)
    {
        app.CreatePerOwinContext(() => new TimesheetsContext());
        app.CreatePerOwinContext<UserManager>(UserManager.Create);
        app.CreatePerOwinContext<RoleManager<Role>>((options, context) =>
            new RoleManager<Role>(
                new RoleStore<Role>(context.Get<TimesheetsContext>())));


        app.UseCookieAuthentication(new CookieAuthenticationOptions
        {
            AuthenticationType = DefaultAuthenticationTypes.ApplicationCookie,
            LoginPath = new PathString("/Home/Login"),
        });
    }
}

And finally

Once all setup, and if automatic migrations aren't turned on, then you need to run Add-migration and Update-database to create a migration and run it againest your database.

back