extern/2FAuth
1
0
Fork 0
mirror of https://github.com/Bubka/2FAuth.git synced 2025-06-19 19:28:08 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update readme.md

Browse Source
This commit is contained in:
Bubka 2020-01-13 21:01:45 +01:00
parent c9bd1b0460
commit 9fc722bda0
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -4,23 +4,23 @@
A web app to manage your Two-factors Auth (2FA) accounts and generate their TOTP tokens A web app to manage your Two-factors Auth (2FA) accounts and generate their TOTP tokens
## Purpose ## Purpose
2FAuth is an web based self-hosted alternative to One Time Passcode (OTP) generators like Google Authenticator that you can use both on mobile or desktop. 2FAuth is a web based self-hosted alternative to One Time Passcode (OTP) generators like Google Authenticator that you can use both on mobile or desktop.
I created it because : I created it because :
* Most of the UIs for this kind of apps show tokens for all accounts in the same time with stressful countdowns (in my opinion) * Most of the UIs for this kind of apps show tokens for all accounts in the same time with stressful countdowns (in my opinion)
* I wanted my 2FA accounts to be stored in a database I can easily backup and restore. * I wanted my 2FA accounts to be stored in a database I can easily backup and restore.
* I hate taking out my smartphone to get an OTP when I'm at my desktop * I hate taking out my smartphone to get an OTP when I use a desktop computer.
* I love self-hosted solution * I love coding and I love self-hosted solution
## Features ## Features
* Manage your 2FA accounts (add, edit, delete), with QR code upload support * Manage 2FA accounts (add, edit, delete), with QR code support
* Generate tokens * Generate tokens
* User authentication to protect access to 2FA accounts * User authentication to protect access to 2FA accounts
#### Single user app #### Single user app
2FA are sensitives data so it is necessary to sign in an user account in order to use the app. And because they are also owned by you only, it is not possible to create more than one account. 2FA are sensitives data so it is necessary to sign in an user account in order to use the app. And because they are owned by the same person, it is not possible to create more than one account.
## RFC compliance #### RFC compliance
2FAuth generates OTP according to RFC 4226 (HOTP Algorithm) and RFC 6238 (TOTP Algorithm) thanks to [Spomky-Labs/OTPHP](https://github.com/Spomky-Labs/otphp) php library. 2FAuth generates OTP according to RFC 4226 (HOTP Algorithm) and RFC 6238 (TOTP Algorithm) thanks to [Spomky-Labs/OTPHP](https://github.com/Spomky-Labs/otphp) php library.
## Requirements ## Requirements