mirror of https://github.com/Bubka/2FAuth.git synced 2024-12-23 23:49:53 +01:00

A Web app to manage your Two-Factor Authentication (2FA) accounts and generate their security codes

2fa 2factor hotp otp qrcode self-hosted totp two-factor two-factor-authentication webapp

Go to file

Bubka 35a91ed6bf Update README.md		2020-01-27 22:05:13 +01:00
app	Update username after Profile update	2020-01-27 22:04:47 +01:00
bootstrap	initial commit	2019-05-20 07:37:41 +02:00
config	Reorganize js resources	2020-01-18 18:19:37 +01:00
database	Remove softDelete from User model	2020-01-14 11:08:21 +01:00
public	Remove built files	2020-01-16 09:13:45 +01:00
resources	Update username after Profile update	2020-01-27 22:04:47 +01:00
routes	Full support of HOTP	2020-01-24 22:37:48 +01:00
storage	Replace bg asset by base64 image in css	2020-01-09 09:23:54 +01:00
tests	Fix unit tests	2020-01-27 21:44:29 +01:00
.editorconfig	initial commit	2019-05-20 07:37:41 +02:00
.env.example	Add .env.example file	2020-01-13 15:22:25 +01:00
.env.testing	in memory db for testing	2019-05-23 21:27:27 +02:00
.env.travis	in memory db for testing	2019-05-23 21:27:27 +02:00
.gitattributes	initial commit	2019-05-20 07:37:41 +02:00
.gitignore	Add built files from .gitignore	2020-01-15 22:55:32 +01:00
.styleci.yml	initial commit	2019-05-20 07:37:41 +02:00
.travis.yml	in memory db for testing	2019-05-23 21:27:27 +02:00
artisan	initial commit	2019-05-20 07:37:41 +02:00
composer.json	Implement i18n localization based on Laravel lang files	2020-01-12 15:12:32 +01:00
composer.lock	Update php dependencies	2020-01-13 20:56:14 +01:00
LICENSE	Add LICENSE file	2020-01-11 00:13:04 +01:00
package-lock.json	Set global axios instance using vue-axios wrapper	2020-01-26 21:04:33 +01:00
package.json	Set global axios instance using vue-axios wrapper	2020-01-26 21:04:33 +01:00
phpunit.xml	Seeder replaced by factories	2019-06-06 13:40:06 +02:00
README.md	Update README.md	2020-01-27 22:05:13 +01:00
server.php	initial commit	2019-05-20 07:37:41 +02:00
webpack.mix.js	Set global axios instance using vue-axios wrapper	2020-01-26 21:04:33 +01:00

README.md

2FAuth

A web app to manage your Two-factors Auth (2FA) accounts and generate their OTP tokens

Purpose

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 :

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 hate taking out my smartphone to get an OTP when I use a desktop computer.
I love coding and I love self-hosted solution

Features

Manage 2FA accounts (add, edit, delete), with QR code support
Generate TOTP and HOTP tokens
User authentication to protect access to 2FA accounts

Single user app

2FA are sensitives data so an authentication is needed to use the app. And because they are usually owned by the same person, it is not possible to create more than one account.

RFC compliance

2FAuth generates OTP according to RFC 4226 (HOTP Algorithm) and RFC 6238 (TOTP Algorithm) thanks to Spomky-Labs/OTPHP php library.

Requirements

MySQL or SQLITE database

Installation (using command line)

Clone the repo

git clone https://github.com/bubka/2fauth.git

Install all php dependencies

php composer.phar install

Don't have composer? you can get it here

Set your variables

In your installation directory make a copy of the .env.example file and rename the copy .env.

Edit the .env file and adapt the settings to your running environment (see instructions in the file)

Prepare some stuff

php artisan migrate:refresh
php artisan passport:install
php artisan storage:link
php artisan config:cache
php artisan vue-i18n:generate

Install js dependencies

npm install

Build

npm run dev or npm run prod

You are ready to go.

Contributing

to complete

License

AGPL-3.0