GreyNoise

GreyNoise Documentation Hub

Welcome to the GreyNoise Documentation Hub. You'll find comprehensive guides and documentation to help you start working with GreyNoise as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    API Reference

Integration Overview: Splunk

Install From SplunkBase

Navigate to the GreyNoise App on Splunkbase and download the GreyNoise TA.

Topology and Setting Up Splunk Environment

Standalone Mode

  • Install GreyNoise App for Splunk. See the INSTALLATION section for more details.
  • Configure the API key and log level. See the CONFIGURATION section for details.

Search Head Cluster

  • In case of Search Head Clustering, make sure that the GreyNoise Setup and Scan Deployment is configured on only a single search head. In such cases, the configuration will not be visible on other search heads. If a user wants to configure Logging (default is INFO), the user can configure it individually on every search head (recommended).
  • If user wants to replicate the configuration settings, follow these steps:
  • On search head deployer, extract the app at $SPLUNK_HOME$/etc/shcluster/apps.
  • Create stanza shclustering at path $SPLUNK_HOME$/etc/shcluster/apps/app-greynoise/local/server.conf and add following information to the stanza: conf_replication_include.app_greynoise_settings = true
  • Push the bundle to search head.
  • Configure the API key and log level. See the CONFIGURATION section for details. Following these steps will replicate the configuration on all search heads.

Installation

Follow the below-listed steps to install an app from the bundle:

  • Download the App package.
  • From the UI navigate to Apps > Manage Apps.
  • In the top right corner select Install app from file.
  • Select Choose File and select the App package.
  • Select Upload and follow the prompts.
  • Restart the Splunk to complete the installation.
    Note: This app contains Adaptive Response Actions, which can be used along with Splunk Enterprise Security. To use these alert actions on the Splunk instance without Splunk Enterprise Security, kindly install Splunk Common Information Model (CIM).

Configure GreyNoise Integration Instance

Configuration

The app can be configured in the following way:

  • From the Splunk UI navigate to Apps > GreyNoise App for Splunk > Configuration.
  • Click on GreyNoise Setup and enter the API Key.
  • Click on the Save button.
  • The app is now configured and all the features (except Scan Deployment) are ready to be used.

Logging

Users can configure the log level by navigating to Apps > GreyNoise App for Splunk > Configuration and selecting Logging.

Scan Deployment

This feature helps users to scan the Splunk Deployment and identify the noise IP addresses from it. It can be configured in the following way:

  • From the Splunk UI navigate to Apps > GreyNoise App for Splunk > Configuration.
  • Click on Scan Deployment.
  • Enter the following details to set up the Scan Deployment:
  • Indexes: Indexes to be scanned in the deployment.
  • CIM Fields: CIM fields containing IP address to scan for noise status.
  • Other Fields: Other comma(,) separated fields containing IP address to scan for noise status.
  • Scan Start Time: Time range for scanning the indexed Splunk data.
  • Enable Scan Deployment: Checkbox to enable or disable scanning of the deployment.
  • Force Scan Deployment: This is useful when the user wants to override the current running scan immediately and start a new one.

On-Demand Commands

The following commands are included as a part of the app:

gnip

Search format:
| gnip ip="(ip_address)"

Purpose: Retrieves context information for a given IP address from the GreyNoise.

gnquick

Search format:
| gnquick ip="(ip_address),(ip_address),(ip_address)"
SPL_QUERY | gnquick ip_field="(ip_field)"

Purpose: Retrieve the noise status of all the IP addresses as separate events [OR] Retrieve the noise status for all the given IPs returned by the SPL_QUERY for specified ip_field.

gnquery

Search format:
| gnquery query="(GNQL_query)" result_size="(result_size)"

Purpose: Retrieve the results of the given GNQL query from GreyNoise. result_size denotes the number of results to be retrieved which is capped at 50,000. result_size is an optional parameter with a default value of 50,000.

gnstats

Search format:
| gnstats query="(GNQL_query)" count="(stats_count)"

Purpose: Fetch the aggregate statistics for the top organizations, actors, tags, ASNs, countries, classifications, and operating systems of all the results for a given GNQL query. count denotes the number of stats to be retrieved. count is an optional parameter.

gnmulti

Search format:
SPL_QUERY | gnmulti ip_field="(ip_field)"

Purpose: Retrieves noise status of the IP addresses represented by ip_field parameter present in each event, and adds the noise information to each event.

gncontext

Search format:
| gncontext ip="(ip_address)"

Purpose: Retrieves context information for a given IP address from the GreyNoise.

gnfilter

Search format:
SPL_QUERY | gnfilter ip_field="(ip_field)" noise_events="(true/false)"

Purpose: Filter Splunk events returned by given SPL_QUERY based on the noise status of IP address present in ip_field of the events. noise_events is an optional parameter with a default value of true. So, it will return events with noise IP addresses by default.

gnenrich

Search format:
SPL_QUERY | gnenrich ip_field="(ip_field)"

Purpose: Enrich the Splunk events returned by given SPL_QUERY with the context information of IP address represented by ip_field in Splunk Search.

Note: While executing the transforming commands from Splunk search UI, ensure that the event count passed to the command is less than 50,000, as per standard limits of Splunk. If the event count is higher than this number, the user can create a Saved Search and pass a higher number of Splunk statistical data to the command.

Alert Actions

The following alert actions are included as a part of the app:

  • GreyNoise Quick Check: Returns noise information from GreyNoise for given IP addresses.
  • GreyNoise Context Check: Returns context information from GreyNoise for given IP Addresses.

These alert actions can be used independently as well as with Splunk Enterprise Security in the form of Adaptive Response Actions. Results from these actions can be found in index=main sourcetype=greynoise

The two sources for these adaptive response actions are:

  • source=greynoise_context
  • source=greynoise_quick

Usage with Splunk Enterprise Security:

These actions can be executed from Incident Review, and results can be accessed directly by refreshing the "Adaptive Responses" panel and clicking the appropriate link.

Workflow Action

Identify Noise workflow action is enabled for all the CIM compliant IP fields which can be used to fetch the context information for the corresponding IP addresses.

Dashboard

This app contains the following three dashboards:

  • Overview: This dashboard represents an overall visualization of the statistics provided by the GreyNoise platform as well as the statistics of the noise IPs in the Splunk deployment.
  • Noise IP Addresses: This dashboard displays all the IP addresses along with their noise status scanned by GreyNoise through the Scan Deployment feature in the current Splunk deployment. This dashboard will be populated when the Scan Deployment feature is enabled.
  • Live Investigation: This dashboard can be used to obtain context information fetched dynamically from the GreyNoise platform based on the form input provided. This is the same as performing a GNQL in the GreyNoise Visualizer or API.

Saved Searches

This app contains the following saved searches, which are used for populating data in the dashboard:

  • greynoise_scan_deployment_once: Used to populate gn_scan_deployment_ip_lookup lookup and is triggered after configuring Scan Deployment feature.
  • greynoise_scan_deployment: Used to populate gn_scan_deployment_ip_lookup lookup and is triggered at an interval of 60 minutes and scans the data of the previous 70 minutes.
  • greynoise_overview_once: Used to populate gn_overview_lookup lookup, and is triggered after configuring the API key.
  • greynoise_overview: Used to populate gn_overview_lookup lookup, and is triggered at an interval of 30 minutes.
    Note: greynoise_scan_deployment_once and greynoise_scan_deployment savedsearches are used for scanning the data indexed in Splunk. So, in the case when these saved searches are skipped, the data indexed during that interval will not be scanned for noise status.

Updated 4 months ago


Integration Overview: Splunk


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.