@lzwme/sserver 0.0.11 → 1.0.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 +71 -108
- package/dist/assets/assets/localsend/style.css +2 -0
- package/dist/assets/assets/localsend/vendor/qr-code-styling.js +2 -0
- package/dist/assets/localsend/style.css +2 -0
- package/dist/assets/localsend/vendor/qr-code-styling.js +2 -0
- package/dist/cli.js +9 -6
- package/dist/config.d.ts +38 -1
- package/dist/config.js +54 -9
- package/dist/lib/get-cert.js +1 -1
- package/dist/lib/merge-config.d.ts +9 -0
- package/dist/lib/merge-config.js +66 -0
- package/dist/lib/utils.d.ts +27 -1
- package/dist/lib/utils.js +94 -14
- package/dist/localsend/audit.d.ts +36 -0
- package/dist/localsend/audit.js +104 -0
- package/dist/localsend/auth.d.ts +94 -0
- package/dist/localsend/auth.js +227 -0
- package/dist/localsend/cache.d.ts +34 -0
- package/dist/localsend/cache.js +269 -0
- package/dist/localsend/chunk.d.ts +114 -0
- package/dist/localsend/chunk.js +475 -0
- package/dist/localsend/cleaner.d.ts +19 -0
- package/dist/localsend/cleaner.js +80 -0
- package/dist/localsend/client/app.js +4131 -0
- package/dist/localsend/client/crypto.js +233 -0
- package/dist/localsend/client/favicon.png +0 -0
- package/dist/localsend/client/icons/icon-192.png +0 -0
- package/dist/localsend/client/icons/icon-512.png +0 -0
- package/dist/localsend/client/index.html +451 -0
- package/dist/localsend/client/manifest.webmanifest +33 -0
- package/dist/localsend/client/sw.js +128 -0
- package/dist/localsend/guard.d.ts +58 -0
- package/dist/localsend/guard.js +210 -0
- package/dist/localsend/index.d.ts +52 -0
- package/dist/localsend/index.js +1771 -0
- package/dist/localsend/manage.d.ts +96 -0
- package/dist/localsend/manage.js +304 -0
- package/dist/localsend/metrics.d.ts +26 -0
- package/dist/localsend/metrics.js +58 -0
- package/dist/localsend/paste.d.ts +72 -0
- package/dist/localsend/paste.js +125 -0
- package/dist/localsend/path.d.ts +33 -0
- package/dist/localsend/path.js +151 -0
- package/dist/localsend/query.d.ts +78 -0
- package/dist/localsend/query.js +147 -0
- package/dist/localsend/secret.d.ts +31 -0
- package/dist/localsend/secret.js +96 -0
- package/dist/localsend/settings.d.ts +53 -0
- package/dist/localsend/settings.js +285 -0
- package/dist/localsend/share.d.ts +35 -0
- package/dist/localsend/share.js +117 -0
- package/dist/localsend/temp.d.ts +10 -0
- package/dist/localsend/temp.js +47 -0
- package/dist/localsend/ticket.d.ts +40 -0
- package/dist/localsend/ticket.js +98 -0
- package/dist/localsend/trash.d.ts +39 -0
- package/dist/localsend/trash.js +261 -0
- package/dist/localsend/webdav.d.ts +50 -0
- package/dist/localsend/webdav.js +530 -0
- package/dist/localsend/zip.d.ts +20 -0
- package/dist/localsend/zip.js +186 -0
- package/dist/proxy/php-proxy.js +31 -20
- package/dist/static-server.js +10 -3
- package/package.json +13 -5
- package/dist/localsend/index.html +0 -531
- package/dist/localsend.d.ts +0 -19
- package/dist/localsend.js +0 -217
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
import type { NextFunction, Request, Response } from 'express';
|
|
2
|
+
export interface GuardOptions {
|
|
3
|
+
/** 是否配置了访问令牌。为空表示不校验。传入函数表示运行时取值 */
|
|
4
|
+
hasToken?: () => boolean;
|
|
5
|
+
/** 校验请求头里的访问令牌摘要 */
|
|
6
|
+
verifyKey?: (digest: string) => boolean;
|
|
7
|
+
/** 校验会话令牌 */
|
|
8
|
+
verifySession?: (token: string) => boolean;
|
|
9
|
+
/** 是否信任 X-Forwarded-For 作为客户端 IP。仅在部署于可信反向代理之后才开启,默认关闭(防止伪造绕过限流) */
|
|
10
|
+
trustProxy?: boolean;
|
|
11
|
+
/** 单 IP 最大并发上传数,默认 3。传入函数表示运行时取值 */
|
|
12
|
+
maxConcurrent?: number | (() => number);
|
|
13
|
+
/** 频率限制:窗口毫秒数与窗口内最大请求数,默认 120 次 / 60 秒。传入函数表示运行时取值 */
|
|
14
|
+
rateLimit?: {
|
|
15
|
+
windowMs?: number;
|
|
16
|
+
max?: number;
|
|
17
|
+
} | (() => {
|
|
18
|
+
windowMs?: number;
|
|
19
|
+
max?: number;
|
|
20
|
+
} | undefined);
|
|
21
|
+
/**
|
|
22
|
+
* 分片上传的独立频率限制。
|
|
23
|
+
*
|
|
24
|
+
* 分片上传按「片」发请求,一个大文件天然会产生几百个请求;
|
|
25
|
+
* 若与普通接口共用一个桶,上传越大越容易把自己限死。
|
|
26
|
+
* 这里单独给一个更宽的桶,普通接口的预算不受影响。
|
|
27
|
+
*/
|
|
28
|
+
chunkRateLimit?: {
|
|
29
|
+
windowMs?: number;
|
|
30
|
+
max?: number;
|
|
31
|
+
} | (() => {
|
|
32
|
+
windowMs?: number;
|
|
33
|
+
max?: number;
|
|
34
|
+
} | undefined);
|
|
35
|
+
/** 触发频率限制时的回调:用于计数与审计,不影响是否放行 */
|
|
36
|
+
onRateLimited?: (req: Request) => void;
|
|
37
|
+
}
|
|
38
|
+
export interface Guard {
|
|
39
|
+
requireAuth: (req: Request, res: Response, next: NextFunction) => void;
|
|
40
|
+
rateLimit: (req: Request, res: Response, next: NextFunction) => void;
|
|
41
|
+
/** 分片上传专用的频率限制(独立计数,不与普通接口共享预算) */
|
|
42
|
+
rateLimitChunk: (req: Request, res: Response, next: NextFunction) => void;
|
|
43
|
+
limitConcurrent: (req: Request, res: Response, next: NextFunction) => void;
|
|
44
|
+
/** 分片上传专用的并发限制(预算比文件级并发更宽) */
|
|
45
|
+
limitConcurrentChunk: (req: Request, res: Response, next: NextFunction) => void;
|
|
46
|
+
/** 当前并发占用与累计限流次数(用于状态查询) */
|
|
47
|
+
stats: () => {
|
|
48
|
+
concurrent: number;
|
|
49
|
+
ips: number;
|
|
50
|
+
rateLimited: number;
|
|
51
|
+
};
|
|
52
|
+
}
|
|
53
|
+
/**
|
|
54
|
+
* 取客户端 IP。X-Forwarded-For 完全由客户端提供,只有显式信任代理时才采用。
|
|
55
|
+
* 导出是为了让审计与指标使用同一套解析口径。
|
|
56
|
+
*/
|
|
57
|
+
export declare function clientIp(req: Request, trustProxy?: boolean): string;
|
|
58
|
+
export declare function createGuard(options?: GuardOptions): Guard;
|
|
@@ -0,0 +1,210 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.clientIp = clientIp;
|
|
4
|
+
exports.createGuard = createGuard;
|
|
5
|
+
/**
|
|
6
|
+
* 取客户端 IP。X-Forwarded-For 完全由客户端提供,只有显式信任代理时才采用。
|
|
7
|
+
* 导出是为了让审计与指标使用同一套解析口径。
|
|
8
|
+
*/
|
|
9
|
+
function clientIp(req, trustProxy = false) {
|
|
10
|
+
if (trustProxy) {
|
|
11
|
+
const forwarded = req.headers['x-forwarded-for'];
|
|
12
|
+
const ip = (Array.isArray(forwarded) ? forwarded[0] : forwarded)?.split(',')[0]?.trim();
|
|
13
|
+
if (ip)
|
|
14
|
+
return ip;
|
|
15
|
+
}
|
|
16
|
+
return req.ip || req.socket?.remoteAddress || 'unknown';
|
|
17
|
+
}
|
|
18
|
+
/**
|
|
19
|
+
* 静态资源(样式、脚本、图标、清单等)不包含任何用户数据,
|
|
20
|
+
* 页面外壳同样不含用户数据,因此这些请求放行:
|
|
21
|
+
* 即使启用了访问令牌,页面也能正常加载并提示用户输入令牌。
|
|
22
|
+
* 文件列表、上传、下载等接口仍然需要会话令牌或令牌摘要。
|
|
23
|
+
*/
|
|
24
|
+
const STATIC_ASSET_RE = /\.(css|js|mjs|json|webmanifest|map|png|jpe?g|gif|svg|ico|webp|avif|woff2?|ttf|otf)$/i;
|
|
25
|
+
function createGuard(options = {}) {
|
|
26
|
+
const trustProxy = options.trustProxy === true;
|
|
27
|
+
/** 是否配置了访问令牌(运行时读取) */
|
|
28
|
+
const getHasToken = () => {
|
|
29
|
+
if (typeof options.hasToken === 'function')
|
|
30
|
+
return !!options.hasToken();
|
|
31
|
+
return !!options.hasToken;
|
|
32
|
+
};
|
|
33
|
+
/** 校验请求头里的令牌摘要 */
|
|
34
|
+
const verifyKey = (digest) => {
|
|
35
|
+
if (typeof options.verifyKey !== 'function')
|
|
36
|
+
return false;
|
|
37
|
+
return options.verifyKey(digest);
|
|
38
|
+
};
|
|
39
|
+
/** 校验会话令牌 */
|
|
40
|
+
const verifySession = (token) => {
|
|
41
|
+
if (typeof options.verifySession !== 'function')
|
|
42
|
+
return false;
|
|
43
|
+
return options.verifySession(token);
|
|
44
|
+
};
|
|
45
|
+
/** 运行时读取当前生效的并发上限 */
|
|
46
|
+
const getMaxConcurrent = () => {
|
|
47
|
+
const value = typeof options.maxConcurrent === 'function' ? options.maxConcurrent() : options.maxConcurrent;
|
|
48
|
+
return value ?? 3;
|
|
49
|
+
};
|
|
50
|
+
/** 运行时读取当前生效的频率限制 */
|
|
51
|
+
const getRateLimit = () => {
|
|
52
|
+
const raw = typeof options.rateLimit === 'function' ? options.rateLimit() : options.rateLimit;
|
|
53
|
+
return { windowMs: raw?.windowMs ?? 60_000, max: raw?.max ?? 120 };
|
|
54
|
+
};
|
|
55
|
+
/**
|
|
56
|
+
* 运行时读取分片上传的频率限制。
|
|
57
|
+
*
|
|
58
|
+
* 默认比普通接口宽得多:未显式配置时按 60 秒 600 片给,
|
|
59
|
+
* 1GB / 4MB = 256 片,仍有余量应对重试与并发分片。
|
|
60
|
+
*/
|
|
61
|
+
const getChunkRateLimit = () => {
|
|
62
|
+
const raw = typeof options.chunkRateLimit === 'function' ? options.chunkRateLimit() : options.chunkRateLimit;
|
|
63
|
+
return { windowMs: raw?.windowMs ?? 60_000, max: raw?.max ?? 600 };
|
|
64
|
+
};
|
|
65
|
+
/** 累计被限流的请求数(诊断用) */
|
|
66
|
+
let rateLimited = 0;
|
|
67
|
+
/** ip -> 当前并发数 */
|
|
68
|
+
const concurrent = new Map();
|
|
69
|
+
/** ip -> 最近请求时间戳队列(普通接口) */
|
|
70
|
+
const hits = new Map();
|
|
71
|
+
/** ip -> 最近请求时间戳队列(分片上传,独立预算) */
|
|
72
|
+
const chunkHits = new Map();
|
|
73
|
+
/**
|
|
74
|
+
* 生成一个基于滑动窗口的限流中间件。
|
|
75
|
+
*
|
|
76
|
+
* 每个桶有自己的计数表,互不影响;
|
|
77
|
+
* 这样「分片请求多」不会挤占「列表/登录」的预算。
|
|
78
|
+
*/
|
|
79
|
+
const createRateLimiter = (bucket, readLimit) => {
|
|
80
|
+
return (req, res, next) => {
|
|
81
|
+
const { windowMs, max: maxRequests } = readLimit();
|
|
82
|
+
if (!maxRequests || maxRequests <= 0)
|
|
83
|
+
return next();
|
|
84
|
+
const ip = clientIp(req, trustProxy);
|
|
85
|
+
const now = Date.now();
|
|
86
|
+
const list = (bucket.get(ip) || []).filter((t) => now - t < windowMs);
|
|
87
|
+
if (list.length >= maxRequests) {
|
|
88
|
+
rateLimited += 1;
|
|
89
|
+
options.onRateLimited?.(req);
|
|
90
|
+
res.status(429).json({ code: 1, msg: '请求过于频繁,请稍后再试' });
|
|
91
|
+
return;
|
|
92
|
+
}
|
|
93
|
+
list.push(now);
|
|
94
|
+
bucket.set(ip, list);
|
|
95
|
+
next();
|
|
96
|
+
};
|
|
97
|
+
};
|
|
98
|
+
const rateLimit = createRateLimiter(hits, getRateLimit);
|
|
99
|
+
const rateLimitChunk = createRateLimiter(chunkHits, getChunkRateLimit);
|
|
100
|
+
// 定期清理过期数据,避免长期运行内存增长
|
|
101
|
+
const timer = setInterval(() => {
|
|
102
|
+
const now = Date.now();
|
|
103
|
+
const { windowMs } = getRateLimit();
|
|
104
|
+
const chunkWindow = getChunkRateLimit().windowMs;
|
|
105
|
+
const prune = (bucket, window) => {
|
|
106
|
+
for (const [ip, list] of bucket) {
|
|
107
|
+
const valid = list.filter((t) => now - t < window);
|
|
108
|
+
if (valid.length)
|
|
109
|
+
bucket.set(ip, valid);
|
|
110
|
+
else
|
|
111
|
+
bucket.delete(ip);
|
|
112
|
+
}
|
|
113
|
+
};
|
|
114
|
+
prune(hits, windowMs);
|
|
115
|
+
prune(chunkHits, chunkWindow);
|
|
116
|
+
for (const [ip, count] of concurrent) {
|
|
117
|
+
if (count <= 0)
|
|
118
|
+
concurrent.delete(ip);
|
|
119
|
+
}
|
|
120
|
+
}, 30_000);
|
|
121
|
+
timer.unref?.();
|
|
122
|
+
const requireAuth = (req, res, next) => {
|
|
123
|
+
// 静态资源与页面外壳不含用户数据,放行,
|
|
124
|
+
// 让页面能正常加载并提示用户输入访问令牌
|
|
125
|
+
if (!req.path.startsWith('/api/') && (STATIC_ASSET_RE.test(req.path) || req.path === '/' || req.path === ''))
|
|
126
|
+
return next();
|
|
127
|
+
// 会话令牌:优先用请求头;SSE、下载链接等无法带请求头的场景用查询参数
|
|
128
|
+
const session = String(req.get('X-Localsend-Session') || req.query.session || '');
|
|
129
|
+
if (session && verifySession(session))
|
|
130
|
+
return next();
|
|
131
|
+
// 带了一个服务端不认的会话:会话失效(口令改了、会话过期、服务重启)。
|
|
132
|
+
// 这与「从未登录」是两回事,必须明确告诉客户端「要重新认证」,
|
|
133
|
+
// 否则客户端会一直以为已登录,界面显示的身份与服务端实际权限也会对不上。
|
|
134
|
+
if (session && getHasToken()) {
|
|
135
|
+
res.status(401).json({ code: 1, msg: '会话已失效,请重新登录', needLogin: true });
|
|
136
|
+
return;
|
|
137
|
+
}
|
|
138
|
+
// 访问令牌摘要:放在请求头里,不进 URL
|
|
139
|
+
const key = String(req.get('X-Localsend-Key') || '');
|
|
140
|
+
if (key && verifyKey(key))
|
|
141
|
+
return next();
|
|
142
|
+
// 配了访问令牌却没有可用凭证:属于「缺令牌」,提示用户输入令牌
|
|
143
|
+
if (getHasToken()) {
|
|
144
|
+
res.status(401).json({ code: 1, msg: '需要访问令牌', needToken: true });
|
|
145
|
+
return;
|
|
146
|
+
}
|
|
147
|
+
// 没配访问令牌:按访客口径放行,具体权限由身份中间件按角色判断
|
|
148
|
+
return next();
|
|
149
|
+
};
|
|
150
|
+
/**
|
|
151
|
+
* 生成并发限制中间件。
|
|
152
|
+
*
|
|
153
|
+
* 分片上传的一次传输会并发发多个分片请求,因此它需要比「文件级并发数」
|
|
154
|
+
* 更宽的预算;否则一个 3 并发的大文件就能把整个 IP 的额度占满。
|
|
155
|
+
*/
|
|
156
|
+
const createConcurrentLimiter = (readMax) => {
|
|
157
|
+
return (req, res, next) => {
|
|
158
|
+
const maxConcurrent = readMax();
|
|
159
|
+
if (!maxConcurrent || maxConcurrent <= 0)
|
|
160
|
+
return next();
|
|
161
|
+
const ip = clientIp(req, trustProxy);
|
|
162
|
+
const current = concurrent.get(ip) || 0;
|
|
163
|
+
if (current >= maxConcurrent) {
|
|
164
|
+
res.status(429).json({ code: 1, msg: `并发上传数已达上限(${maxConcurrent}),请稍后再试` });
|
|
165
|
+
return;
|
|
166
|
+
}
|
|
167
|
+
concurrent.set(ip, current + 1);
|
|
168
|
+
let released = false;
|
|
169
|
+
const release = () => {
|
|
170
|
+
if (released)
|
|
171
|
+
return;
|
|
172
|
+
released = true;
|
|
173
|
+
const count = (concurrent.get(ip) || 1) - 1;
|
|
174
|
+
if (count <= 0)
|
|
175
|
+
concurrent.delete(ip);
|
|
176
|
+
else
|
|
177
|
+
concurrent.set(ip, count);
|
|
178
|
+
};
|
|
179
|
+
res.on('finish', release);
|
|
180
|
+
res.on('close', release);
|
|
181
|
+
next();
|
|
182
|
+
};
|
|
183
|
+
};
|
|
184
|
+
const limitConcurrent = createConcurrentLimiter(getMaxConcurrent);
|
|
185
|
+
/**
|
|
186
|
+
* 分片上传的并发预算:按「文件并发数 × 3 + 3」给。
|
|
187
|
+
*
|
|
188
|
+
* 网页端一个分片文件开 3 个分片任务,最多同时传 3 个文件,
|
|
189
|
+
* 因此 3 × 3 = 9 是正常峰值;默认 maxConcurrent=3 时预算为 12,
|
|
190
|
+
* 既容得下正常并发,也不会让单个 IP 无限堆请求。
|
|
191
|
+
*/
|
|
192
|
+
const limitConcurrentChunk = createConcurrentLimiter(() => {
|
|
193
|
+
const base = getMaxConcurrent();
|
|
194
|
+
if (!base || base <= 0)
|
|
195
|
+
return 0;
|
|
196
|
+
return base * 3 + 3;
|
|
197
|
+
});
|
|
198
|
+
return {
|
|
199
|
+
requireAuth,
|
|
200
|
+
rateLimit,
|
|
201
|
+
rateLimitChunk,
|
|
202
|
+
limitConcurrent,
|
|
203
|
+
limitConcurrentChunk,
|
|
204
|
+
stats: () => ({
|
|
205
|
+
concurrent: [...concurrent.values()].reduce((a, b) => a + b, 0),
|
|
206
|
+
ips: concurrent.size,
|
|
207
|
+
rateLimited,
|
|
208
|
+
}),
|
|
209
|
+
};
|
|
210
|
+
}
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
import { type Express } from 'express';
|
|
2
|
+
/**
|
|
3
|
+
* 探测前端构建产物目录。
|
|
4
|
+
*
|
|
5
|
+
* 产物位置随运行方式而变,因此不写死单一路径,而是从运行目录逐级向上找
|
|
6
|
+
* 第一个包含 style.css 的 assets 目录:
|
|
7
|
+
* - 运行态(__dirname 为 dist/localsend):dist 内自带 assets,发布包开箱即用
|
|
8
|
+
* - 开发态(__dirname 为 src/localsend):产物在仓库根 assets/,需上溯两级
|
|
9
|
+
*
|
|
10
|
+
* 逐级探测的好处是:产物目录无论放在运行目录、其上级还是仓库根,
|
|
11
|
+
* 都能被找到;同时不会误取到更外层的无关 assets 目录。
|
|
12
|
+
*
|
|
13
|
+
* 找不到时返回 null,由调用方决定降级处理(给出提示而非直接崩溃)。
|
|
14
|
+
*
|
|
15
|
+
* @param baseDir 运行目录,默认取当前模块所在目录
|
|
16
|
+
*/
|
|
17
|
+
export declare function resolveAssetsDir(baseDir?: string): string | null;
|
|
18
|
+
/**
|
|
19
|
+
* 修复 multipart 上传的文件名乱码。
|
|
20
|
+
*
|
|
21
|
+
* 浏览器(WHATWG 规范)会把文件名的 UTF-8 原始字节直接写进 Content-Disposition 的 filename 参数,
|
|
22
|
+
* 而 busboy 默认按 latin1(defParamCharset='latin1')解码该参数,中文文件名就会变成乱码
|
|
23
|
+
* (如 `中文.txt` → `䏿–‡.txt`)。
|
|
24
|
+
*
|
|
25
|
+
* 这里保留原始字节(latin1 与字节一一对应,可无损还原),再按 utf-8 / gb18030 依次尝试严格解码:
|
|
26
|
+
* - UTF-8 是浏览器的标准行为;
|
|
27
|
+
* - gb18030 兼容部分国产客户端 / 老程序用 GBK 发送文件名的情况。
|
|
28
|
+
*/
|
|
29
|
+
export declare function decodeUploadName(raw?: unknown): string;
|
|
30
|
+
/**
|
|
31
|
+
* 修复历史上已上传的乱码文件名(把 UTF-8 字节误存成 latin1 字符导致的乱码)。
|
|
32
|
+
* 返回被重命名的 [旧名, 新名] 列表。
|
|
33
|
+
*/
|
|
34
|
+
export declare function repairLocalsendNames(dir: string): [string, string][];
|
|
35
|
+
/**
|
|
36
|
+
* 默认禁止上传的服务端脚本扩展名。
|
|
37
|
+
* 存储目录若位于静态服务的根目录下,上传的可执行脚本可能被 php-cgi 等中间件执行,
|
|
38
|
+
* 相当于对外开放了远程代码执行入口,因此在上传环节直接拦截。
|
|
39
|
+
*/
|
|
40
|
+
export declare const DEFAULT_BLOCK_EXTENSIONS: string[];
|
|
41
|
+
/**
|
|
42
|
+
* 计算目录占用(字节,递归子目录)。忽略读取失败的条目。
|
|
43
|
+
*
|
|
44
|
+
* 内部目录(分片暂存、回收站)不计入:前者是临时数据,
|
|
45
|
+
* 后者由回收站单独统计,混在一起会让「已用空间」与文件列表对不上。
|
|
46
|
+
*/
|
|
47
|
+
export declare function dirSize(target: string, skipInternal?: boolean): number;
|
|
48
|
+
export interface LocalsendHandle {
|
|
49
|
+
/** 停止目录监听与后台定时任务(进程退出、测试收尾时调用) */
|
|
50
|
+
stop: () => void;
|
|
51
|
+
}
|
|
52
|
+
export declare function initLocalsend(app: Express): Promise<LocalsendHandle>;
|