mirror of
https://github.com/mauriceboe/TREK.git
synced 2026-10-19 13:36:48 +00:00
107 lines
6.7 KiB
TypeScript
107 lines
6.7 KiB
TypeScript
/**
|
|
* Host-side capability audit log (#plugins, L1 hardening): resource projection,
|
|
* which methods are auditable, and the per-plugin hash chain.
|
|
*/
|
|
import { describe, it, expect, beforeEach } from 'vitest';
|
|
import Database from 'better-sqlite3';
|
|
import { appendAudit, readAudit, readAuditForUser, auditResource, isAuditable, pruneAudit } from '../../../src/nest/plugins/host/plugin-audit';
|
|
|
|
function makeDb() {
|
|
const db = new Database(':memory:');
|
|
db.exec(`CREATE TABLE plugin_capability_audit (
|
|
id INTEGER PRIMARY KEY AUTOINCREMENT, plugin_id TEXT NOT NULL, acting_user_id INTEGER,
|
|
method TEXT NOT NULL, resource TEXT, code TEXT NOT NULL, ts TEXT NOT NULL,
|
|
prev_hash TEXT, hash TEXT NOT NULL);`);
|
|
return db;
|
|
}
|
|
|
|
describe('auditResource + isAuditable', () => {
|
|
it('projects a resource key from method + params (never raw params)', () => {
|
|
expect(auditResource('trips.getById', { tripId: 12 })).toBe('trip:12');
|
|
expect(auditResource('users.getById', { id: 3 })).toBe('user:3');
|
|
expect(auditResource('ws.broadcastToTrip', { tripId: 7 })).toBe('trip:7');
|
|
expect(auditResource('ws.broadcastToUser', { userId: 9 })).toBe('user:9');
|
|
expect(auditResource('db.query', { sql: 'x' })).toBeNull();
|
|
});
|
|
|
|
it('audits core-data + ws, not a plugin own-db call', () => {
|
|
expect(isAuditable('trips.getReservations')).toBe(true);
|
|
expect(isAuditable('users.getById')).toBe(true);
|
|
expect(isAuditable('packing.list')).toBe(true);
|
|
expect(isAuditable('files.list')).toBe(true);
|
|
expect(isAuditable('ws.broadcastToTrip')).toBe(true);
|
|
expect(isAuditable('db.query')).toBe(false);
|
|
expect(isAuditable('db.migrate')).toBe(false);
|
|
});
|
|
|
|
it('resolves packing/files reads to their trip resource', () => {
|
|
expect(auditResource('packing.list', { tripId: 3 })).toBe('trip:3');
|
|
expect(auditResource('files.list', { tripId: 3 })).toBe('trip:3');
|
|
});
|
|
});
|
|
|
|
describe('appendAudit hash chain', () => {
|
|
let db: ReturnType<typeof makeDb>;
|
|
beforeEach(() => { db = makeDb(); });
|
|
|
|
it('chains each entry off the previous hash (per plugin)', async () => {
|
|
await appendAudit(db, { pluginId: 'p', actingUserId: 42, method: 'trips.getById', resource: 'trip:1', code: 'ok' });
|
|
await appendAudit(db, { pluginId: 'p', actingUserId: 42, method: 'trips.getById', resource: 'trip:2', code: 'ok' });
|
|
const rows = db.prepare('SELECT prev_hash, hash FROM plugin_capability_audit ORDER BY id').all() as Array<{ prev_hash: string | null; hash: string }>;
|
|
expect(rows).toHaveLength(2);
|
|
expect(rows[0].prev_hash).toBeNull();
|
|
expect(rows[1].prev_hash).toBe(rows[0].hash); // chain links
|
|
expect(rows[1].hash).not.toBe(rows[0].hash);
|
|
});
|
|
|
|
it('keeps separate chains per plugin', async () => {
|
|
await appendAudit(db, { pluginId: 'a', method: 'trips.getById', resource: 'trip:1', code: 'ok' });
|
|
await appendAudit(db, { pluginId: 'b', method: 'trips.getById', resource: 'trip:1', code: 'ok' });
|
|
const a = db.prepare("SELECT prev_hash FROM plugin_capability_audit WHERE plugin_id='b'").get() as { prev_hash: string | null };
|
|
expect(a.prev_hash).toBeNull(); // b's first entry doesn't chain off a's
|
|
});
|
|
|
|
it('records denials too (code is the error code)', async () => {
|
|
await appendAudit(db, { pluginId: 'p', actingUserId: 99, method: 'trips.getById', resource: 'trip:1', code: 'RESOURCE_FORBIDDEN' });
|
|
const row = (await readAudit(db, 'p'))[0] as { code: string; method: string };
|
|
expect(row.code).toBe('RESOURCE_FORBIDDEN');
|
|
});
|
|
|
|
it('readAuditForUser returns one user\'s actions across ALL plugins, newest first, with the plugin name', async () => {
|
|
db.exec("CREATE TABLE plugins (id TEXT PRIMARY KEY, name TEXT)");
|
|
db.prepare("INSERT INTO plugins (id, name) VALUES ('koffi','Koffi'), ('flight','Flight Tracker')").run();
|
|
await appendAudit(db, { pluginId: 'koffi', actingUserId: 42, method: 'trips.getById', resource: 'trip:1', code: 'ok' });
|
|
await appendAudit(db, { pluginId: 'flight', actingUserId: 42, method: 'reservations.create', resource: 'trip:1', code: 'ok' });
|
|
await appendAudit(db, { pluginId: 'koffi', actingUserId: 99, method: 'trips.getById', resource: 'trip:2', code: 'ok' }); // another user
|
|
const mine = (await readAuditForUser(db, 42)) as Array<{ plugin_id: string; plugin_name: string; method: string }>;
|
|
expect(mine).toHaveLength(2); // only user 42's rows, across both plugins
|
|
expect(mine[0]).toMatchObject({ plugin_id: 'flight', plugin_name: 'Flight Tracker', method: 'reservations.create' }); // newest first
|
|
expect(mine[1]).toMatchObject({ plugin_id: 'koffi', plugin_name: 'Koffi' });
|
|
expect(mine.some((r) => r.plugin_id === 'koffi' && r.method === 'trips.getById' && (r as { resource?: string }).resource === 'trip:2')).toBe(false); // never another user's
|
|
});
|
|
|
|
it('readAudit returns newest first with the projected fields only', async () => {
|
|
await appendAudit(db, { pluginId: 'p', actingUserId: 42, method: 'trips.getById', resource: 'trip:1', code: 'ok' });
|
|
const rows = (await readAudit(db, 'p')) as Array<Record<string, unknown>>;
|
|
expect(rows[0]).toHaveProperty('method', 'trips.getById');
|
|
expect(rows[0]).not.toHaveProperty('prev_hash'); // internal chain fields not exposed
|
|
});
|
|
|
|
it('pruneAudit keeps only the newest N rows per plugin, leaving the retained window chain-consistent', async () => {
|
|
for (let i = 0; i < 50; i++) await appendAudit(db, { pluginId: 'p', actingUserId: 1, method: 'trips.getById', resource: `trip:${i}`, code: 'ok' });
|
|
await appendAudit(db, { pluginId: 'other', actingUserId: 1, method: 'trips.getById', resource: 'trip:x', code: 'ok' });
|
|
await pruneAudit(db, 'p', 10);
|
|
const rows = db.prepare("SELECT resource, prev_hash, hash FROM plugin_capability_audit WHERE plugin_id = 'p' ORDER BY id ASC").all() as Array<{ resource: string; prev_hash: string | null; hash: string }>;
|
|
expect(rows).toHaveLength(10);
|
|
expect(rows[rows.length - 1].resource).toBe('trip:49'); // newest kept
|
|
// each retained row is still self-consistent: hash === sha256(prev_hash + row-content)
|
|
// (proven by re-appending on top — the chain continues from the surviving tip)
|
|
await appendAudit(db, { pluginId: 'p', actingUserId: 1, method: 'trips.getById', resource: 'trip:new', code: 'ok' });
|
|
expect(db.prepare("SELECT COUNT(*) c FROM plugin_capability_audit WHERE plugin_id='p'").get()).toMatchObject({ c: 11 });
|
|
// pruning one plugin never touches another's rows
|
|
expect(db.prepare("SELECT COUNT(*) c FROM plugin_capability_audit WHERE plugin_id='other'").get()).toMatchObject({ c: 1 });
|
|
await expect(pruneAudit(db, 'p', 0)).resolves.toBeUndefined(); // 0 = disabled, no-op
|
|
expect(db.prepare("SELECT COUNT(*) c FROM plugin_capability_audit WHERE plugin_id='p'").get()).toMatchObject({ c: 11 });
|
|
});
|
|
});
|