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.

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

Account Protection: Add password detection flow #41105

Conversation

dkmyta
Copy link
Contributor

@dkmyta dkmyta commented Jan 15, 2025

Description

Add the password detection flow as described in the designs.

TODOs:

Reliant on:

Other information:

  • Have you written new tests for your changes, if applicable?
  • Have you checked the E2E test CI results, and verified that your changes do not break them?
  • Have you tested your changes on WordPress.com, if applicable (if so, you'll see a generated comment below with a script to run)?

Jetpack product discussion

Does this pull request change what data or activity we track or use?

  • No

Testing instructions:

  • Checkout this branch
  • Run Jurassic Tube
  • Install and activate either Jetpack or Protect and enable the Account Protection settings
  • Log out and proceed to the wp-login.php form an attempt to log in
    • Note that the validation mechanism here has been forced to detect all attempts as fails
  • Ensure that after the validation fails you are redirected to wp-login.php?action=password-detection and that the initial state of the page is styled as per designs and you are presented relevant details and options
  • Verify that clicking the Proceed without updating button redirects you to /wp-admin and that you now logged in
  • Verify that clicking the Create new password button updates the content accordingly and that the email action is triggered only once on the initial render (disabled by setting and a checking a transient)
    • Note that the email action is not yet hooked up to the new endpoint and does not actually perform anything yet
  • Ensure that the Resend email action dynamically updates the UI with status details and that the email function is triggered
  • Ensure no regressions are introduced to core functionality and that the functionality only applies when the toggle is enabled
  • Review the package code responsible for each task

Screen capture

Screen Capture on 2025-01-20 at 12-03-18 (1)

Copy link
Contributor

github-actions bot commented Jan 15, 2025

Are you an Automattician? Please test your changes on all WordPress.com environments to help mitigate accidental explosions.

  • To test on WoA, go to the Plugins menu on a WordPress.com Simple site. Click on the "Upload" button and follow the upgrade flow to be able to upload, install, and activate the Jetpack Beta plugin. Once the plugin is active, go to Jetpack > Jetpack Beta, select your plugin, and enable the add/packages/account-protection-password-detection-flow branch.

  • To test on Simple, run the following command on your sandbox:

    bin/jetpack-downloader test jetpack add/packages/account-protection-password-detection-flow
    

Interested in more tips and information?

  • In your local development environment, use the jetpack rsync command to sync your changes to a WoA dev blog.
  • Read more about our development workflow here: PCYsg-eg0-p2
  • Figure out when your changes will be shipped to customers here: PCYsg-eg5-p2

Copy link
Contributor

github-actions bot commented Jan 15, 2025

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

  • ✅ Include a description of your PR changes.
  • ✅ Add a "[Status]" label (In Progress, Needs Team Review, ...).
  • 🔴 Add a "[Type]" label (Bug, Enhancement, Janitorial, Task).
  • ✅ Add testing instructions.
  • ✅ Specify whether this PR includes any changes to data or privacy.
  • ✅ Add changelog entries to affected projects

This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖


The e2e test report can be found here. Please note that it can take a few minutes after the e2e tests checks are complete for the report to be available.


Follow this PR Review Process:

  1. Ensure all required checks appearing at the bottom of this PR are passing.
  2. Choose a review path based on your changes:
    • A. Team Review: add the "[Status] Needs Team Review" label
      • For most changes, including minor cross-team impacts.
      • Example: Updating a team-specific component or a small change to a shared library.
    • B. Crew Review: add the "[Status] Needs Review" label
      • For significant changes to core functionality.
      • Example: Major updates to a shared library or complex features.
    • C. Both: Start with Team, then request Crew
      • For complex changes or when you need extra confidence.
      • Example: Refactor affecting multiple systems.
  3. Get at least one approval before merging.

Still unsure? Reach out in #jetpack-developers for guidance!


Jetpack plugin:

The Jetpack plugin has different release cadences depending on the platform:

  • WordPress.com Simple releases happen semi-continuously (PCYsg-Jjm-p2).
  • WoA releases happen weekly.
  • Releases to self-hosted sites happen monthly. The next release is scheduled for February 4, 2025 (scheduled code freeze on February 4, 2025).

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.


Protect plugin:

  • Next scheduled release: none scheduled.

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

@github-actions github-actions bot added the [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! label Jan 15, 2025
Copy link
Member

@ArSn ArSn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some small comments / notes, but nothing that keeps us from merging this. I was also able to test this, contrary to that other PR (which I will try again now).

* @return bool True if the password is valid, false otherwise.
*/
public function validate_password( string $password ): bool {
// TODO: Uncomment out once endpoint is live
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is actually live by now :)


// Check if the password is in the list of common/compromised passwords
$password_suffix = substr( $hashed_password, 5 );
if ( in_array( $password_suffix, $body['compromised'] ?? array(), true ) ) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you might also want to check the common index that is available now. However if we're just going to return true in both cases, we could also combine them. The idea was to adjust the messaging based on what hits, I think (tell the user specifically if it is a common or compromised one) - that being said, most common passwords are also compromised by their nature

<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title><?php echo esc_html( $reset ? 'Jetpack - Stay Secure' : 'Jetpack - Secure Your Account' ); ?></title>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should all these texts be translateable? i.e. using esc_html__ functions et. al.?

<button class="action action-reset" type="submit" name="reset-password">Create a new password</button>
</form>
<form method="post">
<?php wp_nonce_field( 'proceed_action', '_wpnonce_proceed' ); ?>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if we really need a nonce in this case, because we're not updating any data?

Significance: patch
Type: changed

Fixes Account Protection endpoint callback
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this PR does a bit more than that? :)

@dkmyta
Copy link
Contributor Author

dkmyta commented Jan 24, 2025

Merging as is, and will add follow-ups to address the items highlighted.

Base automatically changed from add/protect/account-protection-settings to add/account-protection January 24, 2025 20:15
@github-actions github-actions bot added [Feature] WPCOM API [JS Package] API Admin Page React-powered dashboard under the Jetpack menu RNA labels Jan 24, 2025
@dkmyta dkmyta merged commit 1ec2c34 into add/account-protection Jan 24, 2025
47 checks passed
@dkmyta dkmyta deleted the add/packages/account-protection-password-detection-flow branch January 24, 2025 20:22
@github-actions github-actions bot removed [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! [Status] In Progress labels Jan 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Admin Page React-powered dashboard under the Jetpack menu [Feature] WPCOM API [JS Package] API [Package] Account Protection [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Plugin] Protect A plugin with features to protect a site: brute force protection, security scanning, and a WAF. RNA [Tests] Includes Tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants