Using ADO.NET Implementation of ASP.NET Identity 2 for MySQL

In This Topic

ASP.NET Identity is a new system of user authentication and authorization, that continues the evolution of ASP.NET membership system, and is used in the Visual Studio 2013 Update 2 project templates for ASP.NET MVC, Web Forms, Web API and SPA. You can read more on ASP.NET Identity in Microsoft documentation.

dotConnect for MySQL enables you to employ an implementation of ASP.NET Identity for MySQL database using either ADO.NET or Entity Framework functionality in your web applications. This allows you to use such ASP.NET Identity benefits as unit-testable user authentication system, social login support, OWIN integration, etc. This tutorial demonstrates creating an ADO.NET implementation of ASP.NET Identity.

To complete this tutorial you need Visual Studio 2013 Update 2 or higher. For Visual Studio 2013 or Visual Studio 2013 Update 1 see Using ADO.NET Implementation of ASP.NET Identity 1 for MySQL.

In order to create an ASP.NET MVC 5 application using dotConnect for MySQL for storing identity information, perform the following steps:

In the Add New Project dialog box expand Visual C# on the left, then Web, and then select ASP.NET Web Application. Name your project, for example, "AspNet_Identity_Application" and then click OK.
In the New ASP.NET Project dialog box, select the MVC template with the default options (that includes Individual User Accounts as authentication method) and click OK.
In Solution Explorer, right-click your project and select Manage NuGet Packages from the shortcut menu. In the search text box dialog, type "Identity.EntityFramework". Select this package in the list of results and click Uninstall. You will be prompted to uninstall the dependency package EntityFramework. For Visual Studio 2013 Update 2 click Yes. For Visual Studio 2013 Update 3 or higher click No.
Add references to the necessary dotConnect for MySQL assemblies:
- Devart.Data.dll
- Devart.Data.MySql.dll
- Devart.Data.MySql.Web.Identity.dll
For ASP.NET Identity 2 you need to add the reference to the Devart.Data.MySql.Web.Identity.dll, having the revision number 2, and installed to the Program Files\Devart\dotConnect\MySQL\Web\ASP.NET Identity 2 folder

When creating an ASP.NET application, using ASP.NET Identity, you can use the existing ASP.NET Identity functionality as is or customize this functionality. For example, you may add storing some custom information about the user. In our tutorial we will demonstrate both options.

Using Existing ASP.NET Identity Functionality

First, you need to create a schema that will store information about users. To do it, execute the Install_identity_tables.sql script, which goes with dotConnect for MySQL. By default, this script is in the Program Files\Devart\dotConnect\MySQL\Web\ASP.NET Identity 2 folder. You can also copy this script from the Identity Database Script chapter of this topic. You may use any tool to execute this script, for example phpMyAdmin or dbForge Fusion for MySQL. After this perform the following steps:

In the Models project folder open the IdentityModels.cs (or IdentityModels.vb for Visual Basic) file. that is in the Models folder, from the project.

Replace the file contents with

using System.Security.Claims;
using System.Threading.Tasks;
using Microsoft.AspNet.Identity;
using Devart.Common.Web.Identity;
using Devart.Data.MySql.Web.Identity;
using ApplicationUser = Devart.Common.Web.Identity.IdentityUser;

namespace AspNet_Identity_Application.Models
{
    public static class ApplicationUserExtensions
    {
        public static async Task<ClaimsIdentity> GenerateUserIdentityAsync(this ApplicationUser user, UserManager<ApplicationUser> manager)
        {
            // Note the authenticationType must match the one defined in CookieAuthenticationOptions.AuthenticationType
            var userIdentity = await manager.CreateIdentityAsync(user, DefaultAuthenticationTypes.ApplicationCookie);
            // Add custom user claims here
            return userIdentity;
        }
    }
}

Visual Basic



Imports System.Security.Claims
Imports System.Threading.Tasks
Imports Microsoft.AspNet.Identity
Imports Devart.Common.Web.Identity
Imports Devart.Data.MySql.Web.Identity
Imports ApplicationUser = Devart.Common.Web.Identity.IdentityUser

Public Module ApplicationUserExtensions
    <System.Runtime.CompilerServices.Extension> _
    Public Async Function GenerateUserIdentityAsync(user As ApplicationUser, manager As UserManager(Of ApplicationUser)) As Task(Of ClaimsIdentity)
        ' Note the authenticationType must match the one defined in CookieAuthenticationOptions.AuthenticationType
        Dim userIdentity = Await manager.CreateIdentityAsync(user, DefaultAuthenticationTypes.ApplicationCookie)
        ' Add custom user claims here
        Return userIdentity
    End Function
End Module

Note that if you have specified the name for the application other than "AspNet_Identity_Application", you must use the corresponding namespace name in the code above instead of "AspNet_Identity_Application".

In the Controllers project folder open the AccountController.cs (or AccountController.vb for Visual Basic) file.

If you use Visual Studio 2013 Update 2, replace

with:

If you use Visual Studio 2013 Update 3 or higher, there is no such line, just add the above code to the beginning of the file.

In the App_Start project folder open the IdentityConfig.cs (or IdentityConfig.vb for Visual Basic) file.

Replace

with:

Replace the following line in the Create method:

with:

In the App_Start project folder open the Startup.Auth.cs (or Startup.Auth.vb for Visual Basic) file.

If you use Visual Studio 2013 Update 2, replace

with:

If you use Visual Studio 2013 Update 3 or higher, there is no such line, just add the above code to the beginning of the file.

Delete the following line:

For Visual Studio 2013 Update 3 or higher only - in the Controllers project folder open the ManageController.cs (or ManageController.vb for Visual Basic) file. Add the following code to the beginning of the file:

In the web.config file of your project, replace the default connection string with your MySQL one.

<add name="DefaultConnection" connectionString="User Id=root;Host=localhost;Database=Test;" providerName="Devart.Data.MySql" />

Extending ASP.NET Identity Functionality

Checking Application

Now we can run our application and check if everything works correctly.

Run the application by pressing CTRL+F5.
Switch to the Register tab on the top of the page.

For an example with extended ASP.NET Identity functionality the page looks like the following:
Enter a new user name and password (and email - if you have created an example with extended ASP.NET Identity functionality) to the corresponding boxes and click the Register button.
The new user is now registered and logged in.
After this you may use an appropriate database tool to connect to the database where the user data is stored and verify that the data is stored correctly.

Identity Database Script



CREATE TABLE AspNetRoles ( 
  Id varchar(128) NOT NULL,
  Name varchar(166) NOT NULL,
  PRIMARY KEY (Id)
);

CREATE TABLE AspNetUserRoles ( 
  UserId varchar(128) NOT NULL,
  RoleId varchar(128) NOT NULL,
  PRIMARY KEY (UserId, RoleId)
);

CREATE TABLE AspNetUsers ( 
  Id varchar(128) NOT NULL,
  Email varchar(256) NULL,
  EmailConfirmed bit(1) NOT NULL,
  PasswordHash varchar(256) NULL,
  SecurityStamp varchar(256) NULL,
  PhoneNumber varchar(256) NULL,
  PhoneNumberConfirmed bit(1) NOT NULL,
  TwoFactorEnabled bit(1) NOT NULL,
  LockoutEndDateUtc datetime NULL,
  LockoutEnabled bit(1) NOT NULL,
  AccessFailedCount int NOT NULL,
  UserName varchar(166) NOT NULL,
  PRIMARY KEY (Id)
);

CREATE TABLE AspNetUserClaims ( 
  Id int AUTO_INCREMENT UNIQUE NOT NULL,
  UserId varchar(128) NOT NULL,
  ClaimType varchar(256) NULL,
  ClaimValue varchar(256) NULL,
  PRIMARY KEY (Id)
);

CREATE TABLE AspNetUserLogins ( 
  LoginProvider varchar(128) NOT NULL,
  ProviderKey varchar(128) NOT NULL,
  UserId varchar(128) NOT NULL,
  PRIMARY KEY (LoginProvider, ProviderKey, UserId)
);

CREATE UNIQUE INDEX RoleNameIndex ON AspNetRoles (Name);

CREATE INDEX IX_AspNetUserRoles_UserId ON AspNetUserRoles (UserId);

CREATE INDEX IX_AspNetUserRoles_RoleId ON AspNetUserRoles (RoleId);

CREATE UNIQUE INDEX UserNameIndex ON AspNetUsers (UserName);

CREATE INDEX IX_AspNetUserClaims_UserId ON AspNetUserClaims (UserId);

CREATE INDEX IX_AspNetUserLogins_UserId ON AspNetUserLogins (UserId);

ALTER TABLE AspNetUserRoles
  ADD CONSTRAINT FK_AspNetUserRoles_AspNetRoles_RoleId FOREIGN KEY (RoleId) REFERENCES AspNetRoles (Id)
  ON DELETE CASCADE ON UPDATE NO ACTION;

ALTER TABLE AspNetUserRoles
  ADD CONSTRAINT FK_AspNetUserRoles_AspNetUsers_UserId FOREIGN KEY (UserId) REFERENCES AspNetUsers (Id)
  ON DELETE CASCADE ON UPDATE NO ACTION;

ALTER TABLE AspNetUserClaims
  ADD CONSTRAINT FK_AspNetUserClaims_AspNetUsers_UserId FOREIGN KEY (UserId) REFERENCES AspNetUsers (Id)
  ON DELETE CASCADE ON UPDATE NO ACTION;

ALTER TABLE AspNetUserLogins
  ADD CONSTRAINT FK_AspNetUserLogins_AspNetUsers_UserId FOREIGN KEY (UserId) REFERENCES AspNetUsers (Id)
  ON DELETE CASCADE ON UPDATE NO ACTION;

Using Existing ASP.NET Identity Functionality

Extending ASP.NET Identity Functionality

Checking Application

Identity Database Script

See Also