Announcing RTM of ASP.NET Identity 2.0.0

Today, we are releasing the final version of ASP.NET Identity 2.0. The main focus in this release was to add security and account management features as well as address feedback from the community.

Download this release

You can download ASP.NET Identity from the NuGet gallery. You can install or update to these packages through NuGet using the NuGet Package Manager Console, like this:

What’s in this release?

Following is the list of features and major issues that were fixed in 2.0.0.

Two-Factor Authentication

ASP.NET Identity now support two-factor authentication. Two-factor authentication provides an extra layer of security to your user accounts in the case where your password gets compromised. Most  websites protect their data by having a user create an account on their website with a username and password. Passwords are not very secure and sometimes users choose weak passwords which can lead to user accounts being compromised.

SMS is the preferred way of sending codes but you can also use email in case the user does not have access to their phone. You can extend and write your own providers such as QR code generators and use Authenticator apps on phones to validate them.

There is also protection for brute force attacks against the two factor codes. If a user enters incorrect codes for a specified amount of time then the user account will be locked out for a specified amount of time. These values are configurable.

To try out this feature, you can install ASP.NET Identity Samples NuGet package (in an Empty ASP.NET app) and follow the steps to configure and run the project.

Account Lockout

Provide a way to Lockout out the user if the user enters their password or two-factor codes incorrectly. The number of invalid attempts and the timespan for the users are locked out can be configured.  A developer can optionally turn off Account Lockout for certain user accounts should they need to.

Account Confirmation

The ASP.NET Identity system now supports Account Confirmation by confirming the email of the user. This is a fairly common scenario in most websites today where when you register for a new account on the website, you are required to confirm your email before you could do anything in the website. Email Confirmation is useful because it prevents bogus accounts from being created. This is extremely useful if you are using email as a method of communicating with the users of your website such as Forum sites, banking, ecommerce, social web sites.

Note: To send emails you can configure SMTP Server or use some of the popular email services such as SendGrid (http://sendgrid.com/windowsazure.html) which integrate nicely with Windows Azure and require no configuration on the application developer

In the sample project below, you need to hook up the Email service for sending emails. You will not be able to reset your password until you confirm your account

Password Reset

Password Reset is a feature where the user can reset their passwords if they have forgotten their password.

Security Stamp (Sign out everywhere)

Support a way to regenerate the Security Stamp for the user in cases when the User changes their password or any other security related information such as removing an associated login(such as Facebook, Google, Microsoft Account etc). This is needed to ensure that any tokens (cookies) generated with the old password are invalidated. In the sample project, if you change the users password then a new token is generated for the user and any previous tokens are invalidated.

This feature provides an extra layer of security to your application since when you change your password, you will be logged out where you have logged into this application. You can also extend this to Sign out from all places where you have logged in from. This sample shows how to do it.

You can configure this in Startup.Auth.cs by registering a CookieAuthenticationProvider as follows.

Code Snippet
  1. app.UseCookieAuthentication(newCookieAuthenticationOptions {
  2.                 AuthenticationType = DefaultAuthenticationTypes.ApplicationCookie,
  3.                 LoginPath = newPathString(“/Account/Login”),
  4.                 Provider = newCookieAuthenticationProvider {
  5.                     // Enables the application to validate the security stamp when the user logs in.
  6.                     // This is a security feature which is used when you change a password or add an external login to your account. 
  7.                     OnValidateIdentity = SecurityStampValidator.OnValidateIdentity<ApplicationUserManager, ApplicationUser>(
  8.                         validateInterval: TimeSpan.FromMinutes(30),
  9.                         regenerateIdentity: (manager, user) => user.GenerateUserIdentityAsync(manager))
  10.                 }
  11.             });

Make the type of Primary Key be extensible for Users and Roles

In 1.0 the type of PK for Users and Roles was strings. This means when the ASP.NET Identity system was persisted in Sql Server using Entity Framework, we were using nvarchar. There were lots of discussions around this default implementation on Stack Overflow and based on the incoming feedback, we have provided an extensibility hook where you can specify what should be the PK of your Users and Roles table. This extensibility hook is particularly useful if you are migrating your application and the application was storing UserIds are GUIDs or ints.

Since you are changing the type of PK for Users and Roles, you need to plug in the corresponding classes for Claims, Logins which take in the correct PK. Following is a snippet of code which shows how you can change the PK to be int

For a full working sample please see https://aspnet.codeplex.com/SourceControl/latest#Samples/Identity/ChangePK/readme.txt

 

Code Snippet
  1.  
  2. publicclassApplicationUser : IdentityUser<int, CustomUserLogin, CustomUserRole, CustomUserClaim>
  3. {
  4. }
  5.  
  6. publicclassCustomRole : IdentityRole<int, CustomUserRole>
  7. {
  8.     public CustomRole() { }
  9.     public CustomRole(string name) { Name = name; }
  10. }
  11.  
  12. publicclassCustomUserRole : IdentityUserRole<int> { }
  13. publicclassCustomUserClaim : IdentityUserClaim<int> { }
  14. publicclassCustomUserLogin : IdentityUserLogin<int> { }
  15.  
  16. publicclassApplicationDbContext : IdentityDbContext<ApplicationUser, CustomRole, int, CustomUserLogin, CustomUserRole, CustomUserClaim>
  17. {
  18. }

 

 

Support IQueryable on Users and Roles

We have added support for IQueryable on UsersStore and RolesStore so you can easily get the list of Users and Roles.

For eg. the following code uses the IQueryable  and shows how you can get the list of Users from UserManager. You can do the same for getting list of Roles from RoleManager

 

Code Snippet
  1.  
  2. // GET: /Users/
  3. publicasyncTask<ActionResult> Index()
  4. {
  5.     return View(await UserManager.Users.ToListAsync());
  6. }

Delete User account

In 1.0, if you had to delete a User, you could not do it through the UserManager. We have fixed this issue in this release so you can do the following to delete a user

Code Snippet
  1. var result = await UserManager.DeleteAsync(user);

IdentityFactory Middleware/ CreatePerOwinContext

UserManager

You can use Factory implementation to get an instance of UserManager from the OWIN context. This pattern is similar to what we use for getting AuthenticationManager from OWIN context for SignIn and SignOut. This is a recommended way of getting an instance of UserManager per request for the application.

Following snippet of code shows how you can configure this middleware in StartupAuth.cs. This is in the sample project listed below.

 

Code Snippet
  1.  
  2. app.CreatePerOwinContext<ApplicationUserManager>(ApplicationUserManager.Create);

Following snippet of code shows how you can get an instance of UserManager

Code Snippet
  1. HttpContext.GetOwinContext().GetUserManager<ApplicationUserManager>();

DbContext

ASP.NET Identity uses EntityFramework for persisting the Identity system in Sql Server. To do this the Identity System has a reference to the ApplicationDbContext. The DbContextFactory Middleware returns you an instance of the ApplicationDbContext per request which you can use in your application.

Following code shows how you can configure it in StartupAuth.cs. The code for this middleware is in the sample project.

Code Snippet
  1. app.CreatePerOwinContext(ApplicationDbContext.Create);

Indexing on Username

In ASP.NET Identity Entity Framework implementation, we have added a unique index on the Username using the new IndexAttribute in EF 6.1.0. We did this to ensure that Usernames are always unique and there was no race condition in which you could end up with duplicate usernames.

Enhanced Password Validator

The password validator that was shipped in ASP.NET Identity 1.0 was a fairly basic password validator which was only validating the minimum length. There is a new password validator which gives you more control over the complexity of the password. Please note that even if you turn on all the settings in this password, we do encourage you to enable two-factor authentication for the user accounts.

Code Snippet
  1. // Configure validation logic for passwords
  2.             manager.PasswordValidator = new PasswordValidator
  3.             {
  4.                 RequiredLength = 6,
  5.                 RequireNonLetterOrDigit = true,
  6.                 RequireDigit = true,
  7.                 RequireLowercase = true,
  8.                 RequireUppercase = true,
  9.             };

You can also add Password policies as per your own requirements. The following sample shows you how you can extend Identity for this scenario. https://aspnet.codeplex.com/SourceControl/latest#Samples/Identity/Identity-PasswordPolicy/Identity-PasswordPolicy/Readme.txt

ASP.NET Identity Samples NuGet package

We are releasing a Samples NuGet package to make it easier to install samples for ASP.NET Identity. This is a sample ASP.NET MVC application. Please modify the code to suit your application before you deploy this in production. The sample should be installed in an Empty ASP.NET application.

Following are the features in this samples package

    • Initialize ASP.NET Identity to create an Admin user and Admin role.
      • Since ASP.NET Identity is Entity Framework based in this sample, you can use the existing methods of initializing the database as you would have done in EF.
    • Configure user and password validation.
    • Register a user and login using username and password
    • Login using a social account such as Facebook, Twitter, Google, Microsoft account etc.
    • Basic User management
      • Do Create, Update, List and Delete Users. Assign a Role to a new user.
    • Basic Role management
      • Do Create, Update, List and Delete Roles.
    • Account Confirmation by confirming email.
    • Password Reset
    • Two-Factor authentication
    • Account Lockout
    • Security Stamp (Sign out everywhere)
    • Configure the Db context, UserManager and RoleManager  using IdentityFactory Middleware/ PerOwinContext.
    • The AccountController has been split into Account and Manage controller. This was done to simplify the account management code.

The