@rehearsal-db/core 0.1.0-beta.13 → 0.1.0-beta.15
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 +93 -0
- package/README.md +4 -1
- package/dist/package.json +100 -0
- package/dist/scripts/install/create_root_config.d.mts +3 -0
- package/dist/scripts/install/create_root_config.mjs +13 -0
- package/dist/scripts/runtime/manage_database.d.mts +6 -0
- package/{scripts → dist/scripts}/runtime/manage_database.mjs +6 -8
- package/dist/src/application/session.d.mts +96 -0
- package/dist/src/application/session.mjs +380 -0
- package/dist/src/baseline/artifact.d.mts +119 -0
- package/dist/src/baseline/artifact.mjs +522 -0
- package/dist/src/baseline/builder.d.mts +19 -0
- package/dist/src/baseline/builder.mjs +142 -0
- package/dist/src/baseline/input_discovery.d.mts +13 -0
- package/dist/src/baseline/input_discovery.mjs +149 -0
- package/dist/src/baseline/policy_review.d.mts +56 -0
- package/dist/src/baseline/policy_review.mjs +73 -0
- package/dist/src/baseline/preparation.d.mts +63 -0
- package/dist/src/baseline/preparation.mjs +295 -0
- package/dist/src/baseline/privacy_engine.d.mts +162 -0
- package/dist/src/baseline/privacy_engine.mjs +1162 -0
- package/dist/src/baseline/privacy_structured_json.d.mts +66 -0
- package/dist/src/baseline/privacy_structured_json.mjs +464 -0
- package/dist/src/baseline/sanitization_policy.d.mts +69 -0
- package/dist/src/baseline/sanitization_policy.mjs +227 -0
- package/dist/src/baseline/schema_snapshot.d.mts +19 -0
- package/dist/src/baseline/schema_snapshot.mjs +79 -0
- package/dist/src/cli/arguments.d.mts +43 -0
- package/dist/src/cli/arguments.mjs +135 -0
- package/dist/src/cli/guided.d.mts +51 -0
- package/dist/src/cli/guided.mjs +713 -0
- package/dist/src/cli/init_command.d.mts +21 -0
- package/dist/src/cli/init_command.mjs +90 -0
- package/dist/src/cli/project_commands.d.mts +157 -0
- package/dist/src/cli/project_commands.mjs +183 -0
- package/dist/src/cli/rehearsal.d.mts +7 -0
- package/dist/src/cli/rehearsal.mjs +706 -0
- package/dist/src/cli/renderers.d.mts +299 -0
- package/dist/src/cli/renderers.mjs +554 -0
- package/dist/src/cli/runtime_commands.d.mts +265 -0
- package/dist/src/cli/runtime_commands.mjs +599 -0
- package/dist/src/cli/source_commands.d.mts +432 -0
- package/dist/src/cli/source_commands.mjs +299 -0
- package/dist/src/cli/terminal.d.mts +59 -0
- package/dist/src/cli/terminal.mjs +230 -0
- package/dist/src/identity/claim.d.mts +144 -0
- package/dist/src/identity/claim.mjs +947 -0
- package/dist/src/identity/provider_configuration.d.mts +37 -0
- package/dist/src/identity/provider_configuration.mjs +132 -0
- package/dist/src/identity/storage.d.mts +21 -0
- package/dist/src/identity/storage.mjs +122 -0
- package/dist/src/index.d.mts +4 -0
- package/dist/src/index.mjs +3 -0
- package/dist/src/project/configuration.d.mts +181 -0
- package/dist/src/project/configuration.mjs +958 -0
- package/dist/src/project/install_scaffold.d.mts +42 -0
- package/dist/src/project/install_scaffold.mjs +263 -0
- package/dist/src/project/setup.d.mts +87 -0
- package/dist/src/project/setup.mjs +414 -0
- package/dist/src/project/support_report.d.mts +88 -0
- package/dist/src/project/support_report.mjs +83 -0
- package/dist/src/runtime/cleanup.d.mts +85 -0
- package/dist/src/runtime/cleanup.mjs +311 -0
- package/dist/src/runtime/migration_history.d.mts +51 -0
- package/dist/src/runtime/migration_history.mjs +170 -0
- package/dist/src/runtime/plan.d.mts +134 -0
- package/dist/src/runtime/plan.mjs +636 -0
- package/dist/src/runtime/policy.d.mts +66 -0
- package/dist/src/runtime/policy.mjs +369 -0
- package/dist/src/runtime/restore.d.mts +22 -0
- package/dist/src/runtime/restore.mjs +276 -0
- package/dist/src/runtime/service_environment.d.mts +11 -0
- package/dist/src/runtime/service_environment.mjs +58 -0
- package/dist/src/runtime/topology.d.mts +51 -0
- package/dist/src/runtime/topology.mjs +128 -0
- package/dist/src/shared/diagnostics.d.mts +97 -0
- package/dist/src/shared/diagnostics.mjs +170 -0
- package/dist/src/shared/human_output.d.mts +2 -0
- package/{src → dist/src}/shared/human_output.mjs +1 -3
- package/dist/src/shared/node_runtime.d.mts +14 -0
- package/dist/src/shared/node_runtime.mjs +25 -0
- package/dist/src/shared/operation_guard.d.mts +22 -0
- package/dist/src/shared/operation_guard.mjs +150 -0
- package/dist/src/shared/process_environment.d.mts +15 -0
- package/dist/src/shared/process_environment.mjs +50 -0
- package/dist/src/source/access.d.mts +165 -0
- package/dist/src/source/access.mjs +602 -0
- package/dist/src/source/asset_transfer.d.mts +27 -0
- package/dist/src/source/asset_transfer.mjs +202 -0
- package/dist/src/source/baseline.d.mts +66 -0
- package/dist/src/source/baseline.mjs +372 -0
- package/dist/src/source/external_reader.d.mts +42 -0
- package/dist/src/source/external_reader.mjs +278 -0
- package/dist/src/source/postgresql_access.d.mts +86 -0
- package/dist/src/source/postgresql_access.mjs +454 -0
- package/dist/src/source/privacy_paths.d.mts +10 -0
- package/dist/src/source/privacy_paths.mjs +27 -0
- package/dist/src/targets/driver.d.mts +2 -0
- package/dist/src/targets/driver.mjs +13 -0
- package/dist/src/targets/postgresql.d.mts +5 -0
- package/dist/src/targets/postgresql.mjs +641 -0
- package/dist/src/targets/supabase.d.mts +8 -0
- package/dist/src/targets/supabase.mjs +659 -0
- package/dist/src/targets/supabase_environment.d.mts +49 -0
- package/dist/src/targets/supabase_environment.mjs +162 -0
- package/dist/src/targets/target.d.mts +33 -0
- package/dist/src/targets/target.mjs +39 -0
- package/docs/README.md +1 -0
- package/docs/architecture.md +17 -9
- package/docs/configuration.md +49 -8
- package/docs/getting-started.md +28 -0
- package/docs/index.md +1 -0
- package/docs/production-source.md +43 -7
- package/docs/releasing.md +5 -3
- package/docs/roadmap.md +3 -2
- package/docs/sanitization.md +415 -14
- package/docs/standalone-workflow.md +12 -6
- package/docs/troubleshooting.md +5 -1
- package/docs/tutorial.md +5 -0
- package/docs/typescript.md +87 -0
- package/package.json +35 -29
- package/scripts/install/create_root_config.mjs +0 -36
- package/src/README.md +0 -17
- package/src/application/session.mjs +0 -435
- package/src/baseline/artifact.mjs +0 -684
- package/src/baseline/builder.mjs +0 -164
- package/src/baseline/input_discovery.mjs +0 -155
- package/src/baseline/policy_review.mjs +0 -92
- package/src/baseline/preparation.mjs +0 -323
- package/src/baseline/privacy_engine.mjs +0 -952
- package/src/baseline/sanitization_policy.mjs +0 -299
- package/src/baseline/schema_snapshot.mjs +0 -113
- package/src/cli/arguments.mjs +0 -126
- package/src/cli/guided.mjs +0 -814
- package/src/cli/init_command.mjs +0 -94
- package/src/cli/rehearsal.mjs +0 -970
- package/src/cli/renderers.mjs +0 -626
- package/src/cli/runtime_commands.mjs +0 -707
- package/src/cli/source_commands.mjs +0 -347
- package/src/cli/terminal.mjs +0 -275
- package/src/identity/claim.mjs +0 -1163
- package/src/identity/provider_configuration.mjs +0 -177
- package/src/identity/storage.mjs +0 -165
- package/src/project/configuration.mjs +0 -1337
- package/src/project/install_scaffold.mjs +0 -291
- package/src/project/setup.mjs +0 -466
- package/src/project/support_report.mjs +0 -105
- package/src/runtime/cleanup.mjs +0 -381
- package/src/runtime/migration_history.mjs +0 -220
- package/src/runtime/plan.mjs +0 -722
- package/src/runtime/policy.mjs +0 -438
- package/src/runtime/restore.mjs +0 -337
- package/src/runtime/service_environment.mjs +0 -82
- package/src/runtime/topology.mjs +0 -177
- package/src/shared/diagnostics.mjs +0 -207
- package/src/shared/node_runtime.mjs +0 -31
- package/src/shared/operation_guard.mjs +0 -162
- package/src/shared/process_environment.mjs +0 -68
- package/src/source/access.mjs +0 -753
- package/src/source/asset_transfer.mjs +0 -207
- package/src/source/baseline.mjs +0 -482
- package/src/source/external_reader.mjs +0 -255
- package/src/source/postgresql_access.mjs +0 -581
- package/src/source/privacy_paths.mjs +0 -38
- package/src/targets/postgresql.mjs +0 -808
- package/src/targets/supabase.mjs +0 -840
- package/src/targets/supabase_environment.mjs +0 -229
- package/src/targets/target.mjs +0 -66
- /package/{src/project → types}/configuration.d.mts +0 -0
|
@@ -0,0 +1,454 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Apply and retire an exact PostgreSQL source-access plan. This module is used
|
|
3
|
+
* only by explicit source commands; ordinary runtime commands must not import it.
|
|
4
|
+
*/
|
|
5
|
+
import { createHash, randomBytes } from "node:crypto";
|
|
6
|
+
import { chmod, link, lstat, mkdir, open, readFile, rm, writeFile, } from "node:fs/promises";
|
|
7
|
+
import { dirname, isAbsolute, join, relative, resolve } from "node:path";
|
|
8
|
+
import pg from "pg";
|
|
9
|
+
import { assertSourceAccessConfirmation, createSourceRetirementPlan, sourceAccessPolicyFingerprint, sourceTargetFingerprint, } from "./access.mjs";
|
|
10
|
+
import { verifyExternalPostgresqlReader } from "./external_reader.mjs";
|
|
11
|
+
const { Client } = pg;
|
|
12
|
+
const IDENTIFIER = /^[a-z][a-z0-9_]{0,62}$/u;
|
|
13
|
+
const quoteIdentifier = (value) => {
|
|
14
|
+
if (!IDENTIFIER.test(value))
|
|
15
|
+
throw new Error("Unsafe source-access identifier.");
|
|
16
|
+
return `"${value}"`;
|
|
17
|
+
};
|
|
18
|
+
const quoteLiteral = (value) => `'${String(value).replaceAll("'", "''")}'`;
|
|
19
|
+
const ensureOwnedPath = (projectRoot, relativePath) => {
|
|
20
|
+
const root = resolve(projectRoot);
|
|
21
|
+
const path = resolve(root, relativePath);
|
|
22
|
+
const child = relative(root, path);
|
|
23
|
+
if (!child || child.startsWith("..") || isAbsolute(child))
|
|
24
|
+
throw new Error("Source-access file escaped the project root.");
|
|
25
|
+
return path;
|
|
26
|
+
};
|
|
27
|
+
const isInside = (root, path) => {
|
|
28
|
+
const child = relative(root, path);
|
|
29
|
+
return Boolean(child) && !child.startsWith("..") && !isAbsolute(child);
|
|
30
|
+
};
|
|
31
|
+
const resolveSourceStateRoot = ({ projectRoot, artifactRoot = join(projectRoot, ".rehearsal"), }) => ensureOwnedPath(projectRoot, artifactRoot);
|
|
32
|
+
export const resolvePostgresqlSourceStatePaths = ({ projectRoot = process.cwd(), artifactRoot = join(projectRoot, ".rehearsal"), credentialFile, }) => {
|
|
33
|
+
const stateRoot = resolveSourceStateRoot({ projectRoot, artifactRoot });
|
|
34
|
+
const credentialPath = ensureOwnedPath(projectRoot, credentialFile);
|
|
35
|
+
const secretsRoot = join(stateRoot, "secrets");
|
|
36
|
+
if (!isInside(secretsRoot, credentialPath)) {
|
|
37
|
+
throw new Error("Source reader credential must stay inside this target's configured .rehearsal/secrets directory.");
|
|
38
|
+
}
|
|
39
|
+
return Object.freeze({
|
|
40
|
+
stateRoot,
|
|
41
|
+
credentialPath,
|
|
42
|
+
receiptPath: join(stateRoot, "source-access-receipt.json"),
|
|
43
|
+
});
|
|
44
|
+
};
|
|
45
|
+
const readerConnectionString = (administratorConnectionString, role, password) => {
|
|
46
|
+
const target = new URL(administratorConnectionString);
|
|
47
|
+
target.username = role;
|
|
48
|
+
target.password = password;
|
|
49
|
+
return target.toString();
|
|
50
|
+
};
|
|
51
|
+
const writeExclusiveSecret = async (path, content) => {
|
|
52
|
+
await mkdir(dirname(path), { recursive: true, mode: 0o700 });
|
|
53
|
+
const handle = await open(path, "wx", 0o600);
|
|
54
|
+
try {
|
|
55
|
+
await handle.writeFile(content);
|
|
56
|
+
await handle.sync();
|
|
57
|
+
}
|
|
58
|
+
finally {
|
|
59
|
+
await handle.close();
|
|
60
|
+
}
|
|
61
|
+
await chmod(path, 0o600);
|
|
62
|
+
};
|
|
63
|
+
const assertSourceStateAvailable = async (...paths) => {
|
|
64
|
+
for (const path of paths) {
|
|
65
|
+
try {
|
|
66
|
+
await lstat(path);
|
|
67
|
+
}
|
|
68
|
+
catch (error) {
|
|
69
|
+
if (error?.code === "ENOENT")
|
|
70
|
+
continue;
|
|
71
|
+
throw error;
|
|
72
|
+
}
|
|
73
|
+
const error = new Error("Source-access state already exists and will not be overwritten.");
|
|
74
|
+
error.code = "EEXIST";
|
|
75
|
+
throw error;
|
|
76
|
+
}
|
|
77
|
+
};
|
|
78
|
+
const connection = async (connectionString, clientFactory) => {
|
|
79
|
+
const client = clientFactory
|
|
80
|
+
? await clientFactory(connectionString)
|
|
81
|
+
: new Client({
|
|
82
|
+
connectionString,
|
|
83
|
+
application_name: "rehearsal-source-access",
|
|
84
|
+
});
|
|
85
|
+
if (typeof client.connect === "function")
|
|
86
|
+
await client.connect();
|
|
87
|
+
return client;
|
|
88
|
+
};
|
|
89
|
+
const sourceRelation = (relation) => `${quoteIdentifier(relation.source.schema)}.${quoteIdentifier(relation.source.table)}`;
|
|
90
|
+
const viewRelation = (plan, relation) => `${quoteIdentifier(plan.policy.exportSchema)}.${quoteIdentifier(relation.view)}`;
|
|
91
|
+
const assertTarget = (plan, administratorConnectionString) => {
|
|
92
|
+
if (sourceTargetFingerprint(administratorConnectionString) !==
|
|
93
|
+
plan.policy.targetFingerprint) {
|
|
94
|
+
throw new Error("Source administrator credential changed to a different target.");
|
|
95
|
+
}
|
|
96
|
+
};
|
|
97
|
+
const assertUnusedObjects = async (client, plan) => {
|
|
98
|
+
const result = await client.query(`select
|
|
99
|
+
exists(select 1 from pg_namespace where nspname = $1) as schema_exists,
|
|
100
|
+
exists(select 1 from pg_roles where rolname = $2) as reader_exists,
|
|
101
|
+
exists(select 1 from pg_roles where rolname = $3) as owner_exists`, [
|
|
102
|
+
plan.policy.exportSchema,
|
|
103
|
+
plan.policy.reader.role,
|
|
104
|
+
plan.policy.reader.ownerRole,
|
|
105
|
+
]);
|
|
106
|
+
const state = result.rows[0];
|
|
107
|
+
if (!state)
|
|
108
|
+
throw new Error("Source-access object check was inconclusive.");
|
|
109
|
+
if (state.schema_exists || state.reader_exists || state.owner_exists) {
|
|
110
|
+
throw new Error("Source-access targets already exist. Rehearsal will not overwrite or adopt them.");
|
|
111
|
+
}
|
|
112
|
+
};
|
|
113
|
+
const assertSourceColumns = async (client, relation) => {
|
|
114
|
+
const result = await client.query(`select column_name
|
|
115
|
+
from information_schema.columns
|
|
116
|
+
where table_schema = $1 and table_name = $2
|
|
117
|
+
order by ordinal_position`, [relation.source.schema, relation.source.table]);
|
|
118
|
+
if (result.rows.length === 0) {
|
|
119
|
+
throw new Error(`Declared source relation ${relation.source.schema}.${relation.source.table} does not exist.`);
|
|
120
|
+
}
|
|
121
|
+
const actual = new Set(result.rows.map((row) => String(row.column_name)));
|
|
122
|
+
const missing = relation.columns.filter((column) => !actual.has(column));
|
|
123
|
+
if (missing.length) {
|
|
124
|
+
throw new Error(`Declared source relation is missing ${missing.length} reviewed column(s).`);
|
|
125
|
+
}
|
|
126
|
+
};
|
|
127
|
+
const runDenyChecks = async (client, plan) => {
|
|
128
|
+
const role = plan.policy.reader.role;
|
|
129
|
+
for (const relation of plan.policy.relations) {
|
|
130
|
+
const raw = `${relation.source.schema}.${relation.source.table}`;
|
|
131
|
+
const permissions = await client.query(`select
|
|
132
|
+
has_table_privilege($1, $2, 'SELECT') as can_select,
|
|
133
|
+
has_table_privilege($1, $2, 'INSERT') as can_insert,
|
|
134
|
+
has_table_privilege($1, $2, 'UPDATE') as can_update,
|
|
135
|
+
has_table_privilege($1, $2, 'DELETE') as can_delete`, [role, raw]);
|
|
136
|
+
if (Object.values(permissions.rows[0] ?? {}).some(Boolean)) {
|
|
137
|
+
throw new Error("Source reader unexpectedly has raw-table or write privileges.");
|
|
138
|
+
}
|
|
139
|
+
}
|
|
140
|
+
const escalation = await client.query(`select
|
|
141
|
+
pg_has_role($1, $2, 'MEMBER') as owner_member,
|
|
142
|
+
(select rolsuper or rolcreaterole or rolcreatedb or rolreplication or rolbypassrls
|
|
143
|
+
from pg_roles where rolname = $1) as privileged`, [role, plan.policy.reader.ownerRole]);
|
|
144
|
+
const escalationState = escalation.rows[0];
|
|
145
|
+
if (!escalationState) {
|
|
146
|
+
throw new Error("Source reader escalation check was inconclusive.");
|
|
147
|
+
}
|
|
148
|
+
if (escalationState.owner_member || escalationState.privileged) {
|
|
149
|
+
throw new Error("Source reader unexpectedly has role-escalation privileges.");
|
|
150
|
+
}
|
|
151
|
+
const network = await client.query(`select count(*)::integer as exposed
|
|
152
|
+
from pg_proc p
|
|
153
|
+
join pg_namespace n on n.oid = p.pronamespace
|
|
154
|
+
where has_function_privilege($1, p.oid, 'EXECUTE')
|
|
155
|
+
and (n.nspname in ('net', 'http') or p.proname ~* '^(dblink|http|net_)')
|
|
156
|
+
and p.prosecdef`, [role]);
|
|
157
|
+
if (Number(network.rows[0]?.exposed) > 0) {
|
|
158
|
+
throw new Error("Source reader can execute a security-definer network function.");
|
|
159
|
+
}
|
|
160
|
+
};
|
|
161
|
+
const assertApprovedOwnerScopes = (plan, environment) => {
|
|
162
|
+
for (const relation of plan.policy.relations) {
|
|
163
|
+
if (relation.rowScope.kind !== "approved-owner")
|
|
164
|
+
continue;
|
|
165
|
+
const value = environment[relation.rowScope.valueEnvironmentVariable];
|
|
166
|
+
const reviewedRelation = plan.review.relations.find((entry) => entry.view === relation.view);
|
|
167
|
+
const reviewedValueSha256 = reviewedRelation?.rowScope.kind === "approved-owner"
|
|
168
|
+
? reviewedRelation.rowScope.valueSha256
|
|
169
|
+
: undefined;
|
|
170
|
+
if (!value ||
|
|
171
|
+
createHash("sha256").update(value).digest("hex") !== reviewedValueSha256) {
|
|
172
|
+
throw new Error("Approved owner scope changed after the reviewed source-access preview.");
|
|
173
|
+
}
|
|
174
|
+
}
|
|
175
|
+
};
|
|
176
|
+
const buildSourceAccessReceipt = ({ plan, expiresAt, }) => ({
|
|
177
|
+
receiptVersion: 1,
|
|
178
|
+
accessMode: plan.policy.reader.mode,
|
|
179
|
+
policyFingerprint: sourceAccessPolicyFingerprint(plan.policy),
|
|
180
|
+
targetFingerprint: plan.policy.targetFingerprint,
|
|
181
|
+
planDigest: plan.digest,
|
|
182
|
+
exportSchema: plan.policy.exportSchema,
|
|
183
|
+
views: plan.policy.relations.map((relation) => relation.view).sort(),
|
|
184
|
+
relations: plan.policy.relations.map((relation) => ({
|
|
185
|
+
...relation.source,
|
|
186
|
+
columns: relation.columns,
|
|
187
|
+
})),
|
|
188
|
+
migrationLedger: plan.policy.migrationLedger,
|
|
189
|
+
readerRole: plan.policy.reader.role,
|
|
190
|
+
...(plan.policy.reader.mode === "managed"
|
|
191
|
+
? { ownerRole: plan.policy.reader.ownerRole }
|
|
192
|
+
: {}),
|
|
193
|
+
expiresAt,
|
|
194
|
+
});
|
|
195
|
+
const activateExternalPostgresqlSourceAccess = async ({ plan, projectRoot, artifactRoot, environment, clientFactory, now, }) => {
|
|
196
|
+
const connectionString = environment[plan.policy.reader.connectionEnvironmentVariable];
|
|
197
|
+
if (!connectionString) {
|
|
198
|
+
throw new Error(`Missing ${plan.policy.reader.connectionEnvironmentVariable}.`);
|
|
199
|
+
}
|
|
200
|
+
assertTarget(plan, connectionString);
|
|
201
|
+
assertApprovedOwnerScopes(plan, environment);
|
|
202
|
+
const { credentialPath, receiptPath } = resolvePostgresqlSourceStatePaths({
|
|
203
|
+
projectRoot,
|
|
204
|
+
artifactRoot,
|
|
205
|
+
credentialFile: plan.policy.reader.credentialFile,
|
|
206
|
+
});
|
|
207
|
+
await assertSourceStateAvailable(credentialPath, receiptPath);
|
|
208
|
+
const verified = await verifyExternalPostgresqlReader({
|
|
209
|
+
plan,
|
|
210
|
+
connectionString,
|
|
211
|
+
...(clientFactory ? { clientFactory } : {}),
|
|
212
|
+
now,
|
|
213
|
+
});
|
|
214
|
+
const temporaryCredentialPath = `${credentialPath}.building-${process.pid}`;
|
|
215
|
+
const receipt = buildSourceAccessReceipt({
|
|
216
|
+
plan,
|
|
217
|
+
expiresAt: verified.expiresAt,
|
|
218
|
+
});
|
|
219
|
+
let receiptWritten = false;
|
|
220
|
+
try {
|
|
221
|
+
await writeExclusiveSecret(temporaryCredentialPath, `REHEARSAL_SOURCE_DATABASE_URL=${connectionString}\n`);
|
|
222
|
+
await writeFile(receiptPath, `${JSON.stringify(receipt, null, 2)}\n`, {
|
|
223
|
+
flag: "wx",
|
|
224
|
+
mode: 0o600,
|
|
225
|
+
});
|
|
226
|
+
receiptWritten = true;
|
|
227
|
+
await chmod(receiptPath, 0o600);
|
|
228
|
+
await link(temporaryCredentialPath, credentialPath);
|
|
229
|
+
await rm(temporaryCredentialPath, { force: true });
|
|
230
|
+
}
|
|
231
|
+
catch (error) {
|
|
232
|
+
await rm(temporaryCredentialPath, { force: true });
|
|
233
|
+
if (receiptWritten)
|
|
234
|
+
await rm(receiptPath, { force: true });
|
|
235
|
+
throw error;
|
|
236
|
+
}
|
|
237
|
+
return { receipt, credentialPath, receiptPath };
|
|
238
|
+
};
|
|
239
|
+
export const applyPostgresqlSourceAccess = async ({ plan, confirmation, projectRoot = process.cwd(), artifactRoot = join(projectRoot, ".rehearsal"), environment = process.env, clientFactory, now = new Date(), }) => {
|
|
240
|
+
assertSourceAccessConfirmation(plan, confirmation);
|
|
241
|
+
if (plan.policy.reader.mode === "external") {
|
|
242
|
+
return activateExternalPostgresqlSourceAccess({
|
|
243
|
+
plan: plan,
|
|
244
|
+
projectRoot,
|
|
245
|
+
artifactRoot,
|
|
246
|
+
environment,
|
|
247
|
+
...(clientFactory ? { clientFactory } : {}),
|
|
248
|
+
now,
|
|
249
|
+
});
|
|
250
|
+
}
|
|
251
|
+
const managedPlan = plan;
|
|
252
|
+
const administratorConnectionString = environment[managedPlan.policy.administratorEnvironmentVariable];
|
|
253
|
+
if (!administratorConnectionString) {
|
|
254
|
+
throw new Error(`Missing ${managedPlan.policy.administratorEnvironmentVariable}.`);
|
|
255
|
+
}
|
|
256
|
+
assertTarget(managedPlan, administratorConnectionString);
|
|
257
|
+
assertApprovedOwnerScopes(managedPlan, environment);
|
|
258
|
+
const password = randomBytes(32).toString("base64url");
|
|
259
|
+
const expiresAt = new Date(now.valueOf() + managedPlan.policy.reader.validForMinutes * 60_000).toISOString();
|
|
260
|
+
const { credentialPath, receiptPath } = resolvePostgresqlSourceStatePaths({
|
|
261
|
+
projectRoot,
|
|
262
|
+
artifactRoot,
|
|
263
|
+
credentialFile: managedPlan.policy.reader.credentialFile,
|
|
264
|
+
});
|
|
265
|
+
const temporaryCredentialPath = `${credentialPath}.building-${process.pid}`;
|
|
266
|
+
const readerUrl = readerConnectionString(administratorConnectionString, managedPlan.policy.reader.role, password);
|
|
267
|
+
let receiptReserved = false;
|
|
268
|
+
let credentialLinked = false;
|
|
269
|
+
try {
|
|
270
|
+
await writeExclusiveSecret(temporaryCredentialPath, `REHEARSAL_SOURCE_DATABASE_URL=${readerUrl}\n`);
|
|
271
|
+
const receiptReservation = await open(receiptPath, "wx", 0o600);
|
|
272
|
+
receiptReserved = true;
|
|
273
|
+
await receiptReservation.close();
|
|
274
|
+
await link(temporaryCredentialPath, credentialPath);
|
|
275
|
+
credentialLinked = true;
|
|
276
|
+
await rm(temporaryCredentialPath, { force: true });
|
|
277
|
+
}
|
|
278
|
+
catch (error) {
|
|
279
|
+
await rm(temporaryCredentialPath, { force: true });
|
|
280
|
+
if (credentialLinked)
|
|
281
|
+
await rm(credentialPath, { force: true });
|
|
282
|
+
if (receiptReserved)
|
|
283
|
+
await rm(receiptPath, { force: true });
|
|
284
|
+
throw error;
|
|
285
|
+
}
|
|
286
|
+
let client;
|
|
287
|
+
try {
|
|
288
|
+
client = await connection(administratorConnectionString, clientFactory);
|
|
289
|
+
await client.query("begin");
|
|
290
|
+
await client.query("select pg_advisory_xact_lock(hashtext('rehearsal-source-access'))");
|
|
291
|
+
await assertUnusedObjects(client, managedPlan);
|
|
292
|
+
for (const relation of managedPlan.policy.relations)
|
|
293
|
+
await assertSourceColumns(client, relation);
|
|
294
|
+
await client.query(`create role ${quoteIdentifier(managedPlan.policy.reader.ownerRole)}
|
|
295
|
+
nologin noinherit nosuperuser nocreatedb nocreaterole noreplication nobypassrls`);
|
|
296
|
+
await client.query(`create role ${quoteIdentifier(managedPlan.policy.reader.role)}
|
|
297
|
+
login password ${quoteLiteral(password)} valid until ${quoteLiteral(expiresAt)}
|
|
298
|
+
noinherit nosuperuser nocreatedb nocreaterole noreplication nobypassrls`);
|
|
299
|
+
await client.query(`create schema ${quoteIdentifier(managedPlan.policy.exportSchema)}
|
|
300
|
+
authorization ${quoteIdentifier(managedPlan.policy.reader.ownerRole)}`);
|
|
301
|
+
await client.query(`revoke all on schema ${quoteIdentifier(managedPlan.policy.exportSchema)} from public`);
|
|
302
|
+
for (const schema of new Set(managedPlan.policy.relations.map((relation) => relation.source.schema))) {
|
|
303
|
+
await client.query(`grant usage on schema ${quoteIdentifier(schema)}
|
|
304
|
+
to ${quoteIdentifier(managedPlan.policy.reader.ownerRole)}`);
|
|
305
|
+
}
|
|
306
|
+
for (const relation of managedPlan.policy.relations) {
|
|
307
|
+
const columns = relation.columns.map(quoteIdentifier).join(", ");
|
|
308
|
+
await client.query(`grant select (${columns}) on ${sourceRelation(relation)}
|
|
309
|
+
to ${quoteIdentifier(managedPlan.policy.reader.ownerRole)}`);
|
|
310
|
+
const filter = relation.rowScope.kind === "approved-owner"
|
|
311
|
+
? ` where ${quoteIdentifier(relation.rowScope.column)} = ${quoteLiteral(environment[relation.rowScope.valueEnvironmentVariable])}`
|
|
312
|
+
: "";
|
|
313
|
+
await client.query(`set local role ${quoteIdentifier(managedPlan.policy.reader.ownerRole)}`);
|
|
314
|
+
await client.query(`create view ${viewRelation(plan, relation)} with (security_barrier = true) as
|
|
315
|
+
select ${columns} from ${sourceRelation(relation)}${filter}`);
|
|
316
|
+
await client.query("reset role");
|
|
317
|
+
await client.query(`revoke all on ${viewRelation(plan, relation)} from public`);
|
|
318
|
+
await client.query(`grant select on ${viewRelation(managedPlan, relation)} to ${quoteIdentifier(managedPlan.policy.reader.role)}`);
|
|
319
|
+
}
|
|
320
|
+
await client.query(`grant usage on schema ${quoteIdentifier(managedPlan.policy.exportSchema)}
|
|
321
|
+
to ${quoteIdentifier(managedPlan.policy.reader.role)}`);
|
|
322
|
+
const ledger = managedPlan.policy.migrationLedger;
|
|
323
|
+
await client.query(`grant usage on schema ${quoteIdentifier(ledger.schema)}
|
|
324
|
+
to ${quoteIdentifier(managedPlan.policy.reader.role)}`);
|
|
325
|
+
await client.query(`grant select (${[
|
|
326
|
+
ledger.versionColumn,
|
|
327
|
+
ledger.nameColumn,
|
|
328
|
+
ledger.statementsColumn,
|
|
329
|
+
]
|
|
330
|
+
.map(quoteIdentifier)
|
|
331
|
+
.join(", ")}) on ${quoteIdentifier(ledger.schema)}.${quoteIdentifier(ledger.table)}
|
|
332
|
+
to ${quoteIdentifier(managedPlan.policy.reader.role)}`);
|
|
333
|
+
await client.query(`comment on schema ${quoteIdentifier(managedPlan.policy.exportSchema)} is ${quoteLiteral(`rehearsal-source-access:${plan.digest}`)}`);
|
|
334
|
+
await runDenyChecks(client, managedPlan);
|
|
335
|
+
await client.query("commit");
|
|
336
|
+
}
|
|
337
|
+
catch (error) {
|
|
338
|
+
await client?.query("rollback").catch(() => undefined);
|
|
339
|
+
await Promise.all([
|
|
340
|
+
rm(credentialPath, { force: true }),
|
|
341
|
+
rm(receiptPath, { force: true }),
|
|
342
|
+
]);
|
|
343
|
+
throw error;
|
|
344
|
+
}
|
|
345
|
+
finally {
|
|
346
|
+
await client?.end?.();
|
|
347
|
+
}
|
|
348
|
+
const receipt = buildSourceAccessReceipt({ plan, expiresAt });
|
|
349
|
+
await writeFile(receiptPath, `${JSON.stringify(receipt, null, 2)}\n`, {
|
|
350
|
+
flag: "w",
|
|
351
|
+
mode: 0o600,
|
|
352
|
+
});
|
|
353
|
+
await chmod(receiptPath, 0o600);
|
|
354
|
+
return { receipt, credentialPath, receiptPath };
|
|
355
|
+
};
|
|
356
|
+
export const planPostgresqlSourceAccessRetirement = async ({ projectRoot = process.cwd(), artifactRoot = join(projectRoot, ".rehearsal"), targetFingerprint, }) => {
|
|
357
|
+
const receiptPath = join(resolveSourceStateRoot({ projectRoot, artifactRoot }), "source-access-receipt.json");
|
|
358
|
+
const receipt = JSON.parse(await readFile(receiptPath, "utf8"));
|
|
359
|
+
return {
|
|
360
|
+
...createSourceRetirementPlan({ receipt, targetFingerprint }),
|
|
361
|
+
receipt,
|
|
362
|
+
receiptPath,
|
|
363
|
+
};
|
|
364
|
+
};
|
|
365
|
+
export const retirePostgresqlSourceAccess = async ({ plan, confirmation, administratorEnvironmentVariable, projectRoot = process.cwd(), artifactRoot = join(projectRoot, ".rehearsal"), environment = process.env, credentialFile, clientFactory, }) => {
|
|
366
|
+
if (confirmation !== plan.digest) {
|
|
367
|
+
throw new Error(`Source retirement confirmation does not match. Expected ${plan.digest}.`);
|
|
368
|
+
}
|
|
369
|
+
const { credentialPath, receiptPath } = resolvePostgresqlSourceStatePaths({
|
|
370
|
+
projectRoot,
|
|
371
|
+
artifactRoot,
|
|
372
|
+
credentialFile,
|
|
373
|
+
});
|
|
374
|
+
if (resolve(plan.receiptPath) !== receiptPath) {
|
|
375
|
+
throw new Error("Source retirement receipt does not belong to this target's configured state root.");
|
|
376
|
+
}
|
|
377
|
+
if (plan.review.accessMode === "external") {
|
|
378
|
+
await Promise.all([
|
|
379
|
+
rm(credentialPath, { force: true }),
|
|
380
|
+
rm(receiptPath, { force: true }),
|
|
381
|
+
]);
|
|
382
|
+
return { retired: true, providerResourcesPreserved: true };
|
|
383
|
+
}
|
|
384
|
+
const ownerRole = plan.review.ownerRole;
|
|
385
|
+
if (!ownerRole) {
|
|
386
|
+
throw new Error("Managed source retirement is missing its owner role.");
|
|
387
|
+
}
|
|
388
|
+
const administratorConnectionString = administratorEnvironmentVariable === undefined
|
|
389
|
+
? undefined
|
|
390
|
+
: environment[administratorEnvironmentVariable];
|
|
391
|
+
if (!administratorConnectionString)
|
|
392
|
+
throw new Error(administratorEnvironmentVariable
|
|
393
|
+
? `Missing ${administratorEnvironmentVariable}.`
|
|
394
|
+
: "Managed source retirement requires an administrator environment variable.");
|
|
395
|
+
assertTarget({ policy: { targetFingerprint: plan.review.targetFingerprint } }, administratorConnectionString);
|
|
396
|
+
const client = await connection(administratorConnectionString, clientFactory);
|
|
397
|
+
try {
|
|
398
|
+
await client.query("begin");
|
|
399
|
+
await client.query("select pg_advisory_xact_lock(hashtext('rehearsal-source-access'))");
|
|
400
|
+
const inventory = await client.query(`select c.relname,
|
|
401
|
+
obj_description(n.oid, 'pg_namespace') as schema_comment
|
|
402
|
+
from pg_class c join pg_namespace n on n.oid = c.relnamespace
|
|
403
|
+
where n.nspname = $1 and c.relkind in ('v', 'm')
|
|
404
|
+
order by c.relname`, [plan.review.exportSchema]);
|
|
405
|
+
if (inventory.rows.map((row) => row.relname).join("\0") !==
|
|
406
|
+
plan.review.views.join("\0")) {
|
|
407
|
+
throw new Error("Source export schema changed after preparation; retirement stopped.");
|
|
408
|
+
}
|
|
409
|
+
if (inventory.rows.some((row) => row.schema_comment !==
|
|
410
|
+
`rehearsal-source-access:${plan.review.preparationDigest}`)) {
|
|
411
|
+
throw new Error("Source export schema ownership receipt does not match.");
|
|
412
|
+
}
|
|
413
|
+
for (const view of plan.review.views) {
|
|
414
|
+
await client.query(`drop view ${quoteIdentifier(plan.review.exportSchema)}.${quoteIdentifier(view)}`);
|
|
415
|
+
}
|
|
416
|
+
await client.query(`drop schema ${quoteIdentifier(plan.review.exportSchema)} restrict`);
|
|
417
|
+
for (const relation of plan.receipt.relations) {
|
|
418
|
+
await client.query(`revoke select (${relation.columns.map(quoteIdentifier).join(", ")})
|
|
419
|
+
on table ${quoteIdentifier(relation.schema)}.${quoteIdentifier(relation.table)}
|
|
420
|
+
from ${quoteIdentifier(ownerRole)}`);
|
|
421
|
+
}
|
|
422
|
+
for (const schema of new Set(plan.receipt.relations.map((relation) => relation.schema))) {
|
|
423
|
+
await client.query(`revoke usage on schema ${quoteIdentifier(schema)}
|
|
424
|
+
from ${quoteIdentifier(ownerRole)}`);
|
|
425
|
+
}
|
|
426
|
+
const ledger = plan.receipt.migrationLedger;
|
|
427
|
+
await client.query(`revoke all privileges on table ${quoteIdentifier(ledger.schema)}.${quoteIdentifier(ledger.table)}
|
|
428
|
+
from ${quoteIdentifier(plan.review.readerRole)}`);
|
|
429
|
+
await client.query(`revoke usage on schema ${quoteIdentifier(ledger.schema)}
|
|
430
|
+
from ${quoteIdentifier(plan.review.readerRole)}`);
|
|
431
|
+
await client.query(`drop role ${quoteIdentifier(plan.review.readerRole)}`);
|
|
432
|
+
await client.query(`drop role ${quoteIdentifier(ownerRole)}`);
|
|
433
|
+
await client.query("commit");
|
|
434
|
+
const remaining = await client.query(`select
|
|
435
|
+
exists(select 1 from pg_namespace where nspname = $1) as schema_exists,
|
|
436
|
+
exists(select 1 from pg_roles where rolname = $2) as reader_exists,
|
|
437
|
+
exists(select 1 from pg_roles where rolname = $3) as owner_exists`, [plan.review.exportSchema, plan.review.readerRole, ownerRole]);
|
|
438
|
+
if (Object.values(remaining.rows[0] ?? {}).some(Boolean)) {
|
|
439
|
+
throw new Error("Source access retirement could not be independently verified.");
|
|
440
|
+
}
|
|
441
|
+
}
|
|
442
|
+
catch (error) {
|
|
443
|
+
await client.query("rollback").catch(() => undefined);
|
|
444
|
+
throw error;
|
|
445
|
+
}
|
|
446
|
+
finally {
|
|
447
|
+
await client.end?.();
|
|
448
|
+
}
|
|
449
|
+
await Promise.all([
|
|
450
|
+
rm(credentialPath, { force: true }),
|
|
451
|
+
rm(receiptPath, { force: true }),
|
|
452
|
+
]);
|
|
453
|
+
return { retired: true };
|
|
454
|
+
};
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
/** Coordinate private source prefixes with reviewed privacy path mappings. */
|
|
2
|
+
export declare const resolvePrivacyMappedAssets: ({ sourcePolicy, privacyPolicy, environment, }: {
|
|
3
|
+
sourcePolicy: unknown;
|
|
4
|
+
privacyPolicy: unknown;
|
|
5
|
+
environment?: NodeJS.ProcessEnv;
|
|
6
|
+
}) => readonly Readonly<{
|
|
7
|
+
bucket: string;
|
|
8
|
+
prefix: string;
|
|
9
|
+
rights: "approved-public" | "approved-owner";
|
|
10
|
+
}>[];
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
/** Coordinate private source prefixes with reviewed privacy path mappings. */
|
|
2
|
+
import { validateExecutablePrivacyPolicy } from "../baseline/privacy_engine.mjs";
|
|
3
|
+
import { validateSourceAccessPolicy } from "./access.mjs";
|
|
4
|
+
export const resolvePrivacyMappedAssets = ({ sourcePolicy, privacyPolicy, environment = process.env, }) => {
|
|
5
|
+
const source = validateSourceAccessPolicy(sourcePolicy);
|
|
6
|
+
const privacy = validateExecutablePrivacyPolicy(privacyPolicy);
|
|
7
|
+
return Object.freeze(source.assets.map((asset) => {
|
|
8
|
+
if (!("pathMapping" in asset))
|
|
9
|
+
return asset;
|
|
10
|
+
const mapping = privacy.pathMappings[asset.pathMapping];
|
|
11
|
+
if (!mapping) {
|
|
12
|
+
throw new Error(`Storage asset references unknown privacy path mapping ${asset.pathMapping}.`);
|
|
13
|
+
}
|
|
14
|
+
const binding = privacy.bindings[mapping.binding];
|
|
15
|
+
if (!binding) {
|
|
16
|
+
throw new Error(`Storage asset ${asset.bucket} references an unknown privacy binding.`);
|
|
17
|
+
}
|
|
18
|
+
if (binding.environmentVariable !== asset.prefixEnvironmentVariable) {
|
|
19
|
+
throw new Error(`Storage asset ${asset.bucket} must use the environment variable reviewed by privacy path mapping ${asset.pathMapping}.`);
|
|
20
|
+
}
|
|
21
|
+
const prefix = environment[asset.prefixEnvironmentVariable];
|
|
22
|
+
if (typeof prefix !== "string" || !prefix) {
|
|
23
|
+
throw new Error(`Storage asset ${asset.bucket} requires ${asset.prefixEnvironmentVariable}.`);
|
|
24
|
+
}
|
|
25
|
+
return Object.freeze({ ...asset, prefix });
|
|
26
|
+
}));
|
|
27
|
+
};
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
/** Load exactly one supported database driver for the selected runtime target. */
|
|
2
|
+
import { resolveRuntimeTarget } from "./target.mjs";
|
|
3
|
+
export const runRuntimeTarget = async (target) => {
|
|
4
|
+
const resolved = resolveRuntimeTarget(target);
|
|
5
|
+
switch (resolved.id) {
|
|
6
|
+
case "supabase":
|
|
7
|
+
await import("./supabase.mjs");
|
|
8
|
+
return;
|
|
9
|
+
case "postgresql":
|
|
10
|
+
await import("./postgresql.mjs");
|
|
11
|
+
return;
|
|
12
|
+
}
|
|
13
|
+
};
|