README

A driver-based multi-factor authentication package for Laravel

Installation

You can install the package via composer:

composer require worksome/laravel-mfa

You can publish and run the migrations with:

php artisan vendor:publish --tag="mfa-migrations"
php artisan migrate

You can publish the config file with:

php artisan vendor:publish --tag="mfa-config"

This is the contents of the published config file:

return [

    'user' => \App\Models\User::class,

    'channels' => [

        \Worksome\MultiFactorAuth\Enums\Channel::Email->value => [
            'driver' => env('MFA_EMAIL_DRIVER', 'null'),
        ],

        \Worksome\MultiFactorAuth\Enums\Channel::Sms->value => [
            'driver' => env('MFA_SMS_DRIVER', 'null'),
        ],

        \Worksome\MultiFactorAuth\Enums\Channel::Totp->value => [
            'driver' => env('MFA_TOTP_DRIVER', 'null'),
        ],

    ],
    
    // ...

];

For the full configuration, see the config/mfa.php file.

Usage

$twoFactorAuth = new \Worksome\MultiFactorAuth\MultiFactorAuth();
$response = $twoFactorAuth->sms->make(
    new \Worksome\MultiFactorAuth\DataValues\Sms\E164PhoneNumber('+14155552671'),
);

dd($response);

The about command

This package adds information to the artisan about command. This information can be disabled by setting the mfa.features.about_command configuration to false.

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• Owen Voke
• All Contributors

License

The MIT License (MIT). Please see License File for more information.