mirror of
https://github.com/mauriceboe/TREK.git
synced 2026-11-20 19:16:08 +00:00
fix(db): hold plugin SQL on Postgres in layers the database enforces
The token guard kept leaking: on a superuser connection an unqualified `alter type int4 rename to int4x` renamed pg_catalog's type for the whole server, sequences and catalog-only objects grew the database past the quota, regtype/regconfig/regdictionary looked TREK's objects up by name, and a column alias named insert or merge in front of INTO made a table. Instead of a longer word list, the store now asks the database: - No plugin SQL while TREK's role is privileged in the sense of the restore check (PRIVILEGED_ROLE_SQL, imported from server-checks.ts): every db:own call fails with PRIVILEGED_ROLE_PLUGIN_REFUSAL, read once per pool connection, and the boot log says why. - The objects an ALTER, DROP, REFRESH, TRUNCATE or CREATE INDEX ... ON changes, and the tables a CREATE or ALTER TABLE ties to its own, are resolved with to_regclass/to_regtype in the transaction right before the statement, and it is refused unless each one found lies in the plugin's schema. An unqualified int4, text or box is pg_catalog's and refused even with the role check off. - The quota counts every relation of the schema with its TOAST table, and a schema holds at most PLUGIN_SCHEMA_MAX_OBJECTS catalog objects (relations, types, constraints, enum labels). - The guard refuses every reg* type and its array in every spelling, the has_*_privilege functions, currtid2 and the BRIN/GIN maintenance functions; INTO only after the INSERT or MERGE that is the statement's verb or a WITH body's; TEMP only where it makes a temporary object (CREATE TEMP/TEMPORARY, SELECT ... INTO TEMP), so a column named temp works again; a base type; and a NUL anywhere in the SQL text. - A bound value or a migration id holding NUL is refused with the reason instead of being stripped, so the plugin's keys never change meaning. Every bypass from the re-review is a test on the real database, on the role the plugin data is meant to run as and on a superuser connection with the role check off.
This commit is contained in:
@@ -10,6 +10,7 @@
|
||||
* store on a real database is the Postgres lane's
|
||||
* tests/postgres/plugin-data.test.ts.
|
||||
*/
|
||||
import { PRIVILEGED_ROLE_PLUGIN_REFUSAL } from '../../../../../src/db/engine/postgres/plugin-data-checks';
|
||||
import {
|
||||
dropPluginSchema,
|
||||
END_SESSION,
|
||||
@@ -18,6 +19,7 @@ import {
|
||||
PostgresPluginDataStore,
|
||||
type PluginSqlClient,
|
||||
} from '../../../../../src/db/engine/postgres/plugin-data-store';
|
||||
import { PRIVILEGED_ROLE_SQL } from '../../../../../src/db/engine/postgres/server-checks';
|
||||
|
||||
import type { Kysely } from 'kysely';
|
||||
import Cursor from 'pg-cursor';
|
||||
@@ -28,6 +30,12 @@ interface FakeOptions {
|
||||
schemas?: string[];
|
||||
/** The sizes the quota reads answer, in order. */
|
||||
sizes?: number[];
|
||||
/** The catalog object counts the quota reads answer, in order. */
|
||||
objects?: number[];
|
||||
/** Whether the role check answers that TREK's role is privileged. */
|
||||
privileged?: boolean;
|
||||
/** The objects the target check finds outside the plugin's schema. */
|
||||
foreign?: Array<{ name: string; nspname: string }>;
|
||||
/** Rows a cursor yields, by its statement's text; read two at a time. */
|
||||
rows?: Record<string, unknown[]>;
|
||||
/** What a write reports as changed. */
|
||||
@@ -62,6 +70,7 @@ function fakePool(options: FakeOptions = {}) {
|
||||
const cursors: Array<{ text: string; values: unknown[] | null; closed: boolean }> = [];
|
||||
const releases: boolean[] = [];
|
||||
let size = 0;
|
||||
let objects = 0;
|
||||
const run = (sql: string) => {
|
||||
log.push(sql);
|
||||
const err = options.fail?.(sql);
|
||||
@@ -69,7 +78,14 @@ function fakePool(options: FakeOptions = {}) {
|
||||
};
|
||||
const answer = (sql: string) => {
|
||||
if (sql.startsWith('select nspname')) return { rows: (options.schemas ?? []).map((nspname) => ({ nspname })) };
|
||||
if (sql.startsWith('select coalesce(sum(')) return { rows: [{ bytes: options.sizes?.[size++] ?? 0 }], rowCount: 1 };
|
||||
if (sql.startsWith('select (exists')) return { rows: [{ privileged: options.privileged === true }], rowCount: 1 };
|
||||
if (sql.startsWith('select t.name')) return { rows: options.foreign ?? [], rowCount: 0 };
|
||||
if (sql.startsWith('select coalesce((select sum(')) {
|
||||
return {
|
||||
rows: [{ bytes: options.sizes?.[size++] ?? 0, objects: options.objects?.[objects++] ?? 0 }],
|
||||
rowCount: 1,
|
||||
};
|
||||
}
|
||||
if (sql.startsWith('select 1 from')) return { rows: options.migrated ? [{ '?column?': 1 }] : [], rowCount: 0 };
|
||||
return { rows: [], rowCount: options.changes ?? 0 };
|
||||
};
|
||||
@@ -119,6 +135,9 @@ function store(options: FakeOptions = {}, limits = {}) {
|
||||
return { ...pool, store: new PostgresPluginDataStore('notes', pool.connect, new PluginDataSlots(4), limits) };
|
||||
}
|
||||
|
||||
/** The role check every first call on a client runs before its transaction. */
|
||||
const ROLE_CHECK = `select (${PRIVILEGED_ROLE_SQL}) as privileged`;
|
||||
|
||||
/** A pg error with its SQLSTATE. */
|
||||
function pgError(code: string, message: string): Error {
|
||||
return Object.assign(new Error(message), { code });
|
||||
@@ -132,6 +151,7 @@ describe('Postgres plugin data store', () => {
|
||||
expect(s.engine).toBe('postgres');
|
||||
expect(await s.query('SELECT body FROM notes')).toEqual([{ body: 'a' }, { body: 'b' }, { body: 'c' }]);
|
||||
expect(log).toEqual([
|
||||
ROLE_CHECK,
|
||||
'begin',
|
||||
[
|
||||
'create schema if not exists "trek_plugin_notes"',
|
||||
@@ -199,7 +219,7 @@ describe('Postgres plugin data store', () => {
|
||||
|
||||
const reads = store({}, { quotaBytes: 1 });
|
||||
await reads.store.query('SELECT 1');
|
||||
expect(reads.log.some((sql) => sql.startsWith('select coalesce(sum('))).toBe(false);
|
||||
expect(reads.log.some((sql) => sql.startsWith('select coalesce((select sum('))).toBe(false);
|
||||
});
|
||||
|
||||
it('PGSTORE-006: a script commits statement by statement and stops at the first that fails', async () => {
|
||||
@@ -304,7 +324,7 @@ describe('Postgres plugin data store', () => {
|
||||
expect(configs.filter((q) => q.queryMode === 'extended')).toHaveLength(plugin.length);
|
||||
});
|
||||
|
||||
it('PGSTORE-013: every read goes through a cursor on the same client, closed however the read ends, args without NUL', async () => {
|
||||
it('PGSTORE-013: every read goes through a cursor on the same client, closed however the read ends', async () => {
|
||||
// EXTQ-002 before the store checked out its own clients: what is not a plugin write reaches pg as it was.
|
||||
const rows = Array.from({ length: 7 }, (_, i) => ({ i }));
|
||||
const {
|
||||
@@ -312,9 +332,9 @@ describe('Postgres plugin data store', () => {
|
||||
cursors,
|
||||
configs,
|
||||
} = store({ rows: { 'SELECT i FROM t WHERE x = $1': rows, 'SELECT 1 FROM t': [{}] } }, { maxRows: 5 });
|
||||
await expect(s.query('SELECT i FROM t WHERE x = $1', ['a\u0000b'])).rejects.toThrow('more than 5 rows');
|
||||
await expect(s.query('SELECT i FROM t WHERE x = $1', ['ab'])).rejects.toThrow('more than 5 rows');
|
||||
await s.exec('SELECT 1 FROM t', ['x']);
|
||||
await s.exec('INSERT INTO t VALUES ($1)', ['c\u0000d']);
|
||||
await s.exec('INSERT INTO t VALUES ($1)', ['cd']);
|
||||
expect(cursors).toEqual([
|
||||
{ text: 'SELECT i FROM t WHERE x = $1', values: ['ab'], closed: true },
|
||||
{ text: 'SELECT 1 FROM t', values: ['x'], closed: true },
|
||||
@@ -322,6 +342,77 @@ describe('Postgres plugin data store', () => {
|
||||
expect(configs.find((q) => q.text.startsWith('INSERT'))?.values).toEqual(['cd']);
|
||||
});
|
||||
|
||||
it('PGSTORE-016: an argument or a migration id holding NUL is refused before a client is taken, never altered', async () => {
|
||||
const { store: s, log, releases } = store();
|
||||
const nul = /U\+0000 \(NUL\), which Postgres text cannot store/;
|
||||
await expect(s.query('SELECT 1 FROM t WHERE k = $1', ['a\u0000b'])).rejects.toThrow(nul);
|
||||
await expect(s.exec('INSERT INTO t VALUES ($1)', [['x', 'c\u0000d']])).rejects.toThrow(nul);
|
||||
await expect(s.tx([{ sql: 'SELECT 1' }, { sql: 'DELETE FROM t WHERE k = $1', args: ['\u0000'] }])).rejects.toThrow(
|
||||
nul,
|
||||
);
|
||||
await expect(s.migrate('001\u0000', 'CREATE TABLE t (k text)')).rejects.toThrow(nul);
|
||||
expect({ log, releases }).toEqual({ log: [], releases: [] });
|
||||
// A Buffer goes to bytea, which holds any byte.
|
||||
await expect(s.exec('INSERT INTO t VALUES ($1)', [Buffer.from([0, 1])])).resolves.toEqual({ changes: 0 });
|
||||
});
|
||||
|
||||
it('PGSTORE-017: a privileged role is refused before the transaction opens, and the answer is kept per connection', async () => {
|
||||
const privileged = store({ privileged: true });
|
||||
await expect(privileged.store.query('SELECT 1')).rejects.toThrow(PRIVILEGED_ROLE_PLUGIN_REFUSAL);
|
||||
await expect(privileged.store.exec('CREATE TABLE t (x int)')).rejects.toThrow(/db:own\) are refused on Postgres/);
|
||||
// One read for the connection, no transaction, and the client goes back clean.
|
||||
expect(privileged.log).toEqual([ROLE_CHECK, END_SESSION, END_SESSION]);
|
||||
expect(privileged.releases).toEqual([false, false]);
|
||||
|
||||
const plain = store();
|
||||
await plain.store.query('SELECT 1');
|
||||
await plain.store.query('SELECT 2');
|
||||
expect(plain.log.filter((sql) => sql === ROLE_CHECK)).toHaveLength(1);
|
||||
|
||||
// A read that failed is asked again on the next call.
|
||||
let fails = 1;
|
||||
const flaky = store({ fail: (sql) => (sql === ROLE_CHECK && fails-- > 0 ? new Error('reset') : undefined) });
|
||||
await expect(flaky.store.query('SELECT 1')).rejects.toThrow('reset');
|
||||
await expect(flaky.store.query('SELECT 1')).resolves.toEqual([]);
|
||||
expect(flaky.log.filter((sql) => sql === ROLE_CHECK)).toHaveLength(2);
|
||||
});
|
||||
|
||||
it('PGSTORE-018: the objects a statement changes are resolved right before it runs, and one outside the schema refuses it', async () => {
|
||||
const own = store();
|
||||
await own.store.migrate('001', 'CREATE TABLE a (x int); ALTER TYPE mood RENAME TO feeling; DROP TABLE "B", c');
|
||||
const checks = own.configs.filter((q) => q.text.startsWith('select t.name'));
|
||||
expect(checks.map((q) => q.values)).toEqual([
|
||||
[['"mood"'], ['type'], 'trek_plugin_notes'],
|
||||
[['"B"', '"c"'], ['relation', 'relation'], 'trek_plugin_notes'],
|
||||
]);
|
||||
// Each check comes right before its statement, after the ones before it ran.
|
||||
const order = own.log
|
||||
.filter((sql) => /^(select t\.name|CREATE|ALTER|DROP)/.test(sql))
|
||||
.map((sql) => sql.slice(0, 13));
|
||||
expect(order).toEqual(['CREATE TABLE ', 'select t.name', 'ALTER TYPE mo', 'select t.name', 'DROP TABLE "B']);
|
||||
|
||||
const foreign = store({ foreign: [{ name: '"int4"', nspname: 'pg_catalog' }] });
|
||||
await expect(foreign.store.exec('ALTER TYPE int4 RENAME TO int4x')).rejects.toThrow(
|
||||
/"int4" is an object of the schema "pg_catalog"; a plugin changes its own objects only/,
|
||||
);
|
||||
expect(foreign.log).not.toContain('ALTER TYPE int4 RENAME TO int4x');
|
||||
expect(foreign.log.slice(-2)).toEqual(['rollback', END_SESSION]);
|
||||
// A statement that changes no existing object asks nothing.
|
||||
const plain = store();
|
||||
await plain.store.exec('INSERT INTO a VALUES (1)');
|
||||
expect(plain.log.some((sql) => sql.startsWith('select t.name'))).toBe(false);
|
||||
});
|
||||
|
||||
it('PGSTORE-019: a write that takes the schema past its object cap and adds objects rolls back; a drop still runs', async () => {
|
||||
const grows = store({ sizes: [0, 0], objects: [10, 11] }, { maxObjects: 10 });
|
||||
await expect(grows.store.exec('CREATE TABLE t (x int)')).rejects.toThrow(
|
||||
'the plugin database holds more than 10 catalog objects',
|
||||
);
|
||||
expect(grows.log.slice(-2)).toEqual(['rollback', END_SESSION]);
|
||||
const drops = store({ sizes: [0, 0], objects: [12, 11] }, { maxObjects: 10 });
|
||||
await expect(drops.store.exec('DROP TABLE t')).resolves.toEqual({ changes: 0 });
|
||||
});
|
||||
|
||||
it('PGSTORE-014: each transaction checks out a client of its own and gives it back clean, or closes it', async () => {
|
||||
const ok = store({ changes: 1 });
|
||||
await ok.store.exec('INSERT INTO a VALUES (1); INSERT INTO b VALUES (2)');
|
||||
|
||||
@@ -11,6 +11,7 @@ import {
|
||||
parsePluginSql,
|
||||
PluginSqlRefused,
|
||||
tokenize,
|
||||
type PluginTarget,
|
||||
} from '../../../../../src/db/engine/postgres/plugin-sql-guard';
|
||||
|
||||
import { describe, expect, it } from 'vitest';
|
||||
@@ -63,6 +64,20 @@ describe('plugin SQL guard', () => {
|
||||
'WITH gone AS (DELETE FROM notes RETURNING id) INSERT INTO trash SELECT id FROM gone',
|
||||
'MERGE INTO notes n USING incoming i ON n.id = i.id WHEN NOT MATCHED THEN INSERT (body) VALUES (i.body)',
|
||||
'SELECT body AS "into", "temporary" FROM notes',
|
||||
// TEMP is refused only where it makes a temporary object; a column of that name is fine.
|
||||
'CREATE TABLE readings (day text, temp real, temporary bool)',
|
||||
'SELECT day, temp FROM readings WHERE temp > 1 ORDER BY temp',
|
||||
'select 1 from notes as temporary',
|
||||
'INSERT INTO temp (x) VALUES (1)',
|
||||
// INSERT INTO in a WITH query's body or after a WITH clause is the statement's own verb.
|
||||
'WITH n AS (INSERT INTO notes (body) VALUES ($1) RETURNING id) SELECT id FROM n',
|
||||
'WITH n AS NOT MATERIALIZED (SELECT 1) INSERT INTO notes (body) SELECT * FROM n',
|
||||
'WITH n AS MATERIALIZED (INSERT INTO notes (body) VALUES (1) RETURNING id) SELECT 1',
|
||||
// Names that only start like a refused one.
|
||||
'SELECT region, regexp_replace(body, $1, $2), regr_slope(1, 2) FROM notes',
|
||||
'CREATE TYPE span AS RANGE (subtype = float8)',
|
||||
'CREATE TABLE index (x int)',
|
||||
'CREATE INDEX ON notes (body)',
|
||||
])('lets through %s', (sql) => {
|
||||
expect(() => check(sql)).not.toThrow();
|
||||
});
|
||||
@@ -126,7 +141,6 @@ describe('plugin SQL guard', () => {
|
||||
['SELECT `x`', /unexpected character/],
|
||||
['SELECT 1; SELECT * FROM public.users', /another schema/],
|
||||
['SELECT 1 FROM notes INTO TEMP copy', /SELECT \.\.\. INTO/],
|
||||
['SELECT * FROM notes WHERE temp > 1', /TEMP/],
|
||||
['SELECT 0x1F', /hexadecimal/],
|
||||
['SELECT 0o17, 0b1', /hexadecimal/],
|
||||
['SELECT 1_000', /digit separators/],
|
||||
@@ -165,8 +179,33 @@ describe('plugin SQL guard', () => {
|
||||
['CREATE TEMP VIEW v AS SELECT 1', /CREATE TEMP is not allowed/],
|
||||
['CREATE OR REPLACE TEMP VIEW v AS SELECT 1', /CREATE TEMP is not allowed/],
|
||||
['CREATE TEMPORARY SEQUENCE s', /CREATE TEMPORARY is not allowed/],
|
||||
['select temp from notes', /TEMP/],
|
||||
['select 1 from notes as temporary', /TEMPORARY/],
|
||||
// The re-review's bypasses. A column alias named insert or merge in front of INTO made a table.
|
||||
['select 1 insert into t1', /SELECT \.\.\. INTO/],
|
||||
['select 1 merge into t9', /SELECT \.\.\. INTO/],
|
||||
['select 1 insert into unlogged t10', /SELECT \.\.\. INTO/],
|
||||
['select x as insert into t from notes', /SELECT \.\.\. INTO/],
|
||||
['WITH x AS (SELECT 1) SELECT 1 insert INTO t', /SELECT \.\.\. INTO/],
|
||||
['insert into notes select 1 insert into t', /SELECT \.\.\. INTO/],
|
||||
['select 1 insert into temp t', /SELECT \.\.\. INTO TEMP/],
|
||||
// The reg* types and functions that look an object up by a name in a string, in every spelling.
|
||||
["select 'public.users'::regtype::oid", /"regtype" may not be named/],
|
||||
["select cast('int4' as regtype)", /"regtype" may not be named/],
|
||||
["select regtype 'text'", /"regtype" may not be named/],
|
||||
[`select 'x'::"regtype"`, /"regtype" may not be named/],
|
||||
["select 'english'::regconfig", /"regconfig" may not be named/],
|
||||
["select 'simple'::regdictionary", /"regdictionary" may not be named/],
|
||||
["select '{public.users}'::_regclass", /"_regclass" may not be named/],
|
||||
["select 'x'::pg_catalog.regtype", /"pg_catalog" may not be named/],
|
||||
["select has_table_privilege('public.users', 'select')", /"has_table_privilege" may not be named/],
|
||||
["select currtid2('public.users', '(0,1)')", /"currtid2" may not be named/],
|
||||
["select gin_clean_pending_list('public.users_idx')", /"gin_clean_pending_list" may not be named/],
|
||||
["select to_regtype('int4')", /"to_regtype" may not be named/],
|
||||
// A base type is built from C functions, which only a superuser may do.
|
||||
['CREATE TYPE fake (INPUT = int4in, OUTPUT = int4out, INTERNALLENGTH = 1000)', /composite, enum or range/],
|
||||
// The protocol ends a statement's text at a NUL, in a string as anywhere else.
|
||||
["select 'a\u0000' -- then\nfrom public.users", /U\+0000/],
|
||||
['CREATE INDEX i (x)', /must name its table with ON/],
|
||||
['ALTER TABLE', /could not be read/],
|
||||
])('refuses the bypass %j', (sql, reason) => {
|
||||
expect(() => check(sql)).toThrow(PluginSqlRefused);
|
||||
expect(() => check(sql)).toThrow(reason);
|
||||
@@ -234,6 +273,54 @@ describe('plugin SQL guard', () => {
|
||||
expect(qualified.qualifies).toBe(true);
|
||||
});
|
||||
|
||||
it('refuses TEMP where it makes a temporary object, and says so', () => {
|
||||
for (const sql of [
|
||||
'CREATE TEMP TABLE t (x int)',
|
||||
'CREATE TEMPORARY VIEW v AS SELECT 1',
|
||||
'CREATE OR REPLACE TEMP VIEW v AS SELECT 1',
|
||||
'CREATE LOCAL TEMP TABLE t (x int)',
|
||||
'CREATE GLOBAL TEMPORARY TABLE t (x int)',
|
||||
]) {
|
||||
expect(() => check(sql), sql).toThrow(/is not allowed: a temporary object outlives the call/);
|
||||
}
|
||||
expect(() => check('select 1 into temp t')).toThrow(/SELECT \.\.\. INTO TEMP is not allowed: no temporary tables/);
|
||||
expect(() => check('CREATE LOCAL TABLE t (x int)')).toThrow(/CREATE LOCAL is not allowed$/);
|
||||
});
|
||||
|
||||
it('names the existing objects a statement changes, for the store to resolve in its transaction', () => {
|
||||
const targets = (sql: string) => parsePluginSql(sql)[0].targets;
|
||||
const rel = (...name: string[]): PluginTarget => ({ kind: 'relation', name });
|
||||
expect(targets('ALTER TYPE int4 RENAME TO int4x')).toEqual([{ kind: 'type', name: ['int4'] }]);
|
||||
expect(targets('DROP TYPE IF EXISTS mood, "Text" CASCADE')).toEqual([
|
||||
{ kind: 'type', name: ['mood'] },
|
||||
{ kind: 'type', name: ['Text'] },
|
||||
]);
|
||||
expect(targets('DROP TABLE IF EXISTS a, "B", trek_plugin_notes.c CASCADE')).toEqual([
|
||||
rel('a'),
|
||||
rel('B'),
|
||||
rel('trek_plugin_notes', 'c'),
|
||||
]);
|
||||
expect(targets('DROP INDEX CONCURRENTLY IF EXISTS i')).toEqual([rel('i')]);
|
||||
expect(targets('DROP MATERIALIZED VIEW mv')).toEqual([rel('mv')]);
|
||||
expect(targets('REFRESH MATERIALIZED VIEW CONCURRENTLY mv WITH DATA')).toEqual([rel('mv')]);
|
||||
expect(targets('TRUNCATE TABLE ONLY a, b * RESTART IDENTITY')).toEqual([rel('a'), rel('b')]);
|
||||
expect(targets('TRUNCATE a')).toEqual([rel('a')]);
|
||||
expect(targets('CREATE UNIQUE INDEX CONCURRENTLY IF NOT EXISTS i ON ONLY t USING btree (x)')).toEqual([rel('t')]);
|
||||
expect(targets('CREATE INDEX ON t (x)')).toEqual([rel('t')]);
|
||||
expect(targets('ALTER MATERIALIZED VIEW IF EXISTS mv RENAME TO mv2')).toEqual([rel('mv')]);
|
||||
expect(targets('ALTER TABLE IF EXISTS ONLY t ADD CONSTRAINT f FOREIGN KEY (x) REFERENCES p (id)')).toEqual([
|
||||
rel('t'),
|
||||
rel('p'),
|
||||
]);
|
||||
expect(targets('CREATE TABLE c (x int REFERENCES p) INHERITS (q, r)')).toEqual([rel('p'), rel('q'), rel('r')]);
|
||||
expect(targets('CREATE TABLE c PARTITION OF p FOR VALUES IN (1)')).toEqual([rel('p')]);
|
||||
expect(targets('ALTER TABLE p ATTACH PARTITION c FOR VALUES IN (1)')).toEqual([rel('p'), rel('c')]);
|
||||
expect(targets('ALTER TABLE c NO INHERIT p')).toEqual([rel('c'), rel('p')]);
|
||||
expect(targets('CREATE TABLE t (x int)')).toEqual([]);
|
||||
expect(targets('SELECT 1')).toEqual([]);
|
||||
expect(() => parsePluginSql('DROP TABLE a.b.c.d')).toThrow(/at most three parts/);
|
||||
});
|
||||
|
||||
it('turns a SQLite ? placeholder into a message about $1 when args are bound', () => {
|
||||
const [sqliteStyle] = parsePluginSql('SELECT * FROM notes WHERE id = ?');
|
||||
expect(() => checkPlaceholders(sqliteStyle, [1])).toThrow(/\$1, \$2/);
|
||||
|
||||
Reference in New Issue
Block a user