Splunk® Enterprise Security

Installation and Upgrade Manual

Download manual as PDF

This documentation does not apply to the most recent version of ES. Click here for the latest version.
Download topic as PDF

Install and deploy add-ons

The Splunk Enterprise Security installation includes a selection of add-ons designed for compliance with the Common Information Model (CIM). Add-ons are specific to a single technology, or version of a technology, and provide the knowledge necessary to incorporate that source data into Enterprise Security.

Add-ons provided with Enterprise Security

Splunk Enterprise Security provides several add-ons. Some of the add-ons make up the Splunk Enterprise Security framework. See About the ES solution architecture on the Splunk developer portal. Additional security-relevant and CIM-compliant add-ons provided with Enterprise Security are listed below.

For configuration details on an add-on that does not have web-based documentation, see the README file included in the root folder of the add-on.

Other add-ons

Splunk also offers the Splunk Add-on for Facebook ThreatExchange, which allows Splunk Enterprise Security users to leverage intelligence from Facebook ThreatExchange within the ES Threat Intelligence framework to populate the existing Threat Activity and Threat Artifact views. See About the Splunk Add-on for Facebook ThreatExchange for installation and setup instructions.

Distributed installation of add-ons

Add-ons contain pre-defined knowledge about data sources. When you install Splunk Enterprise Security in a distributed environment, add-ons must be distributed based upon the Splunk instance types used in your Splunk environment. Splunk Cloud customers will work with Splunk Support to install add-ons on search heads and indexers, but are responsible for on-premises forwarders.

Splunk instance type Supported Comments
Search Heads Yes Add-ons are installed on the search head with Splunk Enterprise Security. Any unused add-ons should be disabled.
Indexers Yes An add-on that includes index-time props and transforms must be deployed to the indexers. For configuration details on an add-on that does not have web-based documentation, see the README file included in the root of the add-on's folder.
Heavy Forwarders Yes An add-on that includes index-time props and transforms must be deployed to a heavy forwarder if the data source is routed or collected with that forwarder.
Universal Forwarders Yes Most add-ons include input settings for a specific data source. Review the inputs.conf included with an add-on and deploy the add-on to a forwarder as necessary.

Distributed deployment compatibility

Distributed deployment feature Supported Comments
Search Head Clusters Yes Use the search head cluster deployer to distribute add-ons across on-premises search head cluster members. See Installing Add-ons on a Search Head cluster in this topic.
Indexer Clusters Yes Use the cluster master to distribute add-ons across a set of on-premises index cluster peers . See Manage common configurations across all cluster peers and Manage app deployment across all cluster peers in the Managing Indexers and Clusters Manual.
Deployment Server Yes Use the deployment server to distribute add-ons across non-clustered on-premises indexers and forwarders.

Determine which add-ons to deploy on indexers

When you install Splunk Enterprise Security in a distributed environment, the add-ons are installed and enabled on the search head as part of the ES package. Add-ons contain search-time knowledge imported during the ES installation, and can include additional index-time operations. An add-on can remain solely on the search head unless it includes additional index-time operations, in which case you must deploy the add-on to your indexers. Splunk Cloud customers must work with Splunk Support to install add-ons on indexers.

  1. Review the README files included with each add-on to determine if the add-on includes index-time operations.
  2. Collect the add-ons that use index-time operations. Optionally, use the Distributed Configuration Management feature of ES to create an add-on for deployment.
  3. Determine how to deploy the add-ons based on the Splunk platform architecture in your environment:
  • Non-clustered indexers
  1. Place the add-ons on the deployment server.
  2. Use the deployment server to deploy the add-on(s) to the indexers. See Plan a deployment in the Updating Splunk Enterprise Instances Manual.
  • Clustered indexers
  1. Place the add-ons on the cluster master.
  2. Use the cluster master to deploy the add-on(s) to the cluster peers. See Manage app deployment across all peers in the Managing Indexers and Clusters of Indexers Manual.

Creating the Splunk_TA_ForIndexers

Use the Splunk_TA_ForIndexers app to consolidate all of the index-time configurations and basic index definitions in one package to ease deployment for on-premises indexers.

  1. On the Enterprise Security menu bar, browse to Configure > General and select Distributed Configuration Management.
  2. Select the option to Download the Package to merge all indexes.conf and index-time props.conf and transforms.conf settings from all enabled apps and add-ons on the search head, and place them into one add-on for download. The merge creates one indexes.conf, props.conf, and transforms.conf file containing all settings, similar to a ./splunk cmd btool <conf_file_prefix> list output.
  3. After the add-on is downloaded, review indexes.conf and update it if needed to conform with site retention settings and other storage options. Optionally, you can remove the indexes.conf file from the add-on as the index configurations for your environment might be configured and managed in another app. For more information on configuring the indexes for Enterprise Security, see Configure and deploy Indexes in this manual.

When you install a new add-on for use with ES, create an updated copy of Splunk_TA_ForIndexers by returning to the Distributed Configuration Management page and selecting Download the Package.

Automated deployment of the Splunk_TA_ForIndexers

If your on-premises Splunk platform installation uses the Deployment Server to manage the indexer settings, you can configure the Distributed Configuration Management page to push the Splunk_TA_ForIndexers directly to the indexers. This feature is designed to work with a Splunk Deployment Server, and cannot be used for indexer clustering.

  1. Make the search head a deployment client of the Deployment Server.
  2. On the Enterprise Security menu bar, browse to Configure > General and select Distributed Configuration Management.
  3. Select Yes for Do you want to use auto deployment?
  4. Select Add new credential to create a Splunk administration credential for use with the Deployment Server. The user credential must be in the Splunk administrator role on the Deployment Server instance.
  5. Fill out the User and Password fields, and set the Application field to SplunkEnterpriseSecuritySuite.
  6. Save the credential.
  7. Use the Select credentials drop down to choose the Splunk admin credentials required to authenticate with the Deployment Server
  8. Select the indexers that can receive the Splunk_TA_ForIndexers add-on. The indexers list is created from the search head's Distributed search configuration page.
    1. (Optional): You can add additional indexer names manually by entering text in the Select Splunk Indexers field.
  9. Select Save to create the Splunk_TA_ForIndexers add-on that includes the index-time props.conf, and transforms.conf.
    1. (Optional): Enable the Push indexes.conf setting. As the index settings often require storage specific configuration, do not choose this option by default.
If you disable the auto-deployment option after enabling it, the Splunk_TA_ForIndexers add-on will remain on the Deployment Server, and you must remove the add-on and serverclass manually.

Determine which add-ons to deploy on forwarders

Review the add-on documentation to determine if it contains a unique input configuration for the data source, or index-time operations. For information on an add-on that does not have web-based documentation, see the README file included in the root of the add-on's folder. Splunk Cloud customers are responsible the configuration, deployment, and management of on-premises forwarders.

  • Review the inputs.conf included with an add-on, and deploy the add-on to any forwarder ingesting that data.
  • An add-on that includes index-time props and transforms must be deployed to a heavy forwarder if the data source is routed or collected with that forwarder.

Installing add-ons on a search head

Each add-on is specific to a single technology, or version of a technology, and provides the knowledge necessary to incorporate that source data into Enterprise Security. Use the Splunk Apps manager to add additional CIM-compatible add-ons to your on-premises search head. Splunk Cloud customers must work with Splunk Support to install add-ons on search heads. To deploy an add-on to other Splunk instances, see Distributed deployment compatibility in this topic.

Note: Install add-ons that are compatible with the Common Information Model.

Find an add-on

  1. Log in to splunk.com.
  2. Go to Splunkbase.
  3. Browse and search the list of add-ons.
  4. Select an add-on.
  5. Download the add-on.

Add an add-on from a local file

  1. Click Apps next to Splunk in the menu bar.
  2. From the drop-down menu, select Manage Apps.
  3. Select Install app from file.
  4. In the Upload an app panel, browse for the location of the add-on and select it.
  5. Click Upload.

Edit an existing add-on

  1. Click Apps next to Splunk in the menu bar.
  2. From the drop-down menu, select Manage Apps.
  3. Select the add-on from the list.
  4. Click Edit Properties for the add-on you want to configure.
  5. When your finished, click Save.

Note: Do not use the Create app option on the Apps page within Enterprise Security.

Updating add-ons

Some add-ons are released independently of Enterprise Security, and can be downloaded directly from Splunkbase.

Update the add-on from within Splunk

To check for the new version of an app, select Manage Apps on the Apps menu. A link will appear in the Version column if a new version is available.

  1. Log in to splunk.com.
  2. Click the link in the version column in Splunk Enterprise.
  3. Confirm that an updated version of the add-on exists. Click Update to get the new version.
  4. To install the add-on, choose Restart.

Update the app manually

  1. Log in to splunk.com.
  2. Find the new version of the add-on on Splunkbase.
  3. Download the add-on to your desktop or local directory.
  4. Browse to Apps > Manage Apps > Install app from file.
  5. Browse to the add-on location and select the add-on.
  6. Select Upgrade app... so that the new version of the add-on overwrites the prior version.
  7. Choose Upload.
  8. To install the add-on, choose Restart.

Installing Add-ons on a Search Head cluster

Using search head clustering changes the process for deploying apps and configuration files to the on-premises search head cluster members. To distribute app and add-on configurations to search head cluster members, you must use the search head cluster deployer.

Distributing add-ons in a search head cluster with Splunk Enterprise 6.4

App import settings automatically replicate across search head cluster nodes running Splunk Enterprise 6.4 or later. Use the search head cluster deployer to distribute add-ons across the set of search head cluster members. For details, see Use the deployer to distribute apps and configuration updates in the Splunk Enterprise Distributed Search Manual.

Import custom apps and add-ons

You can extend the functionality of Splunk Enterprise Security with apps and add-ons. Download apps and add-ons from Splunkbase or create your own add-on with a tool such as the Splunk Add-on Builder. Splunk Cloud customers must work with Splunk Support to install add-ons on search heads.

Use the Update ES modular input

Splunk Enterprise Security integrates the configurations of apps and add-ons installed on the same search head. The Update ES modular input imports all apps and add-ons that match a regular expression filter. The filter is defined in the app path SplunkEnterpriseSecuritySuite/default/inputs.conf.

Modular input Function
app_imports_update://update_es Imports and updates the metadata for supporting add-ons.
app_imports_update://update_es_da Imports and updates the metadata for domain add-ons.
app_imports_update://update_es_main Imports and updates the metadata for the SplunkEnterpriseSecuritySuite.

Imports are transitive

App imports are transitive. This means than an app (A) that imports another app (B), also imports all of the apps (C) imported by that app.

  1. If app A imports B,
  2. and app B imports C,
  3. then A imports C.

Because supporting add-ons import each other, you might see only one supporting add-on with an updated local.meta file. This is SA-AccessProtection, as it is the first supporting add-on in the list of apps.

View existing app imports

Use the |rest search commands to view the existing app imports. You must have Splunk administrator permissions to run the command. For example, to view the imports for the SplunkEnterpriseSecuritySuite app while authenticated as the admin user:

| rest /servicesNS/admin/system/apps/local/SplunkEnterpriseSecuritySuite/import splunk_server=local | fields import

App and add-on import naming conventions

The modular inputs will automatically import apps and add-ons prefixed with any of the following: DA-ESS-, SA-, TA-, Splunk_SA_, Splunk_TA_, and Splunk_DA-ESS_.

Import add-ons with a different naming convention

If your custom add-on does not use the typical ES naming conventions, you must add the name or a naming convention to the import modular input.

  1. On the Enterprise Security toolbar, select Configure > General and select App Imports Update.
  2. Edit the update_es input.
  3. Update the Application Regular Expression field, adding the naming convention of your add-on to the list of supported naming conventions using a regex.
    1. For example, to import a new add-on named My_datasource update the Application Regular Expression field to:
      (appsbrowser)|(search)|([ST]A-.*)|(Splunk_[ST]A_.*)|(DA-ESS-.*)|(Splunk_DA-ESS_.*)|(My_datasource)
    2. When changing the Application Regular Expression field, always append to the default regex or the existing app imports will fail.
  4. Save.
  5. Preview the changes

    |rest services/data/inputs/app_imports_update | table title app_regex app_exclude_regex updated

  6. Restart Splunk Enterprise services to incorporate the changes.

If your custom app or add-on includes knowledge objects that you want to use in Splunk Enterprise Security, make sure that it is set to export settings to Enterprise Security. See Set permissions for objects in a Splunk app on the Splunk developer portal.

Remove an add-on from app import

To exclude an add-on from the app import process:

  1. On the Enterprise Security toolbar, browse to Configure > General and select App Imports Update.
  2. Edit the update_es input.
  3. Update the Application Exclusion Regular Expression field, adding the naming convention of your add-on to the list of supported naming conventions using a regex.
    1. For example, to exclude a new add-on named TA_new_test update the Application Exclusion Regular Expression field to: |TA_new_test
  4. Save.
  5. Preview the changes

    |rest services/data/inputs/app_imports_update | table title app_regex app_exclude_regex updated

  6. Restart Splunk Enterprise services to incorporate the changes.

Splunk Stream integration

Enterprise Security offers direct integration with Splunk Stream.

Splunk Stream has two components:

  • The Splunk App for Stream is responsible for the job management of the Splunk Stream Add-on. Install the Splunk App for Stream on the Enterprise Security search head.
  • The Splunk Stream Add-on is the listener that siphons data from the network. Install the Splunk Stream Add-on on forwarders.

Data collection using the Splunk Stream Add-on requires a review and analysis of the network topology to determine the best method and location for data capture. See Network collection architectures in the Splunk Stream User Manual.

Stream data collection utilizes system resources that scale with the number of protocols polled and the volume of network data. See Hardware requirements in the Splunk Stream User Manual.

Splunk Stream communications

Integrating Enterprise Security with Splunk Stream requires the installation of the Stream app on the ES search head. The Splunk Stream Add-on is installed on the forwarders, and initiates communications with the Stream app on the search head over HTTP.

Stream data capture jobs are managed from the Splunk App for Stream, and are retrieved for processing by the Stream Add-on. The Splunk Stream Add-on must be configured to communicate with the Splunk App for Stream. See Configure Stream Forwarder in the Splunk Stream User Manual.

For a Splunk Cloud deployment, see Deploy Splunk Stream on Splunk Cloud in the Splunk Stream Installation and Configuration Manual.

Create a Stream capture job

Start a Stream capture as a result of a correlation search or from the Incident Review dashboard. See Start a Stream capture in the Splunk Enterprise Security User Manual.

View and analyze Stream data events captured in Splunk Enterprise Security on the Protocol Intelligence dashboards. See Protocol Intelligence dashboards in the Splunk Enterprise Security User Manual.

PREVIOUS
Install Enterprise Security
  NEXT
Configure and deploy indexes

This documentation applies to the following versions of Splunk® Enterprise Security: 4.5.0, 4.5.1, 4.5.2, 4.5.3, 4.6.0 Cloud only


Was this documentation topic helpful?

Enter your email address, and someone from the documentation team will respond to you:

Please provide your comments here. Ask a question or make a suggestion.

You must be logged into splunk.com in order to post comments. Log in now.

Please try to keep this discussion focused on the content covered in this documentation topic. If you have a more general question about Splunk functionality or are experiencing a difficulty with Splunk, consider posting a question to Splunkbase Answers.

0 out of 1000 Characters