Skip to content

Commit 68ec021

Browse files
committed
Polish README and final repo cleanup
1 parent 61ad177 commit 68ec021

1 file changed

Lines changed: 30 additions & 0 deletions

File tree

README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,19 @@ The validation workflow is driven by `/tests/validation_cases.json` and executed
2121
- Positive fixtures ensure each rule fires on the intended attack sample.
2222
- Negative fixtures ensure the same rule does not fire on curated benign activity.
2323
- The dataset folder includes Mordor-style logs and lightweight lab fixtures formatted as Sysmon-like JSON/JSONL for deterministic CI validation.
24+
- Enriched fixtures such as `mordor_lsass_dump.json` and `schtasks_create.json` contain small event sequences instead of a single alerting row, so rules are tested with realistic context.
25+
26+
## Repository Layout
27+
28+
```text
29+
rules/sigma/ Sigma detection rules
30+
tests/dataset/ Positive and negative datasets
31+
tests/validation_cases.json
32+
tools/validate_datasets.py
33+
tools/run_sigma_cli.py Offline-safe sigma wrapper
34+
tools/build_sigma.py Build helper for SIEM outputs
35+
build/ Generated artifacts
36+
```
2437

2538
## MITRE ATT&CK Coverage Matrix
2639

@@ -46,6 +59,8 @@ python tools/run_sigma_cli.py plugin install elasticsearch
4659
python tools/run_sigma_cli.py plugin install sysmon
4760
```
4861

62+
`tools/run_sigma_cli.py` is used instead of calling `sigma` directly so the project can run in restricted environments without depending on user-profile cache paths or live MITRE metadata downloads.
63+
4964
### 3. Run Sigma syntax checks
5065
```bash
5166
python tools/run_sigma_cli.py check rules/sigma/
@@ -94,6 +109,19 @@ Doğrulama akışı `/tests/validation_cases.json` ile tanımlanır ve `python t
94109
- Pozitif fixture’lar her kuralın hedeflenen saldırı örneğinde tetiklendiğini doğrular.
95110
- Negatif fixture’lar aynı kuralın benign aktivitede tetiklenmediğini doğrular.
96111
- Dataset klasörü, deterministik CI doğrulaması için Mordor tarzı loglar ve Sysmon benzeri JSON/JSONL formatında hafif lab fixture’ları içerir.
112+
- `mordor_lsass_dump.json` ve `schtasks_create.json` gibi zenginleştirilmiş fixture’lar tek event yerine küçük bir event akışı içerir; böylece kurallar daha gerçekçi bağlamda test edilir.
113+
114+
## Repo Yapısı
115+
116+
```text
117+
rules/sigma/ Sigma kuralları
118+
tests/dataset/ Pozitif ve negatif datasetler
119+
tests/validation_cases.json
120+
tools/validate_datasets.py
121+
tools/run_sigma_cli.py Offline uyumlu sigma wrapper'ı
122+
tools/build_sigma.py SIEM build helper'ı
123+
build/ Üretilen artifact'ler
124+
```
97125

98126
## MITRE ATT&CK Kapsam Matrisi
99127

@@ -119,6 +147,8 @@ python tools/run_sigma_cli.py plugin install elasticsearch
119147
python tools/run_sigma_cli.py plugin install sysmon
120148
```
121149

150+
`sigma` komutunu doğrudan çağırmak yerine `tools/run_sigma_cli.py` kullanılıyor; bunun nedeni kısıtlı ortamlarda kullanıcı profilindeki cache dizinlerine veya canlı MITRE metadata indirmelerine bağımlı kalmamak.
151+
122152
### 3. Sigma syntax kontrolü çalıştır
123153
```bash
124154
python tools/run_sigma_cli.py check rules/sigma/

0 commit comments

Comments
 (0)