Skip to content

[ti_cyware_intel_exchange] Initial release of Cyware Intel Exchange #14500

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 6 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
Expand Up @@ -436,6 +436,7 @@
/packages/ti_cif3 @elastic/security-service-integrations
/packages/ti_crowdstrike @elastic/security-service-integrations
/packages/ti_cybersixgill @elastic/security-service-integrations
/packages/ti_cyware_threat_intelligence @elastic/security-service-integrations
/packages/ti_domaintools @elastic/security-service-integrations
/packages/ti_eclecticiq @elastic/security-service-integrations
/packages/ti_eset @elastic/security-service-integrations
Expand Down
3 changes: 3 additions & 0 deletions packages/ti_cyware_intel_exchange/_dev/build/build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
dependencies:
ecs:
reference: [email protected]
62 changes: 62 additions & 0 deletions packages/ti_cyware_intel_exchange/_dev/build/docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
# Cyware Intel Exchange

## Overview

[Cyware Intel Exchange](https://www.cyware.com/products/intel-exchange) is an intelligent client-server exchange that leverages advanced technologies like Artificial Intelligence and Machine Learning to automatically ingest, analyze, correlate and act upon the threat data ingested from multiple external sources and internally deployed security tools.

## Data streams

The Cyware Intel Exchange integration collects the following events:
- **[Indicator](https://ctixapiv3.cyware.com/rules/save-result-set/retrieve-saved-result-set-data)** - This fetches all the saved result set data for conditional IOCs present in the application..

## Requirements

### Agentless-enabled integration
Agentless integrations allow you to collect data without having to manage Elastic Agent in your cloud. They make manual agent deployment unnecessary, so you can focus on your data instead of the agent that collects it. For more information, refer to [Agentless integrations](https://www.elastic.co/guide/en/serverless/current/security-agentless-integrations.html) and the [Agentless integrations FAQ](https://www.elastic.co/guide/en/serverless/current/agentless-integration-troubleshooting.html).

Agentless deployments are only supported in Elastic Serverless and Elastic Cloud environments. This functionality is in beta and is subject to change. Beta features are not subject to the support SLA of official GA features.

### Agent-based installation
Elastic Agent must be installed. For more details, check the Elastic Agent [installation instructions](docs-content://reference/fleet/install-elastic-agents.md). You can install only one Elastic Agent per host.

## Compatibility

For Rest API, this module has been tested against the **[CTIX API v3](https://ctixapiv3.cyware.com/intel-exchange-api-reference)** version.

## Setup

**Note** - Before you start the setup, ensure that you have **Create** and **Update** permissions for **CTIX Integrators**.

### Follow below steps to generate Open API credentials for collecting data from the CTIX API:

1. Go to **Administration** > **Integration Management**.
2. In **Third Party Developers**, click **CTIX Integrators**.
3. Click **Add New**. Enter the following details:
- **Name**: Enter a unique name for the API credentials in 50 characters.
- **Description**: Enter a description for the credentials within 1000 characters.
- **Expiry Date**: Select an expiry date for open API keys. To apply an expiration date for the credentials, you can select **Expires On** and select the date. To ensure the credentials never expire, you can select **Never Expire**.
4. Click **Add New**.
5. Click **Download** to download the API credentials in CSV format. You can also click **Copy** to copy the endpoint URL, secret key, and access ID.

For more details, refer to the [Authentication](https://ctixapiv3.cyware.com/authentication) documentation and the guide on how to [Generate Open API Credentials](https://techdocs.cyware.com/en/299670-447852-configure-open-api.html).

### Enable the integration in Elastic

1. In Kibana navigate to **Management** > **Integrations**.
2. In the search top bar, type **Cyware Intel Exchange**.
3. Select the **Cyware Intel Exchange** integration afrom the search results.
4. Click on the "Add Cyware Intel Exchange" button to add the integration.
5. Add all the required integration configuration parameters: URL, Access ID and Secret Key.
6. Save the integration.

## Logs reference

### Indicator

This is the `Indicator` dataset.

#### Example

{{event "indicator"}}

{{fields "indicator"}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
version: '3.8'
services:
indicator-api:
image: docker.elastic.co/observability/stream:v0.18.0
ports:
- 8080
volumes:
- ./files:/files:ro
environment:
PORT: 8080
command:
- http-server
- --addr=:8080
- --config=/files/config.yml
Loading