Skip to content

Fix empty backup code when appending codes for a user with none #958

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

Open
faithcoder wants to merge 1 commit into
base: master
Choose a base branch
from
+29 −1
Open

Fix empty backup code when appending codes for a user with none #958

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 2 additions & 1 deletion providers/class-two-factor-backup-codes.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -317,7 +317,8 @@ public function generate_codes( $user, $args = array() ) {

// Append or replace (default).
if ( isset( $args['method'] ) && 'append' === $args['method'] ) {
$codes_hashed = (array) get_user_meta( $user->ID, self::BACKUP_CODES_META_KEY, true );
$existing = get_user_meta( $user->ID, self::BACKUP_CODES_META_KEY, true );
$codes_hashed = is_array( $existing ) ? $existing : array();
}

$code_length = $this->get_backup_code_length( $user );
Expand Down
27 changes: 27 additions & 0 deletions tests/providers/class-two-factor-backup-codes.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,6 +201,33 @@ public function test_delete_code() {
$this->assertEquals( 1, $this->provider->codes_remaining_for_user( $user ) );
}

/**
* Verify appending codes for a user with no existing codes does not store an empty entry.
*
* @covers Two_Factor_Backup_Codes::generate_codes
* @covers Two_Factor_Backup_Codes::codes_remaining_for_user
*/
public function test_generate_codes_append_with_no_existing_codes() {
$user = new WP_User( self::factory()->user->create() );

$codes = $this->provider->generate_codes(
$user,
array(
'number' => Two_Factor_Backup_Codes::NUMBER_OF_CODES,
'method' => 'append',
)
);

$this->assertCount( Two_Factor_Backup_Codes::NUMBER_OF_CODES, $codes );

$backup_codes = get_user_meta( $user->ID, Two_Factor_Backup_Codes::BACKUP_CODES_META_KEY, true );

$this->assertIsArray( $backup_codes );
$this->assertCount( Two_Factor_Backup_Codes::NUMBER_OF_CODES, $backup_codes );
$this->assertNotContains( '', $backup_codes );
$this->assertEquals( Two_Factor_Backup_Codes::NUMBER_OF_CODES, $this->provider->codes_remaining_for_user( $user ) );
}

/**
* Test backup code length filter.
*/
Expand Down
Loading