Eyeglass Solutions Publication2

The Hive Zero Trust Alert to Case Integration

Home

Overview

The Hive is a powerful and versatile tool for security incident response. It has the ability to automate tasks very well. The Hive has a user-friendly and intuitive interface that makes it easy to create, manage, and analyze security incidents

Support Statement

NOTE: This documentation is provided "as is" without support for 3rd party software. The level of support for this integration guide is best effort without any SLA on response time. No 3rd party product support can be provided by Superna directly. 3rd party components require support contracts

Limitations

None

Solution Overview

Superna Defender Zero Trust API receives webhook alerts and parses the key data into a HTTPS API payload events that are sent to The Hive endpoint url. The Hive is a modular architecture that provides real-time visibility of your IT infrastructure, which you can use for threat detection and prioritization.

Advanced Zero Trust Capabilities

Webhook to native HTTPS collector API case creation
Webhook updates to the same incident will search for pre-existing case and add a comment with the payload from the update to the incident.

What is The Hive?

TheHive offers a comprehensive 4-in-1 Security Incident Response Platform, serving as a vital tool for Security Operations Centers (SOCs), Computer Security Incident Response Teams (CSIRTs), Computer Emergency Response Teams (CERTs), and all information security professionals involved in swift and effective handling of security incidents. It composes of a robust suite of features designed to streamline incident response workflows, enhance collaboration, and empower information security practitioners to effectively investigate and mitigate security threats. With its seamless integration with MISP and advanced capabilities for task management, evidence handling, and threat intelligence integration, TheHive is an indispensable tool for modern SOC, CSIRT, and CERT teams.

Integration Architecture

Solution Configuration in The Hive and Data Security Edition Zero Trust

Prerequisites

Installed Security Edition
Eyeglass OS appliance version 15.5
1. cat /etc/os-release
License key for the Zero Trust API
The Hive
1. Download from here https://docs.strangebee.com/thehive/download/
2. API key created with create case, create comment permissions

Configuration in The Hive

The steps below create a collector endpoint,

Steps to enable direct API case creation

Log in to the tenant or main console
1. Click on a user account in the users section and create an api key on a user that has organization admin credentials or role
2. Click on the API key tab of the user account
Copy the api token created for use in the steps below

Configuration Steps on Eyeglass Virtual Machine

High Level steps

Create python location to run the application on the Eyeglass vm
Create python main application script
Create linux systemd service and set to auto start
Create Zero Trust configuration in Data Security Edition
Update the main script to customize with The Hive python code
Test the script is running as a service
Create a test event in Defender to validate the alerts appear as indexed parsed events in The Hive

Configuration Step by Step

Configure the Service start and python integration files

Login to the Eyeglass VM via SSH as the admin user
ssh admin@<your-vm-ip>

# Become root
sudo -s
mkdir -p /opt/superna/cgi-bin
chown -R sca:users /opt/superna/cgi-bin
chmod -R u+rwX,g+rwX /opt/superna/cgi-bin
# become SCA user
sudo -u sca -s
cd /opt/superna/cgi-bin
python3 -m venv venv-thehive
source venv-thehive/bin/activate
pip install flask requests
deactivate

# Create required files
touch thehive.py
touch thehive.sh

# Make scripts executable
chmod +x thehive.py
chmod +x thehive.sh

# Create the thehive.sh launch script
nano /opt/superna/cgi-bin/thehive.sh
# past contents below into the file
#!/bin/bash
export PATH="/opt/.pyenv/bin:$PATH"
source /opt/superna/cgi-bin/venv-thehive/bin/activate
exec python /opt/superna/cgi-bin/thehive.py

# Make the launch script executable
chmod +x /opt/superna/cgi-bin/thehive.sh

## exit from being SCA user
exit
whoami
### make sure you are the root user again for these steps

# Create the systemd service unit file
nano /etc/systemd/system/thehive.service

#Paste the contents below into the file
[Unit]
Description=Webhook listener for Zero Trust API translations and integrations
After=network.target

[Service]
Type=simple
User=sca
Group=users
WorkingDirectory=/opt/superna/cgi-bin
ExecStart=/bin/bash /opt/superna/cgi-bin/thehive.sh
Restart=always
RestartSec=5

[Install]
WantedBy=multi-user.target

# Reload systemd to recognize the new service
systemctl daemon-reload

# Enable the service to start on boot (do NOT start it yet)
systemctl enable thehive

Configure the python packages and customize the The Hive integration python code

Customize the application code by downloading the python code from this link to download
1. Open the python template file in a text editor. NOTE: make sure to only replace the values and do not delete any of the commas
2. Locate this section in the file and replace the yellow sections to match your The Hive endpoint URL. The endpoint url is unique and can be copied from the console into the variable below.
  1. # The Hive HTTP Collector Endpoint
    THEHIVE_URL = "https://x.x.x.x:9000/api/cases"
    THEHIVE_API_KEY = "yyyyyyy"
nano /opt/superna/cgi-bin/thehive.py
Open the file locally in Windows OS notepad and use control-A or select all the text in the python template
Paste the clipboard into the ssh terminal session with the open nano editor file
save the file
1. press control+x
2. Answer yes to save and exit the nano editor
Start the service and verify it is running
1. systemctl start thehive
2. systemctl status -l thehive
3. Verify the service is started successfully and returns "active and running".
If the service does not start do not proceed and double check the steps above are completed.

Configure Defender Zero Trust Webhooks

The next step creates an Zero Trust Webhook URL.
1. Configure Zero Trust endpoint in Ransomware Defender Zero Trust tab.
  1. Recommended Configuration: Only Critical and Major events and only the webhooks that set lockout or delayed lockout. Customers can customize based on specific requirements. The goal is to send findings versus a list of alarms that do not pinpoint a security incident.
  2. The endpoint url above will use localhost and will send Webhooks to the application service listening on port 5000. URL to use in the configuration
    1. http://localhost:5000/webhook
    2. Add the Content-Type header with value of application/json and the content-encoding with value gzip as shown above to complete the webhook configuration.
    3. Click save to commit the configuration.
    4. Click save on the main Webhook configuration page
Test the configuration is working following the next section

How to test the Integration with The Hive

To test the integration follow these steps
Prerequisites In The Hive and Eyeglass:
1. Get the ip address of the Eyeglass vm
2. download this curl command template and open with a text editor and locate the ip address of eyeglass at the very end of text and replace the ip address with the IP address of your eyeglass vm.
3. Copy all the text in the text editor
4. ssh to the eyeglass vm as the admin user
5. Paste the entire cli command text to the ssh prompt to send sample data to the running Zero Trust application. This will send test data directly to the application to be processed and sent to The Hive SIEM Integration service that is running on the Eyeglass VM.
6. The output of a successfully processed webhook test will return this text in the ssh terminal
  1. done sending event to The Hive and check for http 200 and success count in response
7. How to review the process logs from the web application
  1. sudo -s
  2. journalctl -f -u The Hive
  3. This allows you to view the logs generated by the application.
  4. To log to a file and review with nano showing only the most recent 250 lines.
  5. journalctl -f -n 250 -u thehive > /tmp/thehive.log
  6. nano /tmp/thehive
  7. In the log below the response code from the The Hive api call should show http 200 status code and successCount 1 to indicate the Finding was successfully created.
  8. You can also view The Hive.log for specific error messages.
Done

The Hive SecOps administrators Integration Experience

Example case created but the integration.