Skip to content
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

Jump to bottom

Destroy existing sessions when activating 2FA. #578

Merged
merged 4 commits into from
Sep 4, 2023
Merged

Destroy existing sessions when activating 2FA. #578

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c86b759
Destroy existing sessions when activating 2FA.
dd32 Jun 7, 2023
7e9a6fb
Adjust when sessions are destroyed.
dd32 Jul 14, 2023
36919c8
Only destroy sessions if when deactivating a provider, there are stil…
dd32 Jul 14, 2023
1d1df91
Update tests to reflect changes.
dd32 Jul 14, 2023
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
16 changes: 16 additions & 0 deletions class-two-factor-core.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1873,6 +1873,22 @@ public static function user_two_factor_options_update( $user_id ) {
) );
}
}

// Destroy other sessions if setup 2FA for the first time, or deactivated a provider
if (
// No providers, enabling one (or more)
( ! $existing_providers && $enabled_providers ) ||
// Has providers, and is disabling one (or more), but remaining with 2FA.
( $existing_providers && $enabled_providers && array_diff( $existing_providers, $enabled_providers ) )
) {
if ( $user_id === get_current_user_id() ) {
// Keep the current session, destroy others sessions for this user.
wp_destroy_other_sessions();
} else {
// Destroy all sessions for the user.
WP_Session_Tokens::get_instance( $user_id )->destroy_all();
}
}
}
}

Expand Down
158 changes: 158 additions & 0 deletions tests/class-two-factor-core.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1342,4 +1342,162 @@ public function test_filter_session_information() {
$this->assertArrayNotHasKey( 'tests-key', $session );
}


/**
* Validate that other sessions are destroyed once Two-Factor is enabled.
*
* @covers Two_Factor_Core::user_two_factor_options_update
*/
public function test_other_sessions_destroyed_when_enabling_2fa() {
$user_id = self::factory()->user->create(
array(
'user_login' => 'username',
'user_pass' => 'password',
)
);

$user = new WP_User( $user_id );

$session_manager = WP_Session_Tokens::get_instance( $user->ID );

$this->assertCount( 0, $session_manager->get_all(), 'No user sessions are present first' );

// Generate multiple existing sessions.
$session_manager->create( time() + HOUR_IN_SECONDS );
$session_manager->create( time() + DAY_IN_SECONDS );
$this->assertCount( 2, $session_manager->get_all(), 'Can fetch active sessions' );

// Shim the cookie... this allows for functions that use sessions to know the current session.
add_action( 'set_logged_in_cookie', function( $logged_in_cookie ) {
$_COOKIE[ LOGGED_IN_COOKIE ] = $logged_in_cookie;
} );

$user_authenticated = wp_signon(
array(
'user_login' => 'username',
'user_password' => 'password',
)
);
$this->assertEquals( $user_authenticated, $user, 'User can authenticate' );

// Enable Two-Factor for the user.
wp_set_current_user( $user->ID );

$key = '_nonce_user_two_factor_options';
$nonce = wp_create_nonce( 'user_two_factor_options' );
$_POST[ $key ] = $nonce;
$_REQUEST[ $key ] = $nonce;

$_POST[ Two_Factor_Core::ENABLED_PROVIDERS_USER_META_KEY ] = array(
'Two_Factor_Dummy' => 'Two_Factor_Dummy'
);

Two_Factor_Core::user_two_factor_options_update( $user->ID );

// Validate that Two-Factor is now enabled.
$this->assertCount( 1, Two_Factor_Core::get_available_providers_for_user( $user->ID ) );
$this->assertCount( 1, Two_Factor_Core::get_enabled_providers_for_user( $user->ID ) );

// Validate that only the current session still exists.
$this->assertCount( 1, $session_manager->get_all(), 'All known authentication sessions have been destroyed' );

// Create another session, activate another provider, verify sessions are still valid.
$session_manager->create( time() + DAY_IN_SECONDS );
$this->assertCount( 2, $session_manager->get_all(), 'Failed to create another session' );

$_POST[ Two_Factor_Core::ENABLED_PROVIDERS_USER_META_KEY ] = array(
'Two_Factor_Dummy' => 'Two_Factor_Dummy',
'Two_Factor_Email' => 'Two_Factor_Email',
);

Two_Factor_Core::user_two_factor_options_update( $user->ID );

// Validate that Two-Factor is now enabled with two providers.
$this->assertCount( 2, Two_Factor_Core::get_available_providers_for_user( $user->ID ) );
$this->assertCount( 2, Two_Factor_Core::get_enabled_providers_for_user( $user->ID ) );

$this->assertCount( 2, $session_manager->get_all(), 'Adding an additional provider should not destroy other sessions.' );

// Disable a provider, verify other sessions are destroyed.
$_POST[ Two_Factor_Core::ENABLED_PROVIDERS_USER_META_KEY ] = array(
'Two_Factor_Dummy' => 'Two_Factor_Dummy',
);

Two_Factor_Core::user_two_factor_options_update( $user->ID );

// Validate that Two-Factor is now enabled with two providers.
$this->assertCount( 1, Two_Factor_Core::get_available_providers_for_user( $user->ID ) );
$this->assertCount( 1, Two_Factor_Core::get_enabled_providers_for_user( $user->ID ) );

$this->assertCount( 1, $session_manager->get_all(), 'All known authentication sessions have been destroyed' );

// Create another session, deactivate two-factor, verify sessions are still valid.
$session_manager->create( time() + DAY_IN_SECONDS );
$this->assertCount( 2, $session_manager->get_all(), 'Failed to create another session' );

$_POST[ Two_Factor_Core::ENABLED_PROVIDERS_USER_META_KEY ] = array();

Two_Factor_Core::user_two_factor_options_update( $user->ID );

// Validate that Two-Factor is now disabled.
$this->assertCount( 0, Two_Factor_Core::get_available_providers_for_user( $user->ID ) );
$this->assertCount( 0, Two_Factor_Core::get_enabled_providers_for_user( $user->ID ) );

$this->assertCount( 2, $session_manager->get_all(), 'All known authentication sessions have been destroyed' );
}

/**
* Validate the current users sessions are not modified when modifying another user.
*
* @covers Two_Factor_Core::user_two_factor_options_update
*/
public function test_all_sessions_destroyed_when_enabling_2fa_by_admin() {
$admin_id = self::factory()->user->create(
array(
'role' => 'administrator'
)
);
wp_set_current_user( $admin_id );

// Create an admin session,.
$admin_session_manager = WP_Session_Tokens::get_instance( $admin_id );

$admin_session_manager->create( time() + DAY_IN_SECONDS );
$this->assertCount( 1, $admin_session_manager->get_all(), 'No admin sessions are present first' );

// Create the target user.
$user_id = self::factory()->user->create(
array(
'user_login' => 'username',
'user_pass' => 'password',
)
);

$session_manager = WP_Session_Tokens::get_instance( $user_id );

$this->assertCount( 0, $session_manager->get_all(), 'No user sessions are present first' );

// Generate multiple existing sessions.
$session_manager->create( time() + DAY_IN_SECONDS );
$this->assertCount( 1, $session_manager->get_all(), 'Can fetch active sessions' );

$key = '_nonce_user_two_factor_options';
$nonce = wp_create_nonce( 'user_two_factor_options' );
$_POST[ $key ] = $nonce;
$_REQUEST[ $key ] = $nonce;

$_POST[ Two_Factor_Core::ENABLED_PROVIDERS_USER_META_KEY ] = array( 'Two_Factor_Dummy' => 'Two_Factor_Dummy' );

Two_Factor_Core::user_two_factor_options_update( $user_id );

// Validate that Two-Factor is now enabled.
$this->assertCount( 1, Two_Factor_Core::get_available_providers_for_user( $user_id ) );
$this->assertCount( 1, Two_Factor_Core::get_enabled_providers_for_user( $user_id ) );

// Validate the User has no sessions.
$this->assertCount( 0, $session_manager->get_all(), 'All known authentication sessions have been destroyed' );

// Validate that the Admin still has a session.
$this->assertCount( 1, $admin_session_manager->get_all(), 'No admin sessions are present first' );
}
}