Download the PHP package stickee/laravel-2fa without Composer

On this page you can find all versions of the php package stickee/laravel-2fa. 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-2fa

Stickee Laravel 2FA

This a composer module for adding two factor authentication.

Contents

Quick Start

  1. composer require stickee/laravel-2fa
  2. php artisan migrate

2FA is now enabled, but not enforced. To enforce it for all users, set in your .env: LARAVEL_2FA_REQUIRED=true

Users will be prompted to enroll in 2FA when they log in.

Installation

composer require stickee/laravel-2fa

This module ships with a Laravel service provider which will be automatically registered for Laravel 5.5+.

Manual registration

The module can be manually registered by adding this to the providers array in config/app.php:

Configuration

Environment Variables

Name Type Default Description
LARAVEL_2FA_ENABLED bool true Used to disable 2FA checking completely
LARAVEL_2FA_REQUIRED bool false Require 2FA for all users

Config File

Publish the configuration file to your project with this command:

php artisan vendor:publish --provider=Stickee\\Laravel2fa\\ServiceProvider --tag=config

Name Type Default Description
enabled bool env('LARAVEL_2FA_ENABLED', true) Enable or disable 2-factor checking
user_class string \App\User::class The user model class
required bool env('LARAVEL_2FA_REQUIRED', false) If 2FA is required or optional for users (force enrollment)
middleware_groups array ['web', 'nova'] Middleware groups to add 2FA to. It will always only apply to authenticated users
routes_middleware array ['web'] Middleware to apply to routes used by the 2FA system (e.g. /2fa/register)
routes_prefix string '2fa' Prefix for routes used by the 2fa system
state_store string \Stickee\Laravel2fa\StateStores\SessionStateStore::class A class implementing \Stickee\Laravel2fa\Contracts\StateStore to store state
session_prefix string 'laravel-2fa' Prefix for variables stored in the session to prevent collisions
drivers array ['google' => \Stickee\Laravel2fa\Drivers\Google::class] A list of classes implementing \Stickee\Laravel2fa\Contracts\Driver. The key should be the driver name
qr_code_generator string \BaconQrCode\Renderer\Image\SvgImageBackEnd::class A backend for Bacon QR Code - one of: \BaconQrCode\Renderer\Image\ImagickImageBackEnd, \BaconQrCode\Renderer\Image\SvgImageBackEnd, \BaconQrCode\Renderer\Image\EpsImageBackEnd. To use a completeley custom generator see How Do I
qr_code_size int 400 The size in pixels of the QR code
lifetime int 0 The number of minutes of inactivity a user is allowed before they must reauthenticate. Set to zero for no limit
keep_alive bool true Whether to update the last activity time with each pageview. If set to false then "lifetime" becomes time since login
prevent_reuse bool false Prevent the user from logging in twice with the same code
recovery_codes_count int 10 How many recovery codes to generate when a user registers
redirect_after_login string '/' The URL to redirect to after logging in (if we don't know where the user was trying to get to)
redirect_after_logout string '/' The URL to redirect to after logging out
app_name ?string null The app name to use in the authenticator (use null to use app.name)
username_attribute string 'email' The attribute on the User model to use as the username in the authenticator

Customisation

The package is highly customisable - most parts can be swapped out for your own implementation if required.

How Do I...?

Developing

The easiest way to make changes is to make the project you're importing the module in to load the module from your filesystem instead of the composer repository, like this:

  1. composer remove stickee/laravel-2fa

  2. Edit composer.json and add

    where "../laravel-2fa" is the path to where you have this project checked out

  3. composer require stickee/laravel-2fa

NOTE: Do not check in your composer.json like this!

All versions of laravel-2fa with dependencies

PHP Build Version
Package Version
Requires php Version ^7.2.0|^8.0
bacon/bacon-qr-code Version ^2.0
illuminate/contracts Version ^5.8|^6.0|^7.0|^8.0|^9.0|^10.0|^11.0
pragmarx/google2fa Version ^7.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 stickee/laravel-2fa contains the following files

Loading the files please wait ....