3 |
3 |
4 |
5 | # Important Notice
6 |
7 | For new development, we encourage you to use the Verify API instead of the Authy API. The Verify API is an evolution of the Authy API with continued support for SMS, voice, and email one-time passcodes, an improved developer experience and new features.
8 |
9 | Please visit the [Verify Quickstarts Page](https://www.twilio.com/docs/verify/quickstarts) to get started with the Verify API. Thank you!
10 |
11 |
12 | # Two-Factor Authentication with ASP.NET Core and Authy
13 |
14 | 
15 |
16 | Here you will learn how to create a login system for ASP.NET Core applications secured with 2FA using Authy.
17 |
18 | [Learn more about this code in our docs](https://www.twilio.com/docs/authy/quickstart/dotnet-core-csharp-two-factor-authentication).
19 |
20 | ## Quickstart
21 |
22 |
23 | ### Create an Authy app
24 |
25 | Enable Authy in your [Twilio Account](https://www.twilio.com/authy/) if you don't
26 | have one already, and then connect it to your Twilio account.
27 |
28 | ### Local development
29 |
30 | This project is built using [.NET Core](https://www.microsoft.com/net/download), which will need to be installed before continuing.
31 |
32 | 1. First clone this repository and `cd` into it.
33 |
34 | ```bash
35 | git clone https://github.com/TwilioDevEd/account-security-csharp.git
36 | cd account-security-csharp
37 | ```
38 |
39 | 1. Install the dependencies.
40 |
41 | ```bash
42 | cd src/AccountSecurity
43 | dotnet restore
44 | ```
45 | #### MSSQL Server
46 |
47 | You can either install it or run it in a docker container.
48 |
49 | - [Install MSSQL Server Express](https://www.microsoft.com/en-us/sql-server/sql-server-editions-express)
50 |
51 | - Run in a docker container:
52 |
53 | `docker run -e 'ACCEPT_EULA=Y' -e 'SA_PASSWORD=yourStrong(!)Password' -p 1433:1433 --name mssql -d microsoft/mssql-server-linux:latest`
54 |
55 | 1. Make sure your `DefaultConnection` connection string is correct for your SQL Server installation. (You may need to change the `Server` to `localhost\\SQLEXPRESS` if running MSSQL Server Express on Windows.)
56 |
57 | 1. Install the Entity Framework tool:
58 | ```bash
59 | dotnet tool install --global dotnet-ef --version 3.1.4
60 | ```
61 |
62 | 1. Run the database migrations:
63 |
64 | ```bash
65 | dotnet ef database update -v
66 | ```
67 |
68 | 1. Set your Authy App API Key in your `appsettings.json` as `AuthyApiKey` which should be found under your [Authy App Settings](https://www.twilio.com/console/authy/applications).
69 |
70 | 1. Run the server.
71 |
72 | ```bash
73 | dotnet run --environment development
74 | ```
75 |
76 | 1. Expose your application to the wider internet using [ngrok](http://ngrok.com). You can click
77 | [here](https://www.twilio.com/blog/2015/09/6-awesome-reasons-to-use-ngrok-when-testing-webhooks.html) for more details. This step
78 | is important because the application won't work as expected if you run it through localhost.
79 |
80 | ```bash
81 | ngrok http 5000
82 | ```
83 |
84 | Once ngrok is running, open up your browser and go to your ngrok URL.
85 | It will look something like this: `http://9a159ccf.ngrok.io`
86 |
87 | ## Meta
88 |
89 | * No warranty expressed or implied. Software is as is.
90 | * [MIT License](http://www.opensource.org/licenses/mit-license.html)
91 | * Lovingly crafted by Twilio Developer Education.
92 |
--------------------------------------------------------------------------------
/src/AccountSecurity/AccountSecurity.csproj:
--------------------------------------------------------------------------------
1 |