raditzfarhan/laravel-user-security

Add security pin, mnemonic key and 2fa authentication feature to users.

v1.0.0 2020-04-18 01:54 UTC

Requires

• endroid/qr-code: ^3.7
• furqansiddiqui/bip39-mnemonic-php: dev-master
• illuminate/database: ^6.0|^7.0|^8.0
• illuminate/support: ^6.0|^7.0|^8.0
• pragmarx/google2fa: ^6.0|^7.0|^8.0

MIT

• Raditz Farhan

• security
• user
• laravel
• pin
• 2fa
• lumen
• mnemonic

README

Laravel User Security - RFAuthenticator

Add security pin, mnemonic key and 2fa authentication feature to users.

Installation

Via Composer

$ composer require raditzfarhan/laravel-user-security:^1.0

Configuration

The Laravel and Lumen configurations vary slightly, so here are the instructions for each of the frameworks.

Laravel

Edit the config/app.php file and add the following line to register the service provider:

'providers' => [
    ...
    RaditzFarhan\UserSecurity\UserSecurityServiceProvider::class,
    ...
],

Tip: If you're on Laravel version 5.5 or higher, you can skip this part of the setup in favour of the Auto-Discovery feature.

Lumen

Edit the bootstrap/app.php file and add the following line to register the service provider:

...
$app->register(RaditzFarhan\UserSecurity\UserSecurityServiceProvider::class);
...

You will also need to enable Facades in bootstrap/app.php:

..
$app->withFacades(true, [
    ...
    RaditzFarhan\UserSecurity\Facades\RFAuthenticator::class => 'RFAuthenticator'
]);
...

Open your user provider model class, for example App\User, and add RaditzFarhan\UserSecurity\Traits\UserSecurable trait:

<?php

namespace App;

...
use RaditzFarhan\UserSecurity\Traits\UserSecurable;

class User extends Model implements AuthenticatableContract, AuthorizableContract
{
    ...
    use UserSecurable;
    ...
}

Usage

Example usage as below snippet:

// to add/update security pin for eloquent user
$user->updateSecurityPin($security_pin);

// to add/update entropy for eloquent user
$user->updateEntropy($entropy);

// to add/update multiple authenticators
$user->updateMultipleAuthenticators(['security_pin' => $security_pin, 'mnemonic_entropy' => $entropy]);

To use mnemonic functions, examples as below:

// Success response

// using service container to generate mnemonic object
$mnemonic = app('RFAuthenticator')->mnemonic()->generate();

// using alias to generate mnemonic object
$mnemonic = \RFAuthenticator::mnemonic()->generate();

// Use mnemonic codes to find entropy
$mnemonic = \RFAuthenticator::mnemonic()->words($words);

// Generate Mnemonic using specified Entropy
$mnemonic = \RFAuthenticator::mnemonic()->entropy($entropy);

Change log

Please see the changelog for more information on what has changed recently.

Credits

• Raditz Farhan

License

MIT. Please see the license file for more information.