Skip to content

Commit 9fdd589

Browse files
authored
Merge pull request #259 from aspnetzero/pr/4681
Update two factor authentication docs
2 parents d7c0003 + 5ad7830 commit 9fdd589

10 files changed

+52
-6
lines changed

docs/en/Features-Angular-Two-Factor-Authentication.md

+26-3
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,17 @@
22

33
ASP.NET Zero is ready to provide two factor login, but it's disabled as default. You can easily enable it in host settings page (in Security tab):
44

5-
<img src="images/lockout-two-factor-settings-1.png" class="img-thumbnail" />
5+
![Two factor settings](images/lockout-two-factor-settings-2.png)
66

77
Note: In a multi-tenant application, two factor authentication is available to tenants only if it's enabled in the host settings. Also, email verification and SMS verification settings are only available in the host side. This is by design.
88

99
When it's enabled, user is asked to select a verification provider after entering user name and password:
1010

11-
<img src="images/send-security-code-1.png" alt="Send security code" class="img-thumbnail" />
11+
![Send security code](images/send-security-code-2.png)
1212

1313
Then a **confirmation code** is sent to the selected provider and user enters the code in the next page:
1414

15-
<img src="images/verify-security-code-1.png" alt="Verify security code" class="thumbnail" />
15+
![Verify security code](images/verify-security-code-2.png)
1616

1717
## Email Verification
1818

@@ -42,6 +42,29 @@ In that case, you need to configure ASP.NET Zero to use your custom implementati
4242
Configuration.ReplaceService<ISmsSender,CustomSmsSender>();
4343
```
4444

45+
## Authenticator Verification
46+
47+
This is available if user has enabled two factor authentication in his/her profile. You can enable it in profile page:
48+
49+
![Enable two factor authenticator app](images/enable-authenticator.png)
50+
51+
Then user can scan the QR code with an authenticator app (like Google Authenticator) and enter the code in the next page:
52+
53+
![Authenticator verification](images/authenticator-verification.png)
54+
55+
56+
Then user can see his/her recovery codes:
57+
58+
![Authenticator recovery codes](images/authenticator-recovery-codes.png)
59+
60+
That's it. Now user use authenticator app to verify himself/herself.
61+
62+
![Authenticator enabled](images/authenticator-enabled.png)
63+
64+
You can also disable two factor authentication and view the recovery codes again:
65+
66+
![Disable two factor authenticator app](images/disable-authenticator.png)
67+
4568
### Twilio Integration
4669

4770
In order to enable Twilio integration, just uncomment the following line in your **{YourProjectName}CoreModule** (in your Core project):

docs/en/Features-Mvc-Core-Two-Factor-Authentication.md

+26-3
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,17 @@
22

33
ASP.NET Zero is ready to provide two factor login, but it's disabled as default. You can easily enable it in host settings page in security tab:
44

5-
<img src="images/lockout-two-factor-settings-1.png" class="img-thumbnail" />
5+
![Two factor settings](images/lockout-two-factor-settings-2.png)
66

77
Note: In a multi-tenant application, two factor authentication is available to tenants only if it's enabled in the host settings. Also, email verification and SMS verification settings are only available in the host side. This is by design.
88

99
When it's enabled, user is asked to select a verification provider after entering user name and password:
1010

11-
<img src="images/send-security-code-1.png" alt="Send security code" class="img-thumbnail" />
11+
![Send security code](images/send-security-code-2.png)
1212

1313
Then a **confirmation code** is sent to the selected provider and user enters the code in the next page:
1414

15-
<img src="images/verify-security-code-1.png" alt="Verify security code" class="img-thumbnail" />
15+
![Verify security code](images/verify-security-code-2.png)
1616

1717
## Email Verification
1818

@@ -22,6 +22,29 @@ This is available if user has a confirmed email address. Since email sending is
2222

2323
This is available if user has a confirmed phone number. SMS sending is not implemented actually (because it requires an integration to an SMS vendor). Current implementation just writes security code to logs. You should complete **SmsSender** class in the solution to make it usable. Otherwise, disable SMS verification in the settings.
2424

25+
## Authenticator Verification
26+
27+
This is available if user has enabled two factor authentication in his/her profile. You can enable it in profile page:
28+
29+
![Enable two factor authenticator app](images/enable-authenticator.png)
30+
31+
Then user can scan the QR code with an authenticator app (like Google Authenticator) and enter the code in the next page:
32+
33+
![Authenticator verification](images/authenticator-verification.png)
34+
35+
36+
Then user can see his/her recovery codes:
37+
38+
![Authenticator recovery codes](images/authenticator-recovery-codes.png)
39+
40+
That's it. Now user use authenticator app to verify himself/herself.
41+
42+
![Authenticator enabled](images/authenticator-enabled.png)
43+
44+
You can also disable two factor authentication and view the recovery codes again:
45+
46+
![Disable two factor authenticator app](images/disable-authenticator.png)
47+
2548
### Twilio Integration
2649

2750
In order to enable Twilio integration, just uncomment the following line in your **CoreModule** (in your .Core project):
34.2 KB
Loading
55.6 KB
Loading
47.5 KB
Loading
46.8 KB
Loading
48.6 KB
Loading
60.5 KB
Loading
27.3 KB
Loading
24.4 KB
Loading

0 commit comments

Comments
 (0)