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

Protect: Add IP block and allow list toggles #38265

Merged
merged 20 commits into from
Jul 17, 2024

Conversation

dkmyta
Copy link
Contributor

@dkmyta dkmyta commented Jul 9, 2024

Description

Updates the Protect Firewall UI to allow the IP block and allow lists to be toggled independently.

Proposed changes:

  • Makes use of the new jetpack_waf_ip_allow_list_enabled / jetpack_waf_ip_block_list_enabled settings, replacing jetpack_waf_ip_list
  • Removes the dedicated page manual rules and adds independent toggles for each IP list to the primary Firewall page
  • Modifies sections dependent on the original setting

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
  • Start up JT, and enable Protect
  • Proceed to Firewall settings and toggle the various options in different combinations
  • Ensure the settings all perform as expected and that no regressions are introduced
  • Manually set Waf_Runner::is_unsupported_environment to false and verify that the BFP allow list still functions
  • Upgrade and downgrade and ensure all expected settings are still accessible and functional
  • Verify that a blocklisted IP cannot make requests or access the site admin when BFP is enabled
  • Ensure that the blocked IP can once again do so once whitelisted
  • Ensure cross compatibility exists when Jetpack is enabled and the settings are toggled from that end
  • Ensure backward compatibility exists when the update is applied to an existing site with the prior settings in place

Screenshots

Enabled:
Screen Shot 2024-07-17 at 08 55 18

Disabled:
Screen Shot 2024-07-17 at 08 57 01

WAF Disabled:
Screen Shot 2024-07-17 at 08 58 07

Unsupported Env:
Screen Shot 2024-07-17 at 09 04 33

@github-actions github-actions bot added [Plugin] Protect A plugin with features to protect a site: brute force protection, security scanning, and a WAF. [Status] In Progress labels Jul 9, 2024
Copy link
Contributor

github-actions bot commented Jul 9, 2024

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 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.


Once your PR is ready for review, check one last time that all required checks appearing at the bottom of this PR are passing or skipped.
Then, add the "[Status] Needs Team Review" label and ask someone from your team review the code. Once reviewed, it can then be merged.
If you need an extra review from someone familiar with the codebase, you can update the labels from "[Status] Needs Team Review" to "[Status] Needs Review", and in that case Jetpack Approvers will do a final review of your PR.


Jetpack plugin:

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

  • WordPress.com Simple releases happen daily.
  • WoA releases happen weekly.
  • Releases to self-hosted sites happen monthly. The next release is scheduled for August 6, 2024 (scheduled code freeze on August 5, 2024).

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


Protect plugin:

  • Next scheduled release: August 6, 2024.
  • Scheduled code freeze: July 29, 2024.

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

@dkmyta dkmyta self-assigned this Jul 9, 2024
Base automatically changed from add/waf/ip-list-toggles to trunk July 15, 2024 17:25
@github-actions github-actions bot added the [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ label Jul 15, 2024
@dkmyta dkmyta marked this pull request as ready for review July 15, 2024 17:27
Comment on lines 173 to 174
// Only attempt to update the WAF if the module is supported and enabled.
if ( Waf_Runner::is_supported_environment() && Waf_Runner::is_enabled() ) {
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm wondering if #38326 makes this change unnecessary, I will double check.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yep, just merged the change and it appears to no longer be an issue! I'll revert this now.

@nateweller
Copy link
Contributor

Suggestion –

Now that the waf package supports separate toggling of the allow/block list, there's opportunity here to simplify our code and remove the duplication of the allow list.

We could get rid of the manualRulesSettings and "manual rules" concept entirely, and output each toggle individually.

i.e.

<div className={ styles[ 'toggle-wrapper' ] }>
    { wafSupported && automaticRulesSettings }
    { bruteForceProtectionSettings }
    { wafSupported && ipBlockListSettings }
    { ipAllowListSettings }
</div>
@nateweller
Copy link
Contributor

What do you think about this positioning for the "add IP to allow list" button?

Screenshot 2024-07-15 at 1 30 45 PM
@dkmyta dkmyta requested a review from nateweller July 15, 2024 21:32
<Col>
<div className={ styles[ 'toggle-wrapper' ] }>
{ wafSupported && automaticRulesSettings }
{ bruteForceProtectionSettings }
Copy link
Contributor

Choose a reason for hiding this comment

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

Minor – can we move the ipAllowList out of bruteForceProtectionSettings and have it rendered here? Will improve readability as the allow list is contextually applicable at this higher level.

i.e.

{ wafSupported && automaticRulesSettings }
{ bruteForceProtectionSettings }
{ ipAllowListSettings }
{ wafSupported && ipBlockListSettings }
<>
<Text mb={ 1 }>
{ __(
"IP addresses added to this list will never be blocked by Jetpack's brute force protection.",
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggestion – can we keep the description for the allow list, i.e. "IP addresses added to this list will never be blocked by Jetpack's security features."

@nateweller
Copy link
Contributor

Code looks great, tests great as well!

What do you think about swapping the order of the allow/block list? My thinking being, the block list is more related to the firewall features, and the allow list is a final exception to any of the features on the page, so it might be suited at the bottom.

nateweller
nateweller previously approved these changes Jul 16, 2024
Copy link
Contributor

@nateweller nateweller left a comment

Choose a reason for hiding this comment

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

Looks good and tests well! LGTM 👍 👍

Copy link
Contributor

@nateweller nateweller left a comment

Choose a reason for hiding this comment

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

LGTM! 🚢

@dkmyta dkmyta enabled auto-merge (squash) July 17, 2024 20:06
@dkmyta dkmyta merged commit 742a6b2 into trunk Jul 17, 2024
54 checks passed
@dkmyta dkmyta deleted the add/protect-ip-block-and-allow-list-toggles branch July 17, 2024 20:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[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. [Tests] Includes Tests
2 participants