Add filters for email token and backup code length#653
Merged
Conversation
Collaborator
Author
|
This is ready for code review. |
kasparsd
commented
Jan 9, 2025
kasparsd
commented
Jan 9, 2025
| $code_placeholder = str_repeat( 'X', $this->get_backup_code_length( $user ) ); | ||
|
|
||
| ?> | ||
| <p class="two-factor-prompt"><?php esc_html_e( 'Enter a recovery code.', 'two-factor' ); ?></p><br/> |
Collaborator
Author
Merged
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.

Fixes #374.
Replaces #419.
What?
Implements two new filters:
two_factor_email_token_ttlfilter overrides the default 8 character count for email tokens. This has been renamed fromtwo_factor_token_ttlwhich is now marked as deprecated.two_factor_backup_code_lengthfilter overrides the default 8 character count for backup codes. Providers theWP_Userof the associated user as the second argument.Why?
Users might want to increase this.
How?
Introduce the filters and rename existing ones for consistency. Add tests to confirm both old and new filters are working.
Updated the input field placeholders to match the expected character length. Note that this might give away the expected character length for a brute force attacker but we're rate limiting these attempts so that is not an issue.
Testing Instructions
Screenshots or screencast
Note the updated
XXXXcharacters for the placeholders and the correct length. Previously the placeholder was also including spaces but that could have confused the users about the format not matching what they get in the email or app. The input automatically removes invalid characters so the processing happens in either way.Inspiration:
Changelog Entry
Added - Introduce
two_factor_email_token_lengthandtwo_factor_backup_code_lengthfilters for adjusting the length of the respective tokens.