dns-worker 1.0.2-3.3 → 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +158 -109
- package/dist/serverfull.mjs +5319 -911
- package/migrations/0052_add_e2ee_to_logs.sql +6 -0
- package/migrations/0053_add_e2ee_key_tables.sql +31 -0
- package/migrations/0054_drop_hourly_rollups.sql +12 -0
- package/migrations/0055_add_is_active_to_user_log_keys.sql +2 -0
- package/migrations/0056_add_kem_keys_and_encrypt_version.sql +21 -0
- package/migrations/0057_add_idx_logs_kem_key_id.sql +2 -0
- package/package.json +8 -5
- package/static/_headers +8 -0
- package/static/assets/AccountView-CdfTI-rw.js +4 -0
- package/static/assets/AnalyticsView-DE25Td6t.js +2 -0
- package/static/assets/AuthView-DeKX1gG-.js +2 -0
- package/static/assets/DestinationMap-CRCdjD4S.js +1 -0
- package/static/assets/FilteringView-9SF7vAn0.js +1 -0
- package/static/assets/LogsView-DGXuCkRb.js +5 -0
- package/static/assets/QRCodeCanvas-9YjBSnzo.js +2 -0
- package/static/assets/RulesView-C8mXn9m8.js +1 -0
- package/static/assets/SettingsView-yiZeyh7q.js +1 -0
- package/static/assets/SetupView-r5GQKPN4.js +1 -0
- package/static/assets/{SwipeableDrawer-B-MfxTWM.js → SwipeableDrawer-DuXKmSrw.js} +1 -1
- package/static/assets/{TrendChart-B20w7SzD.js → TrendChart-BbPOeC8w.js} +3 -3
- package/static/assets/browser-BqNNtPRD.js +1 -0
- package/static/assets/date-dnUzoLoj.js +1 -0
- package/static/assets/de-DE-Bvn6LW48.js +10 -0
- package/static/assets/es-ES-BHMlKDw4.js +10 -0
- package/static/assets/fr-FR-DEgfea4H.js +10 -0
- package/static/assets/index-Ct0QwtUk.js +14 -0
- package/static/assets/index-D53KGRYV.css +2 -0
- package/static/assets/ja-JP-C1UasoOt.js +10 -0
- package/static/assets/ko-KR-DRVmuXAK.js +10 -0
- package/static/assets/ru-RU-BrUQ8HMM.js +10 -0
- package/static/assets/services-unF2tLc7.js +1 -0
- package/static/assets/sqlite.worker-C50yoTbX.js +186 -0
- package/static/assets/sqlite3-Con_VOcu.wasm +0 -0
- package/static/assets/sqlite3-opfs-async-proxy-Ck-yCayi.js +881 -0
- package/static/assets/sqlite3-opfs-async-proxy.js +881 -0
- package/static/assets/sqlite3-worker1-DZ2OAEkd.js +44 -0
- package/static/assets/vendor-react-GZisTXSQ.js +11 -0
- package/static/assets/{vendor-ui-core-BpucEp_q.js → vendor-ui-core-BjAOArGo.js} +1 -1
- package/static/assets/vendor-utils-C-1rF3VB.js +9 -0
- package/static/assets/vi-VN-_fj_hwx9.js +10 -0
- package/static/assets/zh-CN-DRUEP9Sg.js +10 -0
- package/static/assets/zh-TW-v7FvDwjG.js +10 -0
- package/static/index.html +5 -5
- package/static/sqlite3-opfs-async-proxy.js +881 -0
- package/static/sw.js +1 -1
- package/static/assets/AccountView-BvRvODjN.js +0 -4
- package/static/assets/AnalyticsView-DQ7hDChh.js +0 -2
- package/static/assets/AuthView-Bwv6hbdi.js +0 -2
- package/static/assets/DestinationMap-BEQNbcb-.js +0 -1
- package/static/assets/FilteringView-BWD3e-DS.js +0 -1
- package/static/assets/LogsView-kQy7qTGd.js +0 -5
- package/static/assets/QRCodeCanvas-X07w5x_G.js +0 -2
- package/static/assets/RulesView-3d5hga0L.js +0 -1
- package/static/assets/SettingsView-B9D0kPUF.js +0 -1
- package/static/assets/SetupView-D7d-Gsdr.js +0 -1
- package/static/assets/browser-icErLjuM.js +0 -1
- package/static/assets/date-C4b8kvr-.js +0 -1
- package/static/assets/de-DE-CXKS_pep.js +0 -10
- package/static/assets/es-ES-B2e3ea35.js +0 -10
- package/static/assets/fr-FR-1qQHEpoW.js +0 -10
- package/static/assets/index-7FKlsF79.js +0 -16
- package/static/assets/index-DdQuGqR5.css +0 -2
- package/static/assets/ja-JP-CCVeJXwX.js +0 -10
- package/static/assets/ko-KR-bQ1okpC2.js +0 -10
- package/static/assets/ru-RU-DeRsms_o.js +0 -10
- package/static/assets/services-fIMx5oSx.js +0 -1
- package/static/assets/vendor-react-Kt98jRfM.js +0 -11
- package/static/assets/vendor-utils-CfYGGC23.js +0 -9
- package/static/assets/vi-VN-BcXfqmzH.js +0 -10
- package/static/assets/zh-CN-D8YK7j27.js +0 -12
- package/static/assets/zh-TW-C2_-uaZk.js +0 -12
package/README.md
CHANGED
|
@@ -1,57 +1,70 @@
|
|
|
1
1
|
<div align="center">
|
|
2
2
|
<img src="https://raw.githubusercontent.com/Obein/DNS-Worker/main/web/src/assets/obex_cat_eye_logo-256.webp" alt="DNS Worker Logo" width="128">
|
|
3
3
|
<h1>DNS Worker</h1>
|
|
4
|
-
<p>Protective DNS
|
|
5
|
-
<p>Protect your first hop on the internet</p>
|
|
4
|
+
<p>Privacy-First Protective DNS Resolver & DoH / DoT Server</p>
|
|
5
|
+
<p>Protect your first hop on the internet · Dual-Engine: Cloudflare Workers Edge or Standalone Server (VPS / Linux / macOS / Windows)</p>
|
|
6
6
|
<p align="center">
|
|
7
7
|
English | <a href="README_zh-CN.md">中文 (简体)</a> | <a href="README_zh-TW.md">中文 (正體)</a>
|
|
8
8
|
</p>
|
|
9
9
|
|
|
10
10
|
[](LICENSE)
|
|
11
11
|
[](https://workers.cloudflare.com/)
|
|
12
|
+
[](https://nodejs.org/)
|
|
13
|
+
[](https://csrc.nist.gov/pubs/fips/203/final)
|
|
14
|
+
[](#-dual-engine-architecture--deployment-matrix)
|
|
12
15
|
</div>
|
|
13
16
|
|
|
14
17
|
---
|
|
15
18
|
|
|
16
19
|
## 📖 Introduction
|
|
17
20
|
|
|
18
|
-
**DNS Worker
|
|
21
|
+
**DNS Worker**, a privacy-first protective DNS resolution system built with a **Dual-Engine Architecture**. It can be deployed either as a zero-maintenance serverless application on Cloudflare Workers edge network, or run completely independent of Cloudflare as a standalone server on your own VPS, home server, or bare-metal machine (Linux, macOS, Windows) with native SQLite storage.
|
|
19
22
|
|
|
20
23
|
[](https://deploy.workers.cloudflare.com/?url=https://github.com/Obein/DNS-Worker)
|
|
21
24
|
|
|
22
|
-
###
|
|
25
|
+
### What is DNS over HTTPS (DoH) & DNS over TLS (DoT)?
|
|
23
26
|
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
| **Hosting** | Requires a VPS or home server | Runs on Cloudflare's free tier — no server needed |
|
|
27
|
-
| **Latency** | Depends on server location | Edge-computed in 300+ cities worldwide |
|
|
28
|
-
| **Maintenance** | Manual updates, OS patches | Zero-maintenance serverless deployment |
|
|
29
|
-
| **Scaling** | Limited by hardware | Scales automatically with Cloudflare's network |
|
|
30
|
-
| **Cost** | Server fees + electricity | Free for most personal usage |
|
|
27
|
+
* **DNS over HTTPS (DoH / RFC 8484)**: Performs DNS queries over encrypted HTTPS connections. DNS Worker exposes DoH endpoints compatible with all modern browsers, operating systems, and stub resolvers.
|
|
28
|
+
* **DNS over TLS (DoT / RFC 7858)**: Encrypts DNS queries directly over TLS on dedicated port 853. DNS Worker Standalone mode natively routes incoming DoT requests to isolated user profiles using TLS Server Name Indication (SNI), making it ideal for Android 9+ native Private DNS.
|
|
31
29
|
|
|
32
|
-
|
|
30
|
+
---
|
|
33
31
|
|
|
34
|
-
|
|
32
|
+
## ✨ Core Features
|
|
35
33
|
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
34
|
+
- 🌐 **Dual-Engine Deployment**: Run serverless on Cloudflare Workers edge, or run standalone on any VPS / home server with zero Cloudflare dependency.
|
|
35
|
+
- ⚡ **Full-Stack Protocol Support**:
|
|
36
|
+
- **Classic UDP 53**: Standard RFC 1035 DNS for routers and LAN devices.
|
|
37
|
+
- **DoT 853 (DNS over TLS)**: RFC 7858 encrypted DNS with TLS SNI profile routing (`<profile_key>.dns.example.com`), natively compatible with Android Private DNS.
|
|
38
|
+
- **DoH (DNS over HTTPS)**: RFC 8484 encrypted DNS over HTTP/2 and HTTP/3.
|
|
39
|
+
- 🚀 **Ultra-fast Resolution**: Edge-accelerated caching and multi-tier memory pipelines for sub-millisecond query responses.
|
|
40
|
+
- 🗒️ **Multi-Profile Management**: Create independent configurations with isolated endpoints, rules, and upstream settings.
|
|
41
|
+
- 🛡️ **Granular Filtering**:
|
|
42
|
+
- **Allow/Block Lists**: Exact domain and wildcard subdomain matching.
|
|
43
|
+
- **Third-Party Rule Sets**: Subscribe to external blocklists (AdGuard, EasyList, hosts syntax) with fast Bloom filter matching.
|
|
44
|
+
- **Custom Redirections**: Override A, AAAA, TXT, and CNAME records with custom answers.
|
|
45
|
+
- 📊 **Real-time Stats & Logs**: Visual dashboard recording query type, hit reason, client geo-location, and upstream latency.
|
|
46
|
+
- 🔐 **Privacy Controls**: Flexible ECS (EDNS Client Subnet) management (Forward, Custom, or Hidden).
|
|
47
|
+
- 🔒 **Rewrite ECH & ECH Fronting**: Automatically injects/rewrites Encrypted Client Hello (ECH) parameters and outer SNI for HTTPS (Type 65) / SVCB (Type 64) queries to eliminate plaintext SNI leakage *(Note: ECH rewriting is supported for domains proxied by Cloudflare)*.
|
|
48
|
+
- ⚡ **Local-First Architecture**: Embedded in-browser SQLite (WASM + OPFS) and Web Workers deliver instant 0ms log filtering and aggregation without cloud queries. Background bidirectional sync keeps data aligned while saving database read quotas.
|
|
49
|
+
- 🛡️ **Post-Quantum Zero-Knowledge E2EE**: Hardware Passkey (WebAuthn) and Recovery Key protected End-to-End Encryption for query logs. Implements NIST FIPS 203 **P256-MLKEM768** hybrid lattice cryptography with hourly rotating KEM DEKs. Persistent storage holds only irreversible ciphertexts; decryption occurs strictly on your authorized client devices.
|
|
50
|
+
- 🌗 **Modern UI**: High-density management panel with dark mode, built with React + BlueprintJS.
|
|
40
51
|
|
|
41
52
|
---
|
|
42
53
|
|
|
43
|
-
##
|
|
54
|
+
## 🔐 Advanced Privacy: Local-First & Post-Quantum E2EE
|
|
44
55
|
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
56
|
+
DNS Worker redefines personal DNS observability by combining local-first browser computation with cutting-edge post-quantum cryptography:
|
|
57
|
+
|
|
58
|
+
### ⚡ Local-First Browser SQLite (OPFS + WASM)
|
|
59
|
+
* **Instantaneous 0ms Queries**: Resolution logs and analytical charts render immediately from an in-browser SQLite database powered by Origin Private File System (OPFS) and Dedicated Web Workers.
|
|
60
|
+
* **Quota Preservation & Offline Analytics**: High-frequency filtering, pagination, and multi-dimensional analytics run locally without issuing remote D1 read queries, drastically reducing Cloudflare D1 quota consumption and enabling full offline inspection.
|
|
61
|
+
* **Smart Bidirectional Sync**: Automatically reconciles local storage with remote D1 in the background with zero UI freeze.
|
|
62
|
+
|
|
63
|
+
### 🛡️ Post-Quantum End-to-End Encryption (P256-MLKEM768)
|
|
64
|
+
* **Zero-Knowledge Cloud Storage**: Sensitive log fields (domains, client IPs, answers, geo locations, and upstream servers) are encrypted before reaching persistent cloud storage. Cloudflare Workers and D1 database store only ciphertexts.
|
|
65
|
+
* **Quantum-Resistant Hybrid Lattice KEM**: Adopts the NIST FIPS 203 standardized **P256-MLKEM768** (ML-KEM-768 + ECDH P-256) hybrid algorithm, defending user query logs against future "Harvest Now, Decrypt Later" quantum attacks.
|
|
66
|
+
* **Decoupled Hourly Envelope Encryption**: Automatically encapsulates and provisions hourly Data Encryption Keys (DEK), compressing KEM database overhead by ~80% while sustaining hot-path pipeline encryption throughput of **20,000+ queries/second**.
|
|
67
|
+
* **Hardware Passkey Protection**: The private key seed is wrapped with hardware Passkeys (WebAuthn PRF) and single-use self-rotating Recovery Keys; no plaintext secret ever touches the server.
|
|
55
68
|
|
|
56
69
|
---
|
|
57
70
|
|
|
@@ -92,14 +105,20 @@ DoH (RFC 8484) is a protocol for performing DNS queries via encrypted HTTPS conn
|
|
|
92
105
|
### Code Structure
|
|
93
106
|
```text
|
|
94
107
|
├── src/
|
|
95
|
-
│ ├── index.ts #
|
|
108
|
+
│ ├── index.ts # Cloudflare Worker entry point, handles HTTP routing & DoH
|
|
109
|
+
│ ├── serverfull/ # Standalone Server entry point (UDP 53, DoT 853, HTTP 3000)
|
|
110
|
+
│ │ ├── index.ts # Serverfull CLI & Master bootstrap
|
|
111
|
+
│ │ ├── udp.ts # Classic RFC 1035 UDP 53 DNS Server
|
|
112
|
+
│ │ ├── dot.ts # RFC 7858 DoT 853 Server with SNI Profile routing
|
|
113
|
+
│ │ ├── http.ts # Web Dashboard & DoH HTTP server
|
|
114
|
+
│ │ └── db.ts # Native Node.js SQLite (node:sqlite) adapter & migrator
|
|
96
115
|
│ ├── types.ts # Type definitions
|
|
97
116
|
│ ├── api/ # API Controllers (Auth, Account, Profiles)
|
|
98
|
-
│ ├── lib/ # Core logic (RBAC, Rule filtering)
|
|
99
|
-
│ ├── models/ # D1
|
|
100
|
-
│ ├── pipeline/ # DNS Resolution Pipeline (
|
|
117
|
+
│ ├── lib/ # Core logic (RBAC, Rule filtering, PQC Crypto, DEK manager)
|
|
118
|
+
│ ├── models/ # Database models (Unified D1 & SQLite)
|
|
119
|
+
│ ├── pipeline/ # DNS Resolution Pipeline (Unified core business logic)
|
|
101
120
|
│ └── utils/ # Utilities (Cache, GeoIP, DNS Codec, Bloom Filter)
|
|
102
|
-
├── web/ # React/BlueprintJS UI frontend
|
|
121
|
+
├── web/ # React/BlueprintJS UI frontend (Local-First WASM + OPFS)
|
|
103
122
|
│ ├── public/ # Public static files
|
|
104
123
|
│ ├── src/ # Frontend source code
|
|
105
124
|
│ │ ├── assets/ # Static assets (images, icons, etc.)
|
|
@@ -112,14 +131,15 @@ DoH (RFC 8484) is a protocol for performing DNS queries via encrypted HTTPS conn
|
|
|
112
131
|
│ │ └── utils/ # Utility helpers and functions
|
|
113
132
|
│ └── package.json # Frontend dependencies configuration
|
|
114
133
|
├── static/ # Compiled static resources
|
|
115
|
-
├──
|
|
134
|
+
├── scripts/ # Automation scripts (e.g., Linux systemd service generator)
|
|
135
|
+
├── migrations/ # Unified SQL Database migration scripts
|
|
116
136
|
└── wrangler.toml # Cloudflare deployment configuration
|
|
117
137
|
```
|
|
118
138
|
|
|
119
139
|
### Resolution Pipeline
|
|
120
140
|
When a DNS request arrives, it goes through the following processing stages:
|
|
121
141
|
1. **Memory Cache Check**: Checks if a valid response for the query exists in the edge node's memory.
|
|
122
|
-
2. **Config Loading**: Layers profile settings loading from Memory -> Cache API -> D1
|
|
142
|
+
2. **Config Loading**: Layers profile settings loading from Memory -> Cache API -> Database (D1 or SQLite).
|
|
123
143
|
3. **Local Rule Matching**:
|
|
124
144
|
- **Whitelist**: If hit, forwards directly to upstream and returns.
|
|
125
145
|
- **Redirection**: If hit, returns custom records.
|
|
@@ -127,72 +147,23 @@ When a DNS request arrives, it goes through the following processing stages:
|
|
|
127
147
|
4. **External List Filtering**:
|
|
128
148
|
- Use a **Bloom filter** for fast filtering.
|
|
129
149
|
5. **Upstream Resolution**: If none of the above hit, requests the upstream DoH server based on configuration, with optional ECS support.
|
|
130
|
-
6. **Async Logging & Caching**: Asynchronously records resolution logs, fetches target GeoIP, and writes results to various cache levels.
|
|
150
|
+
6. **Async Logging & Caching**: Asynchronously records resolution logs (with optional PQC E2EE encryption), fetches target GeoIP, and writes results to various cache levels.
|
|
131
151
|
|
|
132
152
|
---
|
|
133
153
|
|
|
134
154
|
## 🚀 Deployment Guide
|
|
135
155
|
|
|
136
|
-
|
|
156
|
+
DNS Worker offers two deployment methods tailored to different operational needs:
|
|
157
|
+
* **Option A: 🖥️ Standalone Server / VPS (Cloudflare-Free, Full Sovereignty)** — Best if you want complete control, classic UDP 53 for routers, and native Android DoT 853 on your own machine.
|
|
158
|
+
* **Option B: ☁️ Cloudflare Workers Edge (Serverless, Zero Maintenance)** — Best if you want a globally distributed, zero-cost, zero-maintenance DoH resolver on 300+ edge PoPs.
|
|
137
159
|
|
|
138
|
-
|
|
139
|
-
2. **Create D1 Database**: Log in to the Cloudflare dashboard, go to `Workers & Pages` > `D1`, and create a new database (e.g., named `dns_worker_db`), and copy the created database ID.
|
|
140
|
-
3. **Configure Database ID**: In your forked repository, edit the `wrangler.toml` file and replace `database_id` with the ID of the database you just created.
|
|
141
|
-
4. **Create Worker**: Go to Cloudflare dashboard `Workers & Pages` > `Create application`.
|
|
142
|
-
5. **Import from GitHub & Complete Initial Deployment**: On the deployment page, select `Continue with GitHub`, connect your forked project, and complete the authorized deployment. Under the Build & Deploy settings, configure as follows:
|
|
143
|
-
* **Build command**: `npm run build`
|
|
144
|
-
* **Deploy command**: `npm run deploy`
|
|
145
|
-
* **Root directory (Path)**: `/`
|
|
146
|
-
> ⚠️ **Note**: Environment variables entered in the initial project setup wizard are only injected into the build container and will not take effect as runtime secrets. Proceed with the "Deploy" button directly, and configure runtime secrets in your Worker's settings after the initial deployment finishes.
|
|
147
|
-
6. **Configure JWT Secret**: After the initial deployment completes, go to Cloudflare Dashboard -> `Workers & Pages` -> click on your Worker -> `Settings` -> `Runtime variables and secrets` (or `Variables and secrets`) -> click `Add`. Set the Name to `JWT_SECRET`, choose type `Secret`, input a secure random string as Value, and click `Deploy` (or `Save and Deploy`).
|
|
148
|
-
7. **Configure KEK for Envelope Encryption (Optional)**: In the same `Settings` > `Runtime variables and secrets` section after deployment, to enable server-side envelope encryption for sensitive credentials (such as TOTP keys and recovery keys) in D1, add a variable named `KEK_v1`, type `Secret`, and input a secure key value. When you need to rotate the KEK key, add a new secret `KEK_v(N+1)` (e.g. `KEK_v2` -> `KEK_v3`, etc.) sequentially.
|
|
149
|
-
|
|
150
|
-
### Local Development & Manual Deployment
|
|
151
|
-
|
|
152
|
-
#### Development Environment
|
|
153
|
-
- **Node.js**: v18.x or later
|
|
154
|
-
- **Package Manager**: npm
|
|
155
|
-
- **Cloudflare Account**: Workers and D1 permissions required
|
|
156
|
-
|
|
157
|
-
#### Local Setup & Deployment Steps
|
|
158
|
-
1. Clone the repository and install dependencies:
|
|
159
|
-
|
|
160
|
-
```bash
|
|
161
|
-
npm install
|
|
162
|
-
```
|
|
163
|
-
|
|
164
|
-
2. Initialize D1 Database:
|
|
165
|
-
|
|
166
|
-
```bash
|
|
167
|
-
npm run db:setup
|
|
168
|
-
npm run db:migrate:dev
|
|
169
|
-
```
|
|
170
|
-
|
|
171
|
-
3. Configure environment variables:
|
|
172
|
-
* Create a `.dev.vars` file in the root directory and add a secure random JWT secret (required for session token signing):
|
|
173
|
-
```env
|
|
174
|
-
JWT_SECRET=your_secure_random_string_here
|
|
175
|
-
```
|
|
176
|
-
* (Optional) Enable Envelope Encryption for sensitive credentials (like TOTP secrets and recovery keys) by adding a Key Encryption Key (KEK):
|
|
177
|
-
```env
|
|
178
|
-
KEK_v1=your_secure_kek_v1_key_string
|
|
179
|
-
```
|
|
180
|
-
|
|
181
|
-
4. Start the development server:
|
|
182
|
-
|
|
183
|
-
```bash
|
|
184
|
-
npm run dev
|
|
185
|
-
```
|
|
186
|
-
|
|
187
|
-
5. Deploy manually:
|
|
160
|
+
---
|
|
188
161
|
|
|
189
|
-
|
|
190
|
-
npm run deploy
|
|
191
|
-
```
|
|
162
|
+
### Option A: 🖥️ Standalone Server / VPS (Cloudflare-Free, Full Sovereignty)
|
|
192
163
|
|
|
193
|
-
|
|
164
|
+
Run DNS Worker directly on any Linux, Windows, or macOS host with Node.js `>= 22.5.0` (using built-in `node:sqlite`). No Cloudflare account, tokens, or external databases required.
|
|
194
165
|
|
|
195
|
-
|
|
166
|
+
#### Features in Standalone Mode
|
|
196
167
|
* **Classic UDP DNS (Port 53)**: Standard RFC 1035 UDP DNS resolution service for routers or system DNS settings.
|
|
197
168
|
* **DNS over TLS / DoT (Port 853)**: RFC 7858 encrypted DNS, natively supported by Android 9+ "Private DNS", with SNI-based Profile routing (e.g. `<profile_key>.dns.example.com`).
|
|
198
169
|
* **Web Dashboard & DoH (Default Port 3000)**: Full-featured React management dashboard and REST API.
|
|
@@ -214,25 +185,83 @@ DNS Worker can run completely independent of Cloudflare Workers as a standalone
|
|
|
214
185
|
|
|
215
186
|
#### Quick Start
|
|
216
187
|
|
|
217
|
-
1.
|
|
218
|
-
The project provides an out-of-the-box configuration file `.env.serverfull` (the server automatically loads system environment variables, `.env`, or `.env.serverfull` by priority). You can directly modify `.env.serverfull`, or copy it to `.env` for customization:
|
|
188
|
+
1. Clone repository and install dependencies:
|
|
219
189
|
```bash
|
|
220
|
-
|
|
221
|
-
|
|
190
|
+
git clone https://github.com/Obein/DNS-Worker.git DNS-Worker
|
|
191
|
+
cd DNS-Worker
|
|
192
|
+
npm install
|
|
193
|
+
```
|
|
194
|
+
|
|
195
|
+
2. Configure environment variables:
|
|
196
|
+
The project provides an out-of-the-box configuration template `.env.serverfull`. You can modify it directly or copy it to `.env`:
|
|
197
|
+
```bash
|
|
198
|
+
cp .env.serverfull .env
|
|
199
|
+
nano .env
|
|
222
200
|
```
|
|
223
201
|
|
|
224
|
-
|
|
202
|
+
3. Build frontend and start Standalone Server:
|
|
225
203
|
```bash
|
|
226
204
|
npm run start:serverfull
|
|
227
205
|
```
|
|
228
206
|
|
|
229
|
-
|
|
207
|
+
4. Production deployment as a Linux systemd background service:
|
|
230
208
|
```bash
|
|
231
209
|
sudo npm run service-create:linux
|
|
232
210
|
sudo systemctl start dns-worker
|
|
233
211
|
sudo systemctl status dns-worker
|
|
234
212
|
```
|
|
235
|
-
This generates `/etc/systemd/system/dns-worker.service` configured with `CAP_NET_BIND_SERVICE` privileges to bind ports 53 and 853 with automatic restart on
|
|
213
|
+
This generates `/etc/systemd/system/dns-worker.service` configured with `CAP_NET_BIND_SERVICE` privileges to bind privileged ports 53 and 853 without running as root, with automatic restart on reboot.
|
|
214
|
+
|
|
215
|
+
---
|
|
216
|
+
|
|
217
|
+
### Option B: ☁️ Cloudflare Workers Edge (Serverless, Zero Maintenance)
|
|
218
|
+
|
|
219
|
+
Run DNS Worker across 300+ edge locations worldwide on Cloudflare Workers and D1 database.
|
|
220
|
+
|
|
221
|
+
[](https://deploy.workers.cloudflare.com/?url=https://github.com/Obein/DNS-Worker)
|
|
222
|
+
|
|
223
|
+
#### 1. Online Deployment (Cloudflare Dashboard)
|
|
224
|
+
|
|
225
|
+
1. **Fork this repo**: Click the `Fork` button at the top right to clone the repository to your own GitHub account.
|
|
226
|
+
2. **Create D1 Database**: Log in to the Cloudflare dashboard, go to `Workers & Pages` > `D1`, and create a new database (e.g., named `dns_worker_db`), and copy the created database ID.
|
|
227
|
+
3. **Configure Database ID**: In your forked repository, edit the `wrangler.toml` file and replace `database_id` with the ID of the database you just created.
|
|
228
|
+
4. **Create Worker**: Go to Cloudflare dashboard `Workers & Pages` > `Create application`.
|
|
229
|
+
5. **Import from GitHub & Complete Initial Deployment**: On the deployment page, select `Continue with GitHub`, connect your forked project, and complete the authorized deployment. Under the Build & Deploy settings, configure as follows:
|
|
230
|
+
* **Build command**: `npm run build`
|
|
231
|
+
* **Deploy command**: `npm run deploy`
|
|
232
|
+
* **Root directory (Path)**: `/`
|
|
233
|
+
> ⚠️ **Note**: Environment variables entered in the initial project setup wizard are only injected into the build container and will not take effect as runtime secrets. Proceed with the "Deploy" button directly, and configure runtime secrets in your Worker's settings after the initial deployment finishes.
|
|
234
|
+
6. **Configure JWT Secret**: After the initial deployment completes, go to Cloudflare Dashboard -> `Workers & Pages` -> click on your Worker -> `Settings` -> `Runtime variables and secrets` (or `Variables and secrets`) -> click `Add`. Set the Name to `JWT_SECRET`, choose type `Secret`, input a secure random string as Value, and click `Deploy` (or `Save and Deploy`).
|
|
235
|
+
7. **Configure KEK for Envelope Encryption (Optional)**: In the same `Settings` > `Runtime variables and secrets` section after deployment, to enable server-side envelope encryption for sensitive credentials (such as TOTP keys and recovery keys) in D1, add a variable named `KEK_v1`, type `Secret`, and input a secure key value. When you need to rotate the KEK key, add a new secret `KEK_v(N+1)` (e.g. `KEK_v2` -> `KEK_v3`, etc.) sequentially.
|
|
236
|
+
|
|
237
|
+
#### 2. Local Development & CLI Deployment
|
|
238
|
+
|
|
239
|
+
##### Prerequisites
|
|
240
|
+
- **Node.js**: v18.x or later (v22.5.0+ recommended)
|
|
241
|
+
- **Package Manager**: npm
|
|
242
|
+
- **Cloudflare Account**: Workers and D1 permissions required
|
|
243
|
+
|
|
244
|
+
##### Setup & Deployment Steps
|
|
245
|
+
```bash
|
|
246
|
+
# 1. Clone repository and install dependencies
|
|
247
|
+
npm install
|
|
248
|
+
|
|
249
|
+
# 2. Initialize and migrate local D1 database
|
|
250
|
+
npm run db:setup
|
|
251
|
+
npm run db:migrate:dev
|
|
252
|
+
|
|
253
|
+
# 3. Configure local environment variables (.dev.vars)
|
|
254
|
+
echo "JWT_SECRET=your_secure_random_string_here" > .dev.vars
|
|
255
|
+
echo "KEK_v1=your_secure_kek_v1_key_string" >> .dev.vars
|
|
256
|
+
|
|
257
|
+
# 4. Start local development server
|
|
258
|
+
npm run dev
|
|
259
|
+
|
|
260
|
+
# 5. Deploy to Cloudflare Workers
|
|
261
|
+
npm run deploy
|
|
262
|
+
```
|
|
263
|
+
|
|
264
|
+
---
|
|
236
265
|
|
|
237
266
|
### Online Deployment to Cloudflare Pages (⚠️ Not Recommended)
|
|
238
267
|
|
|
@@ -252,17 +281,37 @@ If you wish to deploy the project using Cloudflare Pages (Advanced Mode):
|
|
|
252
281
|
* **D1 database**: Select your `dns_worker_db` database.
|
|
253
282
|
5. Redeploy the Pages project for the bindings to take effect.
|
|
254
283
|
|
|
284
|
+
### ⚖️ Dual-Engine Architecture & Deployment Matrix
|
|
285
|
+
|
|
286
|
+
Whether you need global edge resolution across 300+ cities or 100% self-hosted data sovereignty with classic UDP 53 and native Android Private DNS (DoT 853), DNS Worker provides an enterprise-grade resolver with granular filtering, instant local-first analytics, and post-quantum end-to-end encrypted query logs.
|
|
287
|
+
|
|
288
|
+
| Feature / Capability | 🖥️ Standalone Server / VPS (Cloudflare-Free) | ☁️ Cloudflare Workers Edge |
|
|
289
|
+
|---|---|---|
|
|
290
|
+
| **Primary Use Case** | Complete data sovereignty, home lab, direct router DNS, Android DoT | Zero-maintenance, global low-latency edge resolution |
|
|
291
|
+
| **Hosting & Runtime** | Linux / VPS / macOS / Windows (`Node.js >= 22.5.0`) | Cloudflare Workers Edge Network (300+ PoPs worldwide) |
|
|
292
|
+
| **Storage Backend** | Native Node.js SQLite (`node:sqlite`) on local NVMe/SSD | Cloudflare D1 (Global distributed serverless database) |
|
|
293
|
+
| **Supported Protocols** | **UDP 53** (RFC 1035) + **DoT 853** (RFC 7858) + **DoH** (RFC 8484) | **DoH** (RFC 8484 over HTTPS) |
|
|
294
|
+
| **Data Sovereignty** | **100% Self-Sovereign** — zero cloud vendor lock-in | Edge-encrypted; hosted on Cloudflare infrastructure |
|
|
295
|
+
| **Router & LAN DNS** | **Direct UDP 53 listener** (point router/LAN DNS directly to server) | Requires a DoH client, proxy, or stub resolver upstream |
|
|
296
|
+
| **Android Private DNS** | **Native DoT 853** with SNI Profile routing (`<profile_key>.dns.example.com`) | Supported via DoH URL or third-party DNS app |
|
|
297
|
+
| **Zero-Knowledge PQC E2EE** | ✅ NIST FIPS 203 **P256-MLKEM768** + Passkey WebAuthn | ✅ NIST FIPS 203 **P256-MLKEM768** + Passkey WebAuthn |
|
|
298
|
+
| **Local-First Web UI** | ✅ In-browser SQLite WASM + OPFS 0ms instant analysis | ✅ In-browser SQLite WASM + OPFS 0ms instant analysis |
|
|
299
|
+
| **Maintenance & Scaling** | Simple systemd service (`npm run service-create:linux`) | Zero server maintenance; scales automatically |
|
|
300
|
+
| **Cost** | Runs on existing VPS or home server hardware | Free tier for personal usage |
|
|
301
|
+
|
|
255
302
|
---
|
|
256
303
|
|
|
257
304
|
## 💪 Powered by
|
|
258
305
|
|
|
259
|
-
* [Cloudflare Workers](https://workers.cloudflare.com/)
|
|
306
|
+
* [Cloudflare Workers](https://workers.cloudflare.com/) & [D1 Database](https://developers.cloudflare.com/d1/)
|
|
307
|
+
* [Node.js](https://nodejs.org/) (Native `node:sqlite` Engine)
|
|
260
308
|
|
|
261
309
|
## 🚚 Dependencies
|
|
262
310
|
|
|
263
|
-
* [Blueprint](https://github.com/palantir/blueprint) (
|
|
311
|
+
* [React](https://github.com/facebook/react) & [Blueprint](https://github.com/palantir/blueprint) (Modern high-density UI)
|
|
264
312
|
* [Tailwind CSS](https://github.com/tailwindlabs/tailwindcss)
|
|
265
|
-
* [
|
|
313
|
+
* [NIST FIPS 203](https://csrc.nist.gov/pubs/fips/203/final) (ML-KEM-768 Post-Quantum Cryptography)
|
|
314
|
+
* [wa-sqlite](https://github.com/rhashimoto/wa-sqlite) (WebAssembly SQLite & OPFS Local-First Storage)
|
|
266
315
|
|
|
267
316
|
---
|
|
268
317
|
|
|
@@ -274,15 +323,15 @@ This project is licensed under the [AGPLv3](LICENSE) License.
|
|
|
274
323
|
|
|
275
324
|
## 📝 Summary
|
|
276
325
|
|
|
277
|
-
DNS Worker gives you full control over your DNS resolution — with
|
|
326
|
+
DNS Worker gives you full control over your DNS resolution — with zero compromises on privacy, performance, or flexibility. By supporting both a high-efficiency standalone Node.js server and Cloudflare Workers global edge, it delivers an enterprise-grade Protective DNS system that is:
|
|
278
327
|
|
|
279
|
-
- **
|
|
280
|
-
- **
|
|
281
|
-
- **
|
|
282
|
-
- **
|
|
283
|
-
- **
|
|
328
|
+
- **Dual-Engine Versatility**: Run completely Cloudflare-free on your own VPS with classic UDP 53 & DoT 853, or deploy globally on Cloudflare Workers edge for zero-maintenance DoH.
|
|
329
|
+
- **Full-Stack Protocol Support**: Classic UDP 53 for routers, Android Private DNS (DoT 853 with SNI profile routing), and DoH (RFC 8484).
|
|
330
|
+
- **Post-Quantum E2EE**: Protects sensitive DNS query logs using NIST FIPS 203 **P256-MLKEM768** lattice cryptography and hardware Passkeys (WebAuthn).
|
|
331
|
+
- **Local-First Speed**: Instant 0ms log filtering and analytics in your browser via SQLite WASM + OPFS, eliminating unnecessary database read quotas.
|
|
332
|
+
- **Granular Governance**: Multi-profile isolation, custom record redirection, ECH parameter rewriting, and Bloom-filter-accelerated adblocking subscriptions.
|
|
284
333
|
|
|
285
|
-
Whether
|
|
334
|
+
Whether protecting a single device, an entire home network, or a distributed organization, DNS Worker provides an elegant, self-sovereign alternative to commercial DNS filtering services.
|
|
286
335
|
|
|
287
336
|
<div align="center">
|
|
288
337
|
<br>
|