RPJosh
/
authelia
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: totp reference (#5404) 

Adds documentation for supported TOTP apps.

Closes #2650

Signed-off-by: James Elliott <james-d-elliott@users.noreply.github.com>
pull/5405/head
James Elliott 2023-05-07 17:52:47 +10:00 committed by GitHub
parent b219a85e12
commit 2116422b79
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 47 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/content/en/configuration/second-factor/time-based-one-time-password.md
View File

@ -65,9 +65,8 @@ by Authelia from others.
*__Important Note:__ Many TOTP applications do not support this option. It is strongly advised you find out which
applications your users use and test them before changing this option. It is insufficient to test that the application
can add the key, it must also authenticate with Authelia as some applications silently ignore these options. [Bitwarden]
is the only one that has been tested at this time. If you'd like to contribute to documenting support for this option
please see [Issue 2650](https://github.com/authelia/authelia/issues/2650).*
can add the key, it must also authenticate with Authelia as some applications silently ignore these options. See the
[Reference Guide](../../reference/integrations/time-based-one-time-password-apps.md) for tested applications.*
[Bitwarden]: https://bitwarden.com/
@ -88,9 +87,8 @@ information.
*__Important Note:__ Some TOTP applications do not support this option. It is strongly advised you find out which
applications your users use and test them before changing this option. It is insufficient to test that the application
can add the key, it must also authenticate with Authelia as some applications silently ignore these options. [Bitwarden]
is the only one that has been tested at this time. If you'd like to contribute to documenting support for this option
please see [Issue 2650](https://github.com/authelia/authelia/issues/2650).*
can add the key, it must also authenticate with Authelia as some applications silently ignore these options. See the
[Reference Guide](../../reference/integrations/time-based-one-time-password-apps.md) for tested applications.*
The number of digits a user needs to input to perform authentication. It's generally not recommended for this to be
altered as many TOTP applications do not support anything other than 6. What's worse is some TOTP applications allow

43
docs/content/en/reference/integrations/time-based-one-time-password-apps.md 100644
View File

@ -0,0 +1,43 @@
---
title: "Time-based OTP Applications"
description: "A Time-based OTP Application integration reference guide"
lead: "This section contains a Time-based OTP Application integration reference guide for Authelia."
date: 2022-11-19T16:47:09+11:00
draft: false
images: []
menu:
reference:
parent: "integrations"
weight: 320
toc: true
---
## Settings
Authelia allows for a wide variety of time-based OTP settings. There are several applications which can support these
algorithms and this matrix is a guide on applications that have been tested that work. It should not be assumed if an
application is on this list that the information is correct for the current version of a product and it's likely they
may now support some that were not previously supported, or in rare cases they may support less than they previously
did.
| Application | Algorithm: SHA1 | Algorithm: SHA256 | Algorithm: SHA512 | Digits: 6 | Digits 8 |
|:----------------------:|:------------------------------:|:------------------------------:|:------------------------------:|:------------------------------:|:-------------------------------:|
| [Google Authenticator] | {{% support support="full" %}} | {{% support %}} | {{% support %}} | {{% support support="full" %}} | {{% support %}} |
| [Bitwarden] | {{% support support="full" %}} | {{% support support="full" %}} | {{% support support="full" %}} | {{% support support="full" %}} | {{% support support="full" %}} |
| [Yubico Authenticator] | {{% support support="full" %}} | {{% support %}} | {{% support %}} | {{% support support="full" %}} | {{% support support="full" %}} |
| [Authenticator Plus] | {{% support support="full" %}} | {{% support %}} | {{% support %}} | {{% support support="full" %}} | {{% support %}} |
| [1Password] | {{% support support="full" %}} | {{% support support="full" %}} | {{% support %}} | {{% support support="full" %}} | {{% support %}} |
| [Ravio] | {{% support support="full" %}} | {{% support support="full" %}} | {{% support %}} | {{% support support="full" %}} | {{% support %}} |
| [Authy] | {{% support support="full" %}} | {{% support %}} | {{% support %}} | {{% support %}} | {{% support support="full" %}} |
| [Aegis] | {{% support support="full" %}} | {{% support %}} | {{% support support="full" %}} | {{% support support="full" %}} | {{% support support="full" %}} |
[Google Authenticator]: https://play.google.com/store/apps/details?id=com.google.android.apps.authenticator2&hl=en&gl=US&pli=1
[Bitwarden]: https://bitwarden.com/
[Yubico Authenticator]: https://www.yubico.com/products/yubico-authenticator/
[Authenticator Plus]: https://www.authenticatorplus.com/
[1Password]: https://1password.com/
[Ravio]: https://raivo-otp.com/
[Authy]: https://authy.com/
[Aegis]: https://getaegis.app/