forked from jordanlambrecht/tracker-tracker
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathbackup.ts
More file actions
546 lines (484 loc) · 18.9 KB
/
Copy pathbackup.ts
File metadata and controls
546 lines (484 loc) · 18.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
// src/lib/backup.ts
//
// Functions: generateBackupPayload, validateBackupJson, encryptBackupPayload, decryptBackupPayload, resolveBackupPassword, pruneOldBackups
import { unlink } from "node:fs/promises"
import path from "node:path"
import { desc, inArray, isNotNull } from "drizzle-orm"
import { decrypt, deriveKey, encrypt, generateSalt } from "@/lib/crypto"
import { db } from "@/lib/db"
import {
appSettings,
backupHistory,
clientSnapshots,
clientUptimeBuckets,
dismissedAlerts,
downloadClients,
notificationTargets,
tagGroupMembers,
tagGroups,
trackerRoles,
trackerSnapshots,
trackers,
} from "@/lib/db/schema"
import { log } from "@/lib/logger"
import { isUnsafeNetworkHost } from "@/lib/network"
import { VALID_NOTIFICATION_TYPES } from "@/lib/notifications/types"
import { HEX_64_RE, ISO_8601_RE, isValidHex, isValidPort } from "@/lib/validators"
import packageJson from "../../package.json"
export const CURRENT_BACKUP_VERSION = 1
export interface BackupManifest {
version: number
appVersion: string
instanceUrl: string | null
createdAt: string
encrypted: boolean
counts: Record<string, number>
}
export interface BackupPayload {
manifest: BackupManifest
settings: Record<string, unknown>
trackers: Record<string, unknown>[]
trackerSnapshots: Record<string, unknown>[]
trackerRoles: Record<string, unknown>[]
downloadClients: Record<string, unknown>[]
tagGroups: Record<string, unknown>[]
tagGroupMembers: Record<string, unknown>[]
clientSnapshots: Record<string, unknown>[]
clientUptimeBuckets?: Record<string, unknown>[]
dismissedAlerts?: Record<string, unknown>[]
notificationTargets?: Record<string, unknown>[]
}
export interface EncryptedBackupEnvelope {
format: "tracker-tracker-encrypted-backup"
version: 1
createdAt: string
encryptionSalt: string
ciphertext: string
}
// Serialize a single value. Converts BigInt to decimal string and Date to ISO 8601.
function serializeValue(value: unknown): unknown {
if (typeof value === "bigint") {
return value.toString()
}
if (value instanceof Date) {
return value.toISOString()
}
return value
}
// Walk a plain object returned by Drizzle and serialize all leaf values.
function serializeRow(row: Record<string, unknown>): Record<string, unknown> {
const out: Record<string, unknown> = {}
for (const key of Object.keys(row)) {
out[key] = serializeValue(row[key])
}
return out
}
export async function generateBackupPayload(): Promise<BackupPayload> {
const now = new Date().toISOString()
// Parallel fetch with all tables independent
const [
[rawSettings],
rawTrackers,
rawSnapshots,
rawRoles,
rawClients,
rawTagGroups,
rawTagGroupMembers,
rawClientSnapshots,
rawUptimeBuckets,
rawDismissedAlerts,
allNotificationTargets,
] = await Promise.all([
db.select().from(appSettings).limit(1),
db.select().from(trackers).orderBy(trackers.id),
db.select().from(trackerSnapshots).orderBy(trackerSnapshots.id),
db.select().from(trackerRoles).orderBy(trackerRoles.id),
db
.select({
id: downloadClients.id,
name: downloadClients.name,
type: downloadClients.type,
enabled: downloadClients.enabled,
host: downloadClients.host,
port: downloadClients.port,
useSsl: downloadClients.useSsl,
encryptedUsername: downloadClients.encryptedUsername,
encryptedPassword: downloadClients.encryptedPassword,
pollIntervalSeconds: downloadClients.pollIntervalSeconds,
isDefault: downloadClients.isDefault,
crossSeedTags: downloadClients.crossSeedTags,
errorSince: downloadClients.errorSince,
createdAt: downloadClients.createdAt,
updatedAt: downloadClients.updatedAt,
})
.from(downloadClients)
.orderBy(downloadClients.id),
db.select().from(tagGroups).orderBy(tagGroups.id),
db.select().from(tagGroupMembers).orderBy(tagGroupMembers.id),
db.select().from(clientSnapshots).orderBy(clientSnapshots.id),
db.select().from(clientUptimeBuckets).orderBy(clientUptimeBuckets.id),
db.select().from(dismissedAlerts).orderBy(dismissedAlerts.id),
db.select().from(notificationTargets).orderBy(notificationTargets.id),
])
// appSettings — exclude: id, passwordHash, failedLoginAttempts, encryptedSchedulerKey, createdAt
const settingsPayload: Record<string, unknown> = {}
if (rawSettings) {
const {
id: _id,
passwordHash: _passwordHash,
failedLoginAttempts: _failedLoginAttempts,
encryptedSchedulerKey: _encryptedSchedulerKey,
createdAt: _createdAt,
...rest
} = rawSettings
for (const key of Object.keys(rest) as Array<keyof typeof rest>) {
settingsPayload[key] = serializeValue(rest[key])
}
}
// trackers — exclude transient runtime state
const trackersPayload = rawTrackers.map((t) => {
const {
lastPolledAt: _lpa,
lastError: _le,
lastErrorAt: _lea,
consecutiveFailures: _cf,
pausedAt: _pa,
...rest
} = t
return serializeRow(rest as Record<string, unknown>)
})
const snapshotsPayload = rawSnapshots.map((s) => serializeRow(s as Record<string, unknown>))
const rolesPayload = rawRoles.map((r) => serializeRow(r as Record<string, unknown>))
// downloadClients — cachedTorrents/cachedTorrentsAt/lastPolledAt/lastError excluded at query level
const clientsPayload = rawClients.map((c) => serializeRow(c as Record<string, unknown>))
const tagGroupsPayload = rawTagGroups.map((g) => serializeRow(g as Record<string, unknown>))
const tagGroupMembersPayload = rawTagGroupMembers.map((m) =>
serializeRow(m as Record<string, unknown>)
)
const clientSnapshotsPayload = rawClientSnapshots.map((cs) =>
serializeRow(cs as Record<string, unknown>)
)
const uptimeBucketsPayload = rawUptimeBuckets.map((ub) =>
serializeRow(ub as Record<string, unknown>)
)
const dismissedAlertsPayload = rawDismissedAlerts.map((a) =>
serializeRow(a as Record<string, unknown>)
)
const backupNotificationTargets = allNotificationTargets.map(
({ lastDeliveryStatus, lastDeliveryAt, lastDeliveryError, ...rest }) =>
serializeRow(rest as Record<string, unknown>)
)
const counts: Record<string, number> = {
trackers: trackersPayload.length,
trackerSnapshots: snapshotsPayload.length,
trackerRoles: rolesPayload.length,
downloadClients: clientsPayload.length,
tagGroups: tagGroupsPayload.length,
tagGroupMembers: tagGroupMembersPayload.length,
clientSnapshots: clientSnapshotsPayload.length,
clientUptimeBuckets: uptimeBucketsPayload.length,
dismissedAlerts: dismissedAlertsPayload.length,
notificationTargets: backupNotificationTargets.length,
}
const manifest: BackupManifest = {
version: CURRENT_BACKUP_VERSION,
appVersion: packageJson.version,
instanceUrl: process.env.BASE_URL || null,
createdAt: now,
encrypted: false,
counts,
}
return {
manifest,
settings: settingsPayload,
trackers: trackersPayload,
trackerSnapshots: snapshotsPayload,
trackerRoles: rolesPayload,
downloadClients: clientsPayload,
tagGroups: tagGroupsPayload,
tagGroupMembers: tagGroupMembersPayload,
clientSnapshots: clientSnapshotsPayload,
clientUptimeBuckets: uptimeBucketsPayload,
dismissedAlerts: dismissedAlertsPayload,
notificationTargets: backupNotificationTargets,
}
}
// ─── Validation helpers ───────────────────────────────────────────────────────
export const VALID_BACKUP_FREQUENCIES = new Set(["daily", "weekly", "monthly"])
function assertString(value: unknown, label: string): asserts value is string {
if (typeof value !== "string") {
throw new Error(`Backup validation: ${label} must be a string`)
}
}
function assertNumber(value: unknown, label: string): asserts value is number {
if (typeof value !== "number" || !Number.isFinite(value)) {
throw new Error(`Backup validation: ${label} must be a number`)
}
}
function assertArray(value: unknown, label: string): asserts value is unknown[] {
if (!Array.isArray(value)) {
throw new Error(`Backup validation: ${label} must be an array`)
}
}
function assertValidIso(value: unknown, label: string): void {
assertString(value, label)
if (!ISO_8601_RE.test(value)) {
throw new Error(`Backup validation: ${label} must be a valid ISO 8601 string`)
}
}
// ─── Public validation ────────────────────────────────────────────────────────
export function validateBackupJson(payload: unknown): asserts payload is BackupPayload {
if (typeof payload !== "object" || payload === null) {
throw new Error("Backup validation: payload must be an object")
}
const p = payload as Record<string, unknown>
// manifest
if (typeof p.manifest !== "object" || p.manifest === null) {
throw new Error("Backup validation: manifest must be an object")
}
const manifest = p.manifest as Record<string, unknown>
if (manifest.version !== CURRENT_BACKUP_VERSION) {
throw new Error(
`Backup validation: unsupported backup version ${manifest.version} (expected ${CURRENT_BACKUP_VERSION})`
)
}
assertValidIso(manifest.createdAt, "manifest.createdAt")
if (
typeof manifest.counts !== "object" ||
manifest.counts === null ||
Array.isArray(manifest.counts)
) {
throw new Error("Backup validation: manifest.counts must be an object")
}
for (const [k, v] of Object.entries(manifest.counts as Record<string, unknown>)) {
if (typeof v !== "number" || !Number.isInteger(v) || v < 0) {
throw new Error(`Backup validation: manifest.counts.${k} must be a non-negative integer`)
}
}
// settings
if (typeof p.settings !== "object" || p.settings === null) {
throw new Error("Backup validation: settings must be an object")
}
const settings = p.settings as Record<string, unknown>
assertString(settings.encryptionSalt, "settings.encryptionSalt")
if (!HEX_64_RE.test(settings.encryptionSalt)) {
throw new Error("Backup validation: settings.encryptionSalt must be exactly 64 hex characters")
}
if (settings.backupScheduleFrequency !== undefined) {
assertString(settings.backupScheduleFrequency, "settings.backupScheduleFrequency")
if (!VALID_BACKUP_FREQUENCIES.has(settings.backupScheduleFrequency)) {
throw new Error(
`Backup validation: settings.backupScheduleFrequency must be one of: ${[...VALID_BACKUP_FREQUENCIES].join(", ")}`
)
}
}
if (settings.backupRetentionCount !== undefined) {
assertNumber(settings.backupRetentionCount, "settings.backupRetentionCount")
if (
!Number.isInteger(settings.backupRetentionCount) ||
settings.backupRetentionCount < 1 ||
settings.backupRetentionCount > 365
) {
throw new Error(
"Backup validation: settings.backupRetentionCount must be an integer between 1 and 365"
)
}
}
// array fields
assertArray(p.trackers, "trackers")
assertArray(p.trackerSnapshots, "trackerSnapshots")
assertArray(p.trackerRoles, "trackerRoles")
assertArray(p.downloadClients, "downloadClients")
assertArray(p.tagGroups, "tagGroups")
assertArray(p.tagGroupMembers, "tagGroupMembers")
assertArray(p.clientSnapshots, "clientSnapshots")
// clientUptimeBuckets is optional for backward compatibility with older backups
if (p.clientUptimeBuckets !== undefined) {
assertArray(p.clientUptimeBuckets, "clientUptimeBuckets")
for (let i = 0; i < p.clientUptimeBuckets.length; i++) {
const ub = p.clientUptimeBuckets[i] as Record<string, unknown>
const prefix = `clientUptimeBuckets[${i}]`
assertNumber(ub.clientId, `${prefix}.clientId`)
assertValidIso(ub.bucketTs, `${prefix}.bucketTs`)
assertNumber(ub.ok, `${prefix}.ok`)
assertNumber(ub.fail, `${prefix}.fail`)
}
}
// dismissedAlerts is optional for backward compatibility with older backups
if (p.dismissedAlerts !== undefined) {
assertArray(p.dismissedAlerts, "dismissedAlerts")
}
// notificationTargets is optional for backward compatibility with older backups
if (p.notificationTargets !== undefined) {
assertArray(p.notificationTargets, "notificationTargets")
for (let i = 0; i < p.notificationTargets.length; i++) {
const nt = p.notificationTargets[i] as Record<string, unknown>
const prefix = `notificationTargets[${i}]`
assertString(nt.name, `${prefix}.name`)
assertString(nt.encryptedConfig, `${prefix}.encryptedConfig`)
assertString(nt.type, `${prefix}.type`)
if (
!VALID_NOTIFICATION_TYPES.includes(nt.type as (typeof VALID_NOTIFICATION_TYPES)[number])
) {
throw new Error(
`Backup validation: ${prefix}.type must be one of: ${VALID_NOTIFICATION_TYPES.join(", ")}`
)
}
}
}
// tracker entries
for (let i = 0; i < p.trackers.length; i++) {
const t = p.trackers[i] as Record<string, unknown>
const prefix = `trackers[${i}]`
assertString(t.name, `${prefix}.name`)
if (t.name.length === 0 || t.name.length > 100) {
throw new Error(`Backup validation: ${prefix}.name must be between 1 and 100 characters`)
}
assertString(t.baseUrl, `${prefix}.baseUrl`)
let parsedUrl: URL
try {
parsedUrl = new URL(t.baseUrl)
} catch {
throw new Error(`Backup validation: ${prefix}.baseUrl is not a valid URL`)
}
if (parsedUrl.protocol !== "http:" && parsedUrl.protocol !== "https:") {
throw new Error(`Backup validation: ${prefix}.baseUrl must use http or https`)
}
if (isUnsafeNetworkHost(parsedUrl.hostname)) {
throw new Error(
`Backup validation: ${prefix}.baseUrl must not target localhost or a private network address`
)
}
assertString(t.encryptedApiToken, `${prefix}.encryptedApiToken`)
// Empty token is valid — happens after a restore clears encrypted fields
if (t.color !== null && t.color !== undefined) {
assertString(t.color, `${prefix}.color`)
if (!isValidHex(t.color, true)) {
throw new Error(`Backup validation: ${prefix}.color must be a valid hex color or null`)
}
}
}
// trackerSnapshot entries
for (let i = 0; i < p.trackerSnapshots.length; i++) {
const s = p.trackerSnapshots[i] as Record<string, unknown>
const prefix = `trackerSnapshots[${i}]`
assertNumber(s.trackerId, `${prefix}.trackerId`)
assertString(s.uploadedBytes, `${prefix}.uploadedBytes`)
try {
BigInt(s.uploadedBytes)
} catch {
throw new Error(`Backup validation: ${prefix}.uploadedBytes must be parseable as BigInt`)
}
assertString(s.downloadedBytes, `${prefix}.downloadedBytes`)
try {
BigInt(s.downloadedBytes)
} catch {
throw new Error(`Backup validation: ${prefix}.downloadedBytes must be parseable as BigInt`)
}
assertValidIso(s.polledAt, `${prefix}.polledAt`)
}
// downloadClient entries
for (let i = 0; i < p.downloadClients.length; i++) {
const c = p.downloadClients[i] as Record<string, unknown>
const prefix = `downloadClients[${i}]`
assertString(c.host, `${prefix}.host`)
assertNumber(c.port, `${prefix}.port`)
if (!isValidPort(c.port)) {
throw new Error(`Backup validation: ${prefix}.port must be an integer between 1 and 65535`)
}
assertString(c.encryptedUsername, `${prefix}.encryptedUsername`)
// Empty credentials are valid — happens after a restore clears encrypted fields
assertString(c.encryptedPassword, `${prefix}.encryptedPassword`)
}
// tagGroupMember entries
for (let i = 0; i < p.tagGroupMembers.length; i++) {
const m = p.tagGroupMembers[i] as Record<string, unknown>
const prefix = `tagGroupMembers[${i}]`
assertNumber(m.groupId, `${prefix}.groupId`)
assertString(m.tag, `${prefix}.tag`)
assertString(m.label, `${prefix}.label`)
}
}
// ─── Encryption wrappers ──────────────────────────────────────────────────────
export async function encryptBackupPayload(
payload: BackupPayload,
password: string
): Promise<EncryptedBackupEnvelope> {
const encryptionSalt = generateSalt() // Generate random salt per backup
const encryptionKey = await deriveKey(password, encryptionSalt)
const jsonString = JSON.stringify(payload)
const ciphertext = encrypt(jsonString, encryptionKey)
return {
format: "tracker-tracker-encrypted-backup",
version: 1,
createdAt: new Date().toISOString(),
encryptionSalt,
ciphertext,
}
}
export function decryptBackupPayload(
envelope: EncryptedBackupEnvelope,
encryptionKey: Buffer
): BackupPayload {
if (envelope.format !== "tracker-tracker-encrypted-backup") {
throw new Error(
`Invalid backup envelope format: expected "tracker-tracker-encrypted-backup", got "${envelope.format}"`
)
}
const jsonString = decrypt(envelope.ciphertext, encryptionKey)
let parsed: unknown
try {
parsed = JSON.parse(jsonString)
} catch {
throw new Error(
"Failed to parse decrypted backup — data may be corrupted or the wrong key was used"
)
}
validateBackupJson(parsed)
return parsed
}
/**
* Decrypts the stored backup password if encryption is enabled.
* Returns null if encryption is not enabled or no password is stored.
* Throws on decrypt failure (callers handle errors differently).
*/
export function resolveBackupPassword(
encryptionEnabled: boolean,
encryptedPassword: string | null,
key: Buffer
): string | null {
if (!encryptionEnabled || !encryptedPassword) return null
return decrypt(encryptedPassword, key)
}
// ─── Pruning ──────────────────────────────────────────────────────────────────
export async function pruneOldBackups(retentionCount: number, basePath: string): Promise<number> {
const allStored = await db
.select()
.from(backupHistory)
.where(isNotNull(backupHistory.storagePath))
.orderBy(desc(backupHistory.createdAt))
if (allStored.length <= retentionCount) {
return 0
}
const toDelete = allStored.slice(retentionCount)
for (const row of toDelete) {
if (row.storagePath !== null) {
const resolved = path.resolve(row.storagePath)
const base = path.resolve(basePath)
if (!resolved.startsWith(base + path.sep)) {
log.error(`Backup prune: path ${resolved} is outside base ${base}, skipping file deletion`)
} else {
try {
await unlink(resolved)
} catch (err) {
log.error(err, `Backup prune: failed to delete file ${resolved}`)
}
}
}
}
const idsToDelete = toDelete.map((row) => row.id)
if (idsToDelete.length > 0) {
await db.delete(backupHistory).where(inArray(backupHistory.id, idsToDelete))
}
return idsToDelete.length
}