GreyNoise App for Splunk
This is an app powered by the Splunk Add-on Builder.
OVERVIEW
GreyNoise Splunk app provides multiple dashboards to effectively analyse and visualize the contextual and statistical data provided by GreyNoise. It also includes custom commands and alert actions which can be used along with Splunk searches to leverage GreyNoise APIs for custom use cases. It periodically scans the Splunk deployment through saved search to indicate the noise and RIOT IPs in the complete Splunk deployment. Along with this, the workflow action provided can be used to obtain live context information of any CIM compliant field containing an IP address.
- Author: GreyNoise Intelligence Inc
- Version: 2.1.2
- Creates Index: False
- Has index-time operation: True
- Implements summarization: False
- Prerequisites: GreyNoise API Key, Search heads without Enterprise Security requires the Splunk Common Information Model (CIM) Add-on to for the Modular Alerts to function.
COMPATIBILITY MATRIX
- Splunk Enterprise version: 8.2.x, 8.1.x, 8.0.x
- OS: Platform independent
- Vendor Products: GreyNoise API
RELEASE NOTES (Version 2.1.2)
- Fixed issue where API key could not be entered on new installs
- IMPORTANT: GreyNoise API Key must be re-entered if upgrading from a previous version
RELEASE NOTES (Version 2.1.1)
- Fixed JQuery 3.5.0 compatibility issue identified via Upgrade Readiness
- Fixed Python3 compatibility issue identified via Upgrade Readiness
- Fixed missing explict definition for cache_maintenance script to use py3
- Update to use GreyNoise SDK 1.2.0
- Updated splunklib to version 1.6.18
RELEASE NOTES (Version 2.1.0)
- Python2 and Splunk7.x support is dropped starting from this release, GreyNoise now only supports Splunk 8.x and Python3
- Updated to latest GreyNoise SDK 1.1.0
- Added gnriot custom command for the RIOT endpoint
- Improves error messages for non-routable and invalid IP address
- Updated splunklib to version 1.6.16
- Updated the time in gnoverview saved search to 6 hours
- Added 2 new codes to the csv file
- Updated the custom commands, saved searches and dashboards to handle the RIOT key
- Fixed an issue to handle Splunk fields with unallowed characters
- Added Caching feature for all the custom commands and saved searches.
OPEN SOURCE COMPONENTS AND LICENSES
The third party library and its license information is as follows:
TOPOLOGY AND SETTING UP SPLUNK ENVIRONMENT
Standalone Mode
- Install GreyNoise App for Splunk. See INSTALLATION section for more details.
- Configure the API key and log level. See 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 single search head. In such cases, the configuration will not be visible on other search heads. In case if user wants to configure the Logging (default is INFO), user can configure individually on every search head. This is 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/SA-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 CONFIGURATION section for details. Following these steps will replicate the configuration on all search heads.
UPGRADING FROM VERSION 2.0.1
Follow the below steps to upgrade the app to the latest version:
- Disable all the saved searches which uses alert actions and custom commands of GreyNoise.
- Backup your current app/configurations outside the Splunk install path.
- To upgrade the app from the UI, follow the steps in the INSTALLATION section below. Ensure that
Upgrade app. checkbox is selected before clicking on the Upload button.
- Follow the steps mentioned in CONFIGURATION section to reconfigure the app.
- If SCAN DEPLOYMENT was configured before app upgrading then go to SCAN DEPLOYMENT tab inside the Configuration tab and Click on Save button to re-configure the scan deployment saved search in the backend.
Note: Upgrade is only supported from UI and not supported from the backend.
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).
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 Save button.
- The app is now configured and all the features apart from Scan Deployment and Caching are ready to be used.
Logging
- User can configure the log level by navigating to
Apps > GreyNoise App for Splunk > Configuration and selecting Logging.
SCAN DEPLOYMENT
This feature helps user to scan the Splunk Deployment and identify the noise and RIOT 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 and RIOT 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 user wants to override current running scan immediately and start a new one.
Caching
This feature helps user to enable/disable caching for all the custom commands and saved searches. It can be configured in the
following way:
- From the Splunk UI navigate to
Apps > GreyNoise App for Splunk > Configuration.
- Click on Caching.
- Enter the following details to set up the Caching:
- Enable caching: Checkbox to enable caching for all custom commands and savedsearches.
- Time to live: Time period (in hours) to configure the cache’s time to live. Responses whose age is greater than the TTL, will be removed from the cache by a savedsearch which will run every hour.
- Purge Cache: Checkbox to purge the cache of all responses.
Note: Configuration can only be done by admin but other custom commands can be used by admin and the users with list_storage_passwords capability.
CUSTOM 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_address1>,<ip_address2>,<ip_address3>" [OR] SPL_QUERY | gnquick ip_field="<ip_field>"
- Purpose: Retrieve the noise and RIOT status of all the IP addresses as separate events [OR] Retrieve the noise and RIOT 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 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 and RIOT status of the IP addresses represented by ip_field parameter present in each event, and adds the noise and RIOT 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 default value 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.
- gnriot
- Search format:
| gnriot ip="<ip_address>" [OR] SPL_QUERY | gnriot ip_field="<ip_field>"
- Purpose: Retrieves RIOT information for a given IP address from the GreyNoise [OR] Retrieves RIOT information for all the given IPs returned by the SPL_QUERY for specified ip_field.
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, user can create a Saved Search and pass 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 and 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.
DASHBOARDS
This app contains the following three dashboards:
- Overview: This dashboard represents an overall visualization of the statistics provided by GreyNoise platform as well as the statistics of the noise IPs and the RIOT IPs in the Splunk deployment.
- Noise IP Addresses: This dashboard displays all the IP addresses along with their noise and RIOT status scanned by GreyNoise through Scan Deployment feature in the current Splunk deployment. This dashboard will be populated when 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.
Note : In Overview, Percentage of RIOT IPs is calculated only for the new IPs scanned after the App was upgraded. Also in the Noise IP Addresses, the RIOT status won't be shown for those IPs that were scanned before the App was upgraded.
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 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 6 hours.
- greynoise_cache_maintenance: Used to remove those responses whose TTL is expired from the Cache for all the custom commands, and is triggered at an interval of 60 minutes.
Note : greynoise_scan_deployment_once and greynoise_scan_deployment savedsearches are used for scanning the data indexed in Splunk. So, in case when these saved searches are skipped, the data indexed during that interval will not be scanned for noise and RIOT status.
UNINSTALL APP
To uninstall app, user can follow below steps:
- SSH to the Splunk instance
- Go to folder apps($SPLUNK_HOME/etc/apps)
- Remove the SA-GreyNoise folder from apps directory
- Restart Splunk
TROUBLESHOOTING
- Alerts fail to write to index=main sourcetype=greynoise and Enterprise Security is not installed.
- Ensure that the Splunk Common Information Model (CIM) Add-on has been installed. No configuration of this add-on is necessary.
- Data in Overview dashboard is not being populated.
- Ensure that
greynoise_overview Saved Search is enabled.
- Data in Noise IP Address dashboard is not being populated.
- Ensure that the Scan Deployment feature is enabled. The data must populate in an hour. In case the issue still persists, make sure that
greynoise_scan_deployment Saved Search is enabled.
- Ensure that the KV store is enabled.
- Custom commands are not being executed and failing with unknown exception. For example:
Exception occurred while fetching the context of the ip=<ip>. See greynoise_main.log for more details.
- Ensure that the user executing custom command has list_storage_passwords capability.
- Noise and RIOT information of some of the IP addresses is being missed in Noise IP Address dashboard.
- Ensure that the corresponding index and fields are entered as per the format while enabling Scan Deployment feature.
- Custom commands exited unexpectedly.
- Ensure that maximum 50000 results are passed to the custom command while executing search from the Splunk Search Interface, as Splunk supports maximum 50000 results. For processing more results, Saved Searches can be used.
- Scan Deployment feature is not working as expected.
- Check for the messages in Splunk UI. If message like
KV store not in ready state. Make sure it is enabled. is shown, ensure that KV store is enabled.
- Check in splunkd.log for messages like
External command based lookup 'gn_scan_deployment_ip_lookup' is disabled because KV Store is disabled.
- If such messages show up, then ensure that the KV store is enabled.
- In search head clustering, configurations are visible on only one search head and not on others.
- This is the expected behaviour when replication is not enabled. The functionalities will work on all the search heads.
- If any of the transforming command is not working as expected, ensure that the events have IP field extracted which is passed to ip_field parameter in the transforming command.
- Getting following error while using transforming custom commands.
- Events might not be returned in sub-second order due to search memory limits.
- Create a file 'limits.conf' in the following directory
$SPLUNK_HOME/etc/SA-GreyNoise/local.
- Add the following stanza in the file:
[search]
max_rawsize_perchunk = 500000000
SUPPORT
COPYRIGHT
- Copyright (C) 2022 GreyNoise Intelligence Inc. All Rights Reserved.
