promocat/yii2-twofa

Provides TOTP and QR codes for use with an authenticator like the one from Google or Authy

Extension for Yii2 providing Two Factor Authentication

Provides TOTP and QR codes for use with an authenticator like the one from Google or Authy, _(*1)

Installation

The preferred way to install this extension is through composer., _(*2)

Either run, _(*3)

php composer.phar require --prefer-dist promocat/yii2-twofa "*"

or add, _(*4)

"promocat/yii2-twofa": "*"

to the require section of your composer.json file., _(*5)

Setup

Update the user component in your config file to use the class, _(*6)

promocat\twofa\User::class

It should sorta look like this, _(*7)

'components' => [
    'user' => [
        'class' => promocat\twofa\User::class,
        'identityClass' => 'common\models\User',
        'enableAutoLogin' => true,
        'identityCookie' => ['name' => '_identity-backend', 'httpOnly' => true],
    ]
]

Also add the "twoFa" component:, _(*8)

'twoFa' => ['class' => promocat\twofa\TwoFa::class]

Next, add the TwoFaBehavior to your User model, _(*9)

public function behaviors() {
    return [
        'two_fa' => ['class' => TwoFaBehavior::class]
    ];
}

Usage

Congratulations, you can now, for example, call, _(*10)

Yii::$app->twofa->generateSecret()

or, _(*11)

Yii::$app->twofa->checkCode($secret, $code);

Use, _(*12)

promocat\models\TwoFaForm

for the 2FA activation and verification forms. Or at least let is be an example., _(*13)

QR Code Widget

<?= TwoFaQr::widget([
    'accountName' => $model->user->username,
    'secret' => $model->secret,
    'issuer' => Yii::$app->params['twoFaIssuer'],
    'size' => 300
]); ?>

How to functionally implement:

See "example.php" to get started., _(*14)