Skip to content

Commit b036dab

Browse files
muskan-agarwal26robester0403
authored andcommitted
[ti_cyware_intel_exchange] Initial release of Cyware Intel Exchange (elastic#14500)
The initial release includes an indicator data stream for supporting indicators via REST API, along with their corresponding dashboards and visualizations. Cyware Intel Exchange fields are mapped to their corresponding ECS fields where possible. Test samples were derived from documentation.
1 parent adacbb9 commit b036dab

35 files changed

+4302
-0
lines changed

.github/CODEOWNERS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -440,6 +440,7 @@
440440
/packages/ti_cif3 @elastic/security-service-integrations
441441
/packages/ti_crowdstrike @elastic/security-service-integrations
442442
/packages/ti_cybersixgill @elastic/security-service-integrations
443+
/packages/ti_cyware_intel_exchange @elastic/security-service-integrations
443444
/packages/ti_domaintools @elastic/security-service-integrations
444445
/packages/ti_eclecticiq @elastic/security-service-integrations
445446
/packages/ti_eset @elastic/security-service-integrations
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
dependencies:
2+
ecs:
3+
reference: [email protected]
Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# Cyware Intel Exchange
2+
3+
## Overview
4+
5+
[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.
6+
7+
## Data streams
8+
9+
The Cyware Intel Exchange integration collects the following events:
10+
- **[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..
11+
12+
## Requirements
13+
14+
### Agentless-enabled integration
15+
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).
16+
17+
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.
18+
19+
### Agent-based installation
20+
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.
21+
22+
## Compatibility
23+
24+
For Rest API, this module has been tested against the **[CTIX API v3](https://ctixapiv3.cyware.com/intel-exchange-api-reference)** version.
25+
26+
## Setup
27+
28+
**Note** - Before you start the setup, ensure that you have **Create** and **Update** permissions for **CTIX Integrators**.
29+
30+
### Follow below steps to generate Open API credentials for collecting data from the CTIX API:
31+
32+
1. Go to **Administration** > **Integration Management**.
33+
2. In **Third Party Developers**, click **CTIX Integrators**.
34+
3. Click **Add New**. Enter the following details:
35+
- **Name**: Enter a unique name for the API credentials in 50 characters.
36+
- **Description**: Enter a description for the credentials within 1000 characters.
37+
- **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**.
38+
4. Click **Add New**.
39+
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.
40+
41+
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).
42+
43+
### Enable the integration in Elastic
44+
45+
1. In Kibana navigate to **Management** > **Integrations**.
46+
2. In the search top bar, type **Cyware Intel Exchange**.
47+
3. Select the **Cyware Intel Exchange** integration afrom the search results.
48+
4. Click on the "Add Cyware Intel Exchange" button to add the integration.
49+
5. Add all the required integration configuration parameters: URL, Access ID and Secret Key.
50+
6. Save the integration.
51+
52+
## Logs reference
53+
54+
### Indicator
55+
56+
This is the `Indicator` dataset.
57+
58+
#### Example
59+
60+
{{event "indicator"}}
61+
62+
{{fields "indicator"}}
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
version: '3.8'
2+
services:
3+
indicator-api:
4+
image: docker.elastic.co/observability/stream:v0.18.0
5+
ports:
6+
- 8080
7+
volumes:
8+
- ./files:/files:ro
9+
environment:
10+
PORT: 8080
11+
command:
12+
- http-server
13+
- --addr=:8080
14+
- --config=/files/config.yml

0 commit comments

Comments
 (0)