Giter Site home page Giter Site logo

cwru-iso / ta-thehive-addon Goto Github PK

View Code? Open in Web Editor NEW
3.0 2.0 0.0 2.23 MB

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

License: GNU General Public License v3.0

Python 99.66% CSS 0.08% HTML 0.16% C 0.11%
thehive splunk splunk-addon

ta-thehive-addon's Introduction

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 <[email protected]>
Case Western Reserve University

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.