fcdns 0.3.12 → 0.3.13

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.
Files changed (3) hide show
  1. package/CHANGELOG.md +2 -0
  2. package/README.md +1 -36
  3. package/package.json +6 -6
package/CHANGELOG.md CHANGED
@@ -2,6 +2,8 @@
2
2
 
3
3
  All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
4
4
 
5
+ ### [0.3.13](https://github.com/BlackGlory/fcdns/compare/v0.3.12...v0.3.13) (2022-04-01)
6
+
5
7
  ### [0.3.12](https://github.com/BlackGlory/fcdns/compare/v0.3.11...v0.3.12) (2022-03-26)
6
8
 
7
9
 
package/README.md CHANGED
@@ -1,27 +1,13 @@
1
1
  # fcdns
2
-
3
2
  DNS relay server with fact-checking.
4
3
 
5
4
  ## Install
6
-
7
5
  ```sh
6
+ # Please do not use Yarn v1 to install this package globally, Yarn v1 cannot properly patch dependencies.
8
7
  npm install --global fcdns
9
- # or
10
- yarn global add fcdns
11
- ```
12
-
13
- ### Install from source
14
-
15
- ```sh
16
- git clone git@github.com:BlackGlory/fcdns.git
17
- cd fcdns
18
- yarn install
19
- yarn build
20
- yarn global add "file:$(pwd)"
21
8
  ```
22
9
 
23
10
  ## Usage
24
-
25
11
  ```sh
26
12
  Usage: fcdns [options]
27
13
 
@@ -52,15 +38,12 @@ fcdns \
52
38
  ```
53
39
 
54
40
  ## 原理
55
-
56
41
  ![流程图](./docs/flow-chart.svg)
57
42
 
58
43
  ## 必要条件
59
-
60
44
  使用fcdns需要指定3个服务器地址, 1份IP地址白名单, 1份主机名白名单.
61
45
 
62
46
  ### 投毒测试服务器(test server)
63
-
64
47
  投毒测试服务器是一台非DNS服务器,
65
48
  当客户端向该远程主机的53端口发送DNS查询(question)时, 查询将会超时或被拒绝.
66
49
  当网络内存在DNS污染时, 向该远程主机发送DNS查询时, 将得到查询结果(answer).
@@ -73,7 +56,6 @@ fcdns会在发出DNS查询的同时发出ping, 因此投毒测试服务器必须
73
56
  fcdns会持久化缓存投毒测试的结果, 同一个主机名只在第一次查询时会经历投毒测试.
74
57
 
75
58
  ### 不可信DNS服务器(untrusted server)
76
-
77
59
  不可信DNS服务器是一台DNS服务器, 客户端与该服务器的连接是被污染的, 或该服务器可能返回被污染的结果.
78
60
  从该服务器返回的结果虽然并不总是可信, 但借助投毒测试, 可以从中筛选出大量的可信结果.
79
61
 
@@ -82,7 +64,6 @@ fcdns会持久化缓存投毒测试的结果, 同一个主机名只在第一次
82
64
  *fcdns只具有最低限度的DNS功能, 强烈建议使用CoreDNS等程序建立本地DNS服务器作为代理.*
83
65
 
84
66
  ### 可信DNS服务器(trusted server)
85
-
86
67
  可信DNS服务器是一台DNS服务器, 客户端与该服务器的连接是不被污染的, 且该服务器不会返回被污染的结果.
87
68
 
88
69
  之所以需要可信DNS服务器, 是为了能够查询那些被投毒的主机名的正确记录.
@@ -91,7 +72,6 @@ fcdns会持久化缓存投毒测试的结果, 同一个主机名只在第一次
91
72
  *fcdns只具有最低限度的DNS功能, 强烈建议使用CoreDNS等程序建立本地DNS服务器作为代理.*
92
73
 
93
74
  ### IP地址白名单(ip whitelist)
94
-
95
75
  IP地址白名单用于指定允许用"不可信DNS服务器"返回的IP地址或IP地址范围,
96
76
  所有不在白名单内的IP地址都会转用"可信DNS服务器"进行二次查询.
97
77
 
@@ -102,7 +82,6 @@ fcdns会持久化缓存查询最终选择的服务器, 同一个主机名只在
102
82
  fcdns之所以使用白名单而不是黑名单, 是因为在真实世界的案例中, 白名单所需的内容条数较少.
103
83
 
104
84
  #### 文件格式
105
-
106
85
  白名单是一个文本文件, 以行为分隔符储存地址或地址范围.
107
86
  地址范围由起点IP和终点IP组成, 以`-`相连.
108
87
 
@@ -133,11 +112,9 @@ IPv6地址范围示例:
133
112
  ```
134
113
 
135
114
  ### 主机名白名单(hostname whitelist)
136
-
137
115
  主机名白名单用于强制使某些主机名在解析时使用不可信DNS服务器, 其优先级高于fcdns里的其他规则.
138
116
 
139
117
  #### 文件格式
140
-
141
118
  白名单是一个文本文件, 以行为分隔符存储主机名模式.
142
119
  主机名模式使用`*`作为通配符, 可以匹配任意个字符.
143
120
  fcdns认为的合法主机名模式只能由数字, 字母, 连字符(`-`), 点(`.`), 通配符(`*`)组成.
@@ -149,13 +126,11 @@ wikipedia.org
149
126
  ```
150
127
 
151
128
  ## 宽松模式
152
-
153
129
  在宽松模式下, 当相关主机名不存在路由缓存时(即第一次查询该主机名), 会立即查询不可信服务器并返回记录, 然后在后台执行投毒测试和路由缓存.
154
130
 
155
131
  宽松模式通过降低fcdns的准确性, 提升了在可信信道不稳定情况下的用户体验, 这适用于只有少数主机名被投毒的环境.
156
132
 
157
133
  ## 性能
158
-
159
134
  fcdns不是作为高性能DNS服务器开发的, 选择Node.js栈完全是出于开发方面的便利性.
160
135
  fcdns的性能经过测试足以应付日常使用.
161
136
 
@@ -163,7 +138,6 @@ fcdns的性能经过测试足以应付日常使用.
163
138
  不实施这些优化的主要原因是为了避免降低代码的可读性.
164
139
 
165
140
  ### 延迟
166
-
167
141
  fcdns存在一些可以被注意到的延迟:
168
142
  - 投毒测试
169
143
  - 可信DNS服务器在无缓存的情况下被查询
@@ -181,9 +155,7 @@ fcdns存在一些可以被注意到的延迟:
181
155
  理论上可以通过将地址范围排序后做二分查找来加速此过程, 但暂未实现.
182
156
 
183
157
  ## 资源占用
184
-
185
158
  ### 硬盘占用
186
-
187
159
  fcdns的缓存文件会在启动时自动压缩, 但在运行时是仅追加(append)的,
188
160
  出现相同域名的并行查询时, 会重复写入相同的记录.
189
161
  如果有非常大量完全不同域名的查询, 则缓存文件可能导致硬盘占用增加, 但在大部分场景下应该无需担心.
@@ -193,29 +165,22 @@ fcdns有两个缓存文件, 分别缓存投毒测试结果和路由结果.
193
165
  fcdns保留投毒测试缓存是考虑到了收集投毒测试结果的需要, 以及清空路由缓存的场景.
194
166
 
195
167
  ### 内存占用
196
-
197
168
  fcdns的内存缓存受V8引擎的实现限制, 且缓存是只增不减的.
198
169
  根据经验, Node.js程序的内存占用量通常会是使用类似数据类型的本地程序的两倍以上.
199
170
  如果有非常大量完全不同域名的查询, 则内存缓存可能导致内存占用增加, 但在大部分场景下应该无需担心.
200
171
 
201
172
  ## 针对fcdns的攻击
202
-
203
173
  ### DNS服务器黑名单/白名单
204
-
205
174
  禁止向非DNS服务器发送DNS数据包将会破坏fcdns的投毒测试功能.
206
175
 
207
176
  ### 禁止ping
208
-
209
177
  禁止发送ping(echo request)或丢弃reply(echo reply)将会破坏fcdns的投毒测试功能.
210
178
 
211
179
  ### 无差别污染
212
-
213
180
  劫持所有DNS响应将会破坏fcdns的投毒测试功能.
214
181
 
215
182
  ### 无规律/间歇性投毒
216
-
217
183
  无规律/间歇性投毒将会使fcdns生成错误的缓存记录.
218
184
 
219
185
  ## 未实现的功能
220
-
221
186
  - [ ] 复用相同域名的并行查询
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "fcdns",
3
- "version": "0.3.12",
3
+ "version": "0.3.13",
4
4
  "description": "DNS relay server with fact-checking.",
5
5
  "keywords": [
6
6
  "dns"
@@ -38,8 +38,8 @@
38
38
  "@types/ms": "^0.7.31",
39
39
  "@types/node": "14",
40
40
  "@types/ping": "^0.4.1",
41
- "@typescript-eslint/eslint-plugin": "^5.16.0",
42
- "@typescript-eslint/parser": "^5.16.0",
41
+ "@typescript-eslint/eslint-plugin": "^5.17.0",
42
+ "@typescript-eslint/parser": "^5.17.0",
43
43
  "eslint": "^8.12.0",
44
44
  "husky": "4",
45
45
  "internet-number": "^3.0.1",
@@ -60,14 +60,14 @@
60
60
  "chalk": "^4.1.2",
61
61
  "commander": "^9.1.0",
62
62
  "extra-filesystem": "^0.4.2",
63
- "extra-logger": "^0.6.5",
63
+ "extra-logger": "^0.6.6",
64
64
  "extra-promise": "^1.0.2",
65
65
  "iterable-operator": "^1.0.1",
66
66
  "ms": "^2.1.3",
67
- "native-node-dns": "^0.7.6",
67
+ "native-node-dns": "0.7.6",
68
+ "native-node-dns-packet": "0.1.5",
68
69
  "patch-package": "^6.4.7",
69
70
  "ping": "^0.4.1",
70
- "postinstall-postinstall": "^2.1.0",
71
71
  "return-style": "^1.0.0"
72
72
  }
73
73
  }