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 07df0cd5e0 Move reusable stuff to vue mixin		2020-10-08 15:33:20 +02:00
app	Set the uploader as a vue component with qrcode-reader as default	2020-04-24 09:03:00 +02:00
bootstrap	initial commit	2019-05-20 07:37:41 +02:00
config	Add option to show/hide icons in accounts list view	2020-10-03 19:29:14 +02:00
database	Add order column to twofaccounts table	2020-03-26 01:37:39 +01:00
public	Replace Composer package with npm package to handle js languages strings	2020-09-30 20:48:42 +02:00
resources	Move reusable stuff to vue mixin	2020-10-08 15:33:20 +02:00
routes	Make the accounts sortable and persist new order.	2020-03-27 22:36:01 +01:00
storage	Replace bg asset by base64 image in css	2020-01-09 09:23:54 +01:00
tests	Complete and update tests	2020-05-07 21:24:14 +02:00
.editorconfig	initial commit	2019-05-20 07:37:41 +02:00
.env.example	Set IsDemoApp option as an .ENV variable	2020-03-18 18:37:57 +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 assets to master to ease installation	2020-03-12 11:56:41 +01:00
.styleci.yml	initial commit	2019-05-20 07:37:41 +02:00
.travis.yml	Remove unwanted php 7.1 from Travis-CI configuration	2020-03-12 08:57:56 +01:00
artisan	initial commit	2019-05-20 07:37:41 +02:00
changelog.md	Bump version number and complete Change log	2020-09-18 00:55:26 +02:00
composer.json	Replace Composer package with npm package to handle js languages strings	2020-09-30 20:48:42 +02:00
composer.lock	Replace Composer package with npm package to handle js languages strings	2020-09-30 20:48:42 +02:00
LICENSE	Add LICENSE file	2020-01-11 00:13:04 +01:00
package-lock.json	Replace Composer package with npm package to handle js languages strings	2020-09-30 20:48:42 +02:00
package.json	Replace Composer package with npm package to handle js languages strings	2020-09-30 20:48:42 +02:00
phpunit.xml	Seeder replaced by factories	2019-06-06 13:40:06 +02:00
README.md	Update description in README	2020-10-03 19:22:20 +02:00
server.php	initial commit	2019-05-20 07:37:41 +02:00
webpack.mix.js	Replace Composer package with npm package to handle js languages strings	2020-09-30 20:48:42 +02:00

2FAuth

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

2FAuth Demo

Credentials (login - password) : demo@2fauth.app - demo

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 with QR code scanning and decoding
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

See Laravel server requirements
Any database supported by Laravel

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 up your database

Create a database with one of the supported tools (see Requirements). For SQLite, place the database .sqlite file in the database/ folder of your 2FAuth installation.

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

You are ready to go.

For development only

Install and build js dependencies

npm install
npm run dev

Update your installation

First, backup your database.

Then, using command line :

git pull
php composer.phar install
php artisan migrate
php artisan config:clear

Contributing

to complete

License

AGPL-3.0

README.md