ramprasadm1986/yii2-google-authenticator

Yii 2 extension wrapper to google authenticator

1.0.1 2022-01-03 12:47 UTC

Requires

• yiisoft/yii2: ~2.0.10

MIT

• Rama Prasad Moharana

• extension
• google authenticator
• yii2
• compents

README

This PHP class can be used to interact with the Google Authenticator mobile app for 2-factor-authentication. This class can generate secrets, generate codes, validate codes and present a QR-Code for scanning the secret. It implements TOTP according to RFC6238

For a secure installation you have to make sure that used codes cannot be reused (replay-attack). You also need to limit the number of verifications, to fight against brute-force attacks. For example you could limit the amount of verifications to 10 tries within 10 minutes for one IP address (or IPv6 block). It depends on your environment.

Install

composer require ramprasadm1986/yii2-google-authenticator

Configuration

'authenticator' => [
    'class' => 'ramprasadm1986\Authenticator\GoogleAuthenticator'
]

Usage example

$authenticator = \Yii::$app->authenticator;

//Google Authenticator Secret
$secret = $authenticator->secret;

//Google Charts URL for the QR-Code
$authenticator->secret = $secret;
$authenticator->name = 'EXAMPLE';
$qRCodeGoogleUrl = $authenticator ->qRCodeGoogleUrl;

//Code
$code = $authenticator->code;
$authenticator->verifyCode($code); //return bool