extern/2FAuth
1
0
Fork 0
mirror of https://github.com/Bubka/2FAuth.git synced 2024-11-23 16:53:26 +01:00
Code Issues Packages Projects Releases Wiki Activity
A Web app to manage your Two-Factor Authentication (2FA) accounts and generate their security codes
384 Commits 4 Branches 47 Tags 25 MiB
PHP 91.4%
Vue 6.9%
RobotFramework 1.7%
0ff62fda17
Go to file
Bubka 0ff62fda17 Upgrade phpunit xml config file to new format
2020-10-11 19:13:28 +02:00
app Update and complete phpunit tests 2020-10-09 13:35:03 +02:00
bootstrap initial commit 2019-05-20 07:37:41 +02:00
config Bump version number ans complete Change log 2020-10-09 18:27:12 +02:00
database Add auto-lock option 2020-10-08 15:38:36 +02:00
public Recompile assets 2020-10-09 18:32:00 +02:00
resources Fix logout not triggering at the end of the inactivity period 2020-10-09 15:09:56 +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 Update and complete phpunit tests 2020-10-09 13:35:03 +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 ans complete Change log 2020-10-09 18:27:12 +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 Upgrade phpunit xml config file to new format 2020-10-11 19:13:28 +02:00
README.md Enhance README.md 2020-10-08 22:27:56 +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

README.md

https://travis-ci.com/github/Bubka/2FAuth https://codecov.io/gh/Bubka/2FAuth https://github.com/Bubka/2FAuth/blob/master/LICENSE

2FAuth

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

screens

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, designed for both mobile and desktop.

It aims to ease you perform your 2FA authentication steps whatever the device you handle, with a clean and suitable interface.

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 standalone database I can easily backup and restore (did you already encountered a smartphone loss with all your 2FA accounts in Google Auth? I did...)
  • I hate taking out my smartphone to get an OTP when I use a desktop computer
  • I love coding and I love self-hosted solutions

Main features

  • Manage 2FA accounts with QR code flashing/scanning and decoding
  • Generate TOTP and HOTP security codes
  • User authentication to protect 2FA data stored in 2FAuth

2FAuth is currently localized in English and in French.

Single user app

2FA are sensitives data so you have to create an account and authenticate yourself to use the app. It is not possible to create more than one user account, the app is thought for personal use.

RFC compliance

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

Requirements

Requires PHP7

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

Checkout the 'dev' branch then install and build js dependencies

npm install
npm run dev

Upgrading

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