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

WAF: Ensure mode is set during activation #39690

Open
wants to merge 1 commit into
base: trunk
Choose a base branch
from

Conversation

nateweller
Copy link
Contributor

@nateweller nateweller commented Oct 8, 2024

Proposed changes:

  • Moves the functionality that ensures certain options exist from the on_waf_activation method (which runs on module activation) into the generic Waf_Runner::activate method (which runs on module activation, plus firewall settings updates).
  • Fixes the case where a site has no "mode" option set, preventing the firewall from falling back into "silent" mode.

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

N/A

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

No

Testing instructions:

  • Test the basic WAF functionality.
  • With the firewall active, delete the jetpack_waf_mode option from your site.
  • Change one of the firewall settings.
  • Verify the jetpack_waf_mode option has been reset to "normal".

@nateweller nateweller requested a review from a team October 8, 2024 19:06
@nateweller nateweller self-assigned this Oct 8, 2024
Copy link
Contributor

github-actions bot commented Oct 8, 2024

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 fix/waf/ensure-mode-option-set branch.

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

    bin/jetpack-downloader test jetpack fix/waf/ensure-mode-option-set
    

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 Oct 8, 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.


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 none scheduled (scheduled code freeze on undefined).

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

@nateweller nateweller added this to the protect/3.1.0 milestone Oct 8, 2024
@nateweller nateweller marked this pull request as ready for review October 8, 2024 19:09
Copy link
Contributor

@dkmyta dkmyta left a comment

Choose a reason for hiding this comment

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

Waf_Runner::activate looks as though it only runs on plugin (or more specifically WAF module, as you've noted) activation - if I delete the option it doesn't appear to get re-set by updating settings.

UPDATE: Oddly enough, I see now that this also is supposed to run on Waf_Rules_Manager::reactivate_on_rules_option_change. With the option set, it does, once deleted, it doesn't 🤔

ANOTHER UPDATE: Ah, Waf_Runner::initialize runs the above and returns early if ! self::is_allowed_mode( JETPACK_WAF_MODE ), which is the case here when the option doesn't exist.

@nateweller nateweller force-pushed the fix/waf/ensure-mode-option-set branch from 0420136 to e1ecba1 Compare October 15, 2024 17:18
@nateweller nateweller force-pushed the fix/waf/ensure-mode-option-set branch from e1ecba1 to cdc40d0 Compare October 27, 2024 21:29
@nateweller nateweller requested a review from dkmyta October 27, 2024 21:29
@nateweller nateweller force-pushed the fix/waf/ensure-mode-option-set branch from cdc40d0 to ad6f61f Compare October 28, 2024 16:44
dkmyta
dkmyta previously approved these changes Oct 28, 2024
Copy link
Contributor

@dkmyta dkmyta left a comment

Choose a reason for hiding this comment

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

Works as described in standard and standalone mode.

One thing I wanted to make note of to ensure it is the expected behaviour, if I delete WAF mode option but don’t reload the UI and update settings the WAF no longer functions to block test requests. It is also does not reset by simply reloading the Firewall UI but rather only on successful WAF settings updates.

@nateweller
Copy link
Contributor Author

Thanks for the review @dkmyta 😄

One thing I wanted to make note of to ensure it is the expected behaviour, if I delete WAF mode option but don’t reload the UI and update settings the WAF no longer functions to block test requests. It is also does not reset by simply reloading the Firewall UI but rather only on successful WAF settings updates.

This is correct, the change here ultimately just moves the setting of the default mode value from the "on waf module activation" event to the more generic "on waf activation".

@nateweller nateweller force-pushed the fix/waf/ensure-mode-option-set branch 2 times, most recently from 4610071 to 86a7647 Compare October 29, 2024 21:30
@nateweller nateweller force-pushed the fix/waf/ensure-mode-option-set branch 2 times, most recently from 43a1be5 to c780f15 Compare November 6, 2024 16:32
@nateweller nateweller force-pushed the fix/waf/ensure-mode-option-set branch from c780f15 to ddb5c34 Compare November 12, 2024 17:43
@nateweller nateweller force-pushed the fix/waf/ensure-mode-option-set branch 3 times, most recently from 13bb302 to b8d9e6b Compare November 13, 2024 18:51
@github-actions github-actions bot added [Tests] Includes Tests [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ labels Nov 13, 2024
Move functionality from module activation into the more generic waf activation method

changelog

Move hooks out of Waf_Runner class

Use update_option to ensure empty/falsey options are updated

Add test teardowns

Use valid blog_charset value in tests

changelog

Revert "Add test teardowns"

This reverts commit bfcf0d1.

Revert "Use valid blog_charset value in tests"

This reverts commit 9d4315d.

Revert "changelog"

This reverts commit 6da6f9f.
@nateweller nateweller force-pushed the fix/waf/ensure-mode-option-set branch from 6da6f9f to bfa3f6d Compare November 13, 2024 21:10
@nateweller nateweller removed this from the protect/3.1.0 milestone Nov 13, 2024
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/ [Status] Needs Team Review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants