Skip to content

Latest commit

 

History

History
115 lines (85 loc) · 5.83 KB

README.md

File metadata and controls

115 lines (85 loc) · 5.83 KB

Open Source SIEM Stack

💗 Shoutout to dLoProdz for helping put this together 🧡


The idea behind this project is to facilitate testing of SOCFortress' Open Source SIEM Stack. This is by no means production safe security-wise, and only intended to get people started in a lab environment. This project is licensed under GPLv3 which means you can use and modify in it any way you like, so long as you keep it under the same licensing scheme. If you don't feel confortable making necessary changes for moving into production you can get in touch with us and we will help you get there.

Watch the Video Walkthrough

Open Source SIEM Stack

Pre-Deployment

The first step is to build the Custom Wazuh Manager image using the build script provided in wazuh/custom-wazuh-manager, there you will find instructions for the build.

Next you need to create, by whichever means you prefer, the required Wazuh SSL certs and place them in the wazuh/config/wazuh_indexer_ssl_certs directory. I'm providing the official Wazuh cert generating script under wazuh/generate-indexer-certs.yml. Instructions for for running this container/script can be found in the Official Wazuh Docker Repo and also under the specific subdirectory. Note: Also copy the root-ca.pem certificate into the graylog/ subdirectory as you will need it in a later step.

After successful build of the Custom Wazuh Image and SSL cert generation, the next step is to modify all the configuration files provided under each module's subdirectory, as the ones provided are templates taken from each tool's documentation; and also the .env file, which comes pre-populated up to a certain point for your convenience and is located in the directory root, to suit your environment and needs. Refer to each tool's documentation or follow Taylor Walton's Youtube Channel for guidance on how to configure each tool.

You'll also need to follow the pre-deployment step outlined in the Graylog section. graylog/README.md

Once that is out of the way, you are ready for Deployment.

Deployment

You can now safely start all containers by running:

docker compose up -d

Most of these services will need some tewaking before you are able to integrate them. I will note the project specific configurations, for the rest please follow Taylor's Videos.

Wazuh

After initial deployment, the Wazuh Dashboard will present an error in the health check for the wazuh-alerts index as this has not been created yet. This error will only be fully fixed after successfully integarting Graylog and the Wazuh Indexer. You can go ahead and create any necessary users/roles for the upcoming integrations to work correctly.

Wazuh Rules

Exec into the Wazuh Manager Container

docker exec -it wazuh.manager /bin/bash
dnf install git -y
curl -so ~/wazuh_socfortress_rules.sh https://raw.githubusercontent.com/socfortress/OSSIEM/main/wazuh_socfortress_rules.sh && bash ~/wazuh_socfortress_rules.sh

Graylog

While the container is running, you'll need to access it's console to perform some extra steps in order to add the Wazuh root CA into Graylog's Java Keystore. Run the following command to spawn a shell inside the container.

docker exec -it graylog bash

Once inside Graylog, you'll need to copy the Java Keystore located at /opt/java/openjdk/lib/security/cacerts into the /usr/share/graylog/data/config/ directory, for this you can run:

cp /opt/java/openjdk/lib/security/cacerts /usr/share/graylog/data/config/

Next you need to import the Wazuh root CA into the keystore, cd into the /usr/share/graylog/data/config/ and run the following command: (change the certificate name and keystore password as needed, but note that if the certificate name doesn't match the template, you'll need to modify the docker-compose.yml file accordingly)

cd /usr/share/graylog/data/config/
keytool -importcert -keystore cacerts -storepass changeit -alias wazuh_root_ca -file root-ca.pem

You will be prompted to accept this certificate, type "yes" and enter. After this is done Graylog will be able to connect to the Wazuh Indexer.

Velociraptor

We now need to generate the api.config.yaml file which CoPilot will use to access the Velociraptor API

docker exec -it velociraptor /bin/bash
./velociraptor --config server.config.yaml config api_client --name admin --role administrator,api api.config.yaml

Copilot

Once Copilot has started up you can retrieve the admin password by running the following command (Only accessible the first time Copilot is started up)

docker logs "$(docker ps --filter ancestor=ghcr.io/socfortress/copilot-backend:latest --format "{{.ID}}")" 2>&1 | grep "Admin user password"

Post-Deployment

After you've reached this point you can take a short break to pat yourself in the back, it's all downhill from here on out.

You'll need to make sure to create any necessary users in each of the tools for the integrations to work correctly. After that has been completed, you can log into CoPilot and start provisioning customers.

Credits

Huge shoutout to SOCFortress and Taylor Walton for their hard work and contributions to the open source community. And of course all credits to the Wazuh Team for their amazing product.