Skip to content

Commit

Permalink
[corelight] initial release of Corelight (elastic#11288)
Browse files Browse the repository at this point in the history
Create New integration package corelight and add below four dashboards:

- Name Resolution Insights
- Remote Activity Insights
- Secure Channel Insights
- Security Posture
  • Loading branch information
sharadcrest authored Oct 31, 2024
1 parent e2e9af1 commit 5de1595
Show file tree
Hide file tree
Showing 14 changed files with 11,844 additions and 0 deletions.
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,7 @@
/packages/cockroachdb @elastic/obs-infraobs-integrations
/packages/containerd @elastic/obs-cloudnative-monitoring
/packages/coredns @elastic/obs-infraobs-integrations
/packages/corelight @elastic/security-service-integrations
/packages/couchbase @elastic/obs-infraobs-integrations
/packages/couchdb @elastic/obs-infraobs-integrations
/packages/cribl @elastic/security-service-integrations
Expand Down
6 changes: 6 additions & 0 deletions packages/corelight/changelog.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# newer versions go on top
- version: "0.1.0"
changes:
- description: Initial release.
type: enhancement
link: https://github.com/elastic/integrations/pull/11288
36 changes: 36 additions & 0 deletions packages/corelight/docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Corelight

[Corelight](https://corelight.com/) provides network detection and response (NDR) solutions that enhance visibility, threat detection, and incident response by leveraging open-source technologies like Zeek. Its platform integrates with existing security tools to deliver high-fidelity network data, helping organizations detect and respond to threats more effectively across both on-premises and cloud environments​.

This integration includes only the Corelight dashboards mentioned below:
- Security Posture
- Remote Activity Insights
- Name Resolution Insights
- Secure Channel Insights

## Prerequisites:

**Add ECS Mappings**: Start by adding the ECS (Elastic Common Schema) mappings from the [Corelight GitHub organization](https://github.com/corelight). You can find the required templates here: [Corelight ECS Templates](https://github.com/corelight/ecs-templates). The script within the repository installs the necessary components, including index settings, index templates, ILM policies, and ingest pipelines etc. These components will ensure that Corelight data is correctly formatted and aligned with Elastic's schema.

**Send Data from Corelight to Elastic**: Once the ECS mappings are in place, configure Elasticsearch in the web interface under Sensor > Export > Export to Elastic. It will require below parameters:
- **Server:** The HTTP or HTTPS URL (including the port).
- **Prefix:** The Elasticsearch index, alias, and template prefix (e.g. logs-corelight-*).
- **Username:** The Username to authenticate to Elasticsearch.
- **Password:** The Password to authenticate to Elasticsearch.
- **Zeek logs to exclude:** Logs that you don't want to export to Elasticsearch. If blank, sensor will export all log types.
- **Elasticsearch log filter:** Logs to exclude using the Corelight Filtering Language.

**Note**: Use the index prefix name (logs-*) instead of a custom index prefix.

## Setup

### Enabling the integration in Elastic:

1. In Kibana navigate to Management > Integrations.
2. In "Search for integrations" top bar, search `Corelight`.
3. Select the "Corelight" integration from the search results.
4. Navigate to Settings.
5. Select the "Install Corelight assets".
6. Navigate to Assets to get list of dashboards.

> **Note:** This integration provides dashboards only. We recommend regularly checking and updating assets using the script from the Corelight repository. For any mapping or parsing issues, especially those not related to the dashboards, we recommend contacting Corelight, as they maintain those components.
15 changes: 15 additions & 0 deletions packages/corelight/img/corelight-logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added packages/corelight/img/security-posture.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

42 changes: 42 additions & 0 deletions packages/corelight/manifest.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
format_version: 3.2.1
name: corelight
title: Corelight
version: 0.1.0
description: Collect logs from Corelight with Elastic Agent.
type: integration
categories:
- security
- dns_security
- network
- network_security
- vpn_security
conditions:
kibana:
version: ^8.14.0
elastic:
subscription: basic
screenshots:
- src: /img/remote-activity-insights-screenshot.png
title: Remote Activity Insights Dashboard Screenshot
size: 600x600
type: image/png
- src: /img/name-resolution-insights.png
title: Name Resolution Insights Dashboard Screenshot
size: 600x600
type: image/png
- src: /img/secure-channel-insights.png
title: Secure Channel Insights Dashboard Screenshot
size: 600x600
type: image/png
- src: /img/security-posture.png
title: Security Posture Dashboard Screenshot
size: 600x600
type: image/png
icons:
- src: /img/corelight-logo.svg
title: Corelight logo
size: 32x32
type: image/svg+xml
owner:
github: elastic/security-service-integrations
type: partner
6 changes: 6 additions & 0 deletions packages/corelight/validation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
errors:
exclude_checks:
- SVR00001 # Saved query, but no filter.
- SVR00002 # Mandatory filters in dashboards.
- SVR00004 # Saved search not allowed?
- SVR00005 # Kibana version for saved tags.

0 comments on commit 5de1595

Please sign in to comment.