Code42 For Splunk integrates Splunk and Code42 to provide robust correlation of endpoint and backup data.
Welcome to Code42 for Splunk Apps documentation!
About Code42 App For Splunk
||Aplura, LLC. Code42, Inc.
|Has index-time operations
|Creates an index
||Currently, the app does not generate summaries
About Code42 App For Splunk
Code42 App For Splunk allows a Splunk Enterprise administrator to extract information and knowledge from Code42.
Scripts and binaries
This App provides the following scripts:
- Enhancements to stability of data ingestion
- [C42-84] - Use is_cloud from Utilities
- [C42-83] - Bug in Batch Processor - Cursor not retrieved correctly
- [C42-81] - SSL Verify in inputs.conf
- [C42-82] - new Code42 Python SDK
- Performance Improvements
- [C42-58] - Failure to update credentials on existing input
- [C42-59] - Splunk Data Error
- [C42-68] - Modular Input stops execution on errors
- [C42-79] - Fix Saved Search
- [C42-80] - Some Searches are RAM inefficient
- Changed the Restore Forensics page to properly account for backend changes that resulted in it no longer displaying data.
- Made several query changes to ensure the accuracy of file size and file counts data in all top 10 lists and line graphs.
- [C42-72] - Enable Historical Lookback
- [C42-71] - Endpoint Argument Enforcement
- [C42-55] - Better Error Handling IN modular input
- [C42-61] - #1 Use SecurityEventsLocation API resource instead of PlanSummary and Storage API resources
- [C42-63] - #2 Use cursors by Plan for SecurityDetectionEvent resource
- [C42-64] - #3 Cache Authentication Tokens by Storage Node
- [C42-65] - #4 Skip users who have been deactivated after we have all their events
- [C42-66] - #5 Increase the default and maximum allowed Sync Frequency
- [C42-67] - #6 Attempt to use RestoreHistory API resource instead of RestoreRecord
- [C42-69] - Better KVStore initialization handling
- [C42-73] - Verbiage Fix
- [C42-78] - Additional Compatibility Updates
- DEVICE_SCAN_RESULT and PERSONAL_CLOUD_SCAN_RESULT events are both no longer included in any of the charts/tables in the Removable Media and Cloud Service dashboards, respectively.
- On the main overview page, the large green numbers displaying users and devices now only reflect active users and devices.
- Standardized all Top 10 lists to always show a table File counts and Total file sizes.
- All charts on the screen except Top 10 style charts are now updated and filtered to display the data of the selected user.
- Standardized all dashboards to now default to a time window of previous 7 days.
- Changed the dropdown user-picker filter at the top of dashboards to a textbox.
- Added EventGen tab in Application Configuration to facilitate enable/disable of event generators.
- Minor JS updates for Certification
- [C42-54] - Incorrect Import
- [C42-51] - Modular Input Pagination
- [C42-48] - App Certification Failure
- [C42-27] - Track Cursor with SecurityDetectionEvents in Checkpoint
- [C42-28] - Security Events Not Indexed at time of incident
- [C42-29] - Dashboard Restore Forensics Username Dropdown
- [C42-30] - Macro Error on Removable Media and Cloud Service Page
- [C42-32] - TypeError Decoding Checkpoint IDs
- [C42-2] - Modular Input
- [C42-3] - Application Configuration
- [C42-4] - Documentation
- [C42-5] - Branding Icons
- [C42-6] - Checklist / Health Checks
- [C42-7] - Dashboard - Instance
- [C42-8] - Dashboard - Restore Forensics
- [C42-9] - Dashboard - Cloud Service
- [C42-10] - Dashboard - Removable Media
- [C42-11] - Dashboard - Security
- [C42-14] - Create CIM Fields for Data
- [C42-18] - Eventgen
- [C42-19] - Dashboard - Files Opened
- [C42-31] - Dashboard - Add Size and Count Breakdowns to Security Dashboards
- [C42-33] - Dashboard - Overview Add CtC Panel
- [C42-34] - Dashboard - Instance Restore
- [C42-46] - Modify Server Alert Panels on Overview Dashboard
- [C42-20] - Dashboard - Security Enhancements
- [C42-21] - Dashboard - Removable Media Enhancements
- [C42-23] - Dashboard - Restore Enhancements
- [C42-24] - Dashboard - Cloud Service Enhancements
- [C42-25] - Update Modular Input to use kvstore (ifconfigured) for checkpoints
- [C42-26] - Update Modular INput to use string.printable encoding of security event idsn
- [C42-37] - Overview changes
- [C42-38] - Instance -> Device Overview
- [C42-39] - Instance -> Device Status Report
- [C42-40] - Instance -> Device Restore Forensics
- [C42-41] - Security -> Security Overview
- [C42-42] - Security -> Removable Media
- [C42-43] - Security -> Cloud Service
- [C42-44] - Security -> Restore Forensics
- [C42-45] - Security -> File Upload
About this release
Version 3.0.10 of Code42 App For Splunk is compatible with:
|Splunk Enterprise versions
||7.1, 7.2, 7.3
||Code42 Enterprise / Small Business
Version 3.0.10 of Code42 App For Splunk has the following known issues:
Support and resources
Questions and answers
Access questions and answers specific to Code42 App For Splunk at https://answers.splunk.com . Be sure to tag your question with the App.
Support is available via email at email@example.com. Responses vary on working days between working hours.
Installation and Configuration
Splunk Enterprise system requirements
Because this App runs on Splunk Enterprise, all of the Splunk Enterprise system requirements apply.
Download Code42 App For Splunk at https://splunkbase.splunk.com/app/3736/.
NOTE: Where referenced, TA-Code42ForSplunk and IA-Code42ForSplunk are located on Splunkbase.
Deploy to single server instance
Follow these steps to install the app in a single server instance of Splunk Enterprise:
- Download the Code42 App For Splunk package from https://splunkbase.splunk.com/app/3736/
- Install the App via the recommended installation methods (CLI, Web GUI)
- Restart Splunk.
- Download IA-Code42ForSplunk from https://splunkbase.splunk.com
- Install IA via the recommended installation methods (CLI, Web GUI)
- Navigate to IA-Code42ForSplunk/App_Config to setup modular input settings.
Deploy to Splunk Cloud
- Have your Splunk Cloud Support handle this installation.
Deploy to distributed deployment
Install to search head
- Download the Code42 App For Splunk package from https://splunkbase.splunk.com/app/3736/
- Install the App via the recommended installation methods (CLI, Web GUI, Deployment Server)
Install to indexers
- Download the TA-Code42ForSplunk package from https://splunkbase.splunk.com.
- Install TA-Code42ForSplunk onto the indexers per your environment.
Install to universal forwarders
- There is no installation to Universal Forwarders.
Install to Heavy Forwarders
- Download the IA-Code42ForSplunk package from https://splunkbase.splunk.com.
- Install IA-Code42ForSplunk onto a heavy forwarder in your environment.
- Configure the Modular Input with the required settings.
Deploy to distributed deployment with Search Head Clustering
- Place the App into the deploy_apps folder on the Deployer Server.
- Follow the instructions to install to a Heavy Forwarder. This Step is REQUIRED in a clustered SH environment!
- Deploy the App to the Search Head Cluster. DO NOT install IA-Code42ForSplunk to the Cluster!
Configure Code42 App For Splunk
- Install the App according to your environment (see steps above)
- Navigate to App > IA-Code42ForSplunk > Administration > Application Configuration
Application Configuration Dashboard
To configure the Code42 application you should start on the Application Configuration page (Administration > Application Configuration)*:
On this screen you can set the base index as well as a flag that specifies that the application is configured. In the future there will be additional configurations available.
If you have configured a proxy server you can view the configuration under this tab. These are proxy server configurations that are being used by existing modular inputs for the Code42 application. You can also delete existing proxy configurations on this tab.
You can view/delete existing credentials on this tab. These are credentials that are being used by existing modular inputs in the Code42 application. These credentials are the credentials used to connect to Code42 appliances.
On this screen you can view and make any changes to existing modular inputs. As you make changes and tab between fields the modular input is modified.
Creating New Proxy Configurations
If you need to use a proxy as part of the connection to the Code42 appliance configure it here.
Creating New Credentials
By default creating a new modular input with a username and password specified will create the necessary encrypted credentials. However if you want to create encrypted credentials manually follow this process:
- To create a new encrypted credential, click the Create New Credential button and fill in with the appropriate username and password.
- The realm is the application name where the encrypted credential is created + the username.
NOTE: By default creating a new modular input will automatically create a new encrypted credential so this process is not necessary unless you need a new credential for another purpose.
Creating New Code42 Inputs
NOTE: You will need to configure a new modular input for each appliance
- To create a new data input, click the Create New Modular Input button and fill in the following fields. Those with a red asterisk on the screen are required.
- Modular Input Name: Name for the data input configuration.
- Hostname and port: The hostname or IP address and port of the Code42 appliance. By default you can specify hostname:443.
- Username: The username used to connect to the appliance. This user should have a of role of Security Center User, Customer Cloud Admin, or Server Admin.
- Password: The password for the previously specified username.
- Toggle all data keys: Check to select all data keys.
- Data keys: List of endpoints available on the Code42 appliance. Check the data key if you wish to pull event data.
- Historical Lookback: This is the number of days to lookback for Security Events. Default is 60.
- Interval: The number of seconds indicate how often the input will poll for new data. This setting must be at least 60.
- Index: This sets the index for data to be written to. This setting should be changed from default, which normally writes to the main index, to a specified index for best performance.
- Use Proxy: Indicates if a proxy should be use for communication with the Code42 appliance.
- Proxy Name: Enter the name of the proxy stanza to use with the input.
- After creating the modular input you may need to disable/re-enable the input in Settings > Data Inputs > Code42 App For Splunk to activate the input.
NOTE: When configuring the modular input through the Application Configuration dashboard, the password is automatically encrypted into the credential store. If you need to change the credential, create a new credential, and reference the host/user pair in the modular input configuration. An encrypted credential is required for this Splunk App.
By default all events will be written to the main index. You should change the index in the configuration files to match your specific index.
Troubleshoot Code42 App For Splunk
- Check the Monitoring Console (>=v6.5) for errors
- Visit the Application Health dashboard
Full Data Reset
If you experiencing issues, and would like to reset the Code42 Data to factory install, there are few steps to take.
- Disable the input.
- Clear the indexed data. This is covered in the Splunk documentation
- Clear the KVStore that is tracking the cursors using the search
- Enable the input.
Code42 App For Splunk contains three automatically generated lookups.
The following lookup files are generated automatically from saved searches every hour.
Code42 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:
- Summary Indexing: No
- Data Model Acceleration: No
- Report Acceleration: No