icon/x Created with Sketch.

Splunk Cookie Policy

We use our own and third-party cookies to provide you with a great online experience. We also use these cookies to improve our products and services, support our marketing campaigns, and advertise to you on our website and other websites. Some cookies may continue to collect information after you have left our website. Learn more (including how to update your settings) here.
Accept Cookie Policy

We are working on something new...

A Fresh New Splunkbase
We are designing a New Splunkbase to improve search and discoverability of apps. Check out our new and improved features like Categories and Collections. New Splunkbase is currently in preview mode, as it is under active development. We welcome you to navigate New Splunkbase and give us feedback.

Accept License Agreements

This app is provided by a third party and your right to use the app is in accordance with the license provided by that third-party licensor. Splunk is not responsible for any third-party apps and does not provide any warranty or support. If you have any questions, complaints or claims with respect to this app, please contact the licensor directly.

Thank You

Downloading Team Cymru Scout App For Splunk
SHA256 checksum (team-cymru-scout-app-for-splunk_101.tgz) 0405e9172d2c0e2b8a83bb090616a94f83d8f63c43ed433aa36c407d7de951ac SHA256 checksum (team-cymru-scout-app-for-splunk_100.tgz) 422b86ff1348056996cf6b545b53d888ab80e8835aadbb28f6aa212abecb46af
To install your download
For instructions specific to your download, click the Details tab after closing this window.

Flag As Inappropriate

splunk

Team Cymru Scout App For Splunk

Splunk Cloud
Overview
Details
The Team Cymru Scout App For Splunk: Accelerate investigations and IR with IP and domain intelligence dashboards inside of Splunk: Tags and Insights, Open Ports, PDNS, X509 Certificate details, Fingerprints, WhoIs Information, Communication timelines.

Team Cymru Scout App For Splunk

OVERVIEW

The Team Cymru Scout App For Splunk pulls Indicators from the Team Cymru Scout platform. The integration does correlation and provides dashboards for visualization.

REQUIREMENTS

COMPATIBILITY MATRIX

  • Splunk version: 9.2.x, 9.1.x,9.0.x
  • Python version: Python3
  • OS Support: Independent
  • Browser Support: Independent

RECOMMENDED SYSTEM CONFIGURATION

RELEASE NOTES

Version 1.0.1

  • Updated Logos
  • Minor Bug Fixes

Version 1.0.0

  • Added data collection for Team Cymru Scout Indicators.
  • Added field-based correlation feature to find sightings in Splunk events.
  • Added Indicators Overview, Correlation Overview, Account Usage and Live Investigation Dashboards.

INSTALLATION

Team Cymru Scout App For Splunk can be installed through UI as shown below. Alternatively, .tar or .spl file can also be extracted directly into $SPLUNK_HOME/etc/apps/folder.

  1. Log in to Splunk Web and navigate to Apps > Manage Apps.
  2. Click Install app from file.
  3. Click Choose file and select the Team Cymru Scout App For Splunk App installation file.
  4. Click on Upload.
  5. Restart Splunk if prompted.

TOPOLOGY AND SETTING UP SPLUNK ENVIRONMENT

This App can be set up in two ways:

  1. Standalone Mode
    • Install the Team Cymru Scout App For Splunk App.
    • Follow all the steps mentioned in App Setup section to configure the App.
  2. Distributed Environment
    • Install the Team Cymru Scout App For Splunk App on the Search Head and Heavy Forwarder.
    • Follow the steps #1, #2 , #3 and #4 from App Setup section on Heavy Forwarder.
    • Follow the step #5 from App Setup section on Search Head.
    • In case of Search Head Clustering, make sure that steps #4 and #5 from App Setupare configured only on single search head. In such cases, the configuration will not be visible on other search heads. This is recommended approach.
    • Follow the step #5 from App Setup section on Search Head. Following these steps will replicate the configuration on all search heads.
  3. Cloud Environment
    • Install the Team Cymru Scout App For Splunk on Searchhead.
    • Install the Team Cymru Scout App For Splunk on IDM instance and configure it. (For the IDM instance Splunk support team will help) Or Setup the Team Cymru Scout App For Splunk on the On-Premise Heavy Forwarder.

CONFIGURATION

Configure Team Cymru Scout App For Splunk

App Setup

  1. Configure the account from which the data needs to be collected. Detailed steps and information for Account Configuration can be found in Account section.
  2. Users can also configure settings corresponding to the Proxy or Logging in their respective sections.
  3. Configure the settings related to Splunk KVStore and Correlation in KV Lookup Rest and Correlation Settings section respectively.
  4. After the configuration of KV Lookup Rest and Correlation Settings, users can configure the inputs by specifying the required parameters.
  5. Configure the settings related to correlation searches and lookups in Correlation Settings section.

NOTE : There might be some delay for the dashboards to populate, as these dashboards are based on savedsearches.

Account

To configure the Account,

  1. Navigate to the Configuration.
  2. Provide your Team Cymru Scout App Platform address, credentials and click on Add.
Team Cymru Scout App Account parameters Mandatory or Optional Description
Account name Mandatory Enter a unique name for this account.
Authentication Type Mandatory Select the type of Authentication. Available options are Basic Auth and Api Key
Username Mandatory (Basic Auth) Enter the username for this account.
Password Mandatory (Basic Auth) Enter the password for this account.
API Key Mandatory (Api Key) Enter the API Key for this account.

Proxy

To configure the Proxy,

  1. Navigate to the Configuration.
  2. Click on the Proxy tab.
  3. Provide your Proxy credential and Click on Save.
Proxy Parameters Mandatory or Optional Description
Enable Optional To enable the proxy
Proxy Type Optional Type of the Proxy. Available options are http and socks5. Default is http.
Host Optional Host or IP of the proxy server
Port Optional Port for proxy server
Username Optional Username of the proxy server
Password Optional Password of the proxy server

Logging

To configure the Logging,

  1. Navigate to the Configuration.
  2. Click on the Logging tab.
  3. Select the log level from the dropdown and click on Save. By default the log level is set to 'INFO'.

KV Lookup Rest

To configure the Splunk KVStore,

  1. Navigate to the Configuration.
  2. Click on the KV Lookup Rest tab.
  3. Provide the required values and click on Save.
KVStore Parameters Mandatory or Optional Description
Collection Type Mandatory Select mode to create lookups. (Defult: Index)
Indicator Indices Mandatory (index) Master lookup for indicators will be updated based on the indicators data in the selected indices.
Splunk Rest Host URL Mandatory (lookup) Enter the Splunk rest host or localhost (without http(s) scheme) to collect data.(Default: localhost)
Port Mandatory (lookup) Enter the management port of the Splunk.(Default: 8089)
Splunk Username Mandatory (lookup) Not required if Splunk Rest Host URL is localhost or 127.0.0.1. Configured user should have at least power role capabilities
Splunk Password Mandatory (lookup) Enter the password for Splunk account. No need to provide a Password if Splunk Rest Host URL is localhost or 127.0.0.1

NOTE : If using Cluster environment then make sure that all fields are configured and splunkd port 8089 of Splunk Management is open for storing lookups.

Correlation Settings

To configure the Correlation Settings,

  1. Navigate to the Configuration.
  2. Click on the Correlation Settings tab.
  3. Provide the required values and click on Save.
Correlation Parameters Mandatory or Optional Description
Enabled Indicator Types Optional Select the indicator types you want to enable correlation for. Available options are Domain and IP.
Search Matching Algorithm Optional Select the method for correlating indicators. Available options are Raw search and Datamodel Search
Select Datamodels Optional Select the data models from the list
IP: Target Query Optional Splunk query to get events from target events for correlation with IP Indicators
IP: Target Fields Optional Comma separated list of fields from target events to be used in correlation
Domain: Target Query Optional Splunk query to get events for correlation with Domain Indicators
Domain: Target Fields Optional Comma separated list of fields to be used in correlation

Upload Indicators

To configure the Upload Indicators,

  1. Navigate to the Upload Indicators.
  2. Provide the required values and click on Save.
Input Parameter Mandatory or Optional Description
File to upload the indicators Mandatory Select a csv file to upload the indicators
File Overwrite Optional Check this checkbox to overwrite the existing IP/Domain indicators. By default the indicators will be appended to the existing ones
API Type Mandatory Select the type of API to collect initially selected Foundation
Team Cymru Scout Account Mandatory Select the Team Cymru Scout Account for which you want to collect data.
Interval Mandatory Time interval of input in seconds. Default=86400
Index Optional Select the index in which data should be collected. Only required if "Collection Type" is set to "Index".

Inputs

To configure the Inputs,

  1. Navigate to the Inputs.
  2. Click on Create New Input.
  3. Provide the required information related to input and click on Add to configure the input.
Input Parameter Mandatory or Optional Description
Name Mandatory A name to uniquely identify the input
Interval Mandatory Time interval of input in seconds. Default=86400
Index Mandatory Select the index in which data should be collected. Only required if "Collection Type" is set to "Index".
Team Cymru Scout Account Mandatory Select the Team Cymru Scout Account for which you want to collect data.
API Type Mandatory Select the type of API to collect
Indicator Types Mandatory Select the type of indicators to collect.
Indicators Mandatory Enter the comma seperated indicators.

LOOKUPS

  • team_cymru_indicators_foundation_ip: This lookup contains foundation data for IP .
  • team_cymru_indicators_details_ip: This lookup contains details data for IP.
  • team_cymru_indicators_details_domain: This lookup contains details data for Domain .
  • team_cymru_matched_indicators_domain: This lookup contains the matched indicator data for Domain.
  • team_cymru_matched_indicators_ip: This lookup contains the matched indicator data for IP.

User can check data in lookup by running following SPL query in Splunk search: | inputlookup <NAME OF LOOKUP>

SAVEDSEARCHES

This application contains the following saved searches:

  • update_team_cymru_foundation_ip_indicator_master_lookup - Update Foundation IP Indicators from index to team_cymru_indicators_foundation_ip
  • update_team_cymru_details_ip_indicator_master_lookup -Update Details IP Indicators from index to team_cymru_indicators_details_ip
  • update_team_cymru_details_domain_indicator_master_lookup - Update Details Domain Indicators from index to team_cymru_indicators_details_domain .
  • team_cymru_correlate_Domains_indicators -Match Indicators of type Domains from the master_lookup against Splunk events .
  • team_cymru_correlate_<Indicators>_indicators - Match Indicators of type IPs from the master_lookup against Splunk events.
  • team_cymru_correlate_<Indicators>indicators<datamodels> - Match indicators from the indicators master_lookup against datamodels events.
  • Delete Older IPs from team_cymru_matched_indicators_ip and team_cymru_indicators_foundation_ip - IPs older than specified time will be deleted from team_cymru_indicators_foundation_ip and team_cymru_matched_indicators_ip lookups.
  • Delete Older IPs from team_cymru_matched_indicators_ip and team_cymru_indicators_details_ip - IPs older than specified time will be deleted from team_cymru_indicators_details_ip and team_cymru_matched_indicators_ip lookups.
  • Delete Older Domains from team_cymru_matched_indicators_domain and team_cymru_indicators_details_domain - Domains older than specified time will be deleted from team_cymru_indicators_details_domain and team_cymru_matched_indicators_domain lookups.

Custom Commands

This application contains the following custom commands:

  • teamcymrumatchindicators

    • Description : This command performs the correlation between Team Cymru indicator and provided Splunk events.
    • Parameters :
      • indicator_type : The type of indicator to be matched
  • teamcymruaccountusage

    • Description : Provide details on query usage, including remaining API calls and the API limit already utilized of the cymru account.
  • teamcymruscoutsectionsearch

    • Description : This command is useful to get live investigation dashboard data.
  • teamcymruscoutsearch

    • Description : This command is useful to get live investigation dashboard data.

Alert Actions

This application contains the following alert actions:

  • team_cymru_indicators_monitors
    • Description : To monitor indicators from given search with Team Cymru Scout.
    • Parameters :
      • field_name: Name of field to be used for monitoring indicators.
      • index: Select the index in which data should be collected.
      • global_account: Select the Team Cymru Scout account for which you want to collect data.
      • api_type: Select the type of API to collect.

SEARCHES

  • To see ingested data for Team Cymru Scout App For Splunk, select the Search tab. Search `team_cymru_indicator_indices` sourcetype=*team_cymru_*.

TROUBLESHOOTING

General Checks

  • To troubleshoot Team Cymru Scout App For Splunk, check $SPLUNK_HOME/var/log/Splunk/ta_team_cymru_scout*.log or user can search index="_internal" source=*ta_team_cymru_scout_*.log* query to see all the logs in UI. Also, user can use index="_internal" source=*ta_team_cymru_scout*.log* ERROR query to see ERROR logs in the Splunk UI.
  • Note that all log files of this App will be generated in $SPLUNK_HOME/var/log/Splunk/ directory.
  • If you are facing a problem related to ip address, domain, or foundation ip address then check lookups team_cymru_indicators_details_ip, team_cymru_indicators_details_domain and team_cymru_indicators_foundation_ip respectively.
  • App icons are not showing up: The App does not require restart after the installation in order for all functionalities to work. However, the icons will be visible after one Splunk restart post installation.

Data Collection

  • If data collection is not working then ensure that the internet is active (On a proxy machine, if proxy is enabled) and also ensure that the kvstore is enabled.
  • Check ta_team_cymru_scout*.log* file for Team Cymru Scout App For Splunk data collection for any relevant error messages.

Correlation

  • Note that correlation is field based and it will only match to those Splunk events having value exactly same as Indicator value.
  • Check ta_team_cymru_scout_correlation_command.log file for further analysis.

Master Lookup

  • If it seems that all the data of indicators from the Splunk index is not available in team_cymru_indicators_<indicator_type> lookup, then execute the savedsearch update_TeamCymruScoutAppForSplunk_<indicator_type>_indicator_master_lookup manually over a larger time range to refill the lookup.

Custom Commands

  • teamcymrumatchindicators
    • Check that indices of the collected Indicators data are stored in Indicator Indices parameter of correlation settings.
    • Check that team_cymru_matched_indicators_<indicator_type> lookup is not empty and also ensure that team_cymru_correlate_<indicator_type> savedsearch is enabled.
    • Check ta_team_cymru_scout_correlation_command.log file for further analysis.
  • teamcymruaccountusage
    • Check ta_team_cymru_scout_enrichment_command.log file for further analysis.
  • teamcymruscoutsectionsearch
    • Check ta_team_cymru_scout_section_search_command.log file for further analysis.
  • teamcymruscoutsearch
    • Check ta_team_cymru_scout_search_command.log file for further analysis.

Dashboards

  • Panel not populating:

    1. Live Investigation Dashboard:
      • Check ta_team_cymru_scout_search_command.log file for further analysis.
      • Check ta_team_cymru_scout_section_search_command.log file for further analysis.
    2. Correlation Overview Dashboard:
      • If the data is not populated in the above listed panels, then ensure that Indicator data is collected in Splunk and the team_cymru_matched_indicators_<indicator_type> lookup is filled with the latest data.
      • Also please ensure that savedsearches team_cymru_correlate_IPs_indicators_<indicator_type> savedsearches are enabled.
      • If dashboard panels are not populating data, it is possible that App's Saved Searches have not yet encountered newly ingested data on their previous execution. Please check Next Schedule Time in Settings -> Searches, reports and alerts. Most likely the panels will be populated once all saved searches complete their next execution.
      • In Matched Indicators Details panel there is column Live investigation if you click on Live investigation cell it will redirect to Live investigation dashboard with the indicator of that row.
      • In Matched Indicators Details panel there is column Local investigation if you click on Local investigation cell it will redirect to Search page with its ip and index.
    3. Indicators Overview Dashboard:
      • If the data is not populated in the above listed panels, then ensure that Indicator data is collected in Splunk and the team_cymru_indicators_details_domain or team_cymru_indicators_details_ip or team_cymru_indicators_foundation_ip lookup is filled with the latest data.
      • Also please ensure that savedsearches update_TeamCymruScoutAppForSplunk_<indicator_type>_indicator_master_lookup savedsearches are enabled.
      • If dashboard panels are not populating data, it is possible that App's Saved Searches have not yet encountered newly ingested data on their previous execution. Please check Next Schedule Time in Settings -> Searches, reports and alerts. Most likely the panels will be populated once all saved searches complete their next execution.
    4. Account Usage Dashboard:
      • If dashboard panels are not populating data, it is possible that App's Saved Searches have not yet encountered newly ingested data on their previous execution. Please check Next Schedule Time in Settings -> Searches, reports and alerts. Most likely the panels will be populated once all saved searches complete their next execution.

UNINSTALL & CLEANUP STEPS

  • Remove $SPLUNK_HOME/etc/apps/TeamCymruScoutAppForSplunk
  • Remove $SPLUNK_HOME/var/log/Splunk/ta_team_cymru_scout.log*.
  • To reflect the cleanup changes in UI, Restart Splunk Enterprise instance

SUPPORT

Copyright © Pure Signal Scout ™ 2007-2024. All rights reserved.

Release Notes

Version 1.0.1
June 13, 2024
  • Updated Logos
  • Minor Bug Fixes
Version 1.0.0
May 3, 2024
  • Added data collection for Team Cymru Scout Indicators.
  • Added field-based correlation feature to find sightings in Splunk events.
  • Added Indicators Overview, Correlation Overview, Account Usage and Live Investigation Dashboards.

Subscribe Share

Are you a developer?

As a Splunkbase app developer, you will have access to all Splunk development resources and receive a 10GB license to build an app that will help solve use cases for customers all over the world. Splunkbase has 1000+ apps from Splunk, our partners and our community. Find an app for most any data source and user need, or simply create your own with help from our developer portal.

Follow Us:
Splunk, Splunk>,Turn Data Into Doing, Data-to-Everything, and D2E are trademarks or registered trademarks of Splunk Inc. in the United States and other countries. All other brand names,product names,or trademarks belong to their respective owners.