Files
blue-team-tools/README.md
T

153 lines
8.2 KiB
Markdown
Raw Normal View History

2021-08-07 21:13:19 +08:00
[![sigma build status](https://github.com/SigmaHQ/sigma/actions/workflows/sigma-test.yml/badge.svg?branch=master)](https://github.com/SigmaHQ/sigma/actions?query=branch%3Amaster)
2017-07-30 11:48:34 -04:00
2016-12-24 11:56:10 +01:00
![sigma_logo](./images/Sigma_0.3.png)
2016-12-26 02:23:34 +01:00
# Sigma
2017-02-06 20:03:57 +01:00
Generic Signature Format for SIEM Systems
2016-12-26 02:23:34 +01:00
# What is Sigma
2016-12-26 02:23:34 +01:00
2020-06-26 12:40:06 +02:00
Sigma is a generic and open signature format that allows you to describe relevant log events in a straightforward manner. The rule format is very flexible, easy to write and applicable to any type of log file. The main purpose of this project is to provide a structured form in which researchers or analysts can describe their once developed detection methods and make them shareable with others.
2016-12-26 11:14:15 +01:00
2017-10-18 15:51:58 +02:00
Sigma is for log files what [Snort](https://www.snort.org/) is for network traffic and [YARA](https://github.com/VirusTotal/yara) is for files.
2016-12-26 02:23:34 +01:00
2017-02-07 00:24:10 +01:00
This repository contains:
2022-12-27 21:05:16 +01:00
1. Sigma rule specification in the [Sigma-Specification](https://github.com/SigmaHQ/sigma-specification) repository
2020-02-02 11:31:22 +01:00
2. Open repository for sigma signatures in the `./rules` subfolder
2017-02-19 11:03:30 +01:00
2018-03-20 23:54:00 +01:00
![sigma_description](./images/Sigma-description.png)
2017-10-18 15:51:58 +02:00
## Hack.lu 2017 Talk
[![Sigma - Generic Signatures for Log Events](https://preview.ibb.co/cMCigR/Screen_Shot_2017_10_18_at_15_47_15.png)](https://www.youtube.com/watch?v=OheVuE9Ifhs "Sigma - Generic Signatures for Log Events")
## SANS Webcast on MITRE ATT&CK® and Sigma
2019-02-16 09:51:02 +01:00
The SANS webcast on Sigma contains a very good 20 min introduction to the project by John Hubbart from minute 39 onward. (SANS account required; registration is free)
[MITRE ATT&CK® and Sigma Alerting Webcast Recording](https://www.sans.org/webcasts/mitre-att-ck-sigma-alerting-110010 "MITRE ATT&CK® and Sigma Alerting")
2019-02-16 09:51:02 +01:00
2017-02-19 11:03:30 +01:00
# Use Cases
* Describe your detection method in Sigma to make it shareable
* Write your SIEM searches in Sigma to avoid a vendor lock-in
2018-06-25 18:29:02 +02:00
* Share the signature in the appendix of your analysis along with IOCs and YARA rules
2017-02-19 11:03:30 +01:00
* Share the signature in threat intel communities - e.g. via MISP
2018-06-25 18:29:02 +02:00
* Provide Sigma signatures for malicious behaviour in your own application
2017-02-19 11:03:30 +01:00
# Why Sigma
2021-04-03 00:58:15 +02:00
Today, everyone collects log data for analysis. People start working on their own, processing numerous white papers, blog posts and log analysis guidelines, extracting the necessary information and build their own searches and dashboard. Some of their searches and correlations are great and very useful but they lack a standardized format in which they can share their work with others.
2017-02-07 00:24:10 +01:00
2021-04-03 00:58:15 +02:00
Others provide excellent analyses, include IOCs and YARA rules to detect the malicious files and network connections, but have no way to describe a specific or generic detection method in log events. Sigma is meant to be an open standard in which such detection mechanisms can be defined, shared and collected in order to improve the detection capabilities for everyone.
2017-02-19 11:03:30 +01:00
## Slides
2017-02-07 00:24:37 +01:00
2017-02-06 20:03:57 +01:00
See the first slide deck that I prepared for a private conference in mid January 2017.
[Sigma - Make Security Monitoring Great Again](https://www.slideshare.net/secret/gvgxeXoKblXRcA)
2017-01-07 22:39:06 +01:00
# Specification
2022-12-27 21:05:16 +01:00
The specifications can be found in the [Sigma-Specification](https://github.com/SigmaHQ/sigma-specification) repository.
2017-02-06 20:03:57 +01:00
2017-03-01 08:55:06 +01:00
The current specification is a proposal. Feedback is requested.
2017-02-06 20:03:57 +01:00
# Getting Started
2018-06-25 18:29:02 +02:00
## Rule Creation
2022-05-23 10:50:59 +02:00
Florian wrote a short [rule creation tutorial](https://www.nextron-systems.com/2018/02/10/write-sigma-rules/) that can help you getting started. Use the [Rule Creation Guide](https://github.com/SigmaHQ/sigma/wiki/Rule-Creation-Guide) in our Wiki for a clear guidance on how to populate the various field in Sigma rules.
2021-04-03 00:58:15 +02:00
## Rule Usage
2018-06-25 18:29:02 +02:00
2023-04-02 01:15:46 +02:00
* Use [Sigma CLI](https://github.com/SigmaHQ/sigma-cli) to convert your rules into queries.
* Use [pySigma](https://github.com/SigmaHQ/pySigma) to integrate Sigma in your own toolchain or product.
* Check out the [legacy sigmatools and sigmac](https://github.com/SigmaHQ/legacy-sigmatools) if your target query
language is not yet supported by the new toolchain. Please be aware that the legacy sigmatools are not maintained
anymore and some of the backends don't generate correct queries.
2017-02-12 17:10:48 +01:00
# Examples
Windows 'Security' Eventlog: Access to LSASS Process with Certain Access Mask / Object Type (experimental)
![sigma_rule example2](./images/Sigma_rule_example2.png)
Sysmon: Remote Thread Creation in LSASS Process
![sigma_rule example1](./images/Sigma_rule_example1.png)
Web Server Access Logs: Web Shell Detection
![sigma_rule example3](./images/Sigma_rule_example3.png)
Sysmon: Web Shell Detection
![sigma_rule example4](./images/Sigma_rule_example4.png)
Windows 'Security' Eventlog: Suspicious Number of Failed Logons from a Single Source Workstation
![sigma_rule example5](./images/Sigma_rule_example5.png)
2019-03-08 16:32:22 +01:00
# Projects or Products that use Sigma
2018-05-28 09:15:48 +02:00
* [MISP](http://www.misp-project.org/2017/03/26/MISP.2.4.70.released.html) (since version 2.4.70, March 2017)
* [Atomic Threat Coverage](https://github.com/atc-project/atomic-threat-coverage) (since December 2018)
2018-06-25 18:29:02 +02:00
* [SOC Prime - Sigma Rule Editor](https://tdm.socprime.com/sigma/)
* [uncoder.io](https://uncoder.io/) - Online Translator for SIEM Searches
2019-10-21 13:34:30 +02:00
* [THOR](https://www.nextron-systems.com/2018/06/28/spark-applies-sigma-rules-in-eventlog-scan/) - Scan with Sigma rules on endpoints
* [Joe Sandbox](https://www.joesecurity.org/)
2021-04-03 00:58:15 +02:00
* [ypsilon](https://github.com/P4T12ICK/ypsilon) - Automated Use Case Testing
2019-03-08 16:32:22 +01:00
* [RANK VASA](https://globenewswire.com/news-release/2019/03/04/1745907/0/en/RANK-Software-to-Help-MSSPs-Scale-Cybersecurity-Offerings.html)
2019-10-21 13:34:30 +02:00
* [TA-Sigma-Searches](https://github.com/dstaulcu/TA-Sigma-Searches) (Splunk App)
* [TimeSketch](https://github.com/google/timesketch/commit/0c6c4b65a6c0f2051d074e87bbb2da2424fa6c35)
2021-04-03 00:58:15 +02:00
* [SIΣGMA](https://github.com/3CORESec/SIEGMA) - SIEM consumable generator that utilizes Sigma for query conversion
2022-04-01 19:34:43 +02:00
* [Aurora Agent](https://www.nextron-systems.com/2021/11/13/aurora-sigma-based-edr-agent-preview/)
2022-04-08 10:02:09 -04:00
* [Confluent Sigma](https://github.com/confluentinc/cyber/tree/master/confluent-sigma)
2023-03-20 09:34:19 +01:00
* [SEKOIA.IO](https://www.sekoia.io) - XDR supporting Sigma and Sigma Correlation rules languages
2017-12-07 21:55:43 +01:00
2021-02-07 15:27:59 +01:00
Sigma is available in some Linux distribution repositories:
2020-10-17 15:50:19 +02:00
[![Packaging status](https://repology.org/badge/vertical-allrepos/sigma.svg)](https://repology.org/project/sigma/versions)
2017-12-07 21:55:43 +01:00
2019-08-06 12:22:03 +02:00
# Contribution
2019-08-06 11:36:54 +02:00
2019-08-06 12:22:31 +02:00
If you want to contribute, you are more then welcome. There are numerous ways to help this project.
2019-08-06 11:36:54 +02:00
## Use it and provide feedback
2021-04-03 00:58:15 +02:00
If you use it, let us know what works and what does not work.
2019-08-06 12:22:03 +02:00
E.g.
* Tell us about false positives (issues section)
* Try to provide an improved rule (new filter) via [pull request](https://docs.github.com/en/repositories/working-with-files/managing-files/editing-files#editing-files-in-another-users-repository) on that rule
2019-08-06 11:36:54 +02:00
## Work on open issues
2019-08-06 12:22:03 +02:00
The github issue tracker is a good place to start tackling some issues others raised to the project. It could be as easy as a review of the documentation.
2019-08-06 11:36:54 +02:00
2019-08-06 12:22:03 +02:00
## Provide Backends / Backend Features / Bugfixes
2019-08-06 11:36:54 +02:00
2022-05-19 07:45:01 +02:00
Please don't provide backends for the old code base (sigmac) anymore. Please use the new [pySigma](https://github.com/SigmaHQ/pySigma). We are working on a documentation on how to write new backends for that new code base. An example backend for Splunk can be found [here](https://github.com/SigmaHQ/pySigma-backend-splunk).
2019-08-06 12:22:03 +02:00
## Spread the word
2019-08-06 11:36:54 +02:00
Last but not least, the more people use Sigma, the better, so help promote it by sharing it via social media. If you are using it, consider giving a talk about your journey and tell us about it.
2019-08-06 11:36:54 +02:00
2017-12-07 21:55:43 +01:00
# Licenses
The content of this repository is released under the following licenses:
* The [Sigma Specification](https://github.com/SigmaHQ/sigma-specification) and the Sigma logo are public domain
2023-01-27 19:42:16 +01:00
* The rules contained in the [SigmaHQ repository](https://github.com/SigmaHQ) are released under the [Detection Rule License (DRL) 1.1](https://github.com/SigmaHQ/Detection-Rule-License)
2018-06-25 18:29:02 +02:00
# Credits
This is a private project mainly developed by Florian Roth and Thomas Patzke with feedback from many fellow analysts and friends. Rules are our own or have been drived from blog posts, tweets or other public sources that are referenced in the rules.
2019-02-09 09:38:01 +01:00
# Info Graphic
2020-03-08 13:06:35 +01:00
## Overview
2019-02-09 09:38:01 +01:00
![sigmac_info_graphic](./images/sigma_infographic_lq.png)
2020-03-08 13:06:35 +01:00
## Coverage Illustration
2020-05-18 08:11:16 +02:00
![sigmac_coverage](./images/Sigma_Coverage.png)