From 03df3a3329dfb4e9ff2568d9c024c8c0b85c8b0f Mon Sep 17 00:00:00 2001 From: Maxime Besson Date: Fri, 4 Mar 2022 17:40:45 +0100 Subject: [PATCH] Update 2FA doc --- doc/sources/admin/secondfactor.rst | 19 ++++++++++++------ doc/sources/admin/start.rst | 32 +++++++++++++++--------------- 2 files changed, 29 insertions(+), 22 deletions(-) diff --git a/doc/sources/admin/secondfactor.rst b/doc/sources/admin/secondfactor.rst index 2ae6ea873..c8602b2c1 100644 --- a/doc/sources/admin/secondfactor.rst +++ b/doc/sources/admin/secondfactor.rst @@ -14,16 +14,23 @@ combination of two different factors between: Since 2.0, LLNG provides some second factor plugins that can be used to complete authentication module with 2FA : -- :doc:`U2F-or-TOTP` *(enable both U2F and TOTP)* -- :doc:`TOTP` *(to use - with* `FreeOTP `__\ *,*\ `Google-Authenticator `__\ *,…)* -- :doc:`U2F tokens` -- :doc:`Yubikey tokens` *(provided by Yubico)* +Second factors that can be registered by the user: + +- :doc:`TOTP` *(to use with* `FreeOTP `__\ *,*\ `Google-Authenticator `__\ *,…)* +- :doc:`WebAuthn` *(Web Authentication API)* +- :doc:`Yubico OTP` *(Legacy OTP method from Yubico)* +- :doc:`U2F tokens` |deprecated| +- :doc:`U2F-or-TOTP` *(enable both U2F and TOTP)* |deprecated| + +Second factors that rely on external systems: + - :doc:`E-Mail 2F` *(Send a code to an email address)* - :doc:`External 2F` *(to call an external command)* - :doc:`REST` *(Remote REST app)* - :doc:`RADIUS` *(Remote RADIUS server)* -- :doc:`WebAuthn` *(Web Authentication API)* + +.. |deprecated| image:: /documentation/deprecated.png + :alt: deprecated The E-Mail, External and REST 2F modules :doc:`may be declared multiple times` with different sets of diff --git a/doc/sources/admin/start.rst b/doc/sources/admin/start.rst index 22c9eb587..61af6fe3e 100644 --- a/doc/sources/admin/start.rst +++ b/doc/sources/admin/start.rst @@ -176,20 +176,24 @@ Obsolete Backends Authenticat :doc:`Remote LL::NG` ✔ ✔ ==================================================================== =============================================== ======== ======== -==================================================================== ============== -Second factor (:doc:`documentation`) Authentication -==================================================================== ============== -:doc:`TOTP-or-U2F` |new| ✔ -:doc:`U2F` |deprecated| ✔ -:doc:`TOTP` *(Google Authenticator,...)* |new| ✔ +==================================================================== ============== ================= +Second factor (:doc:`documentation`) Authentication Self-registration +==================================================================== ============== ================= +:doc:`TOTP` *(Google Authenticator,...)* |new| ✔ ✔ +:doc:`WebAuthn` |new| ✔ ✔ :doc:`E-mail Second Factor` |new| ✔ +:doc:`Yubikey` |new| ✔ ✔ :doc:`External Second Factor` *(OTP, SMS,...)* |new| ✔ -:doc:`Radius Second Factor` |new| [3]_ ✔ :doc:`REST Second Factor` |new| ✔ -:doc:`Yubikey` |new| ✔ -:doc:`WebAuthn` |new| ✔ -:doc:`Additional second factors` |new| [4]_ ✔ -==================================================================== ============== +:doc:`Radius Second Factor` |new| [3]_ ✔ +:doc:`TOTP-or-U2F` |deprecated| ✔ ✔ +:doc:`U2F` |deprecated| ✔ ✔ +==================================================================== ============== ================= + +.. versionadded:: 2.0.6 + See :doc:`Additional second factors` for configuring several multiple + REST, external or e-mail based second factors with different parameters + ==================================================================== ============== Auth addons Authentication @@ -570,14 +574,10 @@ by your language code): .. [3] :doc:`Radius second factor` is available with LLNG ≥ 2.0.6 -.. [4] +.. [5] :doc:`Check DevOps file plugin` are available with LLNG ≥ 2.0.12 -.. [5] - :doc:`Additional second factors` are available with LLNG ≥ - 2.0.6 - .. [6] :doc:`Check user plugin` is available with LLNG ≥ 2.0.3