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

Jetpack: Account Protection #40925

Open
wants to merge 50 commits into
base: trunk
Choose a base branch
from
Open

Jetpack: Account Protection #40925

wants to merge 50 commits into from

Conversation

dkmyta
Copy link
Contributor

@dkmyta dkmyta commented Jan 9, 2025

Project branch for the Account Protection project based off of #40923.

Proposed changes:

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:

  • peb6dq-3yG-p2

@dkmyta dkmyta self-assigned this Jan 9, 2025
Copy link
Contributor

github-actions bot commented Jan 9, 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 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. Make sure to test your changes on all platforms that it applies to. You're responsible for the quality of the code you ship.
  3. You can use GitHub's Reviewers functionality to request a review.
  4. When it's reviewed and merged, you will be pinged in Slack to deploy the changes to WordPress.com simple once the build is done.

If you have questions about anything, 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 as soon as you deploy your changes after merging this PR (PCYsg-Jjm-p2).
  • WoA releases happen weekly.
  • Releases to self-hosted sites happen monthly:
    • Scheduled release: March 4, 2025
    • Code freeze: March 3, 2025

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


Protect plugin:

No scheduled milestone found for this plugin.

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 need more details from you. This label will be auto-added until the PR meets all requirements. label Jan 9, 2025
@dkmyta dkmyta marked this pull request as ready for review January 20, 2025 17:56
Base automatically changed from add/packages/account-protection to trunk January 24, 2025 18:44
Copy link
Contributor

github-actions bot commented Jan 24, 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 WoA dev 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 (Jetpack or WordPress.com Site Helper), and enable the add/account-protection branch.
  • To test on Simple, run the following command on your sandbox:
bin/jetpack-downloader test jetpack add/account-protection
bin/jetpack-downloader test jetpack-mu-wpcom-plugin add/account-protection

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

@github-actions github-actions bot added [Feature] WPCOM API [JS Package] API [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ Admin Page React-powered dashboard under the Jetpack menu RNA [Plugin] Protect A plugin with features to protect a site: brute force protection, security scanning, and a WAF. labels Jan 24, 2025
@dkmyta dkmyta force-pushed the add/account-protection branch from a4b2f4a to 639a306 Compare January 29, 2025 21:06
Copy link
Contributor

github-actions bot commented Jan 31, 2025

Code Coverage Summary

Coverage changed in 5 files.

File Coverage Δ% Δ Uncovered
projects/plugins/protect/src/class-rest-controller.php 0/286 (0.00%) 0.00% 41 💔
projects/packages/account-protection/src/class-account-protection.php 29/49 (59.18%) -40.82% 20 💔
projects/plugins/jetpack/modules/module-headings.php 210/1022 (20.55%) 0.03% 18 💔
projects/plugins/protect/src/class-jetpack-protect.php 0/176 (0.00%) 0.00% 4 💔
projects/plugins/jetpack/_inc/client/lib/plans/constants.js 221/273 (80.95%) 0.07% 0 💚

10 files are newly checked for coverage. Only the first 5 are listed here.

File Coverage
projects/plugins/jetpack/_inc/client/components/data/query-account-protection-settings/index.jsx 0/8 (0.00%) 💔
projects/plugins/jetpack/_inc/client/security/account-protection.jsx 0/6 (0.00%) 💔
projects/packages/account-protection/src/class-password-strength-meter.php 1/48 (2.08%) 💔
projects/packages/account-protection/src/class-validation-service.php 52/125 (41.60%) ❤️‍🩹
projects/packages/account-protection/src/class-password-manager.php 21/31 (67.74%) 💚

Full summary · PHP report · JS report

Add label I don't care about code coverage for this PR Use this label to ignore the check for insufficient code coveage. to override the failing coverage check.

Copy link

jp-launch-control bot commented Feb 15, 2025

Code Coverage Summary

Coverage changed in 8 files. Only the first 5 are listed here.

File Coverage Δ% Δ Uncovered
projects/plugins/protect/src/class-rest-controller.php 0/261 (0.00%) 0.00% 41 💔
projects/packages/account-protection/src/class-account-protection.php 32/56 (57.14%) -42.86% 24 💔
projects/plugins/jetpack/modules/module-headings.php 210/1022 (20.55%) 0.03% 18 💔
projects/packages/my-jetpack/src/products/class-protect.php 27/153 (17.65%) -0.85% 7 💔
projects/plugins/protect/src/class-jetpack-protect.php 0/173 (0.00%) 0.00% 4 💔

10 files are newly checked for coverage. Only the first 5 are listed here.

File Coverage
projects/plugins/jetpack/_inc/client/components/data/query-account-protection-settings/index.jsx 0/8 (0.00%) 💔
projects/plugins/jetpack/_inc/client/security/account-protection.jsx 0/7 (0.00%) 💔
projects/packages/account-protection/src/class-password-strength-meter.php 1/44 (2.27%) 💔
projects/packages/account-protection/src/class-validation-service.php 53/127 (41.73%) ❤️‍🩹
projects/packages/account-protection/src/class-password-detection.php 165/251 (65.74%) 💚

Full summary · PHP report · JS report

If appropriate, add one of these labels to override the failing coverage check: Covered by non-unit tests Use to ignore the Code coverage requirement check when E2Es or other non-unit tests cover the code Coverage tests to be added later Use to ignore the Code coverage requirement check when tests will be added in a follow-up PR I don't care about code coverage for this PR Use this label to ignore the check for insufficient code coveage.

* Module Name: Account protection
* Module Description: When enabled, users can only set passwords that meet strong security standards, helping protect their accounts and your site.
* Sort Order: 4
* First Introduced: $$next-version$$
Copy link
Contributor Author

@dkmyta dkmyta Feb 16, 2025

Choose a reason for hiding this comment

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

Suggested change
* First Introduced: $$next-version$$
* First Introduced: 14.4

This caused build errors, reverted for now but leaving this here as a reminder that this will need to be updated.

[plugins/jetpack 4.266] ::error file=projects/plugins/jetpack/modules/account-protection.php,line=6::Unexpected `$$next-version$$` token.
[plugins/jetpack 5.382] Build failed: Error: Command failed with exit code 1: /home/runner/work/jetpack/jetpack/tools/replace-next-version-tag.sh -v plugins/jetpack 14.4-a.4

dkmyta and others added 26 commits February 28, 2025 14:41
* Protect: use object for account protection settings, add isEnabled and isSupported

* Add test for Settings class

* Minor clean up
…ments (#41830)

* Protect: use object for account protection settings, add isEnabled and isSupported

* Protect: disable account protection toggle when not supported in current env

* Adjust implementation

* Remove custom class name for disabled case

* Fix tests

* Fix error

* Align copy

---------

Co-authored-by: dkmyta <[email protected]>
Co-authored-by: dkmyta <[email protected]>
…ments (#41831)

* Protect: use object for account protection settings, add isEnabled and isSupported

* Jetpack: disable account protection toggle and show notice when in unsupported env

* Use SimpleNotice and adjust position

* Refactor

---------

Co-authored-by: dkmyta <[email protected]>
* Protect: use object for account protection settings, add isEnabled and isSupported

* Jetpack: disable account protection toggle and show notice when in unsupported env

* Use SimpleNotice and adjust position

* Refactor

* Adjust account protection settings UI in Jetpack

---------

Co-authored-by: dkmyta <[email protected]>
* Close modal after auth success

* Simplify

* Improve render_content logic

* Fix phan errors

* Simplify body class logic and remove ABSPATH check
* Add Account Protection toggle to Jetpack security settings

* Import package and run activation/deactivation on module toggle

* changelog

* Add Protect Settings page and hook up Account Protection toggle

* changelog

* Update changelog

* Register modules on plugin activation

* Ensure package is initialized on plugin activation

* Make account protection class init static

* Add auth hooks, redirect and a custom login action template

* Reorg, add Password_Detection class

* Remove user cxn req and banner

* Do not enabled module by default

* Add strict mode option and settings toggle

* changelog

* Add strict mode toggle

* Add strict mode toggle and endpoints

* Reorg and add kill switch and is supported check

* Add testing infrastructure

* Add email handlings, resend AJAX action, and attempt limitations

* Add nonces, checks and template error handling

* Use method over template to avoid lint errors

* Improve render_password_detection_template, update SVG file ext

* Remove template file and include

* Prep for validation endpoints

* Update classes to be dynamic

* Add constructors

* Reorg user meta methods

* Add type declarations and hinting

* Simplify method naming

* Use dynamic classes

* Update class dependencies

* Fix copy

* Revert unrelated changes

* Revert unrelated changes

* Fix method calls

* Do not activate by default

* Fix phan errors

* Changelog

* Update composer deps

* Update lock files, add constructor method

* Fix php warning

* Update lock file

* Changelog

* Fix Password_Detection constructor

* Changelog

* More changelogs

* Remove comments

* Fix static analysis errors

* Remove top level phpunit.xml.dist

* Remove never return type

* Revert tests dir changes in favour of a dedicated task

* Add tests dir

* Reapply default test infrastructure

* Reorg and rename

* Update @Package

* Use never phpdoc return type as per static analysis error

* Enable module by default

* Enable module by default

* Remove all reference to and functionality of strict mode

* Remove unneeded strict mode code, update Protect settings UI

* Updates/fixes

* Fix import

* Update placeholder content

* Revert unrelated changes

* Remove missed code

* Update reset email to two factor auth email

* Updates and improvements

* Reorg

* Optimizations and reorganizations

* Hook up email service

* Update error handling todos, fix weak password check

* Test

* Localize text content

* Fix lint warnings/errors

* Update todos

* Add error handling, enforce input restrictions

* Move main constants back entry file

* Fix package version check

* Optimize setting error transient

* Add nonce check for resend email action

* Fix spacing

* Fix resend nonce handling

* Email service fixes

* Fixes, improvements to doc consistency

* Add remaining password validation

* Update weak password check returns

* Fix phan errors

* Revert prior change

* Fix meta key

* Add process for add/updating recent pass list

* Send auth code via wpcom only

* Update method name

* Optimize validation

* Fix key, remove testing code

* Fix docs

* Add foundation for the custom password strength meter

* Fix tests

* Add ajax request for password validation

* Improve matches user data logic

* Remove password reset nonce verification code

* Updates and fixes

* Updates and improvements

* Include tests for new validation methods

* Include tests for new validation methods

* Add password manager class tests

* Add password validation status handling and hook up ajax callback

* Update variables names

* Add loading state

* Remove todos

* Add nonce to ajax request

* Remove custom nonce, add core create-user nonce check

* Remove todos - always run server side validation

* Update constant naming

* Translate error message

* Ensure styles are enqueued when viewing the password detection page

* Use global page now and action check to enqueue styles

* Skip recent password checks during create user action

* Additional skips, and comment clarification

* Revert skips of user specific reset form validation, hook provides access to this

* Revert unintended additions

* Return early if update is irrelevant

* Only verify nonce if pass is set

* Skip validation if bypass enabled

* Improve logic

* Improvements and reorg

* Add info popovers

* Add core req to initial validation state

* Generalize core info popover message

* Fix core strength meter status

* Remove testing code

* Ensure save enabled when appropriate

* Update todos

* Center validation items

* Fix tests

* Save alt approach

* Fix styling, centralize core references

* Reorg

* Use global pagenow for context, restrict user specific check to profile updates

* Compartmentalize generating and appending validation meter and status initial states

* Optimization and reorg improvements

* Remove todos

* Remove unneeded comments

* Ensure info popover fits in all form views

* Fix test

* Fix test

* Update methods, removes nonce checks, fix tests

* Fix test

* Remove comment

* Fix bindEvents

* Correct colors

* Add aria-live attr to strength-meter

* Remove core input mods and use custom selectors to apply strength meter margins

* Update core validation item message, and display only on failure

* Add clarifying comment

* Remove unnecessary user->ID check, and redundant method

* Only render validating state if not already validating

* Debounce input event listener to limit number of requests

* Ensure hidden checklist items get re-hidden when validating

* Optimize icon svgs

* Improve text centering
* Add Account Protection to pricing table

* changelog
… validation failure (#41941)

* Do not log failed attempts of validation failure

* changelog

* Minor adjustments to PHPdoc comments

---------

Co-authored-by: Nate Weller <[email protected]>
* Update to support links

* Fix link concat

* Fix typo

* Ensure all links open new window
…detected (#41956)

* Update to support links

* Fix link concat

* Fix typo

* Ensure all links open new window

* Disable feature in Protect if unsupported Jetpack version is found

* Fix phan errors

* Update checks to Jetpack 14.5
* Improve the display of error notices on the password detection screen

* Improve success flow, add success notices

* Fix phan errors

* Fix tests

* Fix notice responsiveness

* Use API errors and error object for setting error transients

* Use correct transient prefix constant

* Improve rate limiting

* Enforce request limit per token

* Update account recovery message

* Fix constant

* General constants

* Remove unneeded comments

* Update email request limit message

* Show recovery message on email_send_error also

* Fix phan errors

* Update recovery message to recommend a password reset

* Fix typo

* Remove unrelated changes

* Fix expected transient prefix in tests

---------

Co-authored-by: Nate Weller <[email protected]>
* Optimize icon rendering

* Fix passwordInput border flicker after empty state

* Add todos

* Reorg

* Improve styling

* Remove unused assets

---------

Co-authored-by: Nate Weller <[email protected]>
* Set and validate transient to avoid bypass

* Use user ID in validation
@nateweller nateweller force-pushed the add/account-protection branch from dafcb31 to d224ab8 Compare February 28, 2025 21:43
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 Docs E2E Tests [Feature] WPCOM API [JS Package] API [Package] Account Protection [Package] My Jetpack [Package] WAF [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 [Status] In Progress [Status] Needs Author Reply We need more details from you. This label will be auto-added until the PR meets all requirements. [Tests] Includes Tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants