daohualiuxiang
/
AspNetCore.Docs
mirror of https://github.com/dotnet/AspNetCore.Docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
AspNetCore.Docs/aspnet/identity/overview/features-api/two-factor-authentication-u...

21 KiB
Raw Blame History

uid title author description ms.author ms.date ms.assetid msc.legacyurl msc.type
identity/overview/features-api/two-factor-authentication-using-sms-and-email-with-aspnet-identity Two-factor authentication using SMS and email with ASP.NET Identity | Microsoft Docs HaoK This tutorial will show you how to set up Two-factor authentication (2FA) using SMS and email. This article was written by Rick Anderson ( @RickAndMSFT ), Pr... aspnetcontent 09/15/2015 053e23c4-13c9-40fa-87cb-3e9b0823b31e /identity/overview/features-api/two-factor-authentication-using-sms-and-email-with-aspnet-identity authoredcontent

Two-factor authentication using SMS and email with ASP.NET Identity

by Hao Kung, Pranav Rastogi, Rick Anderson, Suhas Joshi

This tutorial will show you how to set up Two-factor authentication (2FA) using SMS and email.

This article was written by Rick Anderson (@RickAndMSFT), Pranav Rastogi (@rustd), Hao Kung, and Suhas Joshi. The NuGet sample was written primarily by Hao Kung.

This topic covers the following:

Building the Identity sample

In this section, you'll use NuGet to download a sample we will work with. Start by installing and running Visual Studio Express 2013 for Web or Visual Studio 2013. Install Visual Studio 2013 Update 2 or higher.

[!NOTE] Warning: You must install Visual Studio 2013 Update 2 to complete this tutorial.

  1. Create a new empty ASP.NET Web project.

  2. In the Package Manager Console, enter the following the following commands:

    Install-Package SendGrid
    Install-Package -Prerelease Microsoft.AspNet.Identity.Samples

    In this tutorial, we'll use SendGrid to send email and Twilio or ASPSMS for sms texting. The Identity.Samples package installs the code we will be working with.

  3. Set the project to use SSL.

  4. Optional: Follow the instructions in my Email confirmation tutorial to hook up SendGrid and then run the app and register an email account.

  5. *Optional: *Remove the demo email link confirmation code from the sample (The ViewBag.Link code in the account controller. See the DisplayEmail and ForgotPasswordConfirmation action methods and razor views ).

  6. Optional: *Remove the ViewBag.Status code from the Manage and Account controllers and from the *Views\Account\VerifyCode.cshtml and Views\Manage\VerifyPhoneNumber.cshtml razor views. Alternatively, you can keep the ViewBag.Status display to test how this app works locally without having to hook up and send email and SMS messages.

[!NOTE] Warning: If you change any of the security settings in this sample, productions apps will need to undergo a security audit that explicitly calls out the changes made.

Set up SMS for Two-factor authentication

This tutorial provides instructions for using either Twilio or ASPSMS but you can use any other SMS provider.

  1. Creating a User Account with an SMS provider

    Create a Twilio or an ASPSMS account.

  2. Installing additional packages or adding service references

    Twilio:
    In the Package Manager Console, enter the following command:
    Install-Package Twilio

    ASPSMS:
    The following service reference needs to be added:

    Address:
    https://webservice.aspsms.com/aspsmsx2.asmx?WSDL

    Namespace:
    ASPSMSX2

  3. Figuring out SMS Provider User credentials

    Twilio:
    From the Dashboard tab of your Twilio account, copy the Account SID and Auth token.

    ASPSMS:
    From your account settings, navigate to Userkey and copy it together with your self-defined Password.

    We will later store these values in the variables SMSAccountIdentification and SMSAccountPassword .

  4. Specifying SenderID / Originator

    Twilio:
    From the Numbers tab, copy your Twilio phone number.

    ASPSMS:
    Within the Unlock Originators Menu, unlock one or more Originators or choose an alphanumeric Originator (Not supported by all networks).

    We will later store this value in the variable SMSAccountFrom .

  5. Transferring SMS provider credentials into app

    Make the credentials and sender phone number available to the app:

    [!code-csharpMain]

    [!WARNING] Security - Never store sensitive data in your source code. The account and credentials are added to the code above to keep the sample simple. See Jon Atten's ASP.NET MVC: Keep Private Settings Out of Source Control.

  6. Implementation of data transfer to SMS provider

    Configure the SmsService class in the App_Start\IdentityConfig.cs file.

    Depending on the used SMS provider activate either the Twilio or the ASPSMS section:

    [!code-csharpMain]

  7. Run the app and log in with the account you previously registered.

  8. Click on your User ID, which activates the Index action method in Manage controller.

  9. Click Add.

  10. In a few seconds you will get a text message with the verification code. Enter it and press Submit.

  11. The Manage view shows your phone number was added.

Examine the code

[!code-csharpMain]

The Index action method in Manage controller sets the status message based on your previous action and provides links to change your local password or add a local account. The Index method also displays the state or your 2FA phone number, external logins, 2FA enabled, and remember 2FA method for this browser(explained later). Clicking on your user ID (email) in the title bar doesn't pass a message. Clicking on the Phone Number : remove link passes Message=RemovePhoneSuccess as a query string.

https://localhost:44300/Manage?Message=RemovePhoneSuccess

[]

The AddPhoneNumber action method displays a dialog box to enter a phone number that can receive SMS messages.

[!code-csharpMain]

Clicking on the Send verification code button posts the phone number to the HTTP POST AddPhoneNumber action method.

[!code-csharpMain]

The GenerateChangePhoneNumberTokenAsync method generates the security token which will be set in the SMS message. If the SMS service has been configured, the token is sent as the string "Your security code is <token>". The SmsService.SendAsync method to is called asynchronously, then the app is redirected to the VerifyPhoneNumber action method (which displays the following dialog), where you can enter the verification code.

Once you enter the code and click submit, the code is posted to the HTTP POST VerifyPhoneNumber action method.

[!code-csharpMain]

The ChangePhoneNumberAsync method checks the posted security code. If the code is correct, the phone number is added to the PhoneNumber field of the AspNetUsers table. If that call is successful, the SignInAsync method is called:

[!code-csharpMain]

The isPersistent parameter sets whether the authentication session is persisted across multiple requests.

When you change your security profile, a new security stamp is generated and stored in the SecurityStamp field of the AspNetUsers table. Note, the SecurityStamp field is different from the security cookie. The security cookie is not stored in the AspNetUsers table (or anywhere else in the Identity DB). The security cookie token is self-signed using DPAPI and is created with the UserId, SecurityStamp and expiration time information.

The cookie middleware checks the cookie on each request. The SecurityStampValidator method in the Startup class hits the DB and checks security stamp periodically, as specified with the validateInterval. This only happens every 30 minutes (in our sample) unless you change your security profile. The 30 minute interval was chosen to minimize trips to the database.

The SignInAsync method needs to be called when any change is made to the security profile. When the security profile changes, the database is updates the SecurityStamp field, and without calling the SignInAsync method you would stay logged in only until the next time the OWIN pipeline hits the database (the validateInterval). You can test this by changing the SignInAsync method to return immediately, and setting the cookie validateInterval property from 30 minutes to 5 seconds:

[!code-csharpMain]

[!code-csharpMain]

With the above code changes, you can change your security profile (for example, by changing the state of Two Factor Enabled) and you will be logged out in 5 seconds when the SecurityStampValidator.OnValidateIdentity method fails. Remove the return line in the SignInAsync method, make another security profile change and you will not be logged out. The SignInAsync method generates a new security cookie.

Enable two-factor authentication

In the sample app, you need to use the UI to enable two-factor authentication (2FA). To enable 2FA, click on your user ID (email alias) in the navigation bar.
Click on enable 2FA. Log out, then log back in. If you've enabled email (see my previous tutorial), you can select the SMS or email for 2FA. The Verify Code page is displayed where you can enter the code (from SMS or email). Clicking on the Remember this browser check box will exempt you from needing to use 2FA to log on with that computer and browser. Enabling 2FA and clicking on the Remember this browser will provide you with strong 2FA protection from malicious users trying to access your account, as long as they don't have access to your computer. You can do this on any private machine you regularly use. By setting Remember this browser, you get the added security of 2FA from computers you don't regularly use, and you get the convenience on not having to go through 2FA on your own computers.

How to register a Two-factor authentication provider

When you create a new MVC project, the IdentityConfig.cs file contains the following code to register a Two-factor authentication provider:

[!code-csharpMain]

Add a phone number for 2FA

The AddPhoneNumber action method in the Manage controller generates a security token and sends it to the phone number you have provided.

[!code-csharpMain]

After sending the token, it redirects to the VerifyPhoneNumber action method, where you can enter the code to register SMS for 2FA. SMS 2FA is not used until you have verified the phone number.

Enabling 2FA

The EnableTFA action method enables 2FA:

[!code-csharpMain]

Note the SignInAsync must be called because enable 2FA is a change to the security profile. When 2FA is enabled, the user will need to use 2FA to log in, using the 2FA approaches they have registered (SMS and email in the sample).

You can add more 2FA providers such as QR code generators or you can write you own (See Using Google Authenticator with ASP.NET Identity).

[!NOTE] The 2FA codes are generated using Time-based One-time Password Algorithm and codes are valid for six minutes. If you take more than six minutes to enter the code, you'll get an Invalid code error message.

Combine social and local login accounts

You can combine local and social accounts by clicking on your email link. In the following sequence "RickAndMSFT@gmail.com" is first created as a local login, but you can create the account as a social log in first, then add a local login.

Click on the Manage link. Note the 0 external (social logins) associated with this account.

Click the link to another log in service and accept the app requests. The two accounts have been combined, you will be able to log on with either account. You might want your users to add local accounts in case their social log in authentication service is down, or more likely they have lost access to their social account.

In the following image, Tom is a social log in (which you can see from the External Logins: 1 shown on the page).

Clicking on Pick a password allows you to add a local log on associated with the same account.

Account lockout from brute force attacks

You can protect the accounts on your app from dictionary attacks by enabling user lockout. The following code in the ApplicationUserManager Create method configures lock out:

[!code-csharpMain]

The code above enables lockout for two factor authentication only. While you can enable lock out for logins by changing shouldLockout to true in the Login method of the account controller, we recommend you not enable lock out for logins because it makes the account susceptible to DOS login attacks. In the sample code, lockout is disabled for the admin account created in the ApplicationDbInitializer Seed method:

[!code-csharpMain]

Requiring a user to have a validated email account

The following code requires a user to have a validated email account before they can log in:

[!code-csharpMain]

How SignInManager checks for 2FA requirement

Both the local log in and social log in check to see if 2FA is enabled. If 2FA is enabled, the SignInManager logon method returns SignInStatus.RequiresVerification, and the user will be redirected to the SendCode action method, where they will have to enter the code to complete the log in sequence. If the user has RememberMe is set on the users local cookie, the SignInManager will return SignInStatus.Success and they will not have to go through 2FA.

[!code-csharpMain]

[!code-csharpMain]

The following code shows the SendCode action method. A SelectListItem is created with all the 2FA methods enabled for the user. The SelectListItem is passed to the DropDownListFor helper, which allows the user to select the 2FA approach (typically email and SMS).

[!code-csharpMain]

Once the user posts the 2FA approach, the HTTP POST SendCode action method is called, the SignInManager sends the 2FA code, and the user is redirected to the VerifyCode action method where they can enter the code to complete the log in.

[!code-csharpMain]

2FA Lockout

Although you can set account lockout on login password attempt failures, that approach makes your login susceptible to DOS lockouts. We recommend you use account lockout only with 2FA. When the ApplicationUserManager is created, the sample code sets 2FA lockout and MaxFailedAccessAttemptsBeforeLockout to five. Once a user logs in (through local account or social account), each failed attempt at 2FA is stored, and if the maximum attempts is reached, the user is locked out for five minutes (you can set the lock out time with DefaultAccountLockoutTimeSpan).

Additional Resources