Skip to content

Commit 55805d6

Browse files
elastic_security: Initial release of the package.
Initial release with alert data stream, associated dashboards, and ingest pipelines. This package facilitates transferring security alert data from another Elasticsearch instance to your own. API integration was implemented as per the official documentation[1], and test samples were created using sanitized live data [1] https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search
1 parent da0a934 commit 55805d6

File tree

23 files changed

+5811
-0
lines changed

23 files changed

+5811
-0
lines changed

.github/CODEOWNERS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -197,6 +197,7 @@
197197
/packages/elastic_agent @elastic/elastic-agent
198198
/packages/elastic_connectors @elastic/search-extract-and-transform
199199
/packages/elastic_package_registry @elastic/ecosystem
200+
/packages/elastic_security @elastic/security-service-integrations
200201
/packages/elasticsearch @elastic/stack-monitoring
201202
/packages/endace @elastic/sec-deployment-and-devices @elastic/sec-linux-platform
202203
/packages/endace/data_stream/flow @elastic/sec-linux-platform
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
dependencies:
2+
ecs:
3+
reference: "git@v8.17.0"
Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# Elastic Security
2+
3+
## Overview
4+
5+
[Elastic Security](https://www.elastic.co/security) is a free and open solution that helps detect, investigate, and respond to threats using data from endpoints, cloud, and network sources. It offers SIEM and endpoint protection with powerful search, correlation, and visualization features in Kibana.
6+
It enables security teams to streamline investigations and strengthen their overall security posture.
7+
8+
## Data streams
9+
10+
The Elastic Security integration collects the following events:
11+
12+
`alert`: - Retrieve alerts from Elasticsearch Instance using Elasticsearch [_search](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-2) API.
13+
14+
## Requirements
15+
16+
### Agentless-enabled integration
17+
18+
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).
19+
20+
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.
21+
22+
### Agent-based deployment
23+
24+
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.
25+
26+
## Setup
27+
28+
### To collect data from the Elastic API:
29+
30+
You will need the following information:
31+
32+
1. The URL for the Elasticsearch instance.
33+
2. Authentication credentials such as username, password, API key, or bearer token depending on the selected authentication type.
34+
35+
Note:
36+
1. Users must have `read` index privileges on the `..alerts-security.alerts-<space_id>` indices to access and query security alerts.
37+
2. To learn how to create authentication credentials and use the appropriate authentication type, refer to the Elasticsearch Authentication [Documentation](https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/user-authentication).
38+
39+
### Enable the integration in Elastic
40+
41+
1. In Kibana navigate to **Management** > **Integrations**.
42+
2. In the search top bar, type **Elastic Security**.
43+
3. Select the **Elastic Security** integration and add it.
44+
4. Add all the required integration configuration parameters such as username, password, API key, or bearer token depending on the selected authentication type to enable data collection.
45+
5. Select "Save and continue" to save the integration.
46+
47+
## Logs reference
48+
49+
### Alert
50+
51+
This is the `alert` dataset.
52+
53+
#### Example
54+
55+
{{event "alert"}}
56+
57+
{{fields "alert"}}
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
version: '3.0'
2+
services:
3+
elastic_security-cel:
4+
image: docker.elastic.co/observability/stream:v0.18.0
5+
hostname: elastic_security
6+
ports:
7+
- 8090
8+
volumes:
9+
- ./files:/files:ro
10+
environment:
11+
PORT: '8090'
12+
command:
13+
- http-server
14+
- --addr=:8090
15+
- --config=/files/config.yml

0 commit comments

Comments
 (0)