Welcome to Corelight for Splunk Apps documentation!

Overview

About Corelight App For Splunk

About Corelight App For Splunk

Corelight App For Splunk allows a Splunk Enterprise administrator to extract information and knowledge from Zeek data via the Corelight Sensor appliance or open-source Zeek

Scripts and binaries

This App provides the following scripts:

• cid.py
• Community ID Flow Hashing python libraries

Release notes

Version 2.4.4

• New Feature
  • Added Passive Identification dashboard
• Bug
  • Removed unused jQuery library to fix Splunk Cloud compatibility

Version 2.4.3

• New Feature
  • Support for IPv6 addresses in local network configuration
  • Rename of HTTP log's "host" field to "dest_host" to remove conflict with Splunk built-in "host" value
  • Added Workflow Action to support SmartPCAP retrieval
  • Minor CIM mapping update

Version 2.4.2

• New Feature
  • Added Local Network Blocks field in Configuration UI. Direction field will be now evaluated based on the Local Network Blocks for CoreLight SSL logs.
  • Migrated App to the Splunk Add-on Builder v4 to use more modern back-end.
• Bug
  • Removed lookup for direction value to mitigate disk storage issue.

Version 2.4.1

• Bug
  • Fixed version declaration in Tap Hygiene dashboard to fix Splunk Cloud compatibility.

Version 2.4.0

• New Feature

  • Added the dashboard support for Zeek product data.
  • Added the configuration page from where the user can select the product and indexes from which they want to visualize the data.
  • Added drilldowns in the below dashboards.
    • Connections
    • HTTP
    • Intel
    • Notices
    • SSH Inference Overview
  • Optimized the queries for better performance.

• Bug

  • Fixed "Log Rates" panel in Home, Overview and Sensor Overview dashboards
  • Fixed Corelight Sensor filter in Connections and HTTP dashboards

Version 2.3.2

• Bug
  • [CL-78] - Fixed fieldalias for ssl_curve
  • [CL-79] - Made objects created by this app accessible to other system apps

Version 2.3.1

• New Feature

  • [CL-76] - Added tap hygiene dashboards

• Bug

  • [CL-77] - Fixed issue with naming translations within TSV for names with multiple underscores

Version 2.3.0

• New Feature
  • [CL-75] - Added support for TSV log format

Version 2.2.1

• New Feature

  • [CL-67] - Added Suricata Dashboard

• Improvement

  • [CL-70] - Iimproved DNS Hunting dashboard functionality
  • [CL-68] - Improved support for Open Source Zeek data

• Bug

  • [CL-69] - Corrected issues with Drill-down from SSH Inferences Dashboard

Version 2.2.0

Corelight data natively enables Splunk Enterprise Security correlation search functionality for more than 30 correlation searches within the Certificates, Network Resolution, Network Sessions, Network Traffic, and Web data models. Corelight provides data for many Splunk Enterprise Security dashboards out of the box.

• Added parsing and dashboard visibility for Corelight Suricata logs.
• Tagged Suricata for Intrusion Detection data model functionality.
• Improved x509 log tagging for Certificate data model functionality.
• Improved conn log tagging for Network Traffic and Network Session data model functionality.
• Improved dns log tagging for Network Resolution data model functionality.
• Added DNS Hunting dashboard.
• Corrected parsing and extraction issues for corelight_x509_red log.
• Corrected issues with Home and Notices dashboards

Release notes

Version 2.0.0

Compatability

The app and TA extracts information and knowledge from Zeek (formerly known as Bro) via Corelight Sensors or open-source Zeek, resulting in powerful security insights through key traffic dashboards such as:

• Intel: Find IOCs from external sources matched in network traffic.
• Notices: See situations flagged by the Notice policy for further investigation.
• IP Interrogation: Identify anomalies by reviewing top protocol usage, internal vs. external connections, top connections by bytes transferred and more.
• Log Hunting: Accelerate your hunt by narrowing down many logs to only the logs that matter.
• Detections: Find and respond to off-port protocol usage, IOC matches, and other potentially interesting events.
• Connections: Gain situational awareness using lists of top services, ports, dataflows, originators, and responders.
• HTTP: Find suspicious HTTP transactions by reviewing a list of top host headers, originators, rare user agents and rare host headers.
• DNS: Detect DNS exfiltration by spotting queries to non-existent domains and high connection counts.
• Files: Find executables hidden in benign extensions and compressed files.
• Corelight Egress Monitor: Find risky North/South user connections to weak SSL versions.

Known Issues

Version 2.0.0 of Corelight App For Splunk has the following known issues:

• None

Support and resources

Questions and answers

Access questions and answers specific to Corelight App For Splunk at https://answers.splunk.com . Be sure to tag your question with the App.

Support

• Support Email: appsupport@corelight.com
• Support Website: https://www.corelight.com/support
• Support Offered: Email, Web

Support is available via email at appsupport@corelight.com. Responses vary on working days between working hours. Find the latest information about the App and integration on the support website.

Installation and Configuration

Software requirements

Splunk Enterprise system requirements

Because this App runs on Splunk Enterprise, all of the Splunk Enterprise system requirements at https://docs.splunk.com/Documentation/Splunk/latest/Installation/Systemrequirements apply.

Download

Download Corelight App For Splunk at https://splunkbase.splunk.com/.

Installation steps

NOTE: Where referenced, TA-CorelightForSplunk is located on Splunkbase.

Deploy to single server instance

Follow these steps to install the app in a single server instance of Splunk Enterprise:

1. Deploy as you would any App, and restart Splunk. Do NOT install the TA.

Deploy to Splunk Cloud

1. Have your Splunk Cloud Support handle this installation.

Deploy to a Distributed Environment

1. For each Search Head in the environment, deploy the App. DO NOT SEND TA to a Search Head Cluster (SHC).
2. For each indexer in the environment, deploy a copy of the |ta_name| Add-On that is located as mentioned above.

User Guide

Key concepts for Corelight App For Splunk

Configure TA-CorelightForSplunk for use with Corelight.

1. TA-CorelightForSplunk should be placed upon the servers that will get the forwarded data from the Corelight Sensor.
2. Questions should be asked at https://www.corelight.com/support

Indexes

Getting Data In

By default all events will be written to the main index. Please see Corelight documentation on how to change the destination index from the appliance.

Searching for Data

By default, all corelight information is searched for using the corelight_idx event type. To change the location for the app to search for Corelight data, edit the corelight_idx event type to point to your Corelight index.

Troubleshoot Corelight App For Splunk

1. Check the Monitoring Console (>=v6.5) for errors

Lookups

Corelight App For Splunk contains several lookup files.

• port_descriptions - Gives port descriptions to ports.
• corelight_systems - Auto-generated from sensor data
• corelight_services - Auto-generated from services data
• corelight_dns_ports - Auto-generated from DNS data
• corelight_dns_record_types - Auto-generated from NDS data
• corelight_files_mime_types - Auto-generated from files data
• corelight_software_types - Auto-generated from software data
• corelight_dns_reply_code - Provided to lookup reply code types

Event Generator

Corelight App For Splunk does make use of an event generator. This allows the product to display data, when there are no inputs configured.

The stanzas are:

• conn.json.sample
• conn_red.json.sample
• metrics_disk.json.sample
• files.json.sample
• files_red.json.sample
• metrics_memory.json.sample
• metrics_system.json.sample
• metrics_iface.json.sample
• metrics_bro.json.sample
• http.json.sample
• http_red.json.sample
• dns.json.sample
• dns_red.json.sample

Acceleration

1. Summary Indexing: No
2. Data Model Acceleration: No
3. Report Acceleration: No