Skip to content

Commit c45ead8

Browse files
plyblufabaff
authored andcommitted
Update multi-factor-auth.markdown (home-assistant#6128)
* Update multi-factor-auth.markdown improve spelling and grammar * Minor changes
1 parent 44cf071 commit c45ead8

File tree

1 file changed

+10
-11
lines changed

1 file changed

+10
-11
lines changed

source/_docs/authentication/multi-factor-auth.markdown

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -16,17 +16,17 @@ This is an advanced feature. If misconfigured, you will not be able to access Ho
1616

1717
Besides the authentication providers, it's also possible to configure multi-factor authentication modules. These authentication modules will require the user to solve a second challenge besides just logging in. The idea is that you ask the user for something they know, their username/password, and something they have, like a time-based authentication token from their phone.
1818

19-
Multi-factor authentication module can be used mixed-match with authentication providers. After normal authentication provider validation, the login flow will ask user for addional challenge if there are multi-factor authentication modules enabled for this user. If more than one mutli-factor authentication module enabled, user can select one of them during the login.
19+
The multi-factor authentication module can be used mixed-matched with authentication providers. After the normal authentication provider validation, the login flow will ask the user for additional challenge(s) if there are multi-factor authentication modules enabled for this user. If more than one mutli-factor authentication module is enabled, the user can select one of them during the login.
2020

21-
Multi-factor authentication module has to be enabled for user before it can be used in the login process, user can go to profile page enable it by himself.
21+
The multi-factor authentication module has to be enabled for the user before it can be used in the login process. The user can go to the profile page enable it by himself.
2222

2323
## {% linkable_title Configuring mutli-factor authentication modules %}
2424

2525
<p class='note warning'>
2626
By configuring your own instead of using the default configuration, you take full responsibility for the authentication of the system.
2727
</p>
2828

29-
Multi-factor authentication modules are configured in your `configuration.yaml` under the `homeassistant:` block:
29+
Multi-factor authentication modules are configured in your `configuration.yaml` file under the `homeassistant:` block:
3030

3131
```yaml
3232
homeassistant:
@@ -36,27 +36,26 @@ homeassistant:
3636
3737
## {% linkable_title Available mutli-factor authentication modules %}
3838
39-
Below is a list of currently available auth providers.
39+
Below is a list of the currently available auth providers.
4040
4141
### {% linkable_title Time-based One-Time Password mutli-factor authentication module %}
4242
4343
[Time-based One-Time Password](https://en.wikipedia.org/wiki/Time-based_One-time_Password_algorithm) is widely adopted in modern authencation system, it combines a secret key with the current timestamp using a cryptographic hash function to generate a one-time password. Whoever possessed the secret key will get same one-time password in certain time period. By verifying that password, Home Assistant knows the user have the right secrt key.
4444
45-
When try to set up TOTP module, a QR code will show up, user can scan it by an authenticator app, or set it up manauly using the code showed in UI. After setup, user need to input a six digit number generate in the autendicator app to verify the setup is good. If the verificaiton keep falling, you need to check whether the clock on Home Asistant is accurate.
45+
When trying to set up TOTP module, a QR code will show up. The user can scan it by an authenticator app, or set it up manually using the code showed in the UI. After setup, the user needs to input a six digit number generated in the autendicator app to verify the setup is good. If the verification keeps failing, you need to check whether the clock on Home Assistant is accurate.
4646
47-
There are several authenctior apps on the market, we recommend either [Google Authenticator](https://support.google.com/accounts/answer/1066447) or [Authy](https://authy.com/)
47+
There are several authenticator apps on the market, we recommend either [Google Authenticator](https://support.google.com/accounts/answer/1066447) or [Authy](https://authy.com/).
4848
4949
<p class='note warning'>
50-
Please treat the secret key like a password, never exposure it to others.
50+
Please treat the secret key like a password, never expose it to others.
5151
</p>
5252
53+
By default, one TOTP multi-factor named "Authenticator app" will be auto loaded if no `auth_mfa_modules` configuration section defined in the `configuration.yaml` file.
5354

54-
By default one TOTP multi-factor named "Authenticator app" will be auto loaded if no `auth_mfa_modules` config section defined in `configuration.yaml`.
55-
56-
Example of configuration
55+
Example of configuration:
5756

5857
```yaml
5958
homeassistant:
6059
auth_mfa_modules:
6160
- type: totp
62-
```
61+
```

0 commit comments

Comments
 (0)