f15hb0wn commited on
Commit
0a899ae
·
verified ·
1 Parent(s): 13b4652

Remove README for reparse

Browse files
Files changed (1) hide show
  1. README.md +0 -208
README.md DELETED
@@ -1,208 +0,0 @@
1
- ---
2
- license: apache-2.0
3
- task_categories:
4
- - text-classification
5
- - graph-ml
6
- language:
7
- - en
8
- tags:
9
- - cybersecurity
10
- - intrusion-detection
11
- - provenance-graphs
12
- - MITRE-ATT&CK
13
- - SOAR
14
- - security-operations
15
- - IDS
16
- - network-security
17
- - threat-detection
18
- - labeled-dataset
19
- - lead-rules
20
- size_categories:
21
- - 100M<n<1B
22
- dataset_info:
23
- - config_name: signals
24
- splits:
25
- - name: train
26
- num_examples: 114074530
27
- configs:
28
- - config_name: signals
29
- data_files:
30
- - split: train
31
- path: signals/*.parquet
32
- - config_name: graph_nodes
33
- data_files:
34
- - split: train
35
- path: graph/nodes.jsonl
36
- - config_name: graph_edges
37
- data_files:
38
- - split: train
39
- path: graph/edges.jsonl
40
- - config_name: incidents
41
- data_files:
42
- - split: train
43
- path: graph/incidents.jsonl
44
- ---
45
-
46
- # WitFoo Precinct6 Cybersecurity Dataset (114M)
47
-
48
- ## Overview
49
-
50
- 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. This dataset contains **114 million sanitized security events** (signal logs) and **provenance graphs** (10,442 incident graphs with 23,362 nodes and 32,732,650 edges) from real enterprise network monitoring across 5 organizations.
51
-
52
- **Available in two sizes:**
53
- - [`witfoo/precinct6-cybersecurity`](https://huggingface.co/datasets/witfoo/precinct6-cybersecurity) — 2M signals (smaller, faster to load)
54
- - [`witfoo/precinct6-cybersecurity-100m`](https://huggingface.co/datasets/witfoo/precinct6-cybersecurity-100m) — **114M signals (this dataset)**
55
-
56
- **Generate your own:** WitFoo Precinct 6.x customers can create datasets from their own data using the open-source pipeline: [`witfoo/dataset-from-precinct6`](https://github.com/witfoo/dataset-from-precinct6)
57
-
58
- This dataset is designed to support research in:
59
- - **Provenance graph-based intrusion detection** (KnowHow, NodLink, and similar systems)
60
- - **AI-driven cyber defense simulation** (CybORG and MARL-based defense policy training)
61
- - **Security alert classification** (malicious vs. suspicious vs. benign event labeling)
62
- - **Attack lifecycle analysis** using MITRE ATT&CK framework mappings
63
- - **Detection rule evaluation** using WitFoo's 261 lead detection rules
64
-
65
- ## Quick Start
66
-
67
- ```python
68
- from datasets import load_dataset
69
-
70
- # Load flat signal logs (114M rows across 58 Parquet shards)
71
- signals = load_dataset("witfoo/precinct6-cybersecurity-100m", "signals", split="train")
72
-
73
- # Find malicious events (from confirmed incidents)
74
- malicious = signals.filter(lambda x: x["label_binary"] == "malicious")
75
-
76
- # Find suspicious events (matched detection rules)
77
- suspicious = signals.filter(lambda x: x["label_binary"] == "suspicious")
78
-
79
- # Query by product/vendor
80
- cisco_events = signals.filter(lambda x: x["vendor_name"] == "Cisco")
81
-
82
- # Load provenance graph
83
- nodes = load_dataset("witfoo/precinct6-cybersecurity-100m", "graph_nodes", split="train")
84
- edges = load_dataset("witfoo/precinct6-cybersecurity-100m", "graph_edges", split="train")
85
-
86
- # Load full incident graphs
87
- incidents = load_dataset("witfoo/precinct6-cybersecurity-100m", "incidents", split="train")
88
- ```
89
-
90
- ## Label Distribution
91
-
92
- | Label | Count | Percentage |
93
- |-------|-------|------------|
94
- | `benign` | 113,326,050 | 99.34% |
95
- | `malicious` | 125,780 | 0.11% |
96
- | `suspicious` | 622,700 | 0.55% |
97
-
98
- ## Signal Columns
99
-
100
- | Column | Type | Description |
101
- |--------|------|-------------|
102
- | `timestamp` | float | Unix epoch timestamp |
103
- | `message_type` | string | Event classification (e.g., `firewall_action`, `account_logon`, `AssumeRole`) |
104
- | `stream_name` | string | Source product/data stream (see Source Products below) |
105
- | `pipeline` | string | Ingestion pipeline |
106
- | `src_ip` | string | Source IP (sanitized) |
107
- | `dst_ip` | string | Destination IP (sanitized) |
108
- | `src_port` | string | Source port |
109
- | `dst_port` | string | Destination port |
110
- | `protocol` | string | Network protocol (6=TCP, 17=UDP, 1=ICMP) |
111
- | `src_host` | string | Source hostname (sanitized) |
112
- | `dst_host` | string | Destination hostname (sanitized) |
113
- | `username` | string | Associated username (sanitized) |
114
- | `action` | string | Event action (block, permit, logon, logoff) |
115
- | `severity` | string | Severity level |
116
- | `vendor_code` | string | Vendor-specific event code |
117
- | `message_sanitized` | string | Full sanitized raw log message |
118
- | `label_binary` | string | `malicious`, `suspicious`, or `benign` |
119
- | `label_confidence` | float | Confidence score (0.0–1.0) |
120
- | `suspicion_score` | float | WitFoo suspicion score (0.0–1.0) |
121
- | `mo_name` | string | Modus operandi (e.g., `Data Theft`) |
122
- | `lifecycle_stage` | string | Kill chain stage (e.g., `initial-compromise`, `complete-mission`) |
123
- | `matched_rules` | string | JSON array of matched WitFoo lead rule descriptions |
124
- | `set_roles` | string | JSON array of classification roles (e.g., `Exploiting Host`, `C2 Server`) |
125
- | `product_name` | string | Security product name (e.g., `ASA Firewall`, `Falcon`) |
126
- | `vendor_name` | string | Product vendor (e.g., `Cisco`, `Crowdstrike`) |
127
-
128
- ## Source Products
129
-
130
- The dataset contains events from **158 security products** across **70+ vendors**. Complete catalog in `reference/lead_rules_catalog.json`.
131
-
132
- | Category | Products |
133
- |----------|----------|
134
- | **Firewalls** | Cisco ASA, Palo Alto PAN NGFW, Fortinet FortiGate, Checkpoint, Meraki, SonicWall, pfSense, Barracuda, Juniper SRX |
135
- | **Endpoint Protection** | CrowdStrike Falcon, Symantec SEP, Carbon Black, Cylance, SentinelOne, Deep Instinct, Sophos, McAfee, ESET |
136
- | **Network Detection** | Cisco Stealthwatch, Cisco Firepower, Suricata IDS, TippingPoint IPS, Vectra Cognito |
137
- | **Identity & Access** | Microsoft Windows AD, Cisco ISE, Centrify, CyberArk, Duo, Okta, Beyond Trust |
138
- | **Cloud Security** | AWS CloudTrail, AWS VPC Flow Logs, AWS GuardDuty, Azure Security, Zscaler, Netskope, Cisco Umbrella |
139
- | **Email Security** | ProofPoint, Mimecast, FireEye EX, Barracuda ESS, Cisco IronPort, Checkpoint Harmony |
140
- | **Threat Intelligence** | FireEye NX/HX/AX/CMS, Trend Micro, QRadar, Microsoft ATA, Cortex XDR |
141
- | **Infrastructure** | VMware vCenter/NSX, Elastic Filebeat, Linux (sshd, PAM, systemd, auditd), Apache, HAProxy |
142
-
143
- ## Labeling Methodology
144
-
145
- **Three-tier labels** derived from two sources:
146
-
147
- - **`malicious`** (125,780): Events embedded as leads inside confirmed incidents. Extracted directly from incident lead objects with suspicion scores, modus operandi, and MITRE mappings.
148
- - **`suspicious`** (622,700): Events matching WitFoo's 261 lead detection rules (e.g., "ASA Deny", "Windows Failed Login", "CrowdStrike Detection") but not in confirmed incidents.
149
- - **`benign`** (113,326,050): Events not matching any detection rules and not in any incident.
150
-
151
- The `matched_rules` column shows which detection rules matched. The `set_roles` column shows WitFoo classification roles (Exploiting Host, C2 Server, Staging Target, etc.).
152
-
153
- ## Lead Detection Rules
154
-
155
- 261 rules included in `reference/lead_rules_catalog.json`. Examples:
156
-
157
- | Rule | Criteria | Roles |
158
- |------|----------|-------|
159
- | Blocked Action | Any firewall block | Exploiting Host → Exploiting Target |
160
- | ASA Deny | cisco_asa + deny | Exploiting Host → Exploiting Target |
161
- | Windows Failed Login | Event ID 4625 | Exploiting Target → Exploiting Host |
162
- | CrowdStrike Detection | CrowdStrike stream | Exploiting Target → Exploiting Host |
163
- | AWS VPC Reject | VPC flow + REJECT | Exploiting Host → Exploiting Target |
164
- | Authentication Failure | auth_failure type | Exploiting Host → Exploiting Target |
165
- | Audit log cleared | Event ID 1102 | Exploiting Target → Exploiting Host |
166
-
167
- ## Sanitization
168
-
169
- All customer-identifying information removed through a 4-layer iterative pipeline:
170
-
171
- 1. **Structured field sanitization + Aho-Corasick sweep** (~166,000 patterns) with product identifier protection
172
- 2. **Format-specific message parsing** (8 parsers: Cisco ASA, Windows XML, WinLogBeat, CloudTrail, PAN, VMware, DNS, generic)
173
- 3. **ML/NER residual detection** (Presidio + BERT NER)
174
- 4. **Claude AI contextual review**
175
-
176
- Final PII registry: **~302,000 unique mappings** (IPs, hostnames, usernames, orgs, credentials, SIDs, emails, ARNs, etc.)
177
-
178
- ## Graph Data
179
-
180
- | Component | Count |
181
- |-----------|-------|
182
- | Nodes | 23,362 |
183
- | Edges | 32,732,650 |
184
- | Incidents | 10,442 (Data Theft: 10,441, Phishing: 1) |
185
-
186
- ## Limitations
187
-
188
- - **Label imbalance**: 99.77% benign reflects production SOC reality. Sampling strategies needed for balanced training.
189
- - **Temporal scope**: July–August 2024
190
- - **Sanitization**: ~302,000 PII registry entries used for consistent replacement across all records
191
- - **Shared incidents**: Same 10,442 incidents appear in both 2M and 114M datasets
192
- - **Sanitization trade-offs**: Some log message detail reduced by PII replacement
193
-
194
- ## Citation
195
-
196
- ```bibtex
197
- @dataset{witfoo_precinct6_100m_2025,
198
- title={WitFoo Precinct6 Cybersecurity Dataset (114M)},
199
- author={WitFoo, Inc.},
200
- year={2025},
201
- url={https://huggingface.co/datasets/witfoo/precinct6-cybersecurity-100m},
202
- license={Apache-2.0}
203
- }
204
- ```
205
-
206
- ## License
207
-
208
- [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0)