mirror of
https://github.com/librenms/librenms.git
synced 2024-10-07 16:52:45 +00:00
docs: Update Two-Factor-Auth formatting
Removes duplicated TOC and named anchors
This commit is contained in:
Bennett Blodinger
committed by
Neil Lathwood
parent
cf6de3dcda
commit
5eb002f553
@ -1,14 +1,6 @@
|
||||
source: Extensions/Two-Factor-Auth.md
|
||||
Table of Content:
|
||||
- [About](#about)
|
||||
- [Types](#types)
|
||||
- [Timebased One-Time-Password (TOTP)](#totp)
|
||||
- [Counterbased One-Time-Password (HOTP)](#hotp)
|
||||
- [Configuration](#config)
|
||||
- [Usage](#usage)
|
||||
- [Google Authenticator](#usage-google)
|
||||
|
||||
# <a name="about">About</a>
|
||||
# About
|
||||
|
||||
Over the last couple of years, the primary attack vector for internet accounts has been static passwords.
|
||||
Therefore static passwords are no longer sufficient to protect unauthorized access to accounts.
|
||||
@ -18,13 +10,13 @@ A user is now required to supply a changing 6-digit passcode in addition to it's
|
||||
LibreNMS has a RFC4226 conform implementation of both Time and Counter based One-Time-Passwords.
|
||||
It also allows the administrator to configure a throttle time to enforce after 3 failures exceeded. Unlike RFC4226 suggestions, this throttle time will not stack on the amount of failures.
|
||||
|
||||
# <a name="types">Types</a>
|
||||
# Types
|
||||
|
||||
In general, these two types do not differ in algorithmic terms.
|
||||
The types only differ in the variable being used to derive the passcodes from.
|
||||
The underlying HMAC-SHA1 remains the same for both types, security advantages or disadvantages of each are discussed further down.
|
||||
|
||||
## <a name="totp">Timebased One-Time-Password (TOTP)</a>
|
||||
## Timebased One-Time-Password (TOTP)
|
||||
|
||||
Like the name suggests, this type uses the current Time or a subset of it to generate the passcodes.
|
||||
These passcodes solely rely on the secrecy of their Secretkey in order to provide passcodes.
|
||||
@ -32,13 +24,13 @@ An attacker only needs to guess that Secretkey and the other variable part is an
|
||||
RFC4226 suggests a resynchronization attempt in case the passcode mismatches, providing the attacker a range of up to +/- 3 Minutes to create passcodes.
|
||||
|
||||
|
||||
## <a name="hotp">Counterbased One-Time-Password (TOTP)</a>
|
||||
## Counterbased One-Time-Password (TOTP)
|
||||
|
||||
This type uses an internal counter that needs to be in sync with the server's counter to successfully authenticate the passcodes.
|
||||
The main advantage over timebased OTP is the attacker doesn't only need to know the Secretkey but also the server's Counter in order to create valid passcodes.
|
||||
RFC4226 suggests a resynchronization attempt in case the passcode mismatches, providing the attacker a range of up to +4 increments from the actual counter to create passcodes.
|
||||
|
||||
# <a name="config">Configuration</a>
|
||||
# Configuration
|
||||
|
||||
Enable Two-Factor:
|
||||
```php
|
||||
@ -50,7 +42,7 @@ Set throttle-time (in seconds):
|
||||
$config['twofactor_lock'] = 300;
|
||||
```
|
||||
|
||||
# <a name="usage">Usage</a>
|
||||
# Usage
|
||||
|
||||
These steps imply that TwoFactor has been enabled in your `config.php`
|
||||
|
||||
@ -61,7 +53,7 @@ Create a Two-Factor key:
|
||||
- If your browser didn't reload, reload manually
|
||||
- Scan provided QR or click on 'Manual' to see the Key
|
||||
|
||||
## <a name="usage-google">Google Authenticator</a>
|
||||
## Google Authenticator
|
||||
|
||||
Installation guides for Google Authenticator can be found [here](https://support.google.com/accounts/answer/1066447?hl=en).
|
||||
|
||||
|
Reference in New Issue
Block a user