Skip to content

Don't overwrite an already two factor secret unless force = true #518

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Feb 1, 2024
Merged

Don't overwrite an already two factor secret unless force = true #518

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
fcf952a
Update EnableTwoFactorAuthentication.php
danmatthews Jan 31, 2024
8e1adc2
Update TwoFactorAuthenticationController.php
danmatthews Jan 31, 2024
d8b30f9
Update TwoFactorAuthenticationControllerTest.php
danmatthews Jan 31, 2024
46e6d76
Passing tests.
danmatthews Jan 31, 2024
85b7e76
StyleCI
danmatthews Jan 31, 2024
48ecadb
formatting
taylorotwell Feb 1, 2024
935bfce
formatting
taylorotwell Feb 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 11 additions & 8 deletions src/Actions/EnableTwoFactorAuthentication.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,17 +31,20 @@ public function __construct(TwoFactorAuthenticationProvider $provider)
* Enable two factor authentication for the user.
*
* @param mixed $user
* @param bool $force
* @return void
*/
public function __invoke($user)
public function __invoke($user, $force = false)
{
$user->forceFill([
'two_factor_secret' => encrypt($this->provider->generateSecretKey()),
'two_factor_recovery_codes' => encrypt(json_encode(Collection::times(8, function () {
return RecoveryCode::generate();
})->all())),
])->save();
if (empty($user->two_factor_secret) || $force === true) {
$user->forceFill([
'two_factor_secret' => encrypt($this->provider->generateSecretKey()),
'two_factor_recovery_codes' => encrypt(json_encode(Collection::times(8, function () {
return RecoveryCode::generate();
})->all())),
])->save();

TwoFactorAuthenticationEnabled::dispatch($user);
TwoFactorAuthenticationEnabled::dispatch($user);
}
}
}
2 changes: 1 addition & 1 deletion src/Http/Controllers/TwoFactorAuthenticationController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ class TwoFactorAuthenticationController extends Controller
*/
public function store(Request $request, EnableTwoFactorAuthentication $enable)
{
$enable($request->user());
$enable($request->user(), $request->boolean('force', false));

return app(TwoFactorEnabledResponse::class);
}
Expand Down
82 changes: 82 additions & 0 deletions tests/TwoFactorAuthenticationControllerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,88 @@ public function test_two_factor_authentication_can_be_enabled()
$this->assertNotNull($user->twoFactorQrCodeSvg());
}

#[ResetRefreshDatabaseState]
public function test_calling_two_factor_authentication_endpoint_will_not_overwrite_without_force_parameter()
{
Event::fake();

$user = TestTwoFactorAuthenticationUser::forceCreate([
'name' => 'Taylor Otwell',
'email' => '[email protected]',
'password' => bcrypt('secret'),
]);

$response = $this->withoutExceptionHandling()->actingAs($user)->postJson(
'/user/two-factor-authentication'
);

$response->assertStatus(200);

Event::assertDispatched(TwoFactorAuthenticationEnabled::class);

$user = $user->fresh();

$old_value = $user->two_factor_secret;

$response = $this->withoutExceptionHandling()->actingAs($user)->postJson(
'/user/two-factor-authentication'
);

$response->assertStatus(200);

$this->assertNotNull($user->two_factor_secret);
$this->assertNotNull($user->two_factor_recovery_codes);
$this->assertEquals($old_value, $user->fresh()->two_factor_secret);
$this->assertNull($user->two_factor_confirmed_at);
$this->assertIsArray(json_decode(decrypt($user->two_factor_recovery_codes), true));
$this->assertNotNull($user->twoFactorQrCodeSvg());
}

#[ResetRefreshDatabaseState]
public function test_calling_two_factor_authentication_endpoint_will_overwrite_with_force_parameter()
{
Event::fake();

$user = TestTwoFactorAuthenticationUser::forceCreate([
'name' => 'Taylor Otwell',
'email' => '[email protected]',
'password' => bcrypt('secret'),
]);

$response = $this->withoutExceptionHandling()->actingAs($user)->postJson(
'/user/two-factor-authentication',
[
'force' => true,
]
);

$response->assertStatus(200);

Event::assertDispatched(TwoFactorAuthenticationEnabled::class);

$user = $user->fresh();

$old_value = $user->two_factor_secret;

$response = $this->withoutExceptionHandling()->actingAs($user)->postJson(
'/user/two-factor-authentication',
[
'force' => true,
]
);

$response->assertStatus(200);

$user = $user->fresh();

$this->assertNotNull($user->two_factor_secret);
$this->assertNotNull($user->two_factor_recovery_codes);
$this->assertNotEquals($old_value, $user->fresh()->two_factor_secret);
$this->assertNull($user->two_factor_confirmed_at);
$this->assertIsArray(json_decode(decrypt($user->two_factor_recovery_codes), true));
$this->assertNotNull($user->twoFactorQrCodeSvg());
}

public function test_two_factor_authentication_secret_key_can_be_retrieved()
{
Event::fake();
Expand Down