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

[INTPLAT-462] DDS: Orca Security: integration V1.0.0 #19164

Open
wants to merge 28 commits into
base: master
Choose a base branch
from

Conversation

surabhipatel-crest
Copy link
Contributor

@surabhipatel-crest surabhipatel-crest commented Nov 29, 2024

What does this PR do?

This is a initial release PR of Orca Security integration including all the required assets.

Additional Notes

  • This integration is based on in-built datadog integration for orca and so Crawler will not be used.
  • The assets are available in our sandbox and can be shared separately with the required teams.

Review checklist (to be filled by reviewers)

  • Feature or bugfix MUST have appropriate tests (unit, integration, e2e)
  • Add the qa/skip-qa label if the PR doesn't need to be tested during QA.
  • If you need to backport this PR to another branch, you can add the backport/<branch-name> label to the PR and it will automatically open a backport PR once this one is merged

@surabhipatel-crest surabhipatel-crest marked this pull request as ready for review December 5, 2024 11:15
@surabhipatel-crest surabhipatel-crest requested review from a team as code owners December 5, 2024 11:15
@aliciascott aliciascott added the editorial review Waiting on a more in-depth review from a docs team editor label Dec 5, 2024
@aliciascott
Copy link
Contributor

Thank you @surabhipatel-crest I've created an Editorial card for someone on our team to review this further

@torosmassa torosmassa changed the title DDS: Orca Security: integration V1.0.0 [INTPLAT-462] DDS: Orca Security: integration V1.0.0 Dec 5, 2024
Copy link
Contributor

@aliciascott aliciascott left a comment

Choose a reason for hiding this comment

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

Hi @bhargavnariyanicrest looks good just a few small suggestions.


## Overview

[Orca Security][1] a cloud security platform that identifies, prioritizes, and remediates security risks and compliance. It provides features like Real-time visibility, vulnerability management, workload protection, cloud security posture management, compliance management.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
[Orca Security][1] a cloud security platform that identifies, prioritizes, and remediates security risks and compliance. It provides features like Real-time visibility, vulnerability management, workload protection, cloud security posture management, compliance management.
[Orca Security][1] is a cloud security platform that identifies, prioritizes, and remediates security risks and compliance. It provides features like real-time visibility, vulnerability management, workload protection, cloud security posture management, and compliance management.


- Alert: Represents details such as the state of alert, account details, asset in which the alert was found, and more.

The Orca Security integration seamlessly ingests the data of alert logs using the in-built integration of Orca with Datadog. Before ingestion of the data, it normalizes and enriches the logs, ensuring a consistent data format and enhancing information content for downstream processing and analysis. The integration provides insights into alert logs through the out-of-the-box dashboards.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
The Orca Security integration seamlessly ingests the data of alert logs using the in-built integration of Orca with Datadog. Before ingestion of the data, it normalizes and enriches the logs, ensuring a consistent data format and enhancing information content for downstream processing and analysis. The integration provides insights into alert logs through the out-of-the-box dashboards.
The Orca Security integration seamlessly ingests the data of alert logs using the built-in integration of Orca with Datadog. Before ingestion of the data, it normalizes and enriches the logs, ensuring a consistent data format, and enhancing information content for downstream processing and analysis. The integration provides insights into alert logs through the out-of-the-box dashboards.


The Datadog Configuration window opens.
4. Specify the following settings:
- **API Key** - Add API key of Datadog platform.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- **API Key** - Add API key of Datadog platform.
- **API Key** - Add the API key of your Datadog platform.

9. In the **Trigger Query** section, select all the values for alert state in the query. The query should look as below:

```When an alert Alert State is open,in_progress,snoozed,dismissed,closed```
10. In the **Define Results** section, please enable **Apply to Existing Alerts** if existing alerts in the Orca Security platform need to be forwarded to Datadog or disable it to forward newly generated/updated alerts. (**Note:** As per Datadog Log Ingestion behavior, alerts updated older than 18 hours cannot be ingested to Datadog.)
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
10. In the **Define Results** section, please enable **Apply to Existing Alerts** if existing alerts in the Orca Security platform need to be forwarded to Datadog or disable it to forward newly generated/updated alerts. (**Note:** As per Datadog Log Ingestion behavior, alerts updated older than 18 hours cannot be ingested to Datadog.)
10. In the **Define Results** section, please enable **Apply to Existing Alerts** if existing alerts in the Orca Security platform need to be forwarded to Datadog, or disable it to forward newly generated/updated alerts.
**Note**: Alerts that were updated more than 18 hours ago cannot be ingested into Datadog.


```When an alert Alert State is open,in_progress,snoozed,dismissed,closed```
10. In the **Define Results** section, please enable **Apply to Existing Alerts** if existing alerts in the Orca Security platform need to be forwarded to Datadog or disable it to forward newly generated/updated alerts. (**Note:** As per Datadog Log Ingestion behavior, alerts updated older than 18 hours cannot be ingested to Datadog.)
11. In the **SEIM/SOAR** under the **Define Results** section, check the **Datadog** and select **Logs** as the datadog type.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
11. In the **SEIM/SOAR** under the **Define Results** section, check the **Datadog** and select **Logs** as the datadog type.
11. In the **SIEM/SOAR** section under the **Define Results** section, check **Datadog** and select **Logs** as the Datadog type.

aliciascott
aliciascott previously approved these changes Dec 12, 2024
@@ -0,0 +1,240 @@
id: "orca-security"
Copy link
Contributor

Choose a reason for hiding this comment

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

The indentation for this file does not look correct. You have an example here. Could you try make sure the message respect the same indentation. Custom should not be empty is done correctly

Copy link
Contributor Author

Choose a reason for hiding this comment

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

For the log pipeline example, we usually receive the correct output with a custom tag from the validate-log action in the CI/CD pipeline, which we include in the results for all integrations. However, for Orca security, the custom tag appears empty, and despite this, the CI/CD pipeline still passes. We attempted to manually add values to the custom tag and adjusted the indentation according to the given reference. Unfortunately, this led to an internal server error with the message An internal error occurred while assets were being validated. and Contact Datadog to find out how to resolve the problem.

Copy link
Contributor

Choose a reason for hiding this comment

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

the correct output with a custom tag
Indeed you should receive the correct response, but the sample need to properly formatted and I believe we struggle to make it work here. I believe how you committed here, should be the good way. Can you try again and I will follow up to help

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks. We have updated its format and added output with custom tag.

Copy link
Contributor

Choose a reason for hiding this comment

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

Looks good now, thank you!

"rule_id" : "r4c1559f2e0",
"asset_category" : "Encryption and Secrets",
"asset_state" : "enabled",
"service" : "Orca Alerts",
Copy link
Contributor

Choose a reason for hiding this comment

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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

We have added it.

@thibaultkrebs thibaultkrebs added the assets/deploy-logs-staging ONLY USED BY Logs Backend - Validates that a PR is OK to go to staging label Jan 3, 2025
Copy link

codecov bot commented Jan 3, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.01%. Comparing base (96c2b3d) to head (7bbc286).
Report is 351 commits behind head on master.

Additional details and impacted files
Flag Coverage Δ
activemq ?
cassandra ?
hive ?
hivemq ?
ignite ?
jboss_wildfly ?
kafka ?
presto ?
solr ?

Flags with carried forward coverage won't be shown. Click here to find out more.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
assets/deploy-logs-staging ONLY USED BY Logs Backend - Validates that a PR is OK to go to staging docs/requested-changes ecosystems/review-requested editorial review Waiting on a more in-depth review from a docs team editor product/review-requested
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants