Skip to content

Commit

Permalink
Update sigmahq_title_rule.md
Browse files Browse the repository at this point in the history
  • Loading branch information
nasbench authored Aug 23, 2023
1 parent 0cb3dff commit a8c80a3
Showing 1 changed file with 14 additions and 27 deletions.
41 changes: 14 additions & 27 deletions sigmahq/sigmahq_title_rule.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,48 +2,39 @@

This document provides general guidelines and tips on how to write titles for sigma rules.


Note that this is by no means an exhaustive list. It is meant to be a general guide for inspiration and to have an easily sharable resource for new contributors (e.g. a resource to link at in PR discussions).



## Summary

- [Summary](#summary)
- [Generality](#generality)
- [Structure](#structure)
- [Prefix](#prefix)
- [Suffix](#suffix)
- [Description](#description)

- [Prefix (Optional)](#prefix-optional)
- [Suffix (Optional)](#suffix-optional)
- [Main Title](#main-title)

## Generality

Bearing in mind that the title is one of the first things that an analyst will see. It should therefore be used as a clue and be as clear as possible to guide the assessment of the alert.


The title and level of the rule must be consistent



## Structure

Titles can be split with "-" : `Prefix - Main Title - Sufix`


### Prefix (Optional)

It is used to give a category, type of malware or name a threat actor. The choice depends highly on the type of rule.


Examples:

- HackTool
- PUA
- Remote Access Tool


Specific wording example:

- "ATP27 - "
- "ATP29 - "
- "UNC2452 - "
Expand All @@ -53,11 +44,8 @@ Specific wording example:

Sometimes the detections are duplicated across different `logsource`s with little changes to their logic. This is common in the case of Process Creation rules targeting the PowerShell process. Those rules are typically duplicated for the different PowerShell `logsource`s using ScriptBlockText to check for the same characteristics. A suffix in this case will be used to differentiate between the rules of the different `logsource`s.



Example:


```yaml
title: Invoke-Obfuscation Obfuscated IEX Invocation
title: Invoke-Obfuscation Obfuscated IEX Invocation - PowerShell
Expand All @@ -68,44 +56,43 @@ title: Invoke-Obfuscation Obfuscated IEX Invocation - System
### Main Title
The point of a description is to explain the alert in a meaningful way.
The title does not need to use the terms "Detect" or "Detection". It doesn't have to be a sentence. A keyword style increases the information density.
We use a simple formula to describe the alert.
Example:
- "7Zip Compressing ..."
- "Add User to ..."
- "Bypass UAC Using ..."
- "Renamed xxx Execution"
- "UAC Bypass Using ..."
Rules of level `informational` or `low` are not intended to be used to create alerts on their own. Their purpose is to conserve events or criteria of relevance, to be used in correlations or for ideas for threat hunting. A rule of those levels will by definition not create false positives as they should not be used for alerting.

The title should therefore be general and should not indicate that the rule describes suspicious or malicious behaviour.
The title should therefore be general and should not indicate that the rule describes suspicious or malicious behavior.


Example : `Net.exe Execution`
Example : `Net.exe Execution`

`medium` rules can have environment dependent false positives and require a tuning/evaluation phase before deploying to production environments.

Keywords used to indicate this:

- "Potential "



`high` rules requires a prompt review.

Keywords used to indicate this:

- "Suspicious "

`critical` rules should be reviewed immediately
The title must therefore be precise and indicate the specific threat.

Keywords used to indicate this:

`critical` rules should be reviewed with the highest priority.

The title must therefore be precise.
- "Malware"
- "Exploit"
- "... Attempt"
- "<Threat Actor> Activity"

0 comments on commit a8c80a3

Please sign in to comment.