f15hb0wn commited on
Commit
9e0504b
·
verified ·
1 Parent(s): 4dc4bad

UC feedback: add MITRE TA-codes, disposition, attack reports, per-incident GraphML

Browse files
Files changed (1) hide show
  1. README.md +94 -10
README.md CHANGED
@@ -42,7 +42,7 @@ configs:
42
 
43
  ## Overview
44
 
45
- A large-scale, labeled cybersecurity dataset derived from production Security Operations Center (SOC) data processed by [WitFoo Precinct](https://www.witfoo.com/) version 6.x. The dataset contains **2.07 million sanitized security events** (signal logs) and **provenance graphs** (10,442 incident graphs with 30,092 nodes and 595,618 edges) from real enterprise network monitoring across multiple organizations.
46
 
47
  **Available in two sizes:**
48
  - [`witfoo/precinct6-cybersecurity`](https://huggingface.co/datasets/witfoo/precinct6-cybersecurity) — 2M signals (this dataset)
@@ -124,12 +124,18 @@ Tabular format ideal for ML classification, anomaly detection, and feature engin
124
  | `vendor_code` | string | Vendor-specific event code (e.g., `ASA-4-106023` for Cisco) |
125
  | `message_sanitized` | string | Full sanitized raw log message (syslog, XML, JSON, CSV depending on source) |
126
  | `label_binary` | string | `malicious`, `suspicious`, or `benign` (see [Labeling](#labeling-methodology)) |
127
- | `label_confidence` | float | Confidence score for the label (0.0–1.0) |
128
- | `attack_techniques` | string | JSON array of MITRE ATT&CK technique IDs |
129
- | `attack_tactics` | string | JSON array of MITRE ATT&CK tactic names |
 
130
  | `mo_name` | string | Modus operandi / attack campaign type (e.g., `Data Theft`, `Phishing`) |
131
- | `suspicion_score` | float | WitFoo-computed suspicion score (0.0–1.0) |
132
  | `lifecycle_stage` | string | Kill chain stage (e.g., `initial-compromise`, `complete-mission`) |
 
 
 
 
 
133
  | `matched_rules` | string | JSON array of WitFoo lead rule descriptions that matched this event |
134
  | `set_roles` | string | JSON array of WitFoo classification set roles (e.g., `Exploiting Host`, `C2 Server`) |
135
  | `product_name` | string | Security product that generated this event (e.g., `ASA Firewall`, `Falcon`) |
@@ -201,8 +207,10 @@ Complete incident records as produced by WitFoo Precinct's threat detection engi
201
 
202
  ### Additional Files
203
 
204
- - **`graph/graph.graphml`** — Full provenance graph in GraphML format for NetworkX, Gephi, or graph databases
205
  - **`graph/graph.json`** — NetworkX node-link JSON format
 
 
206
  - **`reference/lead_rules_catalog.json`** — Complete catalog of 261 WitFoo lead detection rules, 158 security products, 106 classification sets, and 216 stream-to-product mappings
207
 
208
  ## Data Provenance
@@ -323,9 +331,17 @@ Labels are derived from two sources: WitFoo Precinct's incident analysis and lea
323
 
324
  | Label | Count | Percentage |
325
  |-------|-------|------------|
326
- | `benign` | 1,899,723 | 91.7% |
327
- | `malicious` | 125,780 | 6.1% |
328
- | `suspicious` | 45,420 | 2.2% |
 
 
 
 
 
 
 
 
329
 
330
  **114M Dataset (`witfoo/precinct6-cybersecurity-100m`):**
331
 
@@ -354,9 +370,77 @@ The `matched_rules` column contains JSON arrays of rule descriptions matched for
354
  | User Account Created | Windows Event ID 4720 | Exploiting Target | Exploiting Host |
355
  | Special privileges assigned | Windows Event ID 4672 | Exploiting Target | Exploiting Host |
356
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
357
  ### MITRE ATT&CK Mappings
358
 
359
- Attack technique and tactic labels are derived from WitFoo's framework mapping of incident patterns. The `lifecycle_stage` field maps events to the APT kill chain:
 
 
 
 
 
 
 
 
 
 
 
 
360
 
361
  1. `initial-compromise` — Initial access to the network
362
  2. `establish-foothold` — Execution and establishing persistence
 
42
 
43
  ## Overview
44
 
45
+ A large-scale, labeled cybersecurity dataset derived from production Security Operations Center (SOC) data processed by [WitFoo Precinct](https://www.witfoo.com/) version 6.x. The dataset contains **2.1 million sanitized security events** (signal logs) and **provenance graphs** (13,119 incident graphs with 35,133 nodes and 634,190 edges) from real enterprise network monitoring across multiple organizations. Each incident has a natural-language threat-hunting report describing the attack chain, and per-incident GraphML files for direct loading in graph analysis tools.
46
 
47
  **Available in two sizes:**
48
  - [`witfoo/precinct6-cybersecurity`](https://huggingface.co/datasets/witfoo/precinct6-cybersecurity) — 2M signals (this dataset)
 
124
  | `vendor_code` | string | Vendor-specific event code (e.g., `ASA-4-106023` for Cisco) |
125
  | `message_sanitized` | string | Full sanitized raw log message (syslog, XML, JSON, CSV depending on source) |
126
  | `label_binary` | string | `malicious`, `suspicious`, or `benign` (see [Labeling](#labeling-methodology)) |
127
+ | `label_confidence` | float | Confidence score for the label (0.0–1.0). See [Scoring](#scoring). |
128
+ | `attack_techniques` | string | JSON array of MITRE ATT&CK technique IDs (e.g., `["T1041", "T1567"]`) |
129
+ | `attack_tactics` | string | JSON array of MITRE ATT&CK tactic IDs in `TA0001`-style (e.g., `["TA0009", "TA0010"]`) |
130
+ | `defense_techniques` | string | JSON array of MITRE D3FEND defense technique IDs |
131
  | `mo_name` | string | Modus operandi / attack campaign type (e.g., `Data Theft`, `Phishing`) |
132
+ | `suspicion_score` | float | WitFoo-computed suspicion score (0.0–1.0). See [Scoring](#scoring). |
133
  | `lifecycle_stage` | string | Kill chain stage (e.g., `initial-compromise`, `complete-mission`) |
134
+ | `disposition` | string | Raw Precinct status (`Disrupted`, `Investigating`, `Resolved`, `Dismissed`, `False Positive`, `Unprocessed`). See [Ground Truth](#ground-truth-and-disposition). |
135
+ | `disposition_category` | string | Bucketed disposition (`confirmed-malicious`, `false-positive`, `dismissed`, `automated`) |
136
+ | `is_false_positive` | bool | True if SOC analyst marked this incident as a false positive |
137
+ | `status_name` | string | Same as `disposition` (raw Precinct status); kept for clarity |
138
+ | `incident_ids` | string | JSON array of incident UUIDs referencing this artifact (empty for benign/suspicious) |
139
  | `matched_rules` | string | JSON array of WitFoo lead rule descriptions that matched this event |
140
  | `set_roles` | string | JSON array of WitFoo classification set roles (e.g., `Exploiting Host`, `C2 Server`) |
141
  | `product_name` | string | Security product that generated this event (e.g., `ASA Firewall`, `Falcon`) |
 
207
 
208
  ### Additional Files
209
 
210
+ - **`graph/graph.graphml`** — Full provenance graph in GraphML format (streaming write; ~477 MB)
211
  - **`graph/graph.json`** — NetworkX node-link JSON format
212
+ - **`graph/incidents_graphml/{incident_id}.graphml`** — 13,119 per-incident GraphML files (~1 MB total). Each is small and loadable in Gephi, NetworkX, igraph, or DGL. Useful for graph-based research where loading the entire dataset is impractical.
213
+ - **`graph/attack_reports.jsonl`** — Natural-language threat-hunting reports, one per incident. See [Attack Reports](#attack-reports).
214
  - **`reference/lead_rules_catalog.json`** — Complete catalog of 261 WitFoo lead detection rules, 158 security products, 106 classification sets, and 216 stream-to-product mappings
215
 
216
  ## Data Provenance
 
331
 
332
  | Label | Count | Percentage |
333
  |-------|-------|------------|
334
+ | `benign` | 1,899,587 | 90.4% |
335
+ | `malicious` | 155,520 | 7.4% |
336
+ | `suspicious` | 45,256 | 2.2% |
337
+
338
+ Disposition breakdown for malicious records (raw `status_name`):
339
+
340
+ | Disposition | Count | Meaning |
341
+ |-------------|-------|---------|
342
+ | `Disrupted` | 86,760 | Analyst confirmed and intervened |
343
+ | `Unprocessed` | 68,740 | Automated detection, not yet reviewed |
344
+ | `Dismissed` | 20 | Analyst dismissed (low confidence) |
345
 
346
  **114M Dataset (`witfoo/precinct6-cybersecurity-100m`):**
347
 
 
370
  | User Account Created | Windows Event ID 4720 | Exploiting Target | Exploiting Host |
371
  | Special privileges assigned | Windows Event ID 4672 | Exploiting Target | Exploiting Host |
372
 
373
+ ### Ground Truth and Disposition
374
+
375
+ **All labels in this dataset are derived from WitFoo Precinct's automated incident correlation engine — there is no independent, analyst-verified ground truth.** Researchers should treat Precinct's analysis as a strong but imperfect oracle. The `disposition` column lets you assess label quality on a per-record basis:
376
+
377
+ | `disposition` | Meaning | Confidence in label |
378
+ |---------------|---------|---------------------|
379
+ | `Disrupted` | SOC analyst confirmed the incident and intervened | High — human-confirmed malicious |
380
+ | `Investigating` | SOC analyst is actively investigating | Medium — analyst engaged |
381
+ | `Resolved` | SOC analyst confirmed and resolved | High — human-confirmed malicious |
382
+ | `Dismissed` | SOC analyst dismissed the incident | Negative — analyst rejected |
383
+ | `False Positive` | SOC analyst confirmed false positive | Negative — analyst rejected |
384
+ | `Unprocessed` | Automated detection, no human review | Lower — Precinct-confidence only |
385
+
386
+ The `disposition_category` column buckets these into four values for easier filtering: `confirmed-malicious`, `false-positive`, `dismissed`, `automated`. For experiments where ground-truth quality matters, restrict to records where `disposition` ∈ {`Disrupted`, `Resolved`} to compare against analyst-confirmed labels.
387
+
388
+ For benign and suspicious records, `disposition` is `Unprocessed` (no incident association). For malicious records, `disposition` reflects the parent incident's status at extraction time.
389
+
390
+ ### Scoring
391
+
392
+ The dataset exposes two related score fields:
393
+
394
+ - **`suspicion_score`** (float, 0.0–1.0) — Precinct's proprietary suspicion score. Populated for malicious records from the parent incident; zero for benign and suspicious records. Range observed in this dataset: 0.25 to 0.98, mean 0.55.
395
+
396
+ - **`label_confidence`** (float, 0.0–1.0) — Confidence in the assigned `label_binary` tier. Computed deterministically from corroborating signal:
397
+
398
+ | Label | Formula |
399
+ |-------|---------|
400
+ | `malicious` | `max(0.6, suspicion_score)` clamped to 0.95; lowered to 0.3 if `is_false_positive` |
401
+ | `suspicious` | `0.4 + 0.1 × n_matched_rules + 0.05 × n_set_roles`, clamped to [0.5, 0.85] |
402
+ | `benign` | `0.5` (no positive evidence either way) |
403
+
404
+ Note: `label_confidence` is **not** the probability the activity is malicious — it indicates how much corroborating evidence supports the assigned tier. See `compute_label_confidence` in [`src/precinct6_dataset/label.py`](https://github.com/witfoo/dataset-from-precinct6/blob/main/src/precinct6_dataset/label.py).
405
+
406
+ ### Attack Reports
407
+
408
+ The `graph/attack_reports.jsonl` file contains one natural-language threat-hunting report per incident (13,119 reports). Each report is deterministically composed from structured incident metadata (modus operandi, set roles, lead descriptions, MITRE mappings, timestamps) and explicitly documents that it **reflects Precinct's automated correlation engine output, not an independent threat-hunting investigation**.
409
+
410
+ Each record contains:
411
+
412
+ | Field | Description |
413
+ |-------|-------------|
414
+ | `incident_id` | Unique incident identifier (matches `incidents.jsonl`) |
415
+ | `report_text` | Multi-sentence narrative paragraph |
416
+ | `report_source` | Always `"template"` — sentences produced from a deterministic template |
417
+ | `mo_name` | Modus operandi |
418
+ | `suspicion_score`, `disposition`, `disposition_category` | Same as signal columns |
419
+ | `attack_techniques`, `attack_tactics` | MITRE ATT&CK mappings |
420
+ | `lead_count`, `node_count`, `edge_count` | Graph structure |
421
+ | `first_observed_at`, `last_observed_at` | Attack chain time bounds |
422
+ | `set_role_names` | WitFoo classification roles assigned |
423
+ | `matched_rules` | Detection rule descriptions that triggered |
424
+ | `products_observed` | Security products that detected activity |
425
+ | `lifecycle_stage` | Kill-chain stage |
426
+
427
+ Researchers can audit exactly how each sentence is derived by reading [`src/precinct6_dataset/attack_reports.py`](https://github.com/witfoo/dataset-from-precinct6/blob/main/src/precinct6_dataset/attack_reports.py).
428
+
429
  ### MITRE ATT&CK Mappings
430
 
431
+ Attack technique and tactic labels are derived from three sources, with deduplication:
432
+
433
+ 1. **WitFoo set role names** attached to the incident (e.g., `C2 Server` → `TA0011` Command and Control, `T1071` Application Layer Protocol)
434
+ 2. **Modus operandi** name on the incident (e.g., `Ransomware` → `TA0001`, `TA0002`, `TA0040`; `T1486` Data Encrypted for Impact)
435
+ 3. **Per-product framework data** embedded in `incident.nodes.products.frameworks` (when present)
436
+
437
+ Tactic IDs use the standard MITRE ATT&CK Enterprise format (`TA0001` through `TA0043`). Technique IDs are top-level techniques (no sub-techniques) representing the most likely category for a given role. Researchers wanting precise per-event technique attribution should treat these as priors.
438
+
439
+ **Per-edge/per-node attribution in graph output:** `attack_tactics`, `attack_techniques`, `set_roles`, `lifecycle_stage`, `label_binary`, `label_confidence`, `suspicion_score`, `disposition` are attached at the **edge** level in both NDJSON and GraphML output. Nodes in `incidents.jsonl` carry their own `sets` and `products` dicts with per-entity information.
440
+
441
+ The full mapping tables are in [`src/precinct6_dataset/mitre_mapping.py`](https://github.com/witfoo/dataset-from-precinct6/blob/main/src/precinct6_dataset/mitre_mapping.py).
442
+
443
+ The `lifecycle_stage` field maps events to WitFoo's internal kill-chain model:
444
 
445
  1. `initial-compromise` — Initial access to the network
446
  2. `establish-foothold` — Execution and establishing persistence