[Security Solution] Add support for editing prebuilt rules to the Rule Editing page #199550
+14
−8
Conversation
This file contains 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
dplumlee
added
release_note:skip
|
Pinging @elastic/security-detections-response (Team:Detections and Resp) |
|
Pinging @elastic/security-solution (Team: SecuritySolution) |
|
Pinging @elastic/security-detection-rule-management (Team:Detection Rule Management) |
dhurley14
approved these changes
Nov 13, 2024
...gins/security_solution/public/detection_engine/rule_creation_ui/pages/rule_editing/index.tsx
Outdated
Show resolved
Hide resolved
|
@elasticmachine merge upstream |
💚 Build Succeeded
Metrics [docs]Async chunks
History
cc @dplumlee |
banderror
approved these changes
Nov 13, 2024
There was a problem hiding this comment.
Tested with a few prebuilt rules with the feature flag ON, one of them was the Member Removed From GitHub Organization rule.
I can confirm that the following use cases work on the Rule Editing page:
- All the tabs are enabled and available for editing: Definition, About, Schedule, Actions.
- It's NOT possible to change the rule type.
- Possible to customize index patterns.
- Possible to customize EQL query.
- The non-blocking data validation works: we show that "This rule has validation errors" modal window if certain fields or indices are missing, and it's still possible to save the rule.
- Possible to customize related integrations.
- Possible to customize Timeline template.
- Possible to customize rule name.
- Possible to customize description.
- Possible to customize default severity.
- Possible to customize default risk score.
- Possible to customize schedule.
- Possible to edit rule actions.
Testing of the Rule Editing page with the flag OFF was done right before that here.
The only issue I keep noticing is that almost any attempt to customize a prebuilt rule marks it as customized, even in the cases when it shouldn't. I guess this is the same bug as #199629. For example:
- When you edit a prebuilt rule, change nothing, and save it.
- When you bulk add rule actions. With some prebuilt rules it works correctly, with some of them it doesn't.
We will need to do more thorough per-field manual testing, and also cover each field with tests, when we start working on test plans.
But this PR as is LGTM and the code changes too 👍
Thank you @dplumlee! 🚢
|
Starting backport for target branches: 8.x |
kibanamachine
pushed a commit
to kibanamachine/kibana
that referenced
this pull request
Nov 13, 2024
…e Editing page (elastic#199550) **Resolves: elastic#180172 ## Summary > [!NOTE] > Feature is behind the `prebuiltRulesCustomizationEnabled` feature flag. Removes the logic gates preventing prebuilt rules from being edited via the Rule Edit page behind the `prebuiltRulesCustomizationEnabled` feature flag. This allows all rules types to be fully editable via the UI. Also removes the muting logic we had in place for `Definition` tab warnings ([implemented here](elastic#191487)) ### Screenshots #### _Before_ **Prebuilt rule only has the "Actions" tab enabled, users cannot customize anything else in the form**  #### _After_ **Prebuilt rule now has all tabs/fields available for editing and rule info is populated into the form**  ### Checklist Delete any items that are not applicable to this PR. - [ ] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios ### For maintainers - [ ] This was checked for breaking API changes and was [labeled appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#_add_your_labels) - [ ] This will appear in the **Release Notes** and follow the [guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) --------- Co-authored-by: Elastic Machine <[email protected]> (cherry picked from commit d6e6145)
💚 All backports created successfully
Note: Successful backport PRs will be merged automatically after passing CI. Questions ?Please refer to the Backport tool documentation |
kibanamachine
added a commit
that referenced
this pull request
Nov 14, 2024
…he Rule Editing page (#199550) (#200106) # Backport This will backport the following commits from `main` to `8.x`: - [[Security Solution] Add support for editing prebuilt rules to the Rule Editing page (#199550)](#199550) <!--- Backport version: 9.4.3 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"Davis Plumlee","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-11-13T23:04:38Z","message":"[Security Solution] Add support for editing prebuilt rules to the Rule Editing page (#199550)\n\n**Resolves: https://github.com/elastic/kibana/issues/180172**\r\n\r\n## Summary\r\n\r\n> [!NOTE] \r\n> Feature is behind the `prebuiltRulesCustomizationEnabled` feature\r\nflag.\r\n\r\nRemoves the logic gates preventing prebuilt rules from being edited via\r\nthe Rule Edit page behind the `prebuiltRulesCustomizationEnabled`\r\nfeature flag. This allows all rules types to be fully editable via the\r\nUI.\r\n\r\nAlso removes the muting logic we had in place for `Definition` tab\r\nwarnings ([implemented\r\nhere](https://github.com/elastic/kibana/pull/191487))\r\n\r\n### Screenshots\r\n\r\n#### _Before_\r\n\r\n**Prebuilt rule only has the \"Actions\" tab enabled, users cannot\r\ncustomize anything else in the form**\r\n\r\n\r\n\r\n#### _After_\r\n\r\n**Prebuilt rule now has all tabs/fields available for editing and rule\r\ninfo is populated into the form**\r\n\r\n\r\n### Checklist\r\n\r\nDelete any items that are not applicable to this PR.\r\n\r\n- [ ] [Unit or functional\r\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\r\nwere updated or added to match the most common scenarios\r\n\r\n\r\n\r\n### For maintainers\r\n\r\n- [ ] This was checked for breaking API changes and was [labeled\r\nappropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#_add_your_labels)\r\n- [ ] This will appear in the **Release Notes** and follow the\r\n[guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)\r\n\r\n---------\r\n\r\nCo-authored-by: Elastic Machine <[email protected]>","sha":"d6e6145dacf25bf3e900611425434b0713bce005","branchLabelMapping":{"^v9.0.0$":"main","^v8.17.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","v9.0.0","Team:Detections and Resp","Team: SecuritySolution","Team:Detection Rule Management","Feature:Prebuilt Detection Rules","backport:version","v8.17.0"],"title":"[Security Solution] Add support for editing prebuilt rules to the Rule Editing page","number":199550,"url":"https://github.com/elastic/kibana/pull/199550","mergeCommit":{"message":"[Security Solution] Add support for editing prebuilt rules to the Rule Editing page (#199550)\n\n**Resolves: https://github.com/elastic/kibana/issues/180172**\r\n\r\n## Summary\r\n\r\n> [!NOTE] \r\n> Feature is behind the `prebuiltRulesCustomizationEnabled` feature\r\nflag.\r\n\r\nRemoves the logic gates preventing prebuilt rules from being edited via\r\nthe Rule Edit page behind the `prebuiltRulesCustomizationEnabled`\r\nfeature flag. This allows all rules types to be fully editable via the\r\nUI.\r\n\r\nAlso removes the muting logic we had in place for `Definition` tab\r\nwarnings ([implemented\r\nhere](https://github.com/elastic/kibana/pull/191487))\r\n\r\n### Screenshots\r\n\r\n#### _Before_\r\n\r\n**Prebuilt rule only has the \"Actions\" tab enabled, users cannot\r\ncustomize anything else in the form**\r\n\r\n\r\n\r\n#### _After_\r\n\r\n**Prebuilt rule now has all tabs/fields available for editing and rule\r\ninfo is populated into the form**\r\n\r\n\r\n### Checklist\r\n\r\nDelete any items that are not applicable to this PR.\r\n\r\n- [ ] [Unit or functional\r\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\r\nwere updated or added to match the most common scenarios\r\n\r\n\r\n\r\n### For maintainers\r\n\r\n- [ ] This was checked for breaking API changes and was [labeled\r\nappropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#_add_your_labels)\r\n- [ ] This will appear in the **Release Notes** and follow the\r\n[guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)\r\n\r\n---------\r\n\r\nCo-authored-by: Elastic Machine <[email protected]>","sha":"d6e6145dacf25bf3e900611425434b0713bce005"}},"sourceBranch":"main","suggestedTargetBranches":["8.x"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/199550","number":199550,"mergeCommit":{"message":"[Security Solution] Add support for editing prebuilt rules to the Rule Editing page (#199550)\n\n**Resolves: https://github.com/elastic/kibana/issues/180172**\r\n\r\n## Summary\r\n\r\n> [!NOTE] \r\n> Feature is behind the `prebuiltRulesCustomizationEnabled` feature\r\nflag.\r\n\r\nRemoves the logic gates preventing prebuilt rules from being edited via\r\nthe Rule Edit page behind the `prebuiltRulesCustomizationEnabled`\r\nfeature flag. This allows all rules types to be fully editable via the\r\nUI.\r\n\r\nAlso removes the muting logic we had in place for `Definition` tab\r\nwarnings ([implemented\r\nhere](https://github.com/elastic/kibana/pull/191487))\r\n\r\n### Screenshots\r\n\r\n#### _Before_\r\n\r\n**Prebuilt rule only has the \"Actions\" tab enabled, users cannot\r\ncustomize anything else in the form**\r\n\r\n\r\n\r\n#### _After_\r\n\r\n**Prebuilt rule now has all tabs/fields available for editing and rule\r\ninfo is populated into the form**\r\n\r\n\r\n### Checklist\r\n\r\nDelete any items that are not applicable to this PR.\r\n\r\n- [ ] [Unit or functional\r\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\r\nwere updated or added to match the most common scenarios\r\n\r\n\r\n\r\n### For maintainers\r\n\r\n- [ ] This was checked for breaking API changes and was [labeled\r\nappropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#_add_your_labels)\r\n- [ ] This will appear in the **Release Notes** and follow the\r\n[guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)\r\n\r\n---------\r\n\r\nCo-authored-by: Elastic Machine <[email protected]>","sha":"d6e6145dacf25bf3e900611425434b0713bce005"}},{"branch":"8.x","label":"v8.17.0","branchLabelMappingKey":"^v8.17.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT--> Co-authored-by: Davis Plumlee <[email protected]> Co-authored-by: Elastic Machine <[email protected]>
CAWilson94
pushed a commit
to CAWilson94/kibana
that referenced
this pull request
Nov 18, 2024
…e Editing page (elastic#199550) **Resolves: elastic#180172 ## Summary > [!NOTE] > Feature is behind the `prebuiltRulesCustomizationEnabled` feature flag. Removes the logic gates preventing prebuilt rules from being edited via the Rule Edit page behind the `prebuiltRulesCustomizationEnabled` feature flag. This allows all rules types to be fully editable via the UI. Also removes the muting logic we had in place for `Definition` tab warnings ([implemented here](elastic#191487)) ### Screenshots #### _Before_ **Prebuilt rule only has the "Actions" tab enabled, users cannot customize anything else in the form**  #### _After_ **Prebuilt rule now has all tabs/fields available for editing and rule info is populated into the form**  ### Checklist Delete any items that are not applicable to this PR. - [ ] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios ### For maintainers - [ ] This was checked for breaking API changes and was [labeled appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#_add_your_labels) - [ ] This will appear in the **Release Notes** and follow the [guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) --------- Co-authored-by: Elastic Machine <[email protected]>
CAWilson94
pushed a commit
to CAWilson94/kibana
that referenced
this pull request
Nov 18, 2024
…e Editing page (elastic#199550) **Resolves: elastic#180172 ## Summary > [!NOTE] > Feature is behind the `prebuiltRulesCustomizationEnabled` feature flag. Removes the logic gates preventing prebuilt rules from being edited via the Rule Edit page behind the `prebuiltRulesCustomizationEnabled` feature flag. This allows all rules types to be fully editable via the UI. Also removes the muting logic we had in place for `Definition` tab warnings ([implemented here](elastic#191487)) ### Screenshots #### _Before_ **Prebuilt rule only has the "Actions" tab enabled, users cannot customize anything else in the form**  #### _After_ **Prebuilt rule now has all tabs/fields available for editing and rule info is populated into the form**  ### Checklist Delete any items that are not applicable to this PR. - [ ] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios ### For maintainers - [ ] This was checked for breaking API changes and was [labeled appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#_add_your_labels) - [ ] This will appear in the **Release Notes** and follow the [guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) --------- Co-authored-by: Elastic Machine <[email protected]>
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.
Resolves: #180172
Summary
Note
Feature is behind the
prebuiltRulesCustomizationEnabledfeature flag.Removes the logic gates preventing prebuilt rules from being edited via the Rule Edit page behind the
prebuiltRulesCustomizationEnabledfeature flag. This allows all rules types to be fully editable via the UI.Also removes the muting logic we had in place for
Definitiontab warnings (implemented here)Screenshots
Before
Prebuilt rule only has the "Actions" tab enabled, users cannot customize anything else in the form
After
Prebuilt rule now has all tabs/fields available for editing and rule info is populated into the form
Checklist
Delete any items that are not applicable to this PR.
For maintainers