JavaScript HTML Scala CSS Shell
Clone or download
Permalink
Failed to load latest commit information.
.github bump version number and rewording May 29, 2018
conf #374 Add MISP purpose in application.conf sample Jul 31, 2018
contrib Typo Jun 20, 2017
docker/thehive #618 Replace CERT-BDF by TheHive-Project Jun 25, 2018
images Update the architecture Jun 9, 2018
migration/12/dashboards #312 Add default dashboards during database migration Nov 30, 2017
package #618 Check GPG for RPM repositories Jul 30, 2018
project Update version of Play and Elastic4play Jul 31, 2018
thehive-backend #643 check if zip password is empty Jul 30, 2018
thehive-cortex #609 Add stats API for responder actions Jul 30, 2018
thehive-metrics Update dependencies Jan 31, 2018
thehive-misp #366 If extended event API is not available on MISP, fallback to edit… Jul 27, 2018
ui #609 Add responders menu for task log items Jul 30, 2018
.github_changelog_generator Update change log Mar 7, 2017
.gitignore #618 Build refactoring Jun 25, 2018
.scalariform.conf Update version of scala, sbt, play and other dependencies Nov 14, 2017
AUTHORS Bump year Jan 7, 2018
CHANGELOG.md Update changelog Jul 31, 2018
COMPONENTS Correct a typo Nov 9, 2016
LICENSE First public release Nov 3, 2016
PGP-PUBLIC-KEY Add PGP public key May 12, 2017
README.md Update the architecture Jun 9, 2018
build.sbt #618 Check GPG for RPM repositories Jul 30, 2018
code_of_conduct.md add a code of conduct Jul 24, 2017
debian.sbt #618 Build refactoring Jun 25, 2018
docker.sbt #618 Build refactoring Jun 25, 2018
package.sbt #618 Build refactoring Jun 25, 2018
rpm.sbt #618 Build refactoring Jun 25, 2018
sbt #618 Build refactoring Jun 25, 2018
version.sbt #618 Replace CERT-BDF by TheHive-Project Jun 25, 2018

README.md

Join the chat at https://gitter.im/TheHive-Project/TheHive

TheHive is a scalable 3-in-1 open source and free Security Incident Response Platform designed to make life easier for SOCs, CSIRTs, CERTs and any information security practitioner dealing with security incidents that need to be investigated and acted upon swiftly. It is the perfect companion to MISP. You can synchronize it with one or multiple MISP instances to start investigations out of MISP events. You can also export an investigation's results as a MISP event to help your peers detect and react to attacks you've dealt with. Additionally, when TheHive is used in conjunction with Cortex, security analysts and researchers can easily analyze tens if not hundred of observables.

Current Cases View

Collaborate

Collaboration is at the heart of TheHive. Multiple analysts can work on the same case simultaneously. For example, an analyst may deal with malware analysis while another may work on tracking C2 beaconing activity on proxy logs as soon as IOCs have been added by their coworker. Using TheHive's live stream, everyone can keep an eye on what's happening on the platform, in real time.

Elaborate

Within TheHive, every investigation corresponds to a case. Cases can be created from scratch or from MISP events, SIEM alerts, email reports and any other noteworthy source of security events.

Each case can be broken down into one or more tasks. Instead of adding the same tasks to a given type of case every time one is created, analysts can use TheHive's template engine to create them once and for all. Case templates can also be used to associate metrics to specific case types in order to drive the team's activity, identify the type of investigations that take significant time and seek to automate tedious tasks.

Each task can be assigned to a given analyst. Team members can also take charge of a task without waiting for someone to assign it to them.

Tasks may contain multiple work logs that contributing analysts can use to describe what they are up to, what was the outcome, attach pieces of evidence or noteworthy files and so on. Logs can be written using a rich text editor or Markdown.

Analyze

You can add one or hundreds if not thousands of observables to each case you create. You can also create a case out of a MISP event. TheHive can be very easily linked to one or several MISP instances and MISP events can be previewed to decide whether they warrant an investigation or not. If an investigation is in order, the analyst can then add the event to an existing case or import it as a new case using a customizable template.

Thanks to TheHive4py, TheHive's Python API client, it is possible to send SIEM alerts, phishing and other suspicious emails and other security events to TheHive. They will appear in its Alerts panel along with new or updated MISP events, where they can be previewed, imported into cases or ignored.

The Alerts Pane

TheHive has the ability to automatically identify observables that have been already seen in previous cases. Observables can also be associated with a TLP and the source which provided or generated them using tags. The analyst can also easily mark observables as IOCs and isolate those using a search query then export them for searching in a SIEM or other data stores.

Analysts can analyze tens or hundreds of observables in a few clicks by leveraging the analyzers of one or several Cortex instances depending on your OPSEC needs: DomainTools, VirusTotal, PassiveTotal, Joe Sandbox, geolocation, threat feed lookups and so on.

Security analysts with a knack for scripting can easily add their own analyzers to Cortex in order to automate actions that must be performed on observables or IOCs. They can also decide how analyzers behave according to the TLP. For example, a file added as observable can be submitted to VirusTotal if the associated TLP is WHITE or GREEN. If it's AMBER, its hash is computed and submitted to VT but not the file. If it's RED, no VT lookup is done.

Try it

To try TheHive, you can use the training VM or install it by reading the Installation Guide.

Details

Documentation

We have made several guides available in the Documentation repository.

Architecture

TheHive is written in Scala and uses ElasticSearch 5.x for storage. Its REST API is stateless which allows it to be horizontally scalable. The front-end uses AngularJS with Bootstrap.

architecture

Workflow

The following image shows a typical workflow:

workflow

Additional features

Authentication

TheHive supports 4 authentication methods:

  • Active Directory
  • LDAP
  • API keys
  • local

Statistics

TheHive comes with a powerful statistics module that allows you to create meaningful dashboards to drive your activity and support your budget requests.

Case Merging

Two cases can be easily merged together if you believe they relate to the same threat or have a significant observable overlap.

Case and Observable Filtering

You can filter cases and observables very easily to show only the data that is of interest to you.

MISP and Cortex

TheHive can be configured to import events from one or multiple MISP instances. You can also use TheHive to export cases as MISP events to one or several MISP servers.

Cortex is the perfect companion for TheHive. Use one or several to analyze observables at scale.

Integration with Digital Shadows

TheHive Project provides DigitalShadows2TH, a free, open source Digital Shadows alert feeder for TheHive. You can use it to import Digital Shadows incidents and intel-incidents as alerts in TheHive, where they can be previewed and transformed into new cases using pre-defined incident response templates or added into existing ones.

Integration with Zerofox

Zerofox2TH is a free, open source ZeroFOX alert feeder for TheHive, written by TheHive Project. You can use it to feed ZeroFOX alerts into TheHive, where they can be previewed and transformed into new cases using pre-defined incident response templates or added into existing ones.

License

TheHive is an open source and free software released under the AGPL (Affero General Public License). We, TheHive Project, are committed to ensure that TheHive will remain a free and open source project on the long-run.

Updates

Information, news and updates are regularly posted on TheHive Project Twitter account and on the blog.

Contributing

Please see our Code of conduct. We welcome your contributions. Please feel free to fork the code, play with it, make some patches and send us pull requests via issues.

Support

Please open an issue on GitHub if you'd like to report a bug or request a feature. We are also available on Gitter to help you out.

If you need to contact the project team, send an email to support@thehive-project.org.

Important Note:

Community Discussions

We have set up a Google forum at https://groups.google.com/a/thehive-project.org/d/forum/users. To request access, you need a Google account. You may create one using a Gmail address or without it.

Website

https://thehive-project.org/