Skip to content

An add-on that adds an Alert Action for creating alerts in TheHive.

License

Notifications You must be signed in to change notification settings

cwru-iso/TA-TheHive-Addon

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

TA-TheHive-Addon

This add-on is designed to add the ability to create an alert entry in TheHive as an action to a Splunk alert. Includes general QoL improvements such as formatting alert descriptions, grouping alerts, etc.

Installation

  1. Download the latest TA-TheHive-Addon app package.
  2. Install the app on your Splunk search head(s):
    Apps Dropdown -> Manage Apps -> Install app from file
  3. Restart Splunk (for later updates, you may skip this step)
  4. At next logon, launch the app:
    Apps Dropdown -> TheHive Add-on
  5. Configure the Add-on to use your instance URL and keys.

Alerts can now use the "Create alert in TheHive" action.

Usage

thehive_create_alert

Title - $name$ will automatically be replaced with the Title of the Alert itself by Splunk.

Description - Can be either static text OR a field name (eg: "alert_desc"). All \n's will be replaced with actuall newlines.

Case Template - The name of the template itself in TheHive, including spaces.

PAP - Not supported by TheHive at this time, but there as a placeholder.

Group by - Must be a field that exists in the table output. All alerts that have the same value for that field will have their artifacts grouped into a single alert.

The Title, SourceRef, and Description, will only be pulled from the first occurrence.

Search Setup

[base search query]
| eval alert_desc = "Some long dynamic description for your alert\n\n```\n" . _raw . "\n```"
| eval "dataType:Artifact Message" = someArtifact
| eval "field:fieldType:Field Name" = anotherArtifact
| [... etc ...]
| table alert_desc "dataType:Artifact Message" "field:fieldType:Field Name" ...

Caveats

  • You must table the results at the end with all fields.
  • Any fields that do not include a dataType will not be included in the Alert.
  • All \n will be treated as actual newlines in the Alert description.

Licence

This Splunk app is licensed under the GNU General Public License v3.0.

Credits

Heavily inspired by remg427/TA-thehive.

Authors

Kyle Colantonio <kyle.colantonio@case.edu>
Case Western Reserve University