@softure-ai/backup 0.0.0-stage → 0.1.1
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/CHANGELOG.md +30 -0
- package/LICENSE +21 -0
- package/README.md +243 -2
- package/dist/cli/main.d.ts +3 -0
- package/dist/cli/main.d.ts.map +1 -0
- package/dist/cli/main.js +16 -0
- package/dist/cli/main.js.map +1 -0
- package/dist/cli/run.d.ts +15 -0
- package/dist/cli/run.d.ts.map +1 -0
- package/dist/cli/run.js +442 -0
- package/dist/cli/run.js.map +1 -0
- package/dist/contract.d.ts +41 -0
- package/dist/contract.d.ts.map +1 -0
- package/dist/contract.js +15 -0
- package/dist/contract.js.map +1 -0
- package/dist/index.d.ts +22 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +30 -0
- package/dist/index.js.map +1 -0
- package/dist/messages/en.d.ts +17 -0
- package/dist/messages/en.d.ts.map +1 -0
- package/dist/messages/en.js +17 -0
- package/dist/messages/en.js.map +1 -0
- package/dist/messages/index.d.ts +22 -0
- package/dist/messages/index.d.ts.map +1 -0
- package/dist/messages/index.js +4 -0
- package/dist/messages/index.js.map +1 -0
- package/dist/offsite/config.d.ts +45 -0
- package/dist/offsite/config.d.ts.map +1 -0
- package/dist/offsite/config.js +147 -0
- package/dist/offsite/config.js.map +1 -0
- package/dist/offsite/crypto.d.ts +22 -0
- package/dist/offsite/crypto.d.ts.map +1 -0
- package/dist/offsite/crypto.js +48 -0
- package/dist/offsite/crypto.js.map +1 -0
- package/dist/offsite/dump.d.ts +23 -0
- package/dist/offsite/dump.d.ts.map +1 -0
- package/dist/offsite/dump.js +85 -0
- package/dist/offsite/dump.js.map +1 -0
- package/dist/offsite/index.d.ts +13 -0
- package/dist/offsite/index.d.ts.map +1 -0
- package/dist/offsite/index.js +15 -0
- package/dist/offsite/index.js.map +1 -0
- package/dist/offsite/lifecycle.d.ts +17 -0
- package/dist/offsite/lifecycle.d.ts.map +1 -0
- package/dist/offsite/lifecycle.js +45 -0
- package/dist/offsite/lifecycle.js.map +1 -0
- package/dist/offsite/objects.d.ts +19 -0
- package/dist/offsite/objects.d.ts.map +1 -0
- package/dist/offsite/objects.js +44 -0
- package/dist/offsite/objects.js.map +1 -0
- package/dist/offsite/postgres.d.ts +32 -0
- package/dist/offsite/postgres.d.ts.map +1 -0
- package/dist/offsite/postgres.js +97 -0
- package/dist/offsite/postgres.js.map +1 -0
- package/dist/offsite/record.d.ts +3 -0
- package/dist/offsite/record.d.ts.map +1 -0
- package/dist/offsite/record.js +10 -0
- package/dist/offsite/record.js.map +1 -0
- package/dist/offsite/restore.d.ts +54 -0
- package/dist/offsite/restore.d.ts.map +1 -0
- package/dist/offsite/restore.js +67 -0
- package/dist/offsite/restore.js.map +1 -0
- package/dist/offsite/s3.d.ts +34 -0
- package/dist/offsite/s3.d.ts.map +1 -0
- package/dist/offsite/s3.js +119 -0
- package/dist/offsite/s3.js.map +1 -0
- package/dist/offsite/sigv4.d.ts +19 -0
- package/dist/offsite/sigv4.d.ts.map +1 -0
- package/dist/offsite/sigv4.js +69 -0
- package/dist/offsite/sigv4.js.map +1 -0
- package/dist/offsite/status-sql.d.ts +10 -0
- package/dist/offsite/status-sql.d.ts.map +1 -0
- package/dist/offsite/status-sql.js +37 -0
- package/dist/offsite/status-sql.js.map +1 -0
- package/dist/offsite/upload.d.ts +33 -0
- package/dist/offsite/upload.d.ts.map +1 -0
- package/dist/offsite/upload.js +98 -0
- package/dist/offsite/upload.js.map +1 -0
- package/dist/offsite/verify.d.ts +32 -0
- package/dist/offsite/verify.d.ts.map +1 -0
- package/dist/offsite/verify.js +75 -0
- package/dist/offsite/verify.js.map +1 -0
- package/dist/schema.d.ts +150 -0
- package/dist/schema.d.ts.map +1 -0
- package/dist/schema.js +15 -0
- package/dist/schema.js.map +1 -0
- package/dist/server/index.d.ts +28 -0
- package/dist/server/index.d.ts.map +1 -0
- package/dist/server/index.js +98 -0
- package/dist/server/index.js.map +1 -0
- package/examples/backup-verify.yml +84 -0
- package/migrations/0001_create_runs.sql +21 -0
- package/module.json +12 -0
- package/package.json +73 -4
- package/src/cli/main.ts +16 -0
- package/src/cli/run.ts +441 -0
- package/src/contract.ts +47 -0
- package/src/index.ts +41 -0
- package/src/messages/en.ts +16 -0
- package/src/messages/index.ts +6 -0
- package/src/offsite/config.ts +173 -0
- package/src/offsite/crypto.ts +53 -0
- package/src/offsite/dump.ts +97 -0
- package/src/offsite/index.ts +33 -0
- package/src/offsite/lifecycle.ts +47 -0
- package/src/offsite/objects.ts +54 -0
- package/src/offsite/postgres.ts +115 -0
- package/src/offsite/record.ts +11 -0
- package/src/offsite/restore.ts +108 -0
- package/src/offsite/s3.ts +144 -0
- package/src/offsite/sigv4.ts +84 -0
- package/src/offsite/status-sql.ts +45 -0
- package/src/offsite/upload.ts +116 -0
- package/src/offsite/verify.ts +97 -0
- package/src/schema.ts +17 -0
- package/src/server/index.ts +111 -0
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"en.js","sourceRoot":"","sources":["../../src/messages/en.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,EAAE,GAAG;IAChB,MAAM,EAAE;QACN,EAAE,EAAE,2BAA2B;QAC/B,MAAM,EAAE,wBAAwB;QAChC,cAAc,EAAE,mCAAmC;KACpD;IACD,MAAM,EAAE;QACN,cAAc,EAAE,yDAAyD;QACzE,YAAY,EAAE,sCAAsC;QACpD,cAAc,EAAE,oCAAoC;QACpD,aAAa,EAAE,gEAAgE;QAC/E,aAAa,EAAE,mCAAmC;QAClD,aAAa,EAAE,mCAAmC;QAClD,WAAW,EAAE,mCAAmC;KACjD;CACF,CAAC"}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import { en } from "./en.js";
|
|
2
|
+
export type BackupMessages = typeof en;
|
|
3
|
+
/** The built-in English dictionary; an app passes partial overrides or its own translation per locale. */
|
|
4
|
+
export declare const backupMessages: {
|
|
5
|
+
en: {
|
|
6
|
+
result: {
|
|
7
|
+
ok: string;
|
|
8
|
+
failed: string;
|
|
9
|
+
not_configured: string;
|
|
10
|
+
};
|
|
11
|
+
errors: {
|
|
12
|
+
config_invalid: string;
|
|
13
|
+
file_missing: string;
|
|
14
|
+
encrypt_failed: string;
|
|
15
|
+
upload_denied: string;
|
|
16
|
+
upload_failed: string;
|
|
17
|
+
network_error: string;
|
|
18
|
+
dump_failed: string;
|
|
19
|
+
};
|
|
20
|
+
};
|
|
21
|
+
};
|
|
22
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/messages/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAE,MAAM,SAAS,CAAC;AAE7B,MAAM,MAAM,cAAc,GAAG,OAAO,EAAE,CAAC;AAEvC,0GAA0G;AAC1G,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;CAAS,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/messages/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAE,MAAM,SAAS,CAAC;AAI7B,0GAA0G;AAC1G,MAAM,CAAC,MAAM,cAAc,GAAG,EAAE,EAAE,EAAE,CAAC"}
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
/** The names the nightly upload reads (`.env.prod` on the server). */
|
|
2
|
+
export declare const UPLOAD_ENV_NAMES: readonly ["BACKUP_S3_ENDPOINT", "BACKUP_S3_REGION", "BACKUP_S3_BUCKET", "BACKUP_S3_PREFIX", "BACKUP_S3_ACCESS_KEY_ID", "BACKUP_S3_SECRET_ACCESS_KEY", "BACKUP_AGE_RECIPIENT"];
|
|
3
|
+
/** The names restore, fetch and verify read (the operator's machine or a CI job, never the server). */
|
|
4
|
+
export declare const READ_ENV_NAMES: readonly ["BACKUP_S3_ENDPOINT", "BACKUP_S3_REGION", "BACKUP_S3_BUCKET", "BACKUP_S3_PREFIX", "BACKUP_S3_READ_ACCESS_KEY_ID", "BACKUP_S3_READ_SECRET_ACCESS_KEY"];
|
|
5
|
+
/** The secret names: their values are redacted from every message. */
|
|
6
|
+
export declare const SECRET_ENV_NAMES: readonly ["BACKUP_S3_ACCESS_KEY_ID", "BACKUP_S3_SECRET_ACCESS_KEY", "BACKUP_S3_READ_ACCESS_KEY_ID", "BACKUP_S3_READ_SECRET_ACCESS_KEY"];
|
|
7
|
+
export declare const DEFAULT_REGION = "auto";
|
|
8
|
+
/** Where the objects go: the same for the write and the read side. */
|
|
9
|
+
export interface StoreConfig {
|
|
10
|
+
readonly endpoint: URL;
|
|
11
|
+
readonly region: string;
|
|
12
|
+
readonly bucket: string;
|
|
13
|
+
readonly prefix: string;
|
|
14
|
+
readonly accessKeyId: string;
|
|
15
|
+
readonly secretAccessKey: string;
|
|
16
|
+
}
|
|
17
|
+
export interface UploadConfig {
|
|
18
|
+
readonly store: StoreConfig;
|
|
19
|
+
readonly recipient: string;
|
|
20
|
+
}
|
|
21
|
+
export type ConfigResult<T> = {
|
|
22
|
+
readonly status: "ok";
|
|
23
|
+
readonly config: T;
|
|
24
|
+
} | {
|
|
25
|
+
readonly status: "not_configured";
|
|
26
|
+
} | {
|
|
27
|
+
readonly status: "invalid";
|
|
28
|
+
readonly problems: readonly string[];
|
|
29
|
+
};
|
|
30
|
+
type Env = Readonly<Record<string, string | undefined>>;
|
|
31
|
+
/**
|
|
32
|
+
* The upload settings of the nightly run. `appName` is the default prefix (each app its own folder of a shared
|
|
33
|
+
* bucket); `BACKUP_S3_PREFIX` overrides it. Without `BACKUP_S3_BUCKET` and every other name, not configured.
|
|
34
|
+
*/
|
|
35
|
+
export declare function readUploadConfig(env: Env, appName: string): ConfigResult<UploadConfig>;
|
|
36
|
+
/** The read settings of restore, fetch and verify: the same store with the read token. */
|
|
37
|
+
export declare function readReadConfig(env: Env, appName: string): ConfigResult<StoreConfig>;
|
|
38
|
+
/** The non-empty values of the secret names, for `redactSecrets`. */
|
|
39
|
+
export declare function collectSecrets(env: Env): string[];
|
|
40
|
+
/** The database URLs the CLI reads: their whole text and their password are redacted from every message. */
|
|
41
|
+
export declare const DATABASE_URL_ENV_NAMES: readonly ["BACKUP_DATABASE_URL", "BACKUP_RESTORE_DATABASE_URL", "BACKUP_VERIFY_DATABASE_URL"];
|
|
42
|
+
/** `text` with every secret value replaced by `***`. */
|
|
43
|
+
export declare function redactSecrets(text: string, secrets: readonly string[]): string;
|
|
44
|
+
export {};
|
|
45
|
+
//# sourceMappingURL=config.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../src/offsite/config.ts"],"names":[],"mappings":"AAKA,sEAAsE;AACtE,eAAO,MAAM,gBAAgB,YAC3B,oBAAoB,EACpB,kBAAkB,EAClB,kBAAkB,EAClB,kBAAkB,EAClB,yBAAyB,EACzB,6BAA6B,EAC7B,sBAAsB,CACd,CAAC;AAEX,uGAAuG;AACvG,eAAO,MAAM,cAAc,YACzB,oBAAoB,EACpB,kBAAkB,EAClB,kBAAkB,EAClB,kBAAkB,EAClB,8BAA8B,EAC9B,kCAAkC,CAC1B,CAAC;AAEX,sEAAsE;AACtE,eAAO,MAAM,gBAAgB,YAC3B,yBAAyB,EACzB,6BAA6B,EAC7B,8BAA8B,EAC9B,kCAAkC,CAC1B,CAAC;AAEX,eAAO,MAAM,cAAc,SAAS,CAAC;AASrC,sEAAsE;AACtE,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,QAAQ,EAAE,GAAG,CAAC;IACvB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;CAClC;AAED,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,KAAK,EAAE,WAAW,CAAC;IAC5B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,MAAM,YAAY,CAAC,CAAC,IACtB;IAAE,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC;IAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAA;CAAE,GAC7C;IAAE,QAAQ,CAAC,MAAM,EAAE,gBAAgB,CAAA;CAAE,GACrC;IAAE,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAC;IAAC,QAAQ,CAAC,QAAQ,EAAE,SAAS,MAAM,EAAE,CAAA;CAAE,CAAC;AAEzE,KAAK,GAAG,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC,CAAC;AAqDxD;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,GAAG,YAAY,CAAC,YAAY,CAAC,CAYtF;AAED,0FAA0F;AAC1F,wBAAgB,cAAc,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,GAAG,YAAY,CAAC,WAAW,CAAC,CASnF;AAED,qEAAqE;AACrE,wBAAgB,cAAc,CAAC,GAAG,EAAE,GAAG,GAAG,MAAM,EAAE,CAIjD;AAED,4GAA4G;AAC5G,eAAO,MAAM,sBAAsB,YAAI,qBAAqB,EAAE,6BAA6B,EAAE,4BAA4B,CAAU,CAAC;AAapI,wDAAwD;AACxD,wBAAgB,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,SAAS,MAAM,EAAE,GAAG,MAAM,CAI9E"}
|
|
@@ -0,0 +1,147 @@
|
|
|
1
|
+
// The off-site settings, read only from the environment and validated with zod. A host that sets none of the names
|
|
2
|
+
// is "not configured" (the step is skipped, never failed); one that sets some gets a list of what is missing or
|
|
3
|
+
// wrong, never a value. Two tokens: the nightly upload needs only a write token, restore and verify a read one.
|
|
4
|
+
import { z } from "zod";
|
|
5
|
+
/** The names the nightly upload reads (`.env.prod` on the server). */
|
|
6
|
+
export const UPLOAD_ENV_NAMES = [
|
|
7
|
+
"BACKUP_S3_ENDPOINT",
|
|
8
|
+
"BACKUP_S3_REGION",
|
|
9
|
+
"BACKUP_S3_BUCKET",
|
|
10
|
+
"BACKUP_S3_PREFIX",
|
|
11
|
+
"BACKUP_S3_ACCESS_KEY_ID",
|
|
12
|
+
"BACKUP_S3_SECRET_ACCESS_KEY",
|
|
13
|
+
"BACKUP_AGE_RECIPIENT",
|
|
14
|
+
];
|
|
15
|
+
/** The names restore, fetch and verify read (the operator's machine or a CI job, never the server). */
|
|
16
|
+
export const READ_ENV_NAMES = [
|
|
17
|
+
"BACKUP_S3_ENDPOINT",
|
|
18
|
+
"BACKUP_S3_REGION",
|
|
19
|
+
"BACKUP_S3_BUCKET",
|
|
20
|
+
"BACKUP_S3_PREFIX",
|
|
21
|
+
"BACKUP_S3_READ_ACCESS_KEY_ID",
|
|
22
|
+
"BACKUP_S3_READ_SECRET_ACCESS_KEY",
|
|
23
|
+
];
|
|
24
|
+
/** The secret names: their values are redacted from every message. */
|
|
25
|
+
export const SECRET_ENV_NAMES = [
|
|
26
|
+
"BACKUP_S3_ACCESS_KEY_ID",
|
|
27
|
+
"BACKUP_S3_SECRET_ACCESS_KEY",
|
|
28
|
+
"BACKUP_S3_READ_ACCESS_KEY_ID",
|
|
29
|
+
"BACKUP_S3_READ_SECRET_ACCESS_KEY",
|
|
30
|
+
];
|
|
31
|
+
export const DEFAULT_REGION = "auto";
|
|
32
|
+
/** A prefix is path segments of lower-case letters, digits, `.`, `_` and `-`, so a key can never climb out of it. */
|
|
33
|
+
const PREFIX_PATTERN = /^[a-z0-9][a-z0-9._-]*(\/[a-z0-9][a-z0-9._-]*)*$/;
|
|
34
|
+
/** S3 bucket names: 3 to 63 lower-case letters, digits, `.` and `-`. */
|
|
35
|
+
const BUCKET_PATTERN = /^[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$/;
|
|
36
|
+
const REGION_PATTERN = /^[a-z0-9-]{1,32}$/;
|
|
37
|
+
/** An age X25519 recipient (`age1` and 58 bech32 characters) or a hybrid post-quantum one (`age1pq1…`). */
|
|
38
|
+
const RECIPIENT_PATTERN = /^age1(pq1)?[02-9ac-hj-np-z]{40,}$/;
|
|
39
|
+
const endpointSchema = z
|
|
40
|
+
.string()
|
|
41
|
+
.refine((value) => URL.canParse(value), "is not a URL")
|
|
42
|
+
.transform((value) => new URL(value))
|
|
43
|
+
.refine((url) => url.protocol === "https:" || url.protocol === "http:", "must start with https:// (or http:// for a local MinIO)")
|
|
44
|
+
.refine((url) => url.username === "" && url.password === "", "must not carry a user or password")
|
|
45
|
+
.refine((url) => url.search === "" && url.hash === "", "must not carry a query or fragment");
|
|
46
|
+
function storeSchema(keyName, secretName) {
|
|
47
|
+
return z.object({
|
|
48
|
+
BACKUP_S3_ENDPOINT: endpointSchema,
|
|
49
|
+
BACKUP_S3_REGION: z.string().regex(REGION_PATTERN, "is not a region name").default(DEFAULT_REGION),
|
|
50
|
+
BACKUP_S3_BUCKET: z.string().regex(BUCKET_PATTERN, "is not an S3 bucket name"),
|
|
51
|
+
BACKUP_S3_PREFIX: z.string().regex(PREFIX_PATTERN, "is not a key prefix (lower-case path segments)").optional(),
|
|
52
|
+
[keyName]: z.string().min(1, "is empty").max(256, "is too long"),
|
|
53
|
+
[secretName]: z.string().min(1, "is empty").max(256, "is too long"),
|
|
54
|
+
});
|
|
55
|
+
}
|
|
56
|
+
/** Unset and empty values count as unset; values are trimmed of surrounding blanks a secret store may add. */
|
|
57
|
+
function readNames(env, names) {
|
|
58
|
+
const values = {};
|
|
59
|
+
for (const name of names) {
|
|
60
|
+
const value = env[name]?.trim();
|
|
61
|
+
if (value !== undefined && value !== "")
|
|
62
|
+
values[name] = value;
|
|
63
|
+
}
|
|
64
|
+
return values;
|
|
65
|
+
}
|
|
66
|
+
function describeIssues(error) {
|
|
67
|
+
return error.issues.map((issue) => {
|
|
68
|
+
const name = String(issue.path[0] ?? "configuration");
|
|
69
|
+
return issue.code === "invalid_type" ? `${name} is not set` : `${name} ${issue.message}`;
|
|
70
|
+
});
|
|
71
|
+
}
|
|
72
|
+
function toStore(values, keyName, secretName, defaultPrefix) {
|
|
73
|
+
return {
|
|
74
|
+
endpoint: values.BACKUP_S3_ENDPOINT,
|
|
75
|
+
region: values.BACKUP_S3_REGION,
|
|
76
|
+
bucket: values.BACKUP_S3_BUCKET,
|
|
77
|
+
prefix: values.BACKUP_S3_PREFIX ?? defaultPrefix,
|
|
78
|
+
accessKeyId: values[keyName],
|
|
79
|
+
secretAccessKey: values[secretName],
|
|
80
|
+
};
|
|
81
|
+
}
|
|
82
|
+
function checkPrefix(prefix) {
|
|
83
|
+
return PREFIX_PATTERN.test(prefix) ? null : `the app name ${JSON.stringify(prefix)} is not a key prefix; set BACKUP_S3_PREFIX`;
|
|
84
|
+
}
|
|
85
|
+
/**
|
|
86
|
+
* The upload settings of the nightly run. `appName` is the default prefix (each app its own folder of a shared
|
|
87
|
+
* bucket); `BACKUP_S3_PREFIX` overrides it. Without `BACKUP_S3_BUCKET` and every other name, not configured.
|
|
88
|
+
*/
|
|
89
|
+
export function readUploadConfig(env, appName) {
|
|
90
|
+
const values = readNames(env, UPLOAD_ENV_NAMES);
|
|
91
|
+
if (Object.keys(values).length === 0)
|
|
92
|
+
return { status: "not_configured" };
|
|
93
|
+
const schema = storeSchema("BACKUP_S3_ACCESS_KEY_ID", "BACKUP_S3_SECRET_ACCESS_KEY").extend({
|
|
94
|
+
BACKUP_AGE_RECIPIENT: z.string().regex(RECIPIENT_PATTERN, "is not an age public key (age1…)"),
|
|
95
|
+
});
|
|
96
|
+
const parsed = schema.safeParse(values);
|
|
97
|
+
if (!parsed.success)
|
|
98
|
+
return { status: "invalid", problems: describeIssues(parsed.error) };
|
|
99
|
+
const store = toStore(parsed.data, "BACKUP_S3_ACCESS_KEY_ID", "BACKUP_S3_SECRET_ACCESS_KEY", appName);
|
|
100
|
+
const prefixProblem = checkPrefix(store.prefix);
|
|
101
|
+
if (prefixProblem !== null)
|
|
102
|
+
return { status: "invalid", problems: [prefixProblem] };
|
|
103
|
+
return { status: "ok", config: { store, recipient: values.BACKUP_AGE_RECIPIENT ?? "" } };
|
|
104
|
+
}
|
|
105
|
+
/** The read settings of restore, fetch and verify: the same store with the read token. */
|
|
106
|
+
export function readReadConfig(env, appName) {
|
|
107
|
+
const values = readNames(env, READ_ENV_NAMES);
|
|
108
|
+
if (Object.keys(values).length === 0)
|
|
109
|
+
return { status: "not_configured" };
|
|
110
|
+
const parsed = storeSchema("BACKUP_S3_READ_ACCESS_KEY_ID", "BACKUP_S3_READ_SECRET_ACCESS_KEY").safeParse(values);
|
|
111
|
+
if (!parsed.success)
|
|
112
|
+
return { status: "invalid", problems: describeIssues(parsed.error) };
|
|
113
|
+
const store = toStore(parsed.data, "BACKUP_S3_READ_ACCESS_KEY_ID", "BACKUP_S3_READ_SECRET_ACCESS_KEY", appName);
|
|
114
|
+
const prefixProblem = checkPrefix(store.prefix);
|
|
115
|
+
if (prefixProblem !== null)
|
|
116
|
+
return { status: "invalid", problems: [prefixProblem] };
|
|
117
|
+
return { status: "ok", config: store };
|
|
118
|
+
}
|
|
119
|
+
/** The non-empty values of the secret names, for `redactSecrets`. */
|
|
120
|
+
export function collectSecrets(env) {
|
|
121
|
+
const values = SECRET_ENV_NAMES.map((name) => env[name]?.trim() ?? "");
|
|
122
|
+
for (const name of DATABASE_URL_ENV_NAMES)
|
|
123
|
+
values.push(...readUrlSecrets(env[name]));
|
|
124
|
+
return values.filter((value) => value.length >= 4);
|
|
125
|
+
}
|
|
126
|
+
/** The database URLs the CLI reads: their whole text and their password are redacted from every message. */
|
|
127
|
+
export const DATABASE_URL_ENV_NAMES = ["BACKUP_DATABASE_URL", "BACKUP_RESTORE_DATABASE_URL", "BACKUP_VERIFY_DATABASE_URL"];
|
|
128
|
+
function readUrlSecrets(value) {
|
|
129
|
+
const url = value?.trim() ?? "";
|
|
130
|
+
if (url === "")
|
|
131
|
+
return [];
|
|
132
|
+
try {
|
|
133
|
+
const password = decodeURIComponent(new URL(url).password);
|
|
134
|
+
return password === "" ? [url] : [url, password];
|
|
135
|
+
}
|
|
136
|
+
catch {
|
|
137
|
+
return [url];
|
|
138
|
+
}
|
|
139
|
+
}
|
|
140
|
+
/** `text` with every secret value replaced by `***`. */
|
|
141
|
+
export function redactSecrets(text, secrets) {
|
|
142
|
+
let redacted = text;
|
|
143
|
+
for (const secret of secrets)
|
|
144
|
+
redacted = redacted.split(secret).join("***");
|
|
145
|
+
return redacted;
|
|
146
|
+
}
|
|
147
|
+
//# sourceMappingURL=config.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"config.js","sourceRoot":"","sources":["../../src/offsite/config.ts"],"names":[],"mappings":"AAAA,mHAAmH;AACnH,gHAAgH;AAChH,gHAAgH;AAChH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,sEAAsE;AACtE,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC9B,oBAAoB;IACpB,kBAAkB;IAClB,kBAAkB;IAClB,kBAAkB;IAClB,yBAAyB;IACzB,6BAA6B;IAC7B,sBAAsB;CACd,CAAC;AAEX,uGAAuG;AACvG,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,oBAAoB;IACpB,kBAAkB;IAClB,kBAAkB;IAClB,kBAAkB;IAClB,8BAA8B;IAC9B,kCAAkC;CAC1B,CAAC;AAEX,sEAAsE;AACtE,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC9B,yBAAyB;IACzB,6BAA6B;IAC7B,8BAA8B;IAC9B,kCAAkC;CAC1B,CAAC;AAEX,MAAM,CAAC,MAAM,cAAc,GAAG,MAAM,CAAC;AACrC,qHAAqH;AACrH,MAAM,cAAc,GAAG,iDAAiD,CAAC;AACzE,wEAAwE;AACxE,MAAM,cAAc,GAAG,oCAAoC,CAAC;AAC5D,MAAM,cAAc,GAAG,mBAAmB,CAAC;AAC3C,2GAA2G;AAC3G,MAAM,iBAAiB,GAAG,mCAAmC,CAAC;AAwB9D,MAAM,cAAc,GAAG,CAAC;KACrB,MAAM,EAAE;KACR,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,cAAc,CAAC;KACtD,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC;KACpC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,KAAK,QAAQ,IAAI,GAAG,CAAC,QAAQ,KAAK,OAAO,EAAE,yDAAyD,CAAC;KACjI,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,KAAK,EAAE,IAAI,GAAG,CAAC,QAAQ,KAAK,EAAE,EAAE,mCAAmC,CAAC;KAChG,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,KAAK,EAAE,IAAI,GAAG,CAAC,IAAI,KAAK,EAAE,EAAE,oCAAoC,CAAC,CAAC;AAE/F,SAAS,WAAW,CAAC,OAAe,EAAE,UAAkB;IACtD,OAAO,CAAC,CAAC,MAAM,CAAC;QACd,kBAAkB,EAAE,cAAc;QAClC,gBAAgB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,cAAc,EAAE,sBAAsB,CAAC,CAAC,OAAO,CAAC,cAAc,CAAC;QAClG,gBAAgB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,cAAc,EAAE,0BAA0B,CAAC;QAC9E,gBAAgB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,cAAc,EAAE,gDAAgD,CAAC,CAAC,QAAQ,EAAE;QAC/G,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE,aAAa,CAAC;QAChE,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE,aAAa,CAAC;KACpE,CAAC,CAAC;AACL,CAAC;AAED,8GAA8G;AAC9G,SAAS,SAAS,CAAC,GAAQ,EAAE,KAAwB;IACnD,MAAM,MAAM,GAA2B,EAAE,CAAC;IAC1C,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,MAAM,KAAK,GAAG,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,CAAC;QAChC,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,EAAE;YAAE,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;IAChE,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,cAAc,CAAC,KAAiB;IACvC,OAAO,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;QAChC,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,eAAe,CAAC,CAAC;QACtD,OAAO,KAAK,CAAC,IAAI,KAAK,cAAc,CAAC,CAAC,CAAC,GAAG,IAAI,aAAa,CAAC,CAAC,CAAC,GAAG,IAAI,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;IAC3F,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAS,OAAO,CAAC,MAA+B,EAAE,OAAe,EAAE,UAAkB,EAAE,aAAqB;IAC1G,OAAO;QACL,QAAQ,EAAE,MAAM,CAAC,kBAAyB;QAC1C,MAAM,EAAE,MAAM,CAAC,gBAA0B;QACzC,MAAM,EAAE,MAAM,CAAC,gBAA0B;QACzC,MAAM,EAAG,MAAM,CAAC,gBAAuC,IAAI,aAAa;QACxE,WAAW,EAAE,MAAM,CAAC,OAAO,CAAW;QACtC,eAAe,EAAE,MAAM,CAAC,UAAU,CAAW;KAC9C,CAAC;AACJ,CAAC;AAED,SAAS,WAAW,CAAC,MAAc;IACjC,OAAO,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,gBAAgB,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,4CAA4C,CAAC;AACjI,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,gBAAgB,CAAC,GAAQ,EAAE,OAAe;IACxD,MAAM,MAAM,GAAG,SAAS,CAAC,GAAG,EAAE,gBAAgB,CAAC,CAAC;IAChD,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,EAAE,MAAM,EAAE,gBAAgB,EAAE,CAAC;IAC1E,MAAM,MAAM,GAAG,WAAW,CAAC,yBAAyB,EAAE,6BAA6B,CAAC,CAAC,MAAM,CAAC;QAC1F,oBAAoB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,iBAAiB,EAAE,kCAAkC,CAAC;KAC9F,CAAC,CAAC;IACH,MAAM,MAAM,GAAG,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IACxC,IAAI,CAAC,MAAM,CAAC,OAAO;QAAE,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,cAAc,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;IAC1F,MAAM,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,yBAAyB,EAAE,6BAA6B,EAAE,OAAO,CAAC,CAAC;IACtG,MAAM,aAAa,GAAG,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAChD,IAAI,aAAa,KAAK,IAAI;QAAE,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC,aAAa,CAAC,EAAE,CAAC;IACpF,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,CAAC,oBAAoB,IAAI,EAAE,EAAE,EAAE,CAAC;AAC3F,CAAC;AAED,0FAA0F;AAC1F,MAAM,UAAU,cAAc,CAAC,GAAQ,EAAE,OAAe;IACtD,MAAM,MAAM,GAAG,SAAS,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC;IAC9C,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,EAAE,MAAM,EAAE,gBAAgB,EAAE,CAAC;IAC1E,MAAM,MAAM,GAAG,WAAW,CAAC,8BAA8B,EAAE,kCAAkC,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IACjH,IAAI,CAAC,MAAM,CAAC,OAAO;QAAE,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,cAAc,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;IAC1F,MAAM,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,8BAA8B,EAAE,kCAAkC,EAAE,OAAO,CAAC,CAAC;IAChH,MAAM,aAAa,GAAG,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAChD,IAAI,aAAa,KAAK,IAAI;QAAE,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC,aAAa,CAAC,EAAE,CAAC;IACpF,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC;AACzC,CAAC;AAED,qEAAqE;AACrE,MAAM,UAAU,cAAc,CAAC,GAAQ;IACrC,MAAM,MAAM,GAAG,gBAAgB,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;IACvE,KAAK,MAAM,IAAI,IAAI,sBAAsB;QAAE,MAAM,CAAC,IAAI,CAAC,GAAG,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACrF,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,IAAI,CAAC,CAAC,CAAC;AACrD,CAAC;AAED,4GAA4G;AAC5G,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,qBAAqB,EAAE,6BAA6B,EAAE,4BAA4B,CAAU,CAAC;AAEpI,SAAS,cAAc,CAAC,KAAyB;IAC/C,MAAM,GAAG,GAAG,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;IAChC,IAAI,GAAG,KAAK,EAAE;QAAE,OAAO,EAAE,CAAC;IAC1B,IAAI,CAAC;QACH,MAAM,QAAQ,GAAG,kBAAkB,CAAC,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,CAAC;QAC3D,OAAO,QAAQ,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;IACnD,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,CAAC,GAAG,CAAC,CAAC;IACf,CAAC;AACH,CAAC;AAED,wDAAwD;AACxD,MAAM,UAAU,aAAa,CAAC,IAAY,EAAE,OAA0B;IACpE,IAAI,QAAQ,GAAG,IAAI,CAAC;IACpB,KAAK,MAAM,MAAM,IAAI,OAAO;QAAE,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC5E,OAAO,QAAQ,CAAC;AAClB,CAAC"}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import { Writable } from "node:stream";
|
|
2
|
+
/** Encrypts the file at `source` to `recipient` into `target`. */
|
|
3
|
+
export declare function encryptFile(source: string, target: string, recipient: string): Promise<void>;
|
|
4
|
+
/** A stream of the plaintext of an age `stream`, decrypted with `identities`. */
|
|
5
|
+
export declare function decryptStream(stream: ReadableStream<Uint8Array>, identities: readonly string[]): Promise<ReadableStream<Uint8Array>>;
|
|
6
|
+
/** Writes a web stream to a file, owner read and write only. */
|
|
7
|
+
export declare function writeStreamToFile(stream: ReadableStream<Uint8Array>, path: string): Promise<void>;
|
|
8
|
+
/** Pipes a web stream into a Node writable (a child's stdin). */
|
|
9
|
+
export declare function pipeStreamTo(stream: ReadableStream<Uint8Array>, target: Writable): Promise<void>;
|
|
10
|
+
export type IdentitiesResult = {
|
|
11
|
+
ok: true;
|
|
12
|
+
identities: string[];
|
|
13
|
+
} | {
|
|
14
|
+
ok: false;
|
|
15
|
+
problem: string;
|
|
16
|
+
};
|
|
17
|
+
/**
|
|
18
|
+
* The identities of an age key file's text (the `age-keygen` output: comment lines and one or more keys). The
|
|
19
|
+
* problem never repeats the text.
|
|
20
|
+
*/
|
|
21
|
+
export declare function parseIdentities(text: string): IdentitiesResult;
|
|
22
|
+
//# sourceMappingURL=crypto.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"crypto.d.ts","sourceRoot":"","sources":["../../src/offsite/crypto.ts"],"names":[],"mappings":"AAIA,OAAO,EAAY,QAAQ,EAAE,MAAM,aAAa,CAAC;AAMjD,kEAAkE;AAClE,wBAAsB,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAMlG;AAED,iFAAiF;AACjF,wBAAsB,aAAa,CAAC,MAAM,EAAE,cAAc,CAAC,UAAU,CAAC,EAAE,UAAU,EAAE,SAAS,MAAM,EAAE,GAAG,OAAO,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC,CAI1I;AAED,gEAAgE;AAChE,wBAAsB,iBAAiB,CAAC,MAAM,EAAE,cAAc,CAAC,UAAU,CAAC,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAEvG;AAED,iEAAiE;AACjE,wBAAsB,YAAY,CAAC,MAAM,EAAE,cAAc,CAAC,UAAU,CAAC,EAAE,MAAM,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,CAEtG;AAED,MAAM,MAAM,gBAAgB,GAAG;IAAE,EAAE,EAAE,IAAI,CAAC;IAAC,UAAU,EAAE,MAAM,EAAE,CAAA;CAAE,GAAG;IAAE,EAAE,EAAE,KAAK,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,CAAC;AAEnG;;;GAGG;AACH,wBAAgB,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,gBAAgB,CAU9D"}
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
// age encryption with the pure-JS implementation by the age author (interoperable with the `age` command): the
|
|
2
|
+
// server holds only the public key (`age1…`); the private key (`AGE-SECRET-KEY-1…`) is read at run time from a file
|
|
3
|
+
// or stdin, never from an argument.
|
|
4
|
+
import { createReadStream, createWriteStream } from "node:fs";
|
|
5
|
+
import { Readable, Writable } from "node:stream";
|
|
6
|
+
import { pipeline } from "node:stream/promises";
|
|
7
|
+
import { Decrypter, Encrypter } from "age-encryption";
|
|
8
|
+
const IDENTITY_PATTERN = /^AGE-SECRET-KEY-(PQ-)?1[0-9A-Z]+$/;
|
|
9
|
+
/** Encrypts the file at `source` to `recipient` into `target`. */
|
|
10
|
+
export async function encryptFile(source, target, recipient) {
|
|
11
|
+
const encrypter = new Encrypter();
|
|
12
|
+
encrypter.addRecipient(recipient);
|
|
13
|
+
const input = Readable.toWeb(createReadStream(source));
|
|
14
|
+
const encrypted = await encrypter.encrypt(input);
|
|
15
|
+
await pipeline(Readable.fromWeb(encrypted), createWriteStream(target, { mode: 0o600 }));
|
|
16
|
+
}
|
|
17
|
+
/** A stream of the plaintext of an age `stream`, decrypted with `identities`. */
|
|
18
|
+
export async function decryptStream(stream, identities) {
|
|
19
|
+
const decrypter = new Decrypter();
|
|
20
|
+
for (const identity of identities)
|
|
21
|
+
decrypter.addIdentity(identity);
|
|
22
|
+
return decrypter.decrypt(stream);
|
|
23
|
+
}
|
|
24
|
+
/** Writes a web stream to a file, owner read and write only. */
|
|
25
|
+
export async function writeStreamToFile(stream, path) {
|
|
26
|
+
await pipeline(Readable.fromWeb(stream), createWriteStream(path, { mode: 0o600 }));
|
|
27
|
+
}
|
|
28
|
+
/** Pipes a web stream into a Node writable (a child's stdin). */
|
|
29
|
+
export async function pipeStreamTo(stream, target) {
|
|
30
|
+
await pipeline(Readable.fromWeb(stream), target);
|
|
31
|
+
}
|
|
32
|
+
/**
|
|
33
|
+
* The identities of an age key file's text (the `age-keygen` output: comment lines and one or more keys). The
|
|
34
|
+
* problem never repeats the text.
|
|
35
|
+
*/
|
|
36
|
+
export function parseIdentities(text) {
|
|
37
|
+
const identities = text
|
|
38
|
+
.split(/\r?\n/)
|
|
39
|
+
.map((line) => line.trim())
|
|
40
|
+
.filter((line) => line !== "" && !line.startsWith("#"));
|
|
41
|
+
if (identities.length === 0)
|
|
42
|
+
return { ok: false, problem: "the identity holds no AGE-SECRET-KEY-1… line" };
|
|
43
|
+
if (!identities.every((line) => IDENTITY_PATTERN.test(line))) {
|
|
44
|
+
return { ok: false, problem: "the identity has a line that is not an age secret key (AGE-SECRET-KEY-1…)" };
|
|
45
|
+
}
|
|
46
|
+
return { ok: true, identities };
|
|
47
|
+
}
|
|
48
|
+
//# sourceMappingURL=crypto.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"crypto.js","sourceRoot":"","sources":["../../src/offsite/crypto.ts"],"names":[],"mappings":"AAAA,+GAA+G;AAC/G,oHAAoH;AACpH,oCAAoC;AACpC,OAAO,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC;AAC9D,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACjD,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAEtD,MAAM,gBAAgB,GAAG,mCAAmC,CAAC;AAE7D,kEAAkE;AAClE,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,MAAc,EAAE,MAAc,EAAE,SAAiB;IACjF,MAAM,SAAS,GAAG,IAAI,SAAS,EAAE,CAAC;IAClC,SAAS,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;IAClC,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAA+B,CAAC;IACrF,MAAM,SAAS,GAAG,MAAM,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACjD,MAAM,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,SAAiE,CAAC,EAAE,iBAAiB,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;AAClJ,CAAC;AAED,iFAAiF;AACjF,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,MAAkC,EAAE,UAA6B;IACnG,MAAM,SAAS,GAAG,IAAI,SAAS,EAAE,CAAC;IAClC,KAAK,MAAM,QAAQ,IAAI,UAAU;QAAE,SAAS,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;IACnE,OAAO,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;AACnC,CAAC;AAED,gEAAgE;AAChE,MAAM,CAAC,KAAK,UAAU,iBAAiB,CAAC,MAAkC,EAAE,IAAY;IACtF,MAAM,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,MAA8D,CAAC,EAAE,iBAAiB,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;AAC7I,CAAC;AAED,iEAAiE;AACjE,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,MAAkC,EAAE,MAAgB;IACrF,MAAM,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,MAA8D,CAAC,EAAE,MAAM,CAAC,CAAC;AAC3G,CAAC;AAID;;;GAGG;AACH,MAAM,UAAU,eAAe,CAAC,IAAY;IAC1C,MAAM,UAAU,GAAG,IAAI;SACpB,KAAK,CAAC,OAAO,CAAC;SACd,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;SAC1B,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC;IAC1D,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,8CAA8C,EAAE,CAAC;IAC3G,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;QAC7D,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,2EAA2E,EAAE,CAAC;IAC7G,CAAC;IACD,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC;AAClC,CAAC"}
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
export interface PgDumpOptions {
|
|
2
|
+
readonly url: string;
|
|
3
|
+
/** The backup file to write, e.g. `<dir>/db-20261117T031700Z.dump`. */
|
|
4
|
+
readonly out: string;
|
|
5
|
+
/** Tables whose rows the dump leaves out (deploy.json `database.excludeTableData`). */
|
|
6
|
+
readonly excludeTableData: readonly string[];
|
|
7
|
+
/** The executable: a name on PATH or a path. */
|
|
8
|
+
readonly pgDump: string;
|
|
9
|
+
readonly env: Readonly<Record<string, string | undefined>>;
|
|
10
|
+
}
|
|
11
|
+
export type PgDumpResult = {
|
|
12
|
+
ok: true;
|
|
13
|
+
bytes: number;
|
|
14
|
+
} | {
|
|
15
|
+
ok: false;
|
|
16
|
+
problem: string;
|
|
17
|
+
};
|
|
18
|
+
/** `db-<YYYYMMDD>T<HHMMSS>Z.dump`, the deploy's own backup name, so the off-site keys sort with a VPS's. */
|
|
19
|
+
export declare function buildDumpFileName(at: Date): string;
|
|
20
|
+
/** The arguments of the dump: custom format, no password prompt, the excluded tables' rows left out. */
|
|
21
|
+
export declare function buildPgDumpArgs(excludeTableData: readonly string[]): string[];
|
|
22
|
+
export declare function runPgDump(options: PgDumpOptions): Promise<PgDumpResult>;
|
|
23
|
+
//# sourceMappingURL=dump.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"dump.d.ts","sourceRoot":"","sources":["../../src/offsite/dump.ts"],"names":[],"mappings":"AAYA,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,uEAAuE;IACvE,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,uFAAuF;IACvF,QAAQ,CAAC,gBAAgB,EAAE,SAAS,MAAM,EAAE,CAAC;IAC7C,gDAAgD;IAChD,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,GAAG,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC,CAAC;CAC5D;AAED,MAAM,MAAM,YAAY,GAAG;IAAE,EAAE,EAAE,IAAI,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,GAAG;IAAE,EAAE,EAAE,KAAK,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,CAAC;AAExF,4GAA4G;AAC5G,wBAAgB,iBAAiB,CAAC,EAAE,EAAE,IAAI,GAAG,MAAM,CAGlD;AAED,wGAAwG;AACxG,wBAAgB,eAAe,CAAC,gBAAgB,EAAE,SAAS,MAAM,EAAE,GAAG,MAAM,EAAE,CAE7E;AAED,wBAAsB,SAAS,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,YAAY,CAAC,CA4D7E"}
|
|
@@ -0,0 +1,85 @@
|
|
|
1
|
+
// The night's dump for a host without a server (a Cloudflare app's scheduled workflow): `pg_dump --format=custom` of
|
|
2
|
+
// the database at a URL, to stdout, into a hidden file that becomes the backup file only once pg_dump exited 0, so a
|
|
3
|
+
// dump cut short is never uploaded. The URL goes in as libpq variables, never as an argument. Writing to stdout lets
|
|
4
|
+
// `BACKUP_PG_DUMP` be a `docker run postgres:<major> pg_dump` wrapper of the server's major version.
|
|
5
|
+
import { spawn } from "node:child_process";
|
|
6
|
+
import { createWriteStream, renameSync, rmSync } from "node:fs";
|
|
7
|
+
import { basename, dirname, join } from "node:path";
|
|
8
|
+
import { toLibpqEnv } from "@softure-ai/deploy";
|
|
9
|
+
const MAX_STDERR = 4000;
|
|
10
|
+
const PASSED_ENV = ["PATH", "HOME", "LANG", "DOCKER_HOST", "DOCKER_CONFIG"];
|
|
11
|
+
/** `db-<YYYYMMDD>T<HHMMSS>Z.dump`, the deploy's own backup name, so the off-site keys sort with a VPS's. */
|
|
12
|
+
export function buildDumpFileName(at) {
|
|
13
|
+
const stamp = at.toISOString().replace(/[-:]/g, "").replace(/\.\d{3}Z$/, "Z");
|
|
14
|
+
return `db-${stamp}.dump`;
|
|
15
|
+
}
|
|
16
|
+
/** The arguments of the dump: custom format, no password prompt, the excluded tables' rows left out. */
|
|
17
|
+
export function buildPgDumpArgs(excludeTableData) {
|
|
18
|
+
return ["--format=custom", "--no-password", ...excludeTableData.map((table) => `--exclude-table-data=${table}`)];
|
|
19
|
+
}
|
|
20
|
+
export async function runPgDump(options) {
|
|
21
|
+
const libpq = toLibpqEnv(options.url);
|
|
22
|
+
if (!libpq.ok)
|
|
23
|
+
return { ok: false, problem: libpq.problem };
|
|
24
|
+
const env = { ...libpq.env };
|
|
25
|
+
for (const name of PASSED_ENV) {
|
|
26
|
+
const value = options.env[name];
|
|
27
|
+
if (value !== undefined)
|
|
28
|
+
env[name] = value;
|
|
29
|
+
}
|
|
30
|
+
const partial = join(dirname(options.out), `.partial-${basename(options.out)}`);
|
|
31
|
+
const file = createWriteStream(partial, { mode: 0o600 });
|
|
32
|
+
const fileOpened = new Promise((resolve, reject) => {
|
|
33
|
+
file.once("open", () => {
|
|
34
|
+
resolve();
|
|
35
|
+
});
|
|
36
|
+
file.once("error", reject);
|
|
37
|
+
});
|
|
38
|
+
try {
|
|
39
|
+
await fileOpened;
|
|
40
|
+
}
|
|
41
|
+
catch (error) {
|
|
42
|
+
return { ok: false, problem: `cannot write ${partial} (${error instanceof Error ? error.message : String(error)})` };
|
|
43
|
+
}
|
|
44
|
+
const child = spawn(options.pgDump, buildPgDumpArgs(options.excludeTableData), { env, stdio: ["ignore", "pipe", "pipe"] });
|
|
45
|
+
let stderr = "";
|
|
46
|
+
let bytes = 0;
|
|
47
|
+
child.stderr.on("data", (chunk) => {
|
|
48
|
+
stderr = (stderr + chunk.toString("utf8")).slice(-MAX_STDERR);
|
|
49
|
+
});
|
|
50
|
+
child.stdout.on("data", (chunk) => {
|
|
51
|
+
bytes += chunk.length;
|
|
52
|
+
});
|
|
53
|
+
child.stdout.pipe(file);
|
|
54
|
+
const written = new Promise((resolve, reject) => {
|
|
55
|
+
file.once("finish", resolve);
|
|
56
|
+
file.once("error", reject);
|
|
57
|
+
});
|
|
58
|
+
const exited = new Promise((resolve, reject) => {
|
|
59
|
+
child.once("error", reject);
|
|
60
|
+
child.once("close", (code) => {
|
|
61
|
+
resolve(code);
|
|
62
|
+
});
|
|
63
|
+
});
|
|
64
|
+
let code;
|
|
65
|
+
try {
|
|
66
|
+
code = await exited;
|
|
67
|
+
await written;
|
|
68
|
+
}
|
|
69
|
+
catch (error) {
|
|
70
|
+
file.destroy();
|
|
71
|
+
rmSync(partial, { force: true });
|
|
72
|
+
return { ok: false, problem: `cannot run ${options.pgDump} (${error instanceof Error ? error.message : String(error)})` };
|
|
73
|
+
}
|
|
74
|
+
if (code !== 0) {
|
|
75
|
+
rmSync(partial, { force: true });
|
|
76
|
+
return { ok: false, problem: `pg_dump exited with ${String(code)}: ${stderr.trim().split("\n").slice(-3).join(" / ")}` };
|
|
77
|
+
}
|
|
78
|
+
if (bytes === 0) {
|
|
79
|
+
rmSync(partial, { force: true });
|
|
80
|
+
return { ok: false, problem: "pg_dump wrote nothing" };
|
|
81
|
+
}
|
|
82
|
+
renameSync(partial, options.out);
|
|
83
|
+
return { ok: true, bytes };
|
|
84
|
+
}
|
|
85
|
+
//# sourceMappingURL=dump.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"dump.js","sourceRoot":"","sources":["../../src/offsite/dump.ts"],"names":[],"mappings":"AAAA,qHAAqH;AACrH,qHAAqH;AACrH,qHAAqH;AACrH,qGAAqG;AACrG,OAAO,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAC3C,OAAO,EAAE,iBAAiB,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAChE,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACpD,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAEhD,MAAM,UAAU,GAAG,IAAI,CAAC;AACxB,MAAM,UAAU,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,aAAa,EAAE,eAAe,CAAU,CAAC;AAerF,4GAA4G;AAC5G,MAAM,UAAU,iBAAiB,CAAC,EAAQ;IACxC,MAAM,KAAK,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC;IAC9E,OAAO,MAAM,KAAK,OAAO,CAAC;AAC5B,CAAC;AAED,wGAAwG;AACxG,MAAM,UAAU,eAAe,CAAC,gBAAmC;IACjE,OAAO,CAAC,iBAAiB,EAAE,eAAe,EAAE,GAAG,gBAAgB,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,wBAAwB,KAAK,EAAE,CAAC,CAAC,CAAC;AACnH,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,SAAS,CAAC,OAAsB;IACpD,MAAM,KAAK,GAAG,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACtC,IAAI,CAAC,KAAK,CAAC,EAAE;QAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC;IAC5D,MAAM,GAAG,GAA2B,EAAE,GAAG,KAAK,CAAC,GAAG,EAAE,CAAC;IACrD,KAAK,MAAM,IAAI,IAAI,UAAU,EAAE,CAAC;QAC9B,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAChC,IAAI,KAAK,KAAK,SAAS;YAAE,GAAG,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;IAC7C,CAAC;IACD,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,YAAY,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAChF,MAAM,IAAI,GAAG,iBAAiB,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;IACzD,MAAM,UAAU,GAAG,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACvD,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE;YACrB,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IAC7B,CAAC,CAAC,CAAC;IACH,IAAI,CAAC;QACH,MAAM,UAAU,CAAC;IACnB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,gBAAgB,OAAO,KAAK,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;IACvH,CAAC;IACD,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE,eAAe,CAAC,OAAO,CAAC,gBAAgB,CAAC,EAAE,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC;IAC3H,IAAI,MAAM,GAAG,EAAE,CAAC;IAChB,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,KAAa,EAAE,EAAE;QACxC,MAAM,GAAG,CAAC,MAAM,GAAG,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,UAAU,CAAC,CAAC;IAChE,CAAC,CAAC,CAAC;IACH,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,KAAa,EAAE,EAAE;QACxC,KAAK,IAAI,KAAK,CAAC,MAAM,CAAC;IACxB,CAAC,CAAC,CAAC;IACH,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACxB,MAAM,OAAO,GAAG,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACpD,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QAC7B,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IAC7B,CAAC,CAAC,CAAC;IACH,MAAM,MAAM,GAAG,IAAI,OAAO,CAAgB,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QAC5D,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAC5B,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,EAAE;YAC3B,OAAO,CAAC,IAAI,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IACH,IAAI,IAAmB,CAAC;IACxB,IAAI,CAAC;QACH,IAAI,GAAG,MAAM,MAAM,CAAC;QACpB,MAAM,OAAO,CAAC;IAChB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,CAAC,OAAO,EAAE,CAAC;QACf,MAAM,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;QACjC,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,cAAc,OAAO,CAAC,MAAM,KAAK,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;IAC5H,CAAC;IACD,IAAI,IAAI,KAAK,CAAC,EAAE,CAAC;QACf,MAAM,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;QACjC,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,uBAAuB,MAAM,CAAC,IAAI,CAAC,KAAK,MAAM,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC;IAC3H,CAAC;IACD,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;QAChB,MAAM,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;QACjC,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,uBAAuB,EAAE,CAAC;IACzD,CAAC;IACD,UAAU,CAAC,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC;IACjC,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;AAC7B,CAAC"}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
export { collectSecrets, DEFAULT_REGION, READ_ENV_NAMES, readReadConfig, readUploadConfig, redactSecrets, SECRET_ENV_NAMES, UPLOAD_ENV_NAMES, type ConfigResult, type StoreConfig, type UploadConfig, } from "./config.js";
|
|
2
|
+
export { decryptStream, encryptFile, parseIdentities, type IdentitiesResult } from "./crypto.js";
|
|
3
|
+
export { buildDumpFileName, buildPgDumpArgs, runPgDump, type PgDumpOptions, type PgDumpResult } from "./dump.js";
|
|
4
|
+
export { buildLifecycleJson, buildLifecycleXml, DEFAULT_LIFECYCLE_DAYS, MAX_LIFECYCLE_DAYS, MIN_LIFECYCLE_DAYS, parseLifecycleDays, } from "./lifecycle.js";
|
|
5
|
+
export { buildObjectKey, OBJECT_SUFFIX, parseBackupFileName, parseObjectKey, selectNewestKey, type BackupFileName } from "./objects.js";
|
|
6
|
+
export { fetchBackup, resolveKey, restoreBackup, type FetchOptions, type OffsiteResult, type RestoreOptions, type RestoreOutcome } from "./restore.js";
|
|
7
|
+
export { getObjectStream, getObjectUrl, listObjects, putObjectFile, S3RequestError, type S3Options, type StoredObject } from "./s3.js";
|
|
8
|
+
export { EMPTY_SHA256, encodeRfc3986, formatAmzDate, signRequest, type SignInput } from "./sigv4.js";
|
|
9
|
+
export { recordRun } from "./record.js";
|
|
10
|
+
export { buildStatusSql, getPruneBefore, quoteLiteral, STATUS_RETENTION_DAYS } from "./status-sql.js";
|
|
11
|
+
export { buildNotConfiguredRecord, hashFile, uploadBackups, type RunRecord, type UploadOptions } from "./upload.js";
|
|
12
|
+
export { DEFAULT_MAX_AGE_HOURS, selectVerifyTables, verifyBackup, type VerifyOptions, type VerifyOutcome } from "./verify.js";
|
|
13
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/offsite/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,cAAc,EACd,cAAc,EACd,cAAc,EACd,cAAc,EACd,gBAAgB,EAChB,aAAa,EACb,gBAAgB,EAChB,gBAAgB,EAChB,KAAK,YAAY,EACjB,KAAK,WAAW,EAChB,KAAK,YAAY,GAClB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,eAAe,EAAE,KAAK,gBAAgB,EAAE,MAAM,aAAa,CAAC;AACjG,OAAO,EAAE,iBAAiB,EAAE,eAAe,EAAE,SAAS,EAAE,KAAK,aAAa,EAAE,KAAK,YAAY,EAAE,MAAM,WAAW,CAAC;AACjH,OAAO,EACL,kBAAkB,EAClB,iBAAiB,EACjB,sBAAsB,EACtB,kBAAkB,EAClB,kBAAkB,EAClB,kBAAkB,GACnB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,mBAAmB,EAAE,cAAc,EAAE,eAAe,EAAE,KAAK,cAAc,EAAE,MAAM,cAAc,CAAC;AACxI,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,aAAa,EAAE,KAAK,YAAY,EAAE,KAAK,aAAa,EAAE,KAAK,cAAc,EAAE,KAAK,cAAc,EAAE,MAAM,cAAc,CAAC;AACvJ,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,WAAW,EAAE,aAAa,EAAE,cAAc,EAAE,KAAK,SAAS,EAAE,KAAK,YAAY,EAAE,MAAM,SAAS,CAAC;AACvI,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,aAAa,EAAE,WAAW,EAAE,KAAK,SAAS,EAAE,MAAM,YAAY,CAAC;AACrG,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,YAAY,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AACtG,OAAO,EAAE,wBAAwB,EAAE,QAAQ,EAAE,aAAa,EAAE,KAAK,SAAS,EAAE,KAAK,aAAa,EAAE,MAAM,aAAa,CAAC;AACpH,OAAO,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,YAAY,EAAE,KAAK,aAAa,EAAE,KAAK,aAAa,EAAE,MAAM,aAAa,CAAC"}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
// The host and operator side of @softure-ai/backup: configuration, the nightly upload, status SQL, restore, fetch and
|
|
2
|
+
// verify. The `softure-backup` command line wraps these; an app's own code needs only `@softure-ai/backup/server`.
|
|
3
|
+
export { collectSecrets, DEFAULT_REGION, READ_ENV_NAMES, readReadConfig, readUploadConfig, redactSecrets, SECRET_ENV_NAMES, UPLOAD_ENV_NAMES, } from "./config.js";
|
|
4
|
+
export { decryptStream, encryptFile, parseIdentities } from "./crypto.js";
|
|
5
|
+
export { buildDumpFileName, buildPgDumpArgs, runPgDump } from "./dump.js";
|
|
6
|
+
export { buildLifecycleJson, buildLifecycleXml, DEFAULT_LIFECYCLE_DAYS, MAX_LIFECYCLE_DAYS, MIN_LIFECYCLE_DAYS, parseLifecycleDays, } from "./lifecycle.js";
|
|
7
|
+
export { buildObjectKey, OBJECT_SUFFIX, parseBackupFileName, parseObjectKey, selectNewestKey } from "./objects.js";
|
|
8
|
+
export { fetchBackup, resolveKey, restoreBackup } from "./restore.js";
|
|
9
|
+
export { getObjectStream, getObjectUrl, listObjects, putObjectFile, S3RequestError } from "./s3.js";
|
|
10
|
+
export { EMPTY_SHA256, encodeRfc3986, formatAmzDate, signRequest } from "./sigv4.js";
|
|
11
|
+
export { recordRun } from "./record.js";
|
|
12
|
+
export { buildStatusSql, getPruneBefore, quoteLiteral, STATUS_RETENTION_DAYS } from "./status-sql.js";
|
|
13
|
+
export { buildNotConfiguredRecord, hashFile, uploadBackups } from "./upload.js";
|
|
14
|
+
export { DEFAULT_MAX_AGE_HOURS, selectVerifyTables, verifyBackup } from "./verify.js";
|
|
15
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/offsite/index.ts"],"names":[],"mappings":"AAAA,sHAAsH;AACtH,mHAAmH;AACnH,OAAO,EACL,cAAc,EACd,cAAc,EACd,cAAc,EACd,cAAc,EACd,gBAAgB,EAChB,aAAa,EACb,gBAAgB,EAChB,gBAAgB,GAIjB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,eAAe,EAAyB,MAAM,aAAa,CAAC;AACjG,OAAO,EAAE,iBAAiB,EAAE,eAAe,EAAE,SAAS,EAAyC,MAAM,WAAW,CAAC;AACjH,OAAO,EACL,kBAAkB,EAClB,iBAAiB,EACjB,sBAAsB,EACtB,kBAAkB,EAClB,kBAAkB,EAClB,kBAAkB,GACnB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,mBAAmB,EAAE,cAAc,EAAE,eAAe,EAAuB,MAAM,cAAc,CAAC;AACxI,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,aAAa,EAAmF,MAAM,cAAc,CAAC;AACvJ,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,WAAW,EAAE,aAAa,EAAE,cAAc,EAAqC,MAAM,SAAS,CAAC;AACvI,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,aAAa,EAAE,WAAW,EAAkB,MAAM,YAAY,CAAC;AACrG,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,YAAY,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AACtG,OAAO,EAAE,wBAAwB,EAAE,QAAQ,EAAE,aAAa,EAAsC,MAAM,aAAa,CAAC;AACpH,OAAO,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,YAAY,EAA0C,MAAM,aAAa,CAAC"}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
export declare const DEFAULT_LIFECYCLE_DAYS = 30;
|
|
2
|
+
export declare const MIN_LIFECYCLE_DAYS = 1;
|
|
3
|
+
export declare const MAX_LIFECYCLE_DAYS = 3650;
|
|
4
|
+
export type LifecycleDaysResult = {
|
|
5
|
+
ok: true;
|
|
6
|
+
days: number;
|
|
7
|
+
} | {
|
|
8
|
+
ok: false;
|
|
9
|
+
problem: string;
|
|
10
|
+
};
|
|
11
|
+
/** Whole days from 1 to 3650 (ten years). */
|
|
12
|
+
export declare function parseLifecycleDays(text: string | undefined): LifecycleDaysResult;
|
|
13
|
+
/** The S3 `LifecycleConfiguration` (XML, for PutBucketLifecycleConfiguration) expiring `<prefix>/` after `days`. */
|
|
14
|
+
export declare function buildLifecycleXml(prefix: string, days: number): string;
|
|
15
|
+
/** The same rule as JSON for `aws s3api put-bucket-lifecycle-configuration --lifecycle-configuration file://…`. */
|
|
16
|
+
export declare function buildLifecycleJson(prefix: string, days: number): string;
|
|
17
|
+
//# sourceMappingURL=lifecycle.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"lifecycle.d.ts","sourceRoot":"","sources":["../../src/offsite/lifecycle.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,sBAAsB,KAAK,CAAC;AACzC,eAAO,MAAM,kBAAkB,IAAI,CAAC;AACpC,eAAO,MAAM,kBAAkB,OAAO,CAAC;AAEvC,MAAM,MAAM,mBAAmB,GAAG;IAAE,EAAE,EAAE,IAAI,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAAG;IAAE,EAAE,EAAE,KAAK,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,CAAC;AAE9F,6CAA6C;AAC7C,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,mBAAmB,CAQhF;AAED,oHAAoH;AACpH,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CActE;AAED,mHAAmH;AACnH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CASvE"}
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
// Remote retention is the bucket's: a lifecycle rule on the prefix expires objects after N days. The nightly run
|
|
2
|
+
// never deletes (its token cannot), so a compromised server cannot wipe the history either.
|
|
3
|
+
export const DEFAULT_LIFECYCLE_DAYS = 30;
|
|
4
|
+
export const MIN_LIFECYCLE_DAYS = 1;
|
|
5
|
+
export const MAX_LIFECYCLE_DAYS = 3650;
|
|
6
|
+
/** Whole days from 1 to 3650 (ten years). */
|
|
7
|
+
export function parseLifecycleDays(text) {
|
|
8
|
+
if (text === undefined)
|
|
9
|
+
return { ok: true, days: DEFAULT_LIFECYCLE_DAYS };
|
|
10
|
+
if (!/^\d{1,4}$/.test(text))
|
|
11
|
+
return { ok: false, problem: `--days is a whole number of days, not ${JSON.stringify(text)}` };
|
|
12
|
+
const days = Number(text);
|
|
13
|
+
if (days < MIN_LIFECYCLE_DAYS || days > MAX_LIFECYCLE_DAYS) {
|
|
14
|
+
return { ok: false, problem: `--days is from ${String(MIN_LIFECYCLE_DAYS)} to ${String(MAX_LIFECYCLE_DAYS)}, not ${String(days)}` };
|
|
15
|
+
}
|
|
16
|
+
return { ok: true, days };
|
|
17
|
+
}
|
|
18
|
+
/** The S3 `LifecycleConfiguration` (XML, for PutBucketLifecycleConfiguration) expiring `<prefix>/` after `days`. */
|
|
19
|
+
export function buildLifecycleXml(prefix, days) {
|
|
20
|
+
return [
|
|
21
|
+
'<?xml version="1.0" encoding="UTF-8"?>',
|
|
22
|
+
'<LifecycleConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/">',
|
|
23
|
+
" <Rule>",
|
|
24
|
+
` <ID>softure-backup-${prefix.replace(/[^a-z0-9-]/g, "-")}</ID>`,
|
|
25
|
+
" <Status>Enabled</Status>",
|
|
26
|
+
` <Filter><Prefix>${prefix}/</Prefix></Filter>`,
|
|
27
|
+
` <Expiration><Days>${String(days)}</Days></Expiration>`,
|
|
28
|
+
" <AbortIncompleteMultipartUpload><DaysAfterInitiation>1</DaysAfterInitiation></AbortIncompleteMultipartUpload>",
|
|
29
|
+
" </Rule>",
|
|
30
|
+
"</LifecycleConfiguration>",
|
|
31
|
+
"",
|
|
32
|
+
].join("\n");
|
|
33
|
+
}
|
|
34
|
+
/** The same rule as JSON for `aws s3api put-bucket-lifecycle-configuration --lifecycle-configuration file://…`. */
|
|
35
|
+
export function buildLifecycleJson(prefix, days) {
|
|
36
|
+
const rule = {
|
|
37
|
+
ID: `softure-backup-${prefix.replace(/[^a-z0-9-]/g, "-")}`,
|
|
38
|
+
Status: "Enabled",
|
|
39
|
+
Filter: { Prefix: `${prefix}/` },
|
|
40
|
+
Expiration: { Days: days },
|
|
41
|
+
AbortIncompleteMultipartUpload: { DaysAfterInitiation: 1 },
|
|
42
|
+
};
|
|
43
|
+
return `${JSON.stringify({ Rules: [rule] }, null, 2)}\n`;
|
|
44
|
+
}
|
|
45
|
+
//# sourceMappingURL=lifecycle.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"lifecycle.js","sourceRoot":"","sources":["../../src/offsite/lifecycle.ts"],"names":[],"mappings":"AAAA,iHAAiH;AACjH,4FAA4F;AAC5F,MAAM,CAAC,MAAM,sBAAsB,GAAG,EAAE,CAAC;AACzC,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC;AACpC,MAAM,CAAC,MAAM,kBAAkB,GAAG,IAAI,CAAC;AAIvC,6CAA6C;AAC7C,MAAM,UAAU,kBAAkB,CAAC,IAAwB;IACzD,IAAI,IAAI,KAAK,SAAS;QAAE,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,sBAAsB,EAAE,CAAC;IAC1E,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC;QAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,yCAAyC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC;IAC5H,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;IAC1B,IAAI,IAAI,GAAG,kBAAkB,IAAI,IAAI,GAAG,kBAAkB,EAAE,CAAC;QAC3D,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,kBAAkB,MAAM,CAAC,kBAAkB,CAAC,OAAO,MAAM,CAAC,kBAAkB,CAAC,SAAS,MAAM,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC;IACtI,CAAC;IACD,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;AAC5B,CAAC;AAED,oHAAoH;AACpH,MAAM,UAAU,iBAAiB,CAAC,MAAc,EAAE,IAAY;IAC5D,OAAO;QACL,wCAAwC;QACxC,0EAA0E;QAC1E,UAAU;QACV,0BAA0B,MAAM,CAAC,OAAO,CAAC,aAAa,EAAE,GAAG,CAAC,OAAO;QACnE,8BAA8B;QAC9B,uBAAuB,MAAM,qBAAqB;QAClD,yBAAyB,MAAM,CAAC,IAAI,CAAC,sBAAsB;QAC3D,mHAAmH;QACnH,WAAW;QACX,2BAA2B;QAC3B,EAAE;KACH,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACf,CAAC;AAED,mHAAmH;AACnH,MAAM,UAAU,kBAAkB,CAAC,MAAc,EAAE,IAAY;IAC7D,MAAM,IAAI,GAAG;QACX,EAAE,EAAE,kBAAkB,MAAM,CAAC,OAAO,CAAC,aAAa,EAAE,GAAG,CAAC,EAAE;QAC1D,MAAM,EAAE,SAAS;QACjB,MAAM,EAAE,EAAE,MAAM,EAAE,GAAG,MAAM,GAAG,EAAE;QAChC,UAAU,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE;QAC1B,8BAA8B,EAAE,EAAE,mBAAmB,EAAE,CAAC,EAAE;KAC3D,CAAC;IACF,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC;AAC3D,CAAC"}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import type { BackupKind } from "../contract.js";
|
|
2
|
+
export declare const OBJECT_SUFFIX = ".age";
|
|
3
|
+
export interface BackupFileName {
|
|
4
|
+
readonly kind: BackupKind;
|
|
5
|
+
readonly name: string;
|
|
6
|
+
/** The time in the name, UTC. */
|
|
7
|
+
readonly takenAt: Date;
|
|
8
|
+
}
|
|
9
|
+
/** The kind and time of a backup file name, or null for any other name (or an impossible date). */
|
|
10
|
+
export declare function parseBackupFileName(name: string): BackupFileName | null;
|
|
11
|
+
export declare function buildObjectKey(prefix: string, fileName: string): string;
|
|
12
|
+
/** The backup file name of a key under `prefix`, or null for any other key. */
|
|
13
|
+
export declare function parseObjectKey(prefix: string, key: string): BackupFileName | null;
|
|
14
|
+
/** The newest key of `kind` under `prefix`, by the time in its name; null when there is none. */
|
|
15
|
+
export declare function selectNewestKey(prefix: string, keys: readonly string[], kind: BackupKind): {
|
|
16
|
+
key: string;
|
|
17
|
+
takenAt: Date;
|
|
18
|
+
} | null;
|
|
19
|
+
//# sourceMappingURL=objects.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"objects.d.ts","sourceRoot":"","sources":["../../src/offsite/objects.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAMjD,eAAO,MAAM,aAAa,SAAS,CAAC;AAEpC,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC;IAC1B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,iCAAiC;IACjC,QAAQ,CAAC,OAAO,EAAE,IAAI,CAAC;CACxB;AAMD,mGAAmG;AACnG,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,MAAM,GAAG,cAAc,GAAG,IAAI,CAOvE;AAED,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,CAEvE;AAED,+EAA+E;AAC/E,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,cAAc,GAAG,IAAI,CAKjF;AAED,iGAAiG;AACjG,wBAAgB,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,MAAM,EAAE,EAAE,IAAI,EAAE,UAAU,GAAG;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,IAAI,CAAA;CAAE,GAAG,IAAI,CAQhI"}
|