Download the PHP package maben-dev/laravel-twofactor without Composer

On this page you can find all versions of the php package maben-dev/laravel-twofactor. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package laravel-twofactor

Installation

composer require maben-dev/laravel-twofactor \ php artisan migrate

Now you need to make your user model use MabenDev\TwoFactor\Traits\HasTwoFactor

DONE!

Usage

On the user model you have acces to the function $user->setupTwoFactor, with this function you give the user a 2fa secret.

From here on out the user needs to give his 2fa code every time his session is lost and the user tries to access a route that has the TwoFactor middleware on it.

To delete his 2fa, just do $user->twoFactor->delete().

To edit the views, localization and config do: php artisan vendor:publish --provider="MabenDev\TwoFactor\ServiceProvider"

How it works under water

If the user access a route with the TwoFactor middleware on it, the middleware will check if the user is logged in, if not it does nothing. \ If the user is logged in and has the session required, the middleware will do nothing. \ If the user does not have a 2fa, the middleware will do nothing. \ If anything else the middleware will redirect the user to the 2fa-form route, created by the package.

On the 2fa form the user will see a qr code if it's the first time using it, after this the qr will never show up again.

The user gives his 2fa code, the package checks it and if the code is good, the user will be redirected back to the location he came from, or the redirect_url of the config or if both are no valid url's to /home. \ If the user gives a bad code, he will be shown with a error and can try again.

IMPORTANT NOTES

There are some functions on your user model that can help you with customizing the user experience, but be aware the getQr function should never be used if the 2fa is already setup. \ The secret should never be visible by anyone, besides the user on the first time setting things up. \ If in any way the secret is compromised delete it and setup a new 2fa secret. \


All versions of laravel-twofactor with dependencies

PHP Build Version
Package Version
Requires php Version >=7.2
pragmarx/google2fa Version ^7.0
bacon/bacon-qr-code Version ^2.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package maben-dev/laravel-twofactor contains the following files

Loading the files please wait ....