Adding ASP NET MVC5 Identity Authentication to an existing project

Question

I have seen lots of similar pages on the web  but most of them use a new project instead of an existing one  or don t have the necessary features  So  I have an existing MVC 5 project and want to integrate ASP NET MVC5 Identity with log in  email confirmation and password reset features  In addition to this  I also need to create all the necessary tables on the database i e  User  Roles  groups  etc   I use EF Code First in my project   Is there an article or sample that corresponds to these needs

User · Answer

I recommend IdentityServer This is a  NET Foundation project and covers many issues about authentication and authorization   Overview  IdentityServer is a  NET Katana-based framework and hostable component that allows implementing single sign-on and access control for modern web applications and APIs using protocols like OpenID Connect and OAuth2  It supports a wide range of clients like mobile  web  SPAs and desktop applications and is extensible to allow integration in new and existing architectures   For more information  e g    support for MembershipReboot and ASP NET Identity based user stores support for additional Katana authentication middleware  e g  Google  Twitter  Facebook etc  support for EntityFramework based persistence of configuration support for WS-Federation extensibility   check out the documentation and the demo

User · Answer

This is what I did to integrate Identity with an existing database    Create a sample MVC project with MVC template  This has all the code needed for Identity implementation - Startup Auth cs  IdentityConfig cs  Account Controller code  Manage Controller  Models and related views  Install the necessary nuget packages for Identity and OWIN  You will get an idea by seeing the references in the sample Project and the answer by  Sam Copy all these code to your existing project  Please note don t forget to add the  DefaultConnection  connection string for Identity to map to your database  Please check the ApplicationDBContext class in IdentityModel cs where you will find the reference to  DefaultConnection  connection string  This is the SQL script I ran on my existing database to create necessary tables     USE   YourDatabse   GO         Object   Table  dbo   AspNetRoles     Script Date  16-Aug-15 6 52 25 PM         SET ANSI NULLS ON GO SET QUOTED IDENTIFIER ON GO CREATE TABLE  dbo   AspNetRoles    Id   nvarchar  128  NOT NULL   Name   nvarchar  256  NOT NULL  CONSTRAINT  PK dbo AspNetRoles  PRIMARY KEY CLUSTERED       Id  ASC  WITH  PAD INDEX   OFF  STATISTICS NORECOMPUTE   OFF  IGNORE DUP KEY   OFF  ALLOW ROW LOCKS   ON  ALLOW PAGE LOCKS   ON  ON  PRIMARY    ON  PRIMARY   GO         Object   Table  dbo   AspNetUserClaims     Script Date  16-Aug-15 6 52 25 PM         SET ANSI NULLS ON GO SET QUOTED IDENTIFIER ON GO CREATE TABLE  dbo   AspNetUserClaims       Id   int  IDENTITY 1 1  NOT NULL      UserId   nvarchar  128  NOT NULL      ClaimType   nvarchar  max  NULL      ClaimValue   nvarchar  max  NULL  CONSTRAINT  PK dbo AspNetUserClaims  PRIMARY KEY CLUSTERED        Id  ASC  WITH  PAD INDEX   OFF  STATISTICS NORECOMPUTE   OFF  IGNORE DUP KEY   OFF  ALLOW ROW LOCKS   ON  ALLOW PAGE LOCKS   ON  ON  PRIMARY    ON  PRIMARY  TEXTIMAGE ON  PRIMARY   GO         Object   Table  dbo   AspNetUserLogins     Script Date  16-Aug-15 6 52 25 PM         SET ANSI NULLS ON GO SET QUOTED IDENTIFIER ON GO CREATE TABLE  dbo   AspNetUserLogins        LoginProvider   nvarchar  128  NOT NULL       ProviderKey   nvarchar  128  NOT NULL       UserId   nvarchar  128  NOT NULL  CONSTRAINT  PK dbo AspNetUserLogins  PRIMARY KEY CLUSTERED         LoginProvider  ASC       ProviderKey  ASC       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   GO         Object   Table  dbo   AspNetUserRoles     Script Date  16-Aug-15 6 52 25 PM         SET ANSI NULLS ON GO SET QUOTED IDENTIFIER ON GO CREATE TABLE  dbo   AspNetUserRoles       UserId   nvarchar  128  NOT NULL      RoleId   nvarchar  128  NOT NULL  CONSTRAINT  PK dbo AspNetUserRoles  PRIMARY KEY CLUSTERED         UserId  ASC       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   GO         Object   Table  dbo   AspNetUsers     Script Date  16-Aug-15 6 52 25 PM         SET ANSI NULLS ON GO SET QUOTED IDENTIFIER ON GO CREATE TABLE  dbo   AspNetUsers        Id   nvarchar  128  NOT NULL       Email   nvarchar  256  NULL       EmailConfirmed   bit  NOT NULL       PasswordHash   nvarchar  max  NULL       SecurityStamp   nvarchar  max  NULL       PhoneNumber   nvarchar  max  NULL       PhoneNumberConfirmed   bit  NOT NULL       TwoFactorEnabled   bit  NOT NULL       LockoutEndDateUtc   datetime  NULL       LockoutEnabled   bit  NOT NULL       AccessFailedCount   int  NOT NULL       UserName   nvarchar  256  NOT NULL  CONSTRAINT  PK dbo AspNetUsers  PRIMARY KEY CLUSTERED         Id  ASC  WITH  PAD INDEX   OFF  STATISTICS NORECOMPUTE   OFF  IGNORE DUP KEY   OFF  ALLOW ROW LOCKS   ON  ALLOW PAGE LOCKS   ON  ON  PRIMARY    ON  PRIMARY  TEXTIMAGE ON  PRIMARY    GO  ALTER TABLE  dbo   AspNetUserClaims   WITH CHECK ADD  CONSTRAINT  FK dbo AspNetUserClaims dbo AspNetUsers UserId  FOREIGN KEY  UserId    REFERENCES  dbo   AspNetUsers    Id    ON DELETE CASCADE  GO  ALTER TABLE  dbo   AspNetUserClaims  CHECK CONSTRAINT  FK dbo AspNetUserClaims dbo AspNetUsers UserId   GO  ALTER TABLE  dbo   AspNetUserLogins   WITH CHECK ADD  CONSTRAINT  FK dbo AspNetUserLogins dbo AspNetUsers UserId  FOREIGN KEY  UserId    REFERENCES  dbo   AspNetUsers    Id    ON DELETE CASCADE  GO  ALTER TABLE  dbo   AspNetUserLogins  CHECK CONSTRAINT  FK dbo AspNetUserLogins dbo AspNetUsers UserId   GO  ALTER TABLE  dbo   AspNetUserRoles   WITH CHECK ADD  CONSTRAINT  FK dbo AspNetUserRoles dbo AspNetRoles RoleId  FOREIGN KEY  RoleId    REFERENCES  dbo   AspNetRoles    Id    ON DELETE CASCADE  GO  ALTER TABLE  dbo   AspNetUserRoles  CHECK CONSTRAINT  FK dbo AspNetUserRoles dbo AspNetRoles RoleId   GO  ALTER TABLE  dbo   AspNetUserRoles   WITH CHECK ADD  CONSTRAINT  FK dbo AspNetUserRoles dbo AspNetUsers UserId  FOREIGN KEY  UserId    REFERENCES  dbo   AspNetUsers    Id    ON DELETE CASCADE  GO  ALTER TABLE  dbo   AspNetUserRoles  CHECK CONSTRAINT  FK dbo AspNetUserRoles dbo AspNetUsers UserId   GO  Check and solve any remaining errors and you are done  Identity will handle the rest

User · Answer

Configuring Identity to your existing project is not hard thing  You must install some NuGet package and do some small configuration   First install these NuGet packages with Package Manager Console   PM gt  Install-Package Microsoft AspNet Identity Owin  PM gt  Install-Package Microsoft AspNet Identity EntityFramework PM gt  Install-Package Microsoft Owin Host SystemWeb    Add a user class and with IdentityUser inheritance   public class AppUser   IdentityUser         add your custom properties which have not included in IdentityUser before     public string MyExtraProperty   get  set          Do same thing for role   public class AppRole   IdentityRole       public AppRole     base           public AppRole string name    base name             extra properties here      Change your DbContext parent from DbContext to IdentityDbContext lt AppUser gt  like this   public class MyDbContext   IdentityDbContext lt AppUser gt           Other part of codes still same         You don t need to add AppUser and AppRole         since automatically added by inheriting form IdentityDbContext lt AppUser gt      If you use the same connection string and enabled migration  EF will create necessary tables for you   Optionally  you could extend UserManager to add your desired configuration and customization   public class AppUserManager   UserManager lt AppUser gt        public AppUserManager IUserStore lt AppUser gt  store            base store                      this method is called by Owin therefore this is the best place to configure your User Manager     public static AppUserManager Create          IdentityFactoryOptions lt AppUserManager gt  options  IOwinContext context                var manager   new AppUserManager              new UserStore lt AppUser gt  context Get lt MyDbContext gt                   optionally configure your manager                         return manager            Since Identity is based on OWIN you need to configure OWIN too   Add a class to App Start folder  or anywhere else if you want   This class is used by OWIN  This will be your startup class   namespace MyAppNamespace       public class IdentityConfig               public void Configuration IAppBuilder app                        app CreatePerOwinContext      gt  new MyDbContext                 app CreatePerOwinContext lt AppUserManager gt  AppUserManager Create               app CreatePerOwinContext lt RoleManager lt AppRole gt  gt   options  context    gt                  new RoleManager lt AppRole gt                       new RoleStore lt AppRole gt  context Get lt MyDbContext gt                     app UseCookieAuthentication new CookieAuthenticationOptions                               AuthenticationType   DefaultAuthenticationTypes ApplicationCookie                  LoginPath   new PathString   Home Login                                        Almost done just add this line of code to your web config file so OWIN could find your startup class    lt appSettings gt       lt  -- other setting here -- gt       lt add key  owin AppStartup  value  MyAppNamespace IdentityConfig    gt   lt  appSettings gt    Now in entire project you could use Identity just like any new project had already installed by VS  Consider login action for example   HttpPost  public ActionResult Login LoginViewModel login        if  ModelState IsValid                var userManager   HttpContext GetOwinContext   GetUserManager lt AppUserManager gt             var authManager   HttpContext GetOwinContext   Authentication           AppUser user   userManager Find login UserName  login Password           if  user    null                        var ident   userManager CreateIdentity user                   DefaultAuthenticationTypes ApplicationCookie                 use the instance that has been created               authManager SignIn                  new AuthenticationProperties   IsPersistent   false    ident               return Redirect login ReturnUrl    Url Action  Index    Home                         ModelState AddModelError      Invalid username or password        return View login       You could make roles and add to your users   public ActionResult CreateRole string roleName        var roleManager HttpContext GetOwinContext   GetUserManager lt RoleManager lt AppRole gt  gt          if   roleManager RoleExists roleName           roleManager Create new AppRole roleName           rest of code      You could also add a role to a user  like this   UserManager AddToRole UserManager FindByName  username   Id   roleName      By using Authorize you could guard your actions or controllers    Authorize  public ActionResult MySecretAction        or    Authorize Roles    Admin     public ActionResult MySecretAction        You can also install additional packages and configure them to meet your requirement like Microsoft Owin Security Facebook or whichever you want     Note  Don t forget to add relevant namespaces to your files   using Microsoft AspNet Identity  using Microsoft Owin Security  using Microsoft AspNet Identity Owin  using Microsoft AspNet Identity EntityFramework  using Microsoft Owin  using Microsoft Owin Security Cookies  using Owin    You could also see my other answers like this and this for advanced use of Identity

[asp.net] Adding ASP.NET MVC5 Identity Authentication to an existing project

Overview

For more information, e.g.

Examples related to asp.net

Examples related to asp.net-mvc

Examples related to authentication

Examples related to asp.net-identity

Examples related to owin