Configuration¶

.env¶

totp.algorithm             = 'sha1'
totp.oneTimePasswordLength = 6
totp.keyRegeneration       = 30
totp.window                = 1
totp.secretKeyLength       = 32
totp.issuer                = 'Halberd'
totp.permission            = 'mfa.halberd'
totp.authenticator         = 'totp'
totp.view                  = 'action_totp_2fa'

AuthGroups¶

Create/add a multi-factor authentication group and assign it to users (or add the permission individually on a per-user basis). This permits creation of an opt-in system. The permission string should match the value in the .env file (default is mfa.halberd).

public array $groups = [

    ...

    'mfa' => [
        'title'       => 'Multi-Factor Authentication',
        'description' => 'Users that have opted into multi-factor authentication',
    ],
];

public array $matrix = [

    ...

    'mfa' => [
        'mfa.halberd',
    ],
];

Events¶

Adding a user to the mfa group upon registration will prompt them to initialize their chosen multi-factor authentication application by scanning a QR Code.

Events::on('register', function($user): void {
    // Forces all newly registered users into the 'mfa' group
    $user->addGroup('mfa');
});