first commit

2026-03-06 22:19:58 +07:00
commit 9771033418
13 changed files with 2141 additions and 0 deletions
--- a/doc/FLASH_DOC.md
+++ b/doc/FLASH_DOC.md
@@ -0,0 +1,155 @@
+# Tài liệu Flash Firmware — IoT Firmware Loader
+
+## Tổng quan
+
+Ứng dụng tự động hóa quá trình nạp firmware cho thiết bị **OpenWrt Barrier Breaker 14.07** thông qua giao diện web **LuCI**. Thay vì thao tác thủ công trên trình duyệt, ứng dụng thực hiện 3 bước HTTP tự động cho mỗi thiết bị.
+
+---
+
+## Luồng hoạt động
+
+```mermaid
+flowchart TD
+    A[Chọn Firmware .bin] --> B[Scan LAN]
+    B --> C[Hiển thị danh sách thiết bị]
+    C --> D{Chọn thiết bị ☑}
+    D --> E[Nhấn Flash Selected Devices]
+    E --> F[FlashThread chạy background]
+    F --> G["ThreadPoolExecutor\n(max_workers = N)"]
+    G --> H1[Device 1 → flash_device]
+    G --> H2[Device 2 → flash_device]
+    G --> H3[Device N → flash_device]
+    H1 & H2 & H3 --> I[All Done → Thông báo]
+```
+
+### Chi tiết `flash_device()` cho mỗi thiết bị
+
+```mermaid
+flowchart TD
+    S1["STEP 1: Login\nGET /cgi-bin/luci\nPOST username=root, password=empty"] --> C1{Thành công?}
+    C1 -->|Có cookie sysauth + stok| S2
+    C1 -->|403 Denied| F1["FAIL: Login denied (403)"]
+    C1 -->|Không có session| F2["FAIL: Login failed — no session"]
+
+    S2["STEP 2: Upload Firmware\nPOST /flashops\nField: image=firmware.bin\nkeep=KHÔNG gửi (bỏ tích)"] --> C2{Response?}
+    C2 -->|Trang Verify + Proceed| S3
+    C2 -->|HTTP ≠ 200| F3["FAIL: Upload HTTP xxx"]
+    C2 -->|invalid image| F4["FAIL: Invalid firmware image"]
+    C2 -->|unsupported| F5["FAIL: Firmware not compatible"]
+    C2 -->|Vẫn hiện form upload| F6["FAIL: Upload ignored by server"]
+
+    S3["STEP 3: Proceed\nPOST step=2, keep=empty\nXác nhận flash"] --> C3{Response?}
+    C3 -->|200 Flashing...| R["DONE ✅\nThiết bị đang reboot"]
+    C3 -->|Connection dropped| R
+    C3 -->|Read timeout| R
+```
+
+---
+
+## Bảng Status
+
+### Status trên cột "Status" trong bảng thiết bị
+
+| Icon | Status                                   | Điều kiện hiển thị                                            |
+| ---- | ---------------------------------------- | ------------------------------------------------------------- |
+| —    | `READY`                                  | Sau khi scan, thiết bị chưa được flash                        |
+| ⏳   | `Logging in...`                          | Đang POST login vào LuCI                                      |
+| ⏳   | `Uploading firmware...`                  | Đang upload file .bin (~30MB) lên thiết bị                    |
+| ⏳   | `Confirming (Proceed)...`                | Đã upload xong, đang gửi lệnh xác nhận flash                  |
+| ⏳   | `Rebooting...`                           | Thiết bị đang reboot sau khi flash                            |
+| ✅   | `DONE`                                   | Flash thành công, thiết bị đang khởi động lại                 |
+| ✅   | `DONE (rebooting)`                       | Flash thành công nhưng timeout khi chờ response (bình thường) |
+| ❌   | `FAIL: Cannot connect`                   | Không kết nối được tới thiết bị (sai IP, khác mạng)           |
+| ❌   | `FAIL: Login denied (403)`               | Thiết bị từ chối đăng nhập (sai mật khẩu)                     |
+| ❌   | `FAIL: Login failed — no session`        | Login không trả về cookie hoặc token                          |
+| ❌   | `FAIL: Upload HTTP xxx`                  | Server trả mã lỗi HTTP khi upload                             |
+| ❌   | `FAIL: Invalid firmware image`           | File firmware không hợp lệ                                    |
+| ❌   | `FAIL: Firmware not compatible`          | Firmware không tương thích với thiết bị                       |
+| ❌   | `FAIL: Upload ignored by server`         | Server nhận file nhưng không xử lý (sai form field)           |
+| ❌   | `FAIL: Unexpected response after upload` | Không nhận được trang xác nhận Verify                         |
+
+---
+
+## Chi tiết kỹ thuật HTTP
+
+### Step 1: Login
+
+```
+GET  http://{IP}/cgi-bin/luci                → Lấy trang login, phát hiện field name
+POST http://{IP}/cgi-bin/luci                → Gửi username=root&password=
+```
+
+| Kết quả        | Điều kiện                                                          |
+| -------------- | ------------------------------------------------------------------ |
+| **Thành công** | Response chứa `sysauth` cookie VÀ/HOẶC `stok` token trong URL/body |
+| **Thất bại**   | HTTP 403, hoặc không có cookie/token                               |
+
+**Field names tự động phát hiện:**
+
+- OpenWrt Barrier Breaker 14.07: `username` / `password`
+- OpenWrt mới hơn: `luci_username` / `luci_password`
+
+### Step 2: Upload Firmware
+
+```
+POST http://{IP}/cgi-bin/luci/;stok={TOKEN}/admin/system/flashops
+Content-Type: multipart/form-data
+
+Fields:
+  image = [firmware.bin]     (file upload)
+  keep  = (KHÔNG gửi)       (bỏ tích Keep Settings)
+```
+
+| Kết quả        | Điều kiện                                                               |
+| -------------- | ----------------------------------------------------------------------- |
+| **Thành công** | Response chứa "Flash Firmware - Verify" + "Proceed" + checksum          |
+| **Thất bại**   | Response chứa "invalid image", "unsupported", hoặc vẫn hiện form upload |
+
+### Step 3: Proceed (Xác nhận)
+
+```
+POST http://{IP}/cgi-bin/luci/;stok={TOKEN}/admin/system/flashops
+
+Fields:
+  step = 2
+  keep = (empty string)
+```
+
+| Kết quả        | Điều kiện                                                                       |
+| -------------- | ------------------------------------------------------------------------------- |
+| **Thành công** | Response "The system is flashing now" HOẶC connection bị ngắt (thiết bị reboot) |
+| **Thất bại**   | Hiếm khi xảy ra — nếu đã qua Step 2 thì Step 3 gần như luôn thành công          |
+
+---
+
+## Xử lý song song
+
+```
+FlashThread (QThread - background)
+  └── ThreadPoolExecutor (max_workers = N)
+        ├── Thread 1 → flash_device(IP_1)
+        ├── Thread 2 → flash_device(IP_2)
+        ├── ...
+        └── Thread N → flash_device(IP_N)
+```
+
+| Config                    | Giá trị   | Ý nghĩa                        |
+| ------------------------- | --------- | ------------------------------ |
+| Concurrent devices = `10` | Mặc định  | Flash 10 thiết bị song song    |
+| Concurrent devices = `0`  | Unlimited | Flash tất cả thiết bị cùng lúc |
+| Concurrent devices = `1`  | Tuần tự   | Flash từng thiết bị một        |
+
+**Mỗi thiết bị có session HTTP riêng** → không bị lẫn cookie/token giữa các thiết bị.
+
+---
+
+## Files liên quan
+
+| File            | Chức năng                                     |
+| --------------- | --------------------------------------------- |
+| `flasher.py`    | Logic flash 3 bước (login → upload → proceed) |
+| `main.py`       | UI PyQt6, FlashThread, quản lý song song      |
+| `debug_full.py` | Script debug — chạy 3 bước với log chi tiết   |
+| `scanner.py`    | Scan mạng LAN tìm thiết bị                    |
+
+""", "Complexity": 3, "Description": "Created flash documentation file with workflow diagrams, status conditions, HTTP details, and parallel processing explanation.", "EmptyFile": false, "IsArtifact": false, "Overwrite": false, "TargetFile": "/Users/nguyennhatminh/Documents/file code/Smatec/iot_fw_loader/FLASH_DOC.md
--- a/doc/scanner_docs.md
+++ b/doc/scanner_docs.md
@@ -0,0 +1,59 @@
+# Tài liệu Kỹ thuật: Cơ chế Quét IP trên Mạng (Network Scanner)
+
+## 1. Tổng quan
+Thành phần quét IP (IP Scanner) trong file `scanner.py` được thiết kế để dò tìm và liệt kê tất cả các thiết bị đang hoạt động trên một dải mạng (ví dụ: `192.168.1.0/24`). Nó theo dõi và trả về danh sách các đối tượng chứa địa chỉ **IP** và **MAC Address** của từng thiết bị.
+
+Để đảm bảo tỷ lệ phát hiện cao nhất trên các hệ điều hành khác nhau (Windows, macOS, Linux), script sử dụng kết hợp hai phương pháp dò tìm:
+1. **Quét mồi bằng Ping (Ping Sweep) kết hợp đọc bảng ARP tĩnh của hệ điều hành.**
+2. **Quét ARP trực tiếp ở Tầng 2 (Layer 2) bằng thư viện `scapy`.**
+
+---
+
+## 2. Luồng hoạt động chính (Hàm `scan_network`)
+
+Đây là hàm được gọi trực tiếp khi muốn quét một mạng. Trình tự rà quét diễn ra qua các bước sau:
+
+**Bước 1: "Đánh thức" các thiết bị (Ping Sweep)**
+- Hệ thống gọi hàm `_ping_sweep(network)` để gửi gói Ping (ICMP Echo Request) đồng loạt tới tất cả các IP có thể có trong mạng.
+- Mục đích của bước này là buộc các thiết bị phản hồi, từ đó hệ điều hành của máy đang chạy lệnh sẽ **tự động ghi nhận địa chỉ MAC** của các thiết bị đó vào bộ nhớ đệm ARP (ARP Cache).
+- Hệ thống tạm dừng 1 giây để đảm bảo hệ điều hành kịp lưu thông tin vào ARP Cache.
+
+**Bước 2: Lấy dữ liệu từ bảng ARP của Hệ điều hành (Method 1)**
+- Thực thi lệnh hệ thống `arp -a` để đọc ARP Cache.
+- Kết quả được phân tích cú pháp (Regex) để trích xuất IP và MAC tương ứng, tương thích linh hoạt với cả đầu ra của Windows lẫn macOS/Linux.
+- Các thiết bị đọc được lưu vào danh sách nháp (biến `seen`).
+
+**Bước 3: Quét sâu với Scapy (Method 2 - Dự phòng/Bổ sung)**
+- Script gọi thêm thư viện `scapy` để phát một thông điệp "ARP Who-has" tới địa chỉ MAC Broadcast (`ff:ff:ff:ff:ff:ff`).
+- Phương pháp này giúp phát hiện ra các thiết bị chặn Ping (chặn ICMP) ở Bước 1 nhưng buộc phải phản hồi gói ARP ở tầng Data Link.
+- Những thiết bị mới tìm thấy (nếu chưa có trong danh sách `seen` ở Bước 2) sẽ được bổ sung vào danh sách.
+
+**Bước 4: Trả về kết quả**
+- Danh sách các thiết bị cuối cùng được sắp xếp từ nhỏ đến lớn dựa trên địa chỉ IP và trả về dưới dạng: 
+  `[{"ip": "192.168.1.2", "mac": "aa:bb:cc:dd:ee:ff"}, ...]`
+
+---
+
+## 3. Phân tích chi tiết các hàm hỗ trợ
+
+### `_ping_sweep(network)` \& `_ping_one(ip, is_win)`
+- **Nhiệm vụ:** Quét Ping hàng loạt (Ping Sweep).
+- **Cách thức hoạt động:** Sử dụng `ThreadPoolExecutor` để chạy **tối đa 100 luồng (threads) song song**. Điều này giúp việc gửi Ping hàng loạt diễn ra cực kì nhanh chóng tính bằng giây thay vì phải đợi ping từng IP một.
+- **Biện pháp an toàn:** Script có cơ chế tự bảo vệ chặn flood mạng: nó sẽ **từ chối chạy Ping Sweep** nếu dải mạng (subnet) lớn hơn 256 địa chỉ IP (tức là chỉ chạy cho dải mạng từ `/24` trở xuống).
+
+### `_scan_with_arp_table(network)`
+- **Nhiệm vụ:** Hàm chạy độc lập để quét tìm thiết bị mà **không cần thông qua đặc quyền Root/Administrator** (fallback method).
+- **Hỗ trợ Đa nền tảng:**
+  - **Trên Windows (`win32`):** Chuẩn hóa định dạng chuẩn MAC từ gạch ngang sang dấu hai chấm (vd: từ `cc-2d-21...` sang `cc:2d:21...`). Nó dựa vào Regex nhận diện các dòng chuẩn xuất ra có chữ `dynamic` hoặc `static`.
+  - **Trên macOS / Linux:** Dùng Regex đọc định dạng chuẩn riêng biệt ví dụ: `? (192.168.1.1) at aa:bb:cc:dd:ee:ff on en0`. Loại bỏ những địa chỉ lỗi bị đánh dấu là `(incomplete)`.
+
+### `_scan_with_scapy(network)`
+- **Nhiệm vụ:** Công cụ quét cực mạnh ở Tầng 2 (Layer 2) của mô hình mạng OSI.
+- **Đặc thù:** Đòi hỏi người dùng phải cấp quyền Sudo/Root trên Linux/macOS hoặc phải cài đặt thư viện phần mềm **Npcap/WinPcap** trên Windows thì mới có thể sử dụng. Gửi gói `srp` bằng `scapy` với timeout là 3 giây để lấy về thông tin phần cứng đích thực.
+
+---
+
+## 4. Tóm tắt Ưu & Nhược điểm của thiết kế này
+
+- **Ưu điểm:** Khả năng dò tìm diện rộng rất cao vì sự kết hợp song song của hai phương pháp. Nếu thiết bị không có quyền Root/Sudo để chạy `scapy`, nó vẫn có thể tìm được ít nhất ~90% thiết bị trong mạng nhờ tính năng Ping Sweeping mạnh mẽ. Tính tương thích chéo OS (Windows/Mac/Linux) được xử lý rất tốt và gọn gàng qua Regex. 
+- **Nhược điểm:** Tốn thêm 1 giây (hàm `time.sleep(1)`) và thêm vài giây timeout tổng cộng, do cần chờ để làm đầy bộ nhớ đệm ARP trước khi quét sâu. Nếu thiết bị đích cố tình tắt phản hồi ARP, thì vẫn có khả năng bị lọt dán mạng.