|
| 1 | +// Copyright (c) 2026 ObjectStack. Licensed under the Apache-2.0 license. |
| 2 | + |
| 3 | +/** |
| 4 | + * #27722 — the datasource admin door applies the #27582 own-reference rule to |
| 5 | + * `external.credentialsRef`: **a write may only seal a new value or keep its |
| 6 | + * own record's stored reference.** |
| 7 | + * |
| 8 | + * The door's callers are the admin routes (`POST` / `PATCH /datasources`), a |
| 9 | + * signed-in operator every time; nothing system-side writes through this |
| 10 | + * service, so there is no pass-through to keep here. |
| 11 | + * |
| 12 | + * - **create** — a new record has no reference of its own to keep, so a draft |
| 13 | + * that names `external.credentialsRef` is refused, with one answer whatever |
| 14 | + * it names, before anything is written. The credential arrives as `secret` |
| 15 | + * and the door binds it; that reference is the only one a create stores. |
| 16 | + * - **update** — the record keeps the reference it already holds unless a |
| 17 | + * supplied `secret` rewraps it. A patch that names any other reference never |
| 18 | + * reaches the stored record. |
| 19 | + * |
| 20 | + * The harness is the service's own config seam, so each case reads exactly |
| 21 | + * what the door persisted, bound, removed and registered. |
| 22 | + */ |
| 23 | + |
| 24 | +import { describe, expect, it } from 'vitest'; |
| 25 | +import { |
| 26 | + DatasourceAdminService, |
| 27 | + type DatasourceAdminServiceConfig, |
| 28 | + type StoredDatasource, |
| 29 | +} from '../datasource-admin-service.js'; |
| 30 | + |
| 31 | +/** A reference some other write minted — the kind a caller must not store. */ |
| 32 | +const OTHER_REF = 'sys_secret:sec_minted_elsewhere'; |
| 33 | + |
| 34 | +function makeHarness(seed: StoredDatasource[] = []) { |
| 35 | + const records: StoredDatasource[] = seed.map((r) => ({ ...r })); |
| 36 | + const secrets = new Map<string, string>([[OTHER_REF, 'other-credential']]); |
| 37 | + const ops: string[] = []; |
| 38 | + let seq = 0; |
| 39 | + |
| 40 | + const config: DatasourceAdminServiceConfig = { |
| 41 | + probe: async () => ({ ok: true }), |
| 42 | + listDatasourceRecords: async () => records.map((r) => ({ ...r })), |
| 43 | + getDatasourceRecord: async (name) => { |
| 44 | + const r = records.find((x) => x.name === name); |
| 45 | + return r ? { ...r } : undefined; |
| 46 | + }, |
| 47 | + putDatasourceRecord: async (record) => { |
| 48 | + ops.push(`put:${record.name}`); |
| 49 | + const idx = records.findIndex((r) => r.name === record.name); |
| 50 | + if (idx >= 0) records[idx] = { ...record }; |
| 51 | + else records.push({ ...record }); |
| 52 | + }, |
| 53 | + deleteDatasourceRecord: async (name) => { |
| 54 | + ops.push(`delete:${name}`); |
| 55 | + const idx = records.findIndex((r) => r.name === name); |
| 56 | + if (idx >= 0) records.splice(idx, 1); |
| 57 | + }, |
| 58 | + writeSecret: async (input) => { |
| 59 | + const ref = `sys_secret:sec_minted_${++seq}`; |
| 60 | + ops.push(`writeSecret:${ref}`); |
| 61 | + secrets.set(ref, input.value); |
| 62 | + return ref; |
| 63 | + }, |
| 64 | + removeSecret: async (ref) => { |
| 65 | + ops.push(`removeSecret:${ref}`); |
| 66 | + secrets.delete(ref); |
| 67 | + }, |
| 68 | + readSecret: async (ref) => secrets.get(ref), |
| 69 | + countBoundObjects: async () => 0, |
| 70 | + listObjectsBoundTo: async () => [], |
| 71 | + registerPool: (record) => { |
| 72 | + ops.push(`registerPool:${record.name}`); |
| 73 | + }, |
| 74 | + unregisterPool: (name) => { |
| 75 | + ops.push(`unregisterPool:${name}`); |
| 76 | + }, |
| 77 | + }; |
| 78 | + |
| 79 | + const service = new DatasourceAdminService(config); |
| 80 | + const stored = (name: string) => records.find((r) => r.name === name); |
| 81 | + return { service, stored, secrets, ops }; |
| 82 | +} |
| 83 | + |
| 84 | +const DRAFT = { |
| 85 | + name: 'reporting', |
| 86 | + driver: 'postgres', |
| 87 | + config: { host: 'db.internal', database: 'analytics' }, |
| 88 | +}; |
| 89 | + |
| 90 | +describe('#27722 — a create may not carry a stored credential reference', () => { |
| 91 | + it.each([ |
| 92 | + ['a reference another write minted', OTHER_REF], |
| 93 | + ['a reference that names nothing', 'sys_secret:sec_never_minted'], |
| 94 | + ['a value in no reference shape', 'not-a-reference'], |
| 95 | + ])('refuses %s, writing nothing', async (_label, ref) => { |
| 96 | + const { service, stored, secrets, ops } = makeHarness(); |
| 97 | + |
| 98 | + await expect( |
| 99 | + service.createDatasource({ ...DRAFT, external: { credentialsRef: ref } }), |
| 100 | + ).rejects.toThrow(/external\.credentialsRef/); |
| 101 | + |
| 102 | + expect(stored('reporting')).toBeUndefined(); |
| 103 | + expect(ops).toEqual([]); |
| 104 | + expect(secrets.get(OTHER_REF)).toBe('other-credential'); |
| 105 | + }); |
| 106 | + |
| 107 | + it('answers the same whatever the reference names, and never echoes it', async () => { |
| 108 | + const messages: string[] = []; |
| 109 | + for (const ref of [OTHER_REF, 'sys_secret:sec_never_minted', 'not-a-reference']) { |
| 110 | + const { service } = makeHarness(); |
| 111 | + const err = await service |
| 112 | + .createDatasource({ ...DRAFT, external: { credentialsRef: ref } }) |
| 113 | + .catch((e: unknown) => e as Error); |
| 114 | + expect(err).toBeInstanceOf(Error); |
| 115 | + expect((err as Error).message).not.toContain(ref); |
| 116 | + messages.push((err as Error).message); |
| 117 | + } |
| 118 | + expect(new Set(messages).size).toBe(1); |
| 119 | + }); |
| 120 | + |
| 121 | + it('refuses it beside a supplied secret too: the door mints the only reference a create stores', async () => { |
| 122 | + const { service, stored, ops } = makeHarness(); |
| 123 | + |
| 124 | + await expect( |
| 125 | + service.createDatasource( |
| 126 | + { ...DRAFT, external: { credentialsRef: OTHER_REF } }, |
| 127 | + { value: 'fresh-credential' }, |
| 128 | + ), |
| 129 | + ).rejects.toThrow(/external\.credentialsRef/); |
| 130 | + |
| 131 | + expect(stored('reporting')).toBeUndefined(); |
| 132 | + expect(ops).toEqual([]); |
| 133 | + }); |
| 134 | + |
| 135 | + it('stores the reference its own secret was sealed under', async () => { |
| 136 | + const { service, stored, secrets } = makeHarness(); |
| 137 | + |
| 138 | + await service.createDatasource(DRAFT, { value: 'fresh-credential' }); |
| 139 | + |
| 140 | + const ref = stored('reporting')?.external?.credentialsRef; |
| 141 | + expect(ref).toMatch(/^sys_secret:sec_minted_/); |
| 142 | + expect(ref).not.toBe(OTHER_REF); |
| 143 | + expect(secrets.get(ref!)).toBe('fresh-credential'); |
| 144 | + }); |
| 145 | + |
| 146 | + it('still creates a record that names no reference at all', async () => { |
| 147 | + const { service, stored } = makeHarness(); |
| 148 | + |
| 149 | + await service.createDatasource({ ...DRAFT, schemaMode: 'external', external: { allowWrites: false } }); |
| 150 | + |
| 151 | + expect(stored('reporting')).toBeDefined(); |
| 152 | + expect(stored('reporting')?.external?.credentialsRef).toBeUndefined(); |
| 153 | + }); |
| 154 | +}); |
| 155 | + |
| 156 | +describe('#27722 — an update keeps its own reference and stores no other', () => { |
| 157 | + const OWN_REF = 'sys_secret:sec_own'; |
| 158 | + |
| 159 | + it('keeps the record\'s own reference when a patch names another', async () => { |
| 160 | + const { service, stored, secrets, ops } = makeHarness([ |
| 161 | + { ...DRAFT, origin: 'runtime', external: { credentialsRef: OWN_REF } }, |
| 162 | + ]); |
| 163 | + |
| 164 | + await service.updateDatasource('reporting', { external: { credentialsRef: OTHER_REF } }); |
| 165 | + |
| 166 | + expect(stored('reporting')?.external?.credentialsRef).toBe(OWN_REF); |
| 167 | + expect(ops).not.toContain(`removeSecret:${OTHER_REF}`); |
| 168 | + expect(secrets.get(OTHER_REF)).toBe('other-credential'); |
| 169 | + }); |
| 170 | + |
| 171 | + it('stores no reference on a record that holds none when a patch names one', async () => { |
| 172 | + const { service, stored } = makeHarness([{ ...DRAFT, origin: 'runtime' }]); |
| 173 | + |
| 174 | + await service.updateDatasource('reporting', { external: { credentialsRef: OTHER_REF } }); |
| 175 | + |
| 176 | + expect(stored('reporting')?.external?.credentialsRef).toBeUndefined(); |
| 177 | + }); |
| 178 | + |
| 179 | + it('replaces its own reference only with the one a supplied secret is sealed under', async () => { |
| 180 | + const { service, stored, secrets, ops } = makeHarness([ |
| 181 | + { ...DRAFT, origin: 'runtime', external: { credentialsRef: OWN_REF } }, |
| 182 | + ]); |
| 183 | + |
| 184 | + await service.updateDatasource( |
| 185 | + 'reporting', |
| 186 | + { external: { credentialsRef: OTHER_REF } }, |
| 187 | + { value: 'rotated-credential' }, |
| 188 | + ); |
| 189 | + |
| 190 | + const ref = stored('reporting')?.external?.credentialsRef; |
| 191 | + expect(ref).toMatch(/^sys_secret:sec_minted_/); |
| 192 | + expect(secrets.get(ref!)).toBe('rotated-credential'); |
| 193 | + expect(ops).toContain(`removeSecret:${OWN_REF}`); |
| 194 | + expect(ops).not.toContain(`removeSecret:${OTHER_REF}`); |
| 195 | + expect(secrets.get(OTHER_REF)).toBe('other-credential'); |
| 196 | + }); |
| 197 | +}); |
0 commit comments