Upload 7 files

Add OpenSetDGA-Detection dataset v1.0

.gitattributes

@@ -58,3 +58,6 @@ saved_model/**/* filter=lfs diff=lfs merge=lfs -text
 # Video files - compressed
 *.mp4 filter=lfs diff=lfs merge=lfs -text
 *.webm filter=lfs diff=lfs merge=lfs -text
+known/train.csv filter=lfs diff=lfs merge=lfs -text
+unknown_ood/test_ood.csv filter=lfs diff=lfs merge=lfs -text
+unknown_ood/test_unknown_ood.csv filter=lfs diff=lfs merge=lfs -text

CODEBOOK.md

@@ -0,0 +1,233 @@
+# CODEBOOK — OpenSetDGA-Detection Dataset 
+**Bài toán:** Phát hiện và phân loại Domain Generation Algorithm (DGA) trong bối cảnh Open-set Recognition
+
+---
+
+## 1. Tổng quan Dataset
+
+Dataset được xây dựng để phục vụ bài toán **Open-set DGA Detection**: không chỉ phân loại domain đã biết (closed-set), mà còn phát hiện các họ DGA chưa từng thấy trong huấn luyện (unknown family) và domain hoàn toàn ngoài phân phối (Out-of-Distribution / OOD).
+
+### 1.1 Nguồn dữ liệu gốc
+
+| Nguồn | Loại | Mô tả |
+|---|---|---|
+| `chrmor/DGA_domains_dataset` (GitHub) | DGA | Tập mẫu DGA từ 25 họ phổ biến, do cộng đồng đóng góp |
+| `360netlab` | DGA | Mẫu DGA bổ sung từ nhóm nghiên cứu 360 Netlab |
+| Tranco Top-1M | Benign / OOD | Danh sách 1 triệu tên miền phổ biến nhất, cập nhật theo tuần. Phần đầu dùng làm benign (train/val/test), phần đuôi (`tranco_tail`) nạp vào unknown_ood làm nền OOD hợp lệ nhưng ít phổ biến |
+| crt.sh (Certificate Transparency) | OOD | Domain thu thập từ CT logs qua API crt.sh — domain hợp lệ nhưng ít phổ biến, dùng làm nền OOD |
+| URLhaus (`urlhaus.abuse.ch`) | OOD | Domain độc hại/phishing thực tế từ feed công khai |
+| OpenPhish (`openphish.com`) | OOD | Domain phishing thực tế từ feed OpenPhish |
+| Hagezi DNS Blocklist (`hagezi/dns-blocklists`) | OOD | Danh sách chặn DNS tổng hợp từ nhiều nguồn |
+| Phishing Army (`phishing_army_blocklist`) | OOD | Blocklist phishing cập nhật liên tục |
+| Stamparm Blackbook (`stamparm/blackbook`) | OOD | Danh sách IP/domain độc hại từ cộng đồng bảo mật |
+
+### 1.2 Cấu trúc Split
+
+Dataset được chia thành **5 split** theo thiết kế Open-set Recognition:
+
+| File | Số dòng | Mô tả |
+|---|---|---|
+| `known/train.csv` | 320,000 | Huấn luyện: benign + 18 họ DGA đã biết (known families) |
+| `known/val.csv` | 40,000 | Validation: cùng phân phối với train |
+| `known/test_known.csv` | 40,000 | Test in-distribution: đánh giá phân loại trên known families |
+| `unknown_family/test_unknown_family.csv` | 50,000 | Test open-set: 5 họ DGA hoàn toàn mới, không xuất hiện trong train |
+| `unknown_ood/test_unknown_ood.csv` | 100,000 | Test OOD: domain thực từ blocklist/phishing, ngoài phân phối hoàn toàn |
+
+**Tổng cộng: 550,000 dòng**
+
+### 1.3 Phân phối nhãn trong train (320,000 dòng)
+
+| Nhãn | Số dòng | Tỉ lệ |
+|---|---|---|
+| `dga` | 160,083 | 50.03% |
+| `benign` | 159,917 | 49.97% |
+
+Dataset được thiết kế **cân bằng nhị phân** (benign vs DGA) trong tập train để tránh bias khi học classifier nhị phân.
+
+---
+
+## 2. Data Dictionary — Mô tả 7 cột
+
+Mỗi file CSV trong `data/processed/` đều có cấu trúc **7 cột** như sau:
+
+### Cột 1: `domain`
+
+| Thuộc tính | Giá trị |
+|---|---|
+| **Kiểu dữ liệu** | `string` |
+| **Mô tả** | Tên miền đã được chuẩn hóa về dạng eTLD+1 (second-level domain + top-level domain). Subdomain và trailing dot đã được loại bỏ. |
+| **Miền giá trị** | Chuỗi ký tự [a-z0-9\-\.], không có khoảng trắng, không có `http://` hay `https://` |
+| **Ví dụ** | `google.com`, `xjk38dh2kq.ru`, `mortiscontrastatim.com` |
+| **Ghi chú** | Domain không hợp lệ (không parse được eTLD+1) đã bị loại bỏ trong bước làm sạch |
+
+---
+
+### Cột 2: `family`
+
+| Thuộc tính | Giá trị |
+|---|---|
+| **Kiểu dữ liệu** | `string` (categorical) |
+| **Mô tả** | Họ (family) của domain. Với domain benign, giá trị là `benign`. Với domain DGA, là tên họ DGA tương ứng. Với domain OOD, là `ood`. |
+| **Miền giá trị** | Xem bảng họ DGA bên dưới (Mục 3) |
+| **Ví dụ** | `benign`, `nymaim`, `emotet`, `ood` |
+
+---
+
+### Cột 3: `source`
+
+| Thuộc tính | Giá trị |
+|---|---|
+| **Kiểu dữ liệu** | `string` |
+| **Mô tả** | Nguồn gốc thu thập của domain, dùng để truy vết dữ liệu thô (data provenance). |
+| **Miền giá trị** | Tên nguồn theo định dạng `host:path` hoặc tên viết tắt |
+| **Ví dụ** | `tranco`, `chrmor_github`, `urlhaus.abuse.ch:text_online`, `openphish.com:feed.txt`, `crtsh`, `360netlab`, `raw.githubusercontent.com:hagezi/dns-blocklists`, `phishing.army:phishing_army_blocklist.txt`, `raw.githubusercontent.com:stamparm/blackbook`, `tranco_tail` |
+
+---
+
+### Cột 4: `label`
+
+| Thuộc tính | Giá trị |
+|---|---|
+| **Kiểu dữ liệu** | `string` (categorical, 3 giá trị) |
+| **Mô tả** | Nhãn cấp cao (coarse-grained label) dùng cho bài toán **phát hiện nhị phân** (DGA detection) và bài toán OOD detection. |
+| **Miền giá trị** | `benign` / `dga` / `ood` |
+| **Ý nghĩa** | `benign` = domain hợp lệ, phổ biến; `dga` = domain sinh bởi thuật toán DGA; `ood` = domain ngoài phân phối (phishing, blocklist, CT logs) |
+| **Ghi chú** | Trong `test_unknown_family.csv`, domain DGA từ họ hold-out vẫn mang nhãn `dga` — mô hình không được biết family cụ thể nhưng biết đây là DGA |
+
+---
+
+### Cột 5: `split`
+
+| Thuộc tính | Giá trị |
+|---|---|
+| **Kiểu dữ liệu** | `string` (categorical, 5 giá trị) |
+| **Mô tả** | Tên split mà dòng dữ liệu thuộc về. |
+| **Miền giá trị** | `train` / `val` / `test_known` / `unknown_family` / `unknown_ood` |
+| **Ý nghĩa** | Xác định vai trò của dòng dữ liệu trong pipeline huấn luyện và đánh giá |
+
+---
+
+### Cột 6: `class_label`
+
+| Thuộc tính | Giá trị |
+|---|---|
+| **Kiểu dữ liệu** | `string` (categorical) |
+| **Mô tả** | Nhãn chi tiết (fine-grained label) dùng cho bài toán **phân loại đa lớp** (multiclass classification). Đây là nhãn mà mô hình multiclass cần dự đoán. |
+| **Miền giá trị** | `benign` hoặc tên họ DGA cụ thể (18 họ trong train). Với OOD: `ood` |
+| **Quan hệ với `label`** | Nếu `label = benign` thì `class_label = benign`. Nếu `label = dga` thì `class_label = tên_family`. Nếu `label = ood` thì `class_label = ood` |
+| **Ví dụ** | `benign`, `nymaim`, `emotet`, `conficker`, `ood` |
+| **Số lớp trong train** | 19 lớp: 1 (`benign`) + 18 họ DGA |
+
+---
+
+### Cột 7: `split_hint`
+
+| Thuộc tính | Giá trị |
+|---|---|
+| **Kiểu dữ liệu** | `string` (categorical) |
+| **Mô tả** | Gợi ý về nhóm split ở cấp cao hơn, dùng để phân biệt dữ liệu in-distribution (đã biết) với dữ liệu dùng cho open-set evaluation. |
+| **Miền giá trị** | `known` / `unknown_family` / `unknown_ood` |
+| **Ý nghĩa** | `known` = thuộc tập train/val/test_known (in-distribution); `unknown_family` = họ DGA hold-out; `unknown_ood` = domain ngoài phân phối hoàn toàn |
+| **Ghi chú** | Cột này giúp script đánh giá lọc nhanh các nhóm mà không cần đọc tên file |
+
+---
+
+## 3. Hệ thống nhãn — Label System
+
+### 3.1 Known DGA Families (18 họ — có trong train/val/test_known)
+
+Đây là các họ DGA mà mô hình **được học** trong quá trình huấn luyện:
+
+| STT | Family | Số mẫu trong train | Đặc điểm nổi bật |
+|---|---|---|---|
+| 1 | `nymaim` | 9,225 | DGA dạng dictionary-based, ghép từ có nghĩa |
+| 2 | `simda` | 9,211 | DGA arithmetic, domain ngắn |
+| 3 | `ramdo` | 9,194 | DGA entropy cao, toàn ký tự ngẫu nhiên |
+| 4 | `pykspa` | 9,191 | DGA dựa trên Markov chain |
+| 5 | `rovnix` | 9,190 | DGA dùng seed theo ngày |
+| 6 | `suppobox` | 9,181 | DGA dictionary-based |
+| 7 | `dircrypt` | 9,173 | DGA mã hóa, entropy rất cao |
+| 8 | `matsnu` | 9,171 | DGA ghép từ ngẫu nhiên |
+| 9 | `padcrypt` | 9,169 | DGA ransomware |
+| 10 | `emotet` | 9,167 | DGA banking trojan nổi tiếng |
+| 11 | `ramnit` | 9,160 | DGA worm, domain dài |
+| 12 | `cryptolocker` | 9,154 | DGA ransomware, từng gây thiệt hại lớn |
+| 13 | `murofet` | 9,138 | DGA dùng Bitcoin blockchain làm seed |
+| 14 | `gozi` | 9,119 | DGA banking trojan |
+| 15 | `conficker` | 9,110 | DGA botnet lớn nhất lịch sử |
+| 16 | `tinba` | 9,073 | DGA banking trojan nhỏ nhất |
+| 17 | `necurs` | 8,869 | DGA spam botnet |
+| 18 | `kraken` | 4,587 | DGA botnet, ít mẫu hơn |
+| — | `corebot` | 1 | Chỉ có 1 mẫu — thực tế không được học |
+
+> **Lưu ý `corebot`:** Chỉ có 1 mẫu trong dataset — quá ít để mô hình học được đặc trưng. Trong thực nghiệm multiclass, `corebot` được xem là degenerate class. Báo cáo cần đề cập điều này khi phân tích per-class F1.
+
+### 3.2 Unknown DGA Families (5 họ — chỉ có trong test_unknown_family)
+
+Đây là các họ DGA bị **hold-out hoàn toàn** khỏi train — dùng để đánh giá khả năng phát hiện unknown family:
+
+| STT | Family | Mô tả |
+|---|---|---|
+| 1 | `vawtrak` | DGA banking trojan, dùng seed theo tuần |
+| 2 | `pushdo` | DGA spam botnet |
+| 3 | `fobber` | DGA sử dụng RC4 để sinh domain |
+| 4 | `ranbyus` | DGA banking trojan |
+| 5 | `qadars` | DGA banking trojan, hoạt động ở châu Âu |
+
+### 3.3 OOD Sources (trong test_unknown_ood — 100,000 dòng)
+
+| Nguồn | Số dòng | Tỉ lệ | Loại |
+|---|---|---|---|
+| `phishing.army` | 40,000 | 40.0% | Phishing domain thực tế |
+| `hagezi/dns-blocklists` | 36,382 | 36.4% | DNS blocklist tổng hợp |
+| `tranco_tail` | 18,891 | 18.9% | Domain hợp lệ nhưng ít phổ biến (hard negatives) |
+| `stamparm/blackbook` | 3,618 | 3.6% | Domain/IP độc hại |
+| `crtsh` | 412 | 0.4% | Certificate Transparency logs |
+| `360netlab` | 324 | 0.3% | Threat intelligence feed |
+| `urlhaus` | 322 | 0.3% | Malware URL feed |
+| `openphish` | 51 | 0.1% | Phishing feed |
+
+> **Lưu ý thiết kế:** OOD không phải chỉ gồm domain "rõ ràng xấu" — `tranco_tail` (18.9%) là domain hợp lệ nhưng ít phổ biến, đây là **hard negative** thực sự thách thức OOD detector. Điều này phản ánh thực tế: hệ thống phải phân biệt DGA với cả domain lạ nhưng hợp lệ.
+
+---
+
+## 4. Quy trình Tiền xử lý
+
+### 4.1 Chuẩn hóa domain
+
+Mọi domain đều được chuẩn hóa về dạng **eTLD+1** (effective TLD + 1 label) trước khi lưu vào dataset:
+
+- `www.google.com` → `google.com`
+- `mail.evil-bot.co.uk` → `evil-bot.co.uk`
+- Domain không parse được eTLD+1 → loại bỏ
+
+**Lý do:** Mô hình học đặc trưng từ SLD (second-level domain), không phải subdomain. Chuẩn hóa đảm bảo tính nhất quán giữa các nguồn.
+
+### 4.2 Nguyên tắc Zero Data Leakage
+
+- Tất cả tham số (nếu có scaling) chỉ được tính trên `train.csv`, không dùng val/test
+- Domain trong `test_unknown_family` và `test_unknown_ood` **không xuất hiện** trong `train.csv` hay `val.csv`
+- Các họ DGA trong `unknown_family` **không xuất hiện** trong train dưới bất kỳ nhãn nào
+
+### 4.3 Thiết kế Split
+
+| Split | Tỉ lệ (known) | Nguyên tắc |
+|---|---|---|
+| train | 80% | Cân bằng benign/DGA (50/50), phân bố đều 18 họ |
+| val | 10% | Cùng phân phối với train |
+| test_known | 10% | Cùng phân phối, dùng đánh giá closed-set |
+| unknown_family | Riêng biệt | 5 họ hold-out, ~10k mẫu/họ |
+| unknown_ood | Riêng biệt | 100k mẫu từ 8 nguồn OOD thực tế |
+
+---
+
+## 5. Hạn chế đã biết (Known Limitations)
+
+- **`corebot` chỉ có 1 mẫu** trong train — không đủ để học, per-class F1 của họ này không có ý nghĩa thống kê.
+- **OOD mất cân bằng nguồn:** `phishing.army` chiếm 40% OOD — kết quả OOD detection có thể bị ảnh hưởng bởi đặc trưng riêng của nguồn này.
+- **Domain tĩnh (static snapshot):** Dataset không phản ánh sự thay đổi theo thời gian của DGA (temporal drift). Mô hình huấn luyện trên dataset này có thể kém hiệu quả với DGA mới xuất hiện sau thời điểm thu thập.
+- **Chỉ dùng lexical features:** Dataset được thiết kế cho phân tích dựa trên chuỗi ký tự, không bao gồm thông tin DNS (TTL, IP, ASN) hay ngữ cảnh mạng.
+
+---
+
+*File này là tài liệu kèm theo dataset `OpenSetDGA-Detection v1.0`. Mọi thay đổi về cấu trúc dataset cần được cập nhật đồng bộ vào file này.*

known/train.csv

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:b001a5959709b48535fc18eeb934f0a3c10339a79d254f0b52955940634c1573
+size 19329940

unknown_ood/test_ood.csv

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:f3e93d85bc7f36f45367311f19402a2b07da49d3b2111e64d5bd8170ba922bef
+size 10922266

unknown_ood/test_unknown_ood.csv

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:f3e93d85bc7f36f45367311f19402a2b07da49d3b2111e64d5bd8170ba922bef
+size 10922266