Skip to content

crowdstrike.fdr: Parse additional notification payloads using parsing script. #13875

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

Open
wants to merge 10 commits into
base: main
Choose a base branch
from

Conversation

kcreddy
Copy link
Contributor

@kcreddy kcreddy commented May 11, 2025

Proposed commit message

crowdstrike.fdr: Update script to parse all notification payloads.

Current parsing script works well when SQS notification payload 
matches FDR queue notification format. AWS S3 input supports 
several other ingestion modes such as via generic SQS, SNS, and 
EventBridge. While current script can still lead to successful 
ingestion in some cases such as via generic SQS and via SNS, 
it fails via EventBridge. It also depends on "Is FDR queue: false" 
to succeed in those few cases. 

This PR removes the dependency on users choosing "Is FDR queue" 
option. It removes the option and updates the parsing script to check
various notification formats and infer the ingestion mode.The logic is 
similar to beats AWS S3 input[1].

[1]: https://github.com/elastic/beats/blob/main/x-pack/filebeat/input/awss3/sqs_s3_event.go#L308-L334

Checklist

  • I have reviewed tips for building integrations and this pull request is aligned with them.
  • I have verified that all data streams collect metrics or logs.
  • I have added an entry to my package's changelog.yml file.
  • I have verified that Kibana version constraints are current according to guidelines.
  • I have verified that any added dashboard complies with Kibana's Dashboard good practices

How to test this PR locally

Tested documented in #13065 (comment)

Related issues

@kcreddy kcreddy changed the title crowdstrike.fdr: Parse additional notification types using parsing script. crowdstrike.fdr: Parse additional notification payloads using parsing script. May 11, 2025
@elastic-vault-github-plugin-prod
Copy link

elastic-vault-github-plugin-prod bot commented May 11, 2025

🚀 Benchmarks report

To see the full report comment with /test benchmark fullreport

@kcreddy kcreddy added enhancement New feature or request Team:Security-Service Integrations Security Service Integrations team [elastic/security-service-integrations] labels May 13, 2025
@kcreddy kcreddy marked this pull request as ready for review May 13, 2025 12:00
@kcreddy kcreddy requested a review from a team as a code owner May 13, 2025 12:00
@elasticmachine
Copy link

Pinging @elastic/security-service-integrations (Team:Security-Service Integrations)

required: true
show_user: true
description: |
By default the FDR queue is expected. This option must be set to `false` if you are using your own queue.
Copy link
Contributor

Choose a reason for hiding this comment

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

Can the semantic equivalent of this in the context of the net code be added to the documentation for fdr_parsing_script?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated in 2ae8e7c. Let me know if this updated description of parsing script makes sense.

Copy link
Contributor Author

@kcreddy kcreddy May 14, 2025

Choose a reason for hiding this comment

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

Also, do you think removing this option is a breaking-change for the users? it has required: true before, but our script is capable of parsing custom notifications too, although I haven't tested due to lack of FDR queue setup.

Copy link
Contributor

Choose a reason for hiding this comment

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

What circumstances could break users here? If they are following the documented behaviour and using this to indicate that the data is coming from an FDR queue, and our parsing script is able to process this without having this exist — which is the case. The issue arises when they are saying that it is not an FDR source and somehow the data is acceptable without any processing, being broken when there is some mutation applied to the data. I can't think of any case where that would be what is going on, but I guess it might.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

What circumstances could break users here?

Yeah I don't think so too, but just wanted to confirm as well. We have handled all the cases that AWS S3 input can along with FDR format.

Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe we could leave the door open to a work-around by making this not required and have the inclusion in the template dependent on it existing, with a note in the documentation that it should only be left empty when the user knows what they are doing. Maybe wait for @andrewkroh to chime in?

@kcreddy kcreddy requested a review from efd6 May 14, 2025 11:57
@elasticmachine
Copy link

💚 Build Succeeded

History

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request Integration:crowdstrike CrowdStrike Team:Security-Service Integrations Security Service Integrations team [elastic/security-service-integrations]
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Crowdstrike FDR]Handle All SQS Notification Payloads
4 participants