Eyeglass Solutions Publication

Sumo Logic SIEM Zero Trust Alert Integration

Home



 

Overview

Customers using Sumo Logic SIEM solution can now leverage a native integration that initiates native ingestion API alerts from Security Editions zero trust alerts.   Customers can augment the capabilities of Sumo Logic SIEM with threat intelligence and Cyber Storage capabilities of Superna Security Edition.

Support Statement

  1. 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

  1. 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 SIEM collector endpoint url.  Sumo Logic SIEM (Security Information and Event Management) 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

  1. Webhook to native HTTPS collector API alarm integration

What is Sumo Logic SIEM?

Sumo Logic Cloud SIEM provides security analysts and SOC managers with enhanced visibility across the enterprise to thoroughly understand the scope and context of an attack. Streamlined workflows automatically triage alerts to detect known and unknown threats faster.


Integration Architecture



Solution Configuration in Sumo Logic SIEM and Defender Zero Trust

Prerequisites

  1. Installed Security Edition
  2. Eyeglass OS appliance version 15.5
    1. cat /etc/os-release
  3. License key for the Zero Trust API 
  4. Sumo Logic SIEM


Configuration in Sumo Logic SIEM

The steps below create a collector endpoint, 

Steps to Create an HTTP Source

  1. Log in to Sumo Logic
  2. Go to Sumo Logic’s login page.
  3. Navigate to the “Collectors” Page
    1. In the left-hand menu, go to:
    2. Manage Data → Collection → Add Source.
  4. Select Your Collector
  5. Click Add Collector to create one.
  6. Select Hosted Collector (to collect data from an HTTP source)
  7.  
  8.  
  9. Add a New HTTP Source
    1. Click Add Source within your Hosted Collector.
    2. Select HTTP Logs and Metrics as the source type.
    3. Configure the HTTP Source
    4. Name: Enter a descriptive name (e.g., “Webhook Data Ingest”).
    5. Description: Optional field for notes.
    6. Source Category: Use a meaningful category, e.g., webhook/sumo_logic.
    7. Click Save.
    8. Copy the HTTP Endpoint URL
    9.  
    10. Save this URL to update the integration code below.
  10. done


Configuration Steps on Eyeglass Virtual Machine

High Level steps

  1. Create python location to run the application on the Eyeglass vm
  2. Create python main application script
  3. Create linux systemd service and set to auto start
  4. Create Zero Trust configuration in Defender
  5. Update the main script to customize with Sumo Logic SIEM python code
  6. Test the script is running as a service
  7. Create a test event in Defender to validate the alerts appear as indexed parsed events in Sumo Logic SIEM

Configuration Step by Step

Configure the Service start and python integration files
  1. Login to eyeglass vm using ssh as the admin user to create zero trust application
    1. sudo -s 
    2. mkdir -p /opt/superna/cgi-bin
    3. touch /opt/superna/cgi-bin/sumologic.py
    4. touch /opt/superna/cgi-bin/sumologic.sh 
    5. sca:users /opt/superna/cgi-bin/sumologic.*
    6. chmod +x  /opt/superna/cgi-bin/sumologic.py 
    7. chmod +x /opt/superna/cgi-bin/sumologic.sh 
  2. Create systemd configuration
    1. nano  /etc/systemd/system/sumologic.service
    2. Copy the values below and Paste these contents into the file opened in nano editor in the step above
    3. Save the file 
      1. press control+x
      2. Answer yes to save and exit
  3. Restart systemd
    1. systemctl daemon-reload
  4. Set to enabled
    1. systemctl enable sumologic
  5. Create sumologic.sh service script
    1. Copy the values below
    2. nano /opt/superna/cgi-bin/sumologic.sh
    3. paste the script values below into the nano editor
    4. Save the file
      1. press control+x
      2. Answer yes to save and exit the editor
  6. Once the script is created below,  do not start the service at this step.
  7. Done

### Service definition text to copy into /etc/systemd/system/sumologic.service. ###
[Unit]
Description=Webhook listener for Zero Trust api translations and integrations
After=network.target

[Service]
User=sca
Group=users
WorkingDirectory=/opt/superna/cgi-bin
Environment="PATH=/opt/.pyenv/shims:/usr/bin:/usr/local/bin"

ExecStart=/bin/bash /opt/superna/cgi-bin/sumologic.sh

[Install]
WantedBy=multi-user.target


Copy paste this for sh script


### service launch script /opt/superna/cgi-bin/sumologic.sh ### 
#!/bin/bash
export PATH="/opt/.pyenv/bin:$PATH"
/opt/.pyenv/shims/python3 sumologic.py


Configure the python packages and customize the sumologic integration python code

  1. Now install required python packages for the SCA users that will run the service.  NOTE this is the same user that runs the main eyeglass application code.
    1. su - sca  (you may need to install the packages as the root user)
    2. pip3 install flask boto3 requests logging
    3. exit 
    4. NOTE: you must type exit to ensure you are the root user for the remaining steps.  Type whoami to make sure you are the root user.
  2. 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 sumologic endpoint URL.   The endpoint url is unique and can be copied from the console into the variable below.
      1. SUMO_LOGIC_URL = "https://endpoint4.collection.sumologic.com/receiver/v1/http/{unique endpoint}"
  1. nano /opt/superna/cgi-bin/sumologic.py
  2. Open the file locally in Windows OS notepad and use control-A or select all the text in the python template
  3. Paste the clipboard into the ssh terminal session with the open nano editor file
  4. save the file
    1. press control+x
    2. Answer yes to save and exit the nano editor 
  5. Start the service and verify it is running
    1. systemctl start sumologic
    2. systemctl status -l sumologic 
    3. Verify the service is started successfully and returns "active and running".

  6. If the service does not start do not proceed and double check the steps above are completed. 

Configure Defender Zero Trust Webhooks

  1. 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 as shown above to complete the webhook configuration.
        3. Click save to commit the configuration.
        4. Click save on the main Webhook configuration page
  2. Test the configuration is working following the next section

How to test the Integration with Sumo Logic SIEM

  1. To test the integration follow these steps
  2. Prerequisites In Sumo Logic SIEMand Eyeglass:
    1. install the Sumo Logic SIEMagent on a test machine.  Record the ip address of this test machine.
    2. Get the ip address of the Eyeglass vm
    3. 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.
    4. Copy all the text in the text editor
    5. ssh to the eyeglass vm as the admin user
    6. 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 Sumo Logic SIEM Integration service that is running on the Eyeglass VM.
    7. The output of a successfully processed webhook test will return this text in the ssh terminal
      1. done sending event to sumologic and check for http 200 and success count in response
    8. How to review the process logs from the web application
      1. sudo -s 
      2. journalctl -f -u sumologic 
      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 sumologic  > /tmp/sumologic.log
      6. nano /tmp/sumologic.log
      7. In the log below the response code from the Sumo Logic SIEM api call should show http 200 status code and successCount 1 to indicate the Finding was successfully created.
      8.   You can also view sumologic.log for specific error messages.
    9. Login to the Sumo Logic SIEM and verify lot events can be seen in the log event viewer
      1.  
  3. Done


Sumo Logic SIEM SecOps administrators Integration Experience 

Example parsed results after an alert is sent to the collector endpoint url and parsed.

  1. Example log that is fully parsed
    1.  
  2. How to Search for all events from a collector
    1. Open the Collector UI tab and open a search from the http collector icon.  
    2.  


How to create an Alert Monitor

  1. Under the Alert monitor section of the left menu
    1. Click Add and import
      1. Download this json file (right click download) and copy all the contents in the the import option and click Save
      2. Edit the monitor to change the Notifications as required.
    2.  This enables a policy to look for critical Superna events every 5 minutes and raise an alert for each event 
  2. Once it fires the Alert list should display an alert.  NOTE: Use the testing procedure to create a webhook for testing log creation and Monitor alerts.

© Superna Inc