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

[Security Solutions][Detection Engine][Meta][Remix] - Migration of security_solution rules to Stack Management export/import/copy #124294

Open
3 tasks
yctercero opened this issue Feb 1, 2022 · 5 comments
Labels
8.2 candidate considered, but not committed, for 8.2 release Team:Detection Engine Security Solution Detection Engine Area Team:Detection Rule Management Security Detection Rule Management Team Team:Detections and Resp Security Detection Response Team Team: SecuritySolution Security Solutions Team working on SIEM, Endpoint, Timeline, Resolver, etc. Team:Threat Hunting:Investigations Security Solution Investigations Team Team:Threat Hunting Security Solution Threat Hunting Team

Comments

@yctercero
Copy link
Contributor

yctercero commented Feb 1, 2022

Objective

At it's most basic, we want to enable security solution rules to be exported using the Stack Management UI/APIs and begin deprecating our own import/export API.

A ticket that dives more into the technical details and different considerations/use cases thought through exists here. This issue is meant to be more high level.

Security Solution Rules At a Glance

Screen Shot 2022-02-01 at 1 08 33 PM

Current Experience

As a security solution user, I want to export my security solution rules and all saved objects associated with it:

  • Go to the security solution rule management UI and select rules to export
  • Export file includes rules and exceptions
  • Connectors are not included, you must export those by going to the Stack Management UI

As a user of multiple solutions, I want to export my rules and all saved objects associated with it:

  • Go to the stack management page and import/export your non security solution rules
  • Go to the security solution rule management UI and select rules to export
  • Export file includes rules and exceptions
  • Connectors are not included, you must export those by going to the Stack Management UI
  • Rules from SOM and rules exported from security solution will be exported in two different formats

Proposed Experience

As a security solution user, I want to export my security solution rules and all saved objects associated with it:

  • Go to the rules management page and import/export is available in the same format as the SOM
  • OR go to the stack management page and import/export rules

As a user of multiple solutions, I want to export my rules and all saved objects associated with it:

  • Go to the stack management page and import/export rules (not needing to think through which solution the rules belong to)

Exclusions

  • Value lists (stored in data indices)
    • Not currently accessible within our own import/export - no value added/subtracted here in moving to the SOM

Possible effects to user experience

  • No support for data validation on import/export. More details discussed here.
    • -Our current security solution import/export endpoints conduct thorough validations
    • -This means users can break themselves by importing an invalid structure
    • +However, they are provided a way to fix themselves and additional validation can be added client side (on our end, not talking about the SOM client)
    • +Other solutions currently use the SOM as is

TLDR

This effort is more than just a matter of user experience. On the technical side, security solution is currently maintaining a separate export/import API and needing to implement functionality to maintain parity with the SOM. Complexity has increased as shareable saved objects are introduced.

Open questions

  • Security solution makes use of signature ids (rule_id, timeline_template_id, item_id, list_id) - is there any support for this in core? What would signature id clashes look like in export/import?
  • Can timeline move to SOM, if not, can we exclude? What's needed to move over?
  • Can trusted apps move to SOM, if not, can we exclude? What's needed to move over?
@yctercero yctercero added Team: SecuritySolution Security Solutions Team working on SIEM, Endpoint, Timeline, Resolver, etc. Team:Security Solution Platform Security Solution Platform Team Team:Detection Rule Management Security Detection Rule Management Team Team:Threat Hunting:Investigations Security Solution Investigations Team 8.2 candidate considered, but not committed, for 8.2 release labels Feb 1, 2022
@elasticmachine
Copy link
Contributor

Pinging @elastic/security-solution (Team: SecuritySolution)

@jethr0null
Copy link

Huge +1 on the proposed experience.

@yctercero
Copy link
Contributor Author

NOTE: It appears that meta fields in the SOM are taken from the import file and written to the SOs (created_by, created_at, udpated_by, updated_at). This diverges from our current import/export that prevented a user from specifying these fields for security purposes.

@MindyRS MindyRS added the Team:Threat Hunting Security Solution Threat Hunting Team label Feb 23, 2022
@elasticmachine
Copy link
Contributor

Pinging @elastic/security-threat-hunting (Team:Threat Hunting)

@MindyRS MindyRS added the Team:Detections and Resp Security Detection Response Team label Feb 23, 2022
@elasticmachine
Copy link
Contributor

Pinging @elastic/security-detections-response (Team:Detections and Resp)

@yctercero yctercero added Team:Detection Engine Security Solution Detection Engine Area and removed Team:Security Solution Platform Security Solution Platform Team labels May 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
8.2 candidate considered, but not committed, for 8.2 release Team:Detection Engine Security Solution Detection Engine Area Team:Detection Rule Management Security Detection Rule Management Team Team:Detections and Resp Security Detection Response Team Team: SecuritySolution Security Solutions Team working on SIEM, Endpoint, Timeline, Resolver, etc. Team:Threat Hunting:Investigations Security Solution Investigations Team Team:Threat Hunting Security Solution Threat Hunting Team
Projects
None yet
Development

No branches or pull requests

4 participants