As of 2017 MembershipReboot will no longer be maintained. It has served its purpose, and ASP.NET Identity has finally caught up (and surpassed) this library in terms of security and functionality. If you are interested in taking over maintenance, let me know.
What is MembershipReboot
MembershipReboot is a user identity management and authentication library. It has nothing to do with the ASP.NET Membership Provider, but was inspired by it due to frustrations with the built-in ASP.NET Membership system. The goals are to improve upon and provide missing features from ASP.NET Membership. It is designed to encapsulate the important security logic while leaving most of the other aspects of account management either configurable or extensible for application developers to customize as needed.
Some of the features of MembershipReboot are:
- single- or multi-tenant account management
- flexible account storage design (relational/SQL or object/NoSql)
- samples using both EF and RavenDB
- claims-aware user identities
- support for account registration, email verification, password reset, etc.
- account lockout for multiple failed login attempts (password guessing)
- extensible templating for email notifications
- customizable username, password and email validation
- notification system for account activity and updates (e.g. for auditing)
- account linking with external identity providers (enterprise or social)
- supports certificate based authentication
- proper password storage (via PBKDF2)
- configurable iterations
- defaults to OWASP recommendations for iterations (e.g. 64K in year 2012)
- two factor authentication support via mobile phone SMS messages or client certificates
The most common use case will be to integrate this into an ASP.NET or ASP.NET MVC application, though the library can also be used over a network as a service.
Getting Started with MembershipReboot
There is a core project (BrockAllen.MembershipReboot), two projects to implement the storage of the user account data (one uses EF, the other uses RavenDB), and a unit test project. There are also several sample applications demonstrating various use-cases. The best way to see MembershipReboot in action is to start with the SingleTenantWebApp from the samples folder.
MembershipReboot, Claims and Windows Identity Foundation (WIF)
MembershipReboot is intended to support modern identity management, thus it heavily uses claims and some related concepts based upon Windows Identity Foundation in .NET 4.5. If you need a primer before diving in, we suggest the following one-hour video by Dominick Baier:
The sample application's web.config shows proper configuration of WIF which includes both of the following:
<configSections> ... <section name="system.identityModel" type="System.IdentityModel.Configuration.SystemIdentityModelSection, System.IdentityModel, Version=22.214.171.124, Culture=neutral, PublicKeyToken=B77A5C561934E089" /> <section name="system.identityModel.services" type="System.IdentityModel.Services.Configuration.SystemIdentityModelServicesSection, System.IdentityModel.Services, Version=126.96.36.199, Culture=neutral, PublicKeyToken=B77A5C561934E089" /> </configSections>
<system.webServer> ... <modules> <add name="SessionAuthenticationModule" type="System.IdentityModel.Services.SessionAuthenticationModule, System.IdentityModel.Services, Version=188.8.131.52, Culture=neutral, PublicKeyToken=b77a5c561934e089" preCondition="managedHandler" /> </modules> </system.webServer>
MembershipReboot allows for some flexibility in how it manages user accounts via its SecuritySettings class. It has these properties:
- MultiTenant (bool)
- if the deployment is to support multi-tenant
- DefaultTenant (string)
- the default tenant to use if one is not provided in the various APIs
- EmailIsUsername (bool)
- is the identifier used for authentication intended to be an email address
- even in a multi-tenant scenario, usernames must be unique
- RequireAccountVerification (bool)
- requires a user's email address to be verified before then can login
- AllowLoginAfterAccountCreation (bool)
- can a user login after account creation, or must they be approved first
- AccountLockoutFailedLoginAttempts (integer)
- number of failed login attempts before the account is locked out
- AccountLockoutDuration (TimeSpan)
- duration an account is locked out when the AccountLockoutFailedLoginAttempts is met
- AllowAccountDeletion (bool)
- allow permanent account deletion in the database (or just use a "closed" flag)
- PasswordHashingIterationCount (integer)
- number of iterations used in password storage
- if not specified, then the OWASP recommondations are used (dynamically based upon the current year)
- PasswordResetFrequency (integer)
- frequency (in number of days) a user must change their password
These settings are configurable in a .config file or in code. See the samples for examples.
The default configuration uses the .NET SMTP configuration to send emails. To run the samples you must configure your own SMTP settings. Here is an example configuration for email to use the www.sendgrid.com service:
<system.net> <mailSettings> <smtp deliveryMethod="Network" from="email@example.com"> <network host="smtp.sendgrid.net" port="587" userName="mySendgridUsername" password="mySendgridUsername" enableSsl="true" /> </smtp> </mailSettings> </system.net>
TIP: If you are using Google mail, it is very easy to create multiple email addresses for testing. If your real email address is firstname.lastname@example.org then you can also use email@example.com or firstname.lastname@example.org and Google mail sends them all to email@example.com.
The samples use Entity Framework and SQL Server Compact. You don't need to and can configure your own repository (such as SQL Azure, or even a NoSql database). See the samples for an example.
There is preliminary documentation here.