@terreno/api 57.1.0 → 57.3.0
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/README.md +17 -7
- package/dist/actions.js +19 -7
- package/dist/adminTypes.d.ts +26 -0
- package/dist/api.d.ts +4 -0
- package/dist/api.js +12 -24
- package/dist/auth.d.ts +23 -10
- package/dist/auth.js +97 -32
- package/dist/authRecovery.d.ts +5 -0
- package/dist/authRecovery.js +350 -0
- package/dist/authTokens.d.ts +8 -0
- package/dist/authTokens.js +162 -0
- package/dist/betterAuth.d.ts +33 -0
- package/dist/betterAuthApp.d.ts +4 -0
- package/dist/betterAuthApp.js +26 -8
- package/dist/betterAuthSetup.d.ts +44 -2
- package/dist/betterAuthSetup.js +288 -18
- package/dist/collectionRegistry.d.ts +38 -0
- package/dist/collectionRegistry.js +72 -0
- package/dist/configurationApp.d.ts +11 -2
- package/dist/configurationApp.js +2 -4
- package/dist/docLoader.js +35 -6
- package/dist/expressServer.d.ts +26 -3
- package/dist/expressServer.js +79 -11
- package/dist/index.d.ts +16 -0
- package/dist/index.js +38 -2
- package/dist/mcp/auth.d.ts +1 -0
- package/dist/mcp/auth.js +47 -25
- package/dist/mcp/handlers.d.ts +1 -1
- package/dist/mcp/handlers.js +67 -233
- package/dist/mcp/query.d.ts +2 -2
- package/dist/mcp/registry.d.ts +1 -5
- package/dist/mcp/registry.js +31 -20
- package/dist/mcp/schemaGenerator.d.ts +2 -7
- package/dist/mcp/schemaGenerator.js +41 -116
- package/dist/mcp/server.d.ts +1 -0
- package/dist/mcp/server.js +1 -0
- package/dist/mcp/serviceTokens.d.ts +16 -0
- package/dist/mcp/serviceTokens.js +345 -0
- package/dist/mcp/types.d.ts +2 -2
- package/dist/models/mcpServiceToken.d.ts +3 -0
- package/dist/models/mcpServiceToken.js +208 -0
- package/dist/openApiBuilder.d.ts +5 -4
- package/dist/openApiBuilder.js +61 -8
- package/dist/openApiCompat.js +1 -1
- package/dist/openApiValidator.js +0 -2
- package/dist/plugins.d.ts +14 -1
- package/dist/plugins.js +17 -6
- package/dist/populate.d.ts +2 -2
- package/dist/populate.js +47 -42
- package/dist/rateLimit/applyTrustProxy.d.ts +3 -0
- package/dist/rateLimit/applyTrustProxy.js +17 -0
- package/dist/rateLimit/createStore.d.ts +2 -0
- package/dist/rateLimit/createStore.js +28 -0
- package/dist/rateLimit/memoryStore.d.ts +2 -0
- package/dist/rateLimit/memoryStore.js +108 -0
- package/dist/rateLimit/middleware.d.ts +11 -0
- package/dist/rateLimit/middleware.js +110 -0
- package/dist/rateLimit/mongoStore.d.ts +3 -0
- package/dist/rateLimit/mongoStore.js +122 -0
- package/dist/rateLimit/policies.d.ts +14 -0
- package/dist/rateLimit/policies.js +151 -0
- package/dist/rateLimit/redisStore.d.ts +3 -0
- package/dist/rateLimit/redisStore.js +155 -0
- package/dist/rateLimit/types.d.ts +54 -0
- package/dist/rateLimit/types.js +9 -0
- package/dist/rbac/access.js +5 -1
- package/dist/rbac/assertAllowed.d.ts +9 -0
- package/dist/rbac/assertAllowed.js +182 -0
- package/dist/rbac/modelRouterAccess.d.ts +1 -0
- package/dist/rbac/modelRouterAccess.js +8 -4
- package/dist/rbac/permissionUtils.js +3 -2
- package/dist/rbac/resolve.js +5 -4
- package/dist/rbac/routes.js +15 -6
- package/dist/rbac/statements.d.ts +10 -0
- package/dist/rbac/statements.js +13 -2
- package/dist/realtime/deprecation.d.ts +12 -0
- package/dist/realtime/deprecation.js +32 -0
- package/dist/realtime/realtimeApp.d.ts +1 -1
- package/dist/realtime/realtimeApp.js +10 -11
- package/dist/realtime/registry.d.ts +0 -31
- package/dist/realtime/registry.js +44 -31
- package/dist/realtime/socketAuth.d.ts +5 -5
- package/dist/realtime/socketAuth.js +11 -1
- package/dist/realtime/socketUser.d.ts +5 -1
- package/dist/realtime/types.d.ts +14 -4
- package/dist/schemaMetadata.d.ts +56 -0
- package/dist/schemaMetadata.js +513 -0
- package/dist/seedRunner.d.ts +88 -0
- package/dist/seedRunner.js +627 -0
- package/dist/sync/executors.d.ts +12 -2
- package/dist/sync/executors.js +8 -10
- package/dist/sync/loadHarness.js +28 -19
- package/dist/sync/models.js +26 -24
- package/dist/sync/mutationHandler.d.ts +9 -0
- package/dist/sync/mutationHandler.js +11 -6
- package/dist/sync/registrationSideEffects.d.ts +35 -0
- package/dist/sync/registrationSideEffects.js +151 -0
- package/dist/sync/registry.d.ts +2 -52
- package/dist/sync/registry.js +38 -187
- package/dist/sync/routes.js +3 -2
- package/dist/sync/scripts/compactTombstones.js +0 -2
- package/dist/sync/syncApp.d.ts +3 -3
- package/dist/sync/syncApp.js +4 -4
- package/dist/sync/syncBatch.js +3 -2
- package/dist/sync/syncSeqPlugin.d.ts +1 -1
- package/dist/sync/syncSeqPlugin.js +20 -16
- package/dist/terrenoApp.d.ts +19 -5
- package/dist/terrenoApp.js +66 -18
- package/dist/tests/models.d.ts +2 -0
- package/dist/tests/models.js +6 -0
- package/dist/types/authToken.d.ts +33 -0
- package/dist/types/authToken.js +2 -0
- package/dist/types/mcpServiceToken.d.ts +41 -0
- package/dist/types/mcpServiceToken.js +2 -0
- package/dist/webhooks/headerValue.d.ts +2 -0
- package/dist/webhooks/headerValue.js +14 -0
- package/dist/webhooks/idempotency/memoryStore.d.ts +10 -0
- package/dist/webhooks/idempotency/memoryStore.js +65 -0
- package/dist/webhooks/idempotency/mongoStore.d.ts +4 -0
- package/dist/webhooks/idempotency/mongoStore.js +150 -0
- package/dist/webhooks/idempotency/webhookReceipt.d.ts +62 -0
- package/dist/webhooks/idempotency/webhookReceipt.js +39 -0
- package/dist/webhooks/rawBody.d.ts +14 -0
- package/dist/webhooks/rawBody.js +22 -0
- package/dist/webhooks/timingSafeEqual.d.ts +4 -0
- package/dist/webhooks/timingSafeEqual.js +17 -0
- package/dist/webhooks/verifiers/hmac.d.ts +15 -0
- package/dist/webhooks/verifiers/hmac.js +49 -0
- package/dist/webhooks/verifiers/sendgrid.d.ts +10 -0
- package/dist/webhooks/verifiers/sendgrid.js +56 -0
- package/dist/webhooks/verifiers/stripe.d.ts +9 -0
- package/dist/webhooks/verifiers/stripe.js +99 -0
- package/dist/webhooks/verifiers/twilio.d.ts +9 -0
- package/dist/webhooks/verifiers/twilio.js +112 -0
- package/dist/webhooks/webhooksApp.d.ts +33 -0
- package/dist/webhooks/webhooksApp.js +195 -0
- package/package.json +5 -6
- package/src/__snapshots__/openApi.test.ts.snap +270 -0
- package/src/__snapshots__/openApiBuilder.test.ts.snap +30 -12
- package/src/__snapshots__/schemaMetadata.test.ts.snap +197 -0
- package/src/actions.ts +20 -13
- package/src/adminModelRouter.test.ts +133 -0
- package/src/adminTypes.ts +23 -0
- package/src/api.arrayOperations.test.ts +43 -31
- package/src/api.hooks.test.ts +38 -29
- package/src/api.query.test.ts +31 -31
- package/src/api.test.ts +95 -96
- package/src/api.ts +16 -27
- package/src/auth.test.ts +107 -51
- package/src/auth.ts +98 -29
- package/src/authRecovery.test.ts +281 -0
- package/src/authRecovery.ts +279 -0
- package/src/authTokens.test.ts +94 -0
- package/src/authTokens.ts +118 -0
- package/src/authVerification.test.ts +293 -0
- package/src/betterAuth.ts +24 -0
- package/src/betterAuthApp.test.ts +1 -0
- package/src/betterAuthApp.ts +27 -9
- package/src/betterAuthSetup.test.ts +568 -38
- package/src/betterAuthSetup.ts +260 -5
- package/src/collectionRegistry.test.ts +165 -0
- package/src/collectionRegistry.ts +115 -0
- package/src/configurationApp.ts +13 -7
- package/src/docLoader.test.ts +45 -1
- package/src/docLoader.ts +37 -6
- package/src/express.d.ts +1 -0
- package/src/expressServer.test.ts +130 -66
- package/src/expressServer.ts +75 -19
- package/src/githubAuth.test.ts +60 -55
- package/src/index.ts +58 -0
- package/src/mcp/auth.test.ts +47 -0
- package/src/mcp/auth.ts +32 -11
- package/src/mcp/handlers.ts +45 -172
- package/src/mcp/integration.test.ts +59 -9
- package/src/mcp/query.ts +2 -4
- package/src/mcp/registry.ts +29 -20
- package/src/mcp/schemaGenerator.test.ts +8 -0
- package/src/mcp/schemaGenerator.ts +49 -131
- package/src/mcp/server.ts +2 -0
- package/src/mcp/serviceTokens.test.ts +330 -0
- package/src/mcp/serviceTokens.ts +307 -0
- package/src/mcp/toolGenerator.test.ts +1 -1
- package/src/mcp/types.ts +2 -6
- package/src/models/mcpServiceToken.test.ts +129 -0
- package/src/models/mcpServiceToken.ts +158 -0
- package/src/openApi.test.ts +80 -64
- package/src/openApiBuilder.test.ts +95 -7
- package/src/openApiBuilder.ts +46 -9
- package/src/openApiCompat.ts +1 -1
- package/src/openApiValidator.test.ts +49 -54
- package/src/openApiValidator.ts +1 -3
- package/src/plugins.test.ts +14 -0
- package/src/plugins.ts +34 -9
- package/src/populate.test.ts +34 -0
- package/src/populate.ts +40 -29
- package/src/rateLimit/applyTrustProxy.ts +17 -0
- package/src/rateLimit/createStore.ts +25 -0
- package/src/rateLimit/memoryStore.ts +40 -0
- package/src/rateLimit/middleware.ts +79 -0
- package/src/rateLimit/mongoStore.test.ts +80 -0
- package/src/rateLimit/mongoStore.ts +76 -0
- package/src/rateLimit/policies.ts +130 -0
- package/src/rateLimit/rateLimit.test.ts +328 -0
- package/src/rateLimit/redisStore.ioredis.test.ts +29 -0
- package/src/rateLimit/redisStore.test.ts +114 -0
- package/src/rateLimit/redisStore.ts +85 -0
- package/src/rateLimit/types.ts +64 -0
- package/src/rbac/access.ts +5 -1
- package/src/rbac/assertAllowed.test.ts +325 -0
- package/src/rbac/assertAllowed.ts +157 -0
- package/src/rbac/backfillAdmins.test.ts +124 -0
- package/src/rbac/fieldViews.test.ts +89 -0
- package/src/rbac/modelRouterAccess.test.ts +126 -0
- package/src/rbac/modelRouterAccess.ts +5 -2
- package/src/rbac/permissionUtils.ts +3 -2
- package/src/rbac/realtimeAccess.test.ts +109 -1
- package/src/rbac/resolve.ts +5 -4
- package/src/rbac/roleManager.test.ts +169 -0
- package/src/rbac/routes.test.ts +233 -0
- package/src/rbac/routes.ts +16 -6
- package/src/rbac/statements.test.ts +2 -0
- package/src/rbac/statements.ts +12 -1
- package/src/realtime/deprecation.test.ts +60 -0
- package/src/realtime/deprecation.ts +32 -0
- package/src/realtime/realtime.test.ts +8 -4
- package/src/realtime/realtimeApp.ts +10 -11
- package/src/realtime/realtimeAppSetup.test.ts +32 -5
- package/src/realtime/registry.ts +48 -42
- package/src/realtime/sessionRevalidation.test.ts +57 -44
- package/src/realtime/socketAuth.test.ts +75 -23
- package/src/realtime/socketAuth.ts +17 -6
- package/src/realtime/socketUser.ts +5 -3
- package/src/realtime/types.ts +14 -4
- package/src/schemaMetadata.test.ts +405 -0
- package/src/schemaMetadata.ts +593 -0
- package/src/scrubAdminFields.test.ts +105 -0
- package/src/seedRunner.test.ts +591 -0
- package/src/seedRunner.ts +464 -0
- package/src/sync/docMatchesMutationData.test.ts +16 -0
- package/src/sync/ensureSyncIndexes.test.ts +54 -15
- package/src/sync/executors.test.ts +40 -0
- package/src/sync/executors.ts +24 -12
- package/src/sync/integration.test.ts +15 -7
- package/src/sync/loadHarness.ts +28 -19
- package/src/sync/models.ts +32 -18
- package/src/sync/mutationHandler.test.ts +16 -16
- package/src/sync/mutationHandler.ts +9 -7
- package/src/sync/registrationSideEffects.test.ts +126 -0
- package/src/sync/registrationSideEffects.ts +131 -0
- package/src/sync/registry.ts +45 -171
- package/src/sync/routes.ts +3 -2
- package/src/sync/scripts/compactTombstones.ts +0 -2
- package/src/sync/sessionRevalidationIntegration.test.ts +12 -11
- package/src/sync/sync.test.ts +25 -23
- package/src/sync/syncApp.ts +4 -4
- package/src/sync/syncBatch.ts +3 -2
- package/src/sync/syncFrontier.test.ts +17 -15
- package/src/sync/syncPhaseC.test.ts +54 -43
- package/src/sync/syncRoutes.test.ts +51 -36
- package/src/sync/syncSeqPlugin.ts +66 -44
- package/src/sync/syncSocket.test.ts +112 -81
- package/src/terrenoApp.mcpServiceTokens.test.ts +173 -0
- package/src/terrenoApp.ts +87 -15
- package/src/tests/models.ts +14 -1
- package/src/types/authToken.ts +43 -0
- package/src/types/mcpServiceToken.ts +54 -0
- package/src/webhooks/headerValue.test.ts +22 -0
- package/src/webhooks/headerValue.ts +12 -0
- package/src/webhooks/idempotency/memoryStore.ts +34 -0
- package/src/webhooks/idempotency/mongoStore.test.ts +274 -0
- package/src/webhooks/idempotency/mongoStore.ts +83 -0
- package/src/webhooks/idempotency/webhookReceipt.ts +70 -0
- package/src/webhooks/rawBody.test.ts +74 -0
- package/src/webhooks/rawBody.ts +23 -0
- package/src/webhooks/timingSafeEqual.ts +16 -0
- package/src/webhooks/verifiers/hmac.test.ts +110 -0
- package/src/webhooks/verifiers/hmac.ts +54 -0
- package/src/webhooks/verifiers/providerVerifiers.test.ts +388 -0
- package/src/webhooks/verifiers/sendgrid.ts +59 -0
- package/src/webhooks/verifiers/stripe.ts +67 -0
- package/src/webhooks/verifiers/twilio.ts +69 -0
- package/src/webhooks/webhooksApp.test.ts +221 -0
- package/src/webhooks/webhooksApp.ts +144 -0
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import {describe, expect, it} from "bun:test";
|
|
2
|
+
import {assert} from "chai";
|
|
2
3
|
import mongoose from "mongoose";
|
|
3
4
|
|
|
4
5
|
import type {User} from "../auth";
|
|
@@ -8,6 +9,7 @@ import {createAccess} from "./access";
|
|
|
8
9
|
import {
|
|
9
10
|
buildAccessPermissions,
|
|
10
11
|
buildAccessQueryFilter,
|
|
12
|
+
resolveActionForMethod,
|
|
11
13
|
resolveModelRouterAccess,
|
|
12
14
|
validateAccessWriteBody,
|
|
13
15
|
wrapAccessResponseHandler,
|
|
@@ -35,6 +37,24 @@ const createTestUser = (
|
|
|
35
37
|
};
|
|
36
38
|
};
|
|
37
39
|
|
|
40
|
+
/**
|
|
41
|
+
* Minimal TerrenoAccess stub for the filter-merging branches, which depend only on
|
|
42
|
+
* `statements` and `queryFilter` and would otherwise need a seeded role per case.
|
|
43
|
+
*/
|
|
44
|
+
const createAccessStub = (
|
|
45
|
+
scopeFilter: Record<string, unknown> | null
|
|
46
|
+
): AnyTerrenoAccess & {queryFilterCalls: number} => {
|
|
47
|
+
const stub = {
|
|
48
|
+
queryFilter: async () => {
|
|
49
|
+
stub.queryFilterCalls += 1;
|
|
50
|
+
return scopeFilter;
|
|
51
|
+
},
|
|
52
|
+
queryFilterCalls: 0,
|
|
53
|
+
statements: appStatements,
|
|
54
|
+
};
|
|
55
|
+
return stub as unknown as AnyTerrenoAccess & {queryFilterCalls: number};
|
|
56
|
+
};
|
|
57
|
+
|
|
38
58
|
describe("modelRouterAccess", () => {
|
|
39
59
|
it("builds permissions from access config", async () => {
|
|
40
60
|
await setupDb();
|
|
@@ -315,6 +335,112 @@ describe("modelRouterAccess", () => {
|
|
|
315
335
|
expect(resolved.responseHandler).toBeDefined();
|
|
316
336
|
});
|
|
317
337
|
|
|
338
|
+
it("resolves actions per method", () => {
|
|
339
|
+
const statements: Record<string, readonly string[]> = appStatements;
|
|
340
|
+
assert.equal(
|
|
341
|
+
resolveActionForMethod("list", {actions: {list: "browse"}, resource: "todo"}, statements),
|
|
342
|
+
"browse"
|
|
343
|
+
);
|
|
344
|
+
assert.isNull(
|
|
345
|
+
resolveActionForMethod("read", {actions: {read: null}, resource: "todo"}, statements)
|
|
346
|
+
);
|
|
347
|
+
assert.equal(resolveActionForMethod("list", {resource: "todo"}, statements), "list");
|
|
348
|
+
assert.equal(resolveActionForMethod("list", {resource: "unknown"}, statements), "read");
|
|
349
|
+
assert.equal(resolveActionForMethod("update", {resource: "todo"}, statements), "update");
|
|
350
|
+
});
|
|
351
|
+
|
|
352
|
+
it("returns null when the access scope filter denies every row", async () => {
|
|
353
|
+
const queryFilter = buildAccessQueryFilter(createAccessStub(null), {resource: "todo"});
|
|
354
|
+
assert.isNull(await queryFilter(createTestUser(["reader"]), {completed: false}));
|
|
355
|
+
});
|
|
356
|
+
|
|
357
|
+
it("keeps the incoming query when the scope filter is empty", async () => {
|
|
358
|
+
const queryFilter = buildAccessQueryFilter(createAccessStub({}), {resource: "todo"});
|
|
359
|
+
assert.deepEqual(await queryFilter(createTestUser(["reader"]), {completed: false}), {
|
|
360
|
+
completed: false,
|
|
361
|
+
});
|
|
362
|
+
});
|
|
363
|
+
|
|
364
|
+
it("skips scope filtering when the list action is disabled", async () => {
|
|
365
|
+
const access = createAccessStub({ownerId: "someone-else"});
|
|
366
|
+
const queryFilter = buildAccessQueryFilter(access, {
|
|
367
|
+
actions: {list: null},
|
|
368
|
+
resource: "todo",
|
|
369
|
+
});
|
|
370
|
+
|
|
371
|
+
assert.deepEqual(await queryFilter(createTestUser(["reader"]), {completed: true}), {
|
|
372
|
+
completed: true,
|
|
373
|
+
});
|
|
374
|
+
assert.equal(access.queryFilterCalls, 0);
|
|
375
|
+
});
|
|
376
|
+
|
|
377
|
+
it("merges the per-router scope filter on top of the access filter", async () => {
|
|
378
|
+
const queryFilter = buildAccessQueryFilter(createAccessStub({tenantId: "t1"}), {
|
|
379
|
+
resource: "todo",
|
|
380
|
+
scope: {
|
|
381
|
+
filter: async ({user}) => ({ownerId: user.id}),
|
|
382
|
+
},
|
|
383
|
+
});
|
|
384
|
+
const user = createTestUser(["reader"]);
|
|
385
|
+
|
|
386
|
+
assert.deepEqual(await queryFilter(user, {completed: false}), {
|
|
387
|
+
$and: [{$and: [{completed: false}, {tenantId: "t1"}]}, {ownerId: user.id}],
|
|
388
|
+
});
|
|
389
|
+
});
|
|
390
|
+
|
|
391
|
+
it("denies scope checks for anonymous requests and rejected docs", async () => {
|
|
392
|
+
await setupDb();
|
|
393
|
+
const access = createAccess({
|
|
394
|
+
connection: mongoose.connection,
|
|
395
|
+
defaultRoles: [
|
|
396
|
+
{
|
|
397
|
+
displayName: "Reader",
|
|
398
|
+
name: "reader",
|
|
399
|
+
permissions: {todo: ["read"]},
|
|
400
|
+
},
|
|
401
|
+
],
|
|
402
|
+
statements: appStatements,
|
|
403
|
+
});
|
|
404
|
+
await access.roles.seedDefaults();
|
|
405
|
+
|
|
406
|
+
const permissions = buildAccessPermissions(access as AnyTerrenoAccess, {
|
|
407
|
+
resource: "todo",
|
|
408
|
+
scope: {
|
|
409
|
+
check: ({doc}) => (doc as {ownerId?: string} | undefined)?.ownerId === "mine",
|
|
410
|
+
},
|
|
411
|
+
});
|
|
412
|
+
const scopeCheck = permissions.read[1];
|
|
413
|
+
const user = createTestUser(["reader"]);
|
|
414
|
+
|
|
415
|
+
assert.isFalse(await scopeCheck("read", undefined, {ownerId: "mine"}));
|
|
416
|
+
assert.isFalse(await scopeCheck("read", user, {ownerId: "theirs"}));
|
|
417
|
+
assert.isTrue(await scopeCheck("read", user, {ownerId: "mine"}));
|
|
418
|
+
});
|
|
419
|
+
|
|
420
|
+
it("appends the `also` permission checks after the access checks", async () => {
|
|
421
|
+
await setupDb();
|
|
422
|
+
const access = createAccess({
|
|
423
|
+
connection: mongoose.connection,
|
|
424
|
+
defaultRoles: [
|
|
425
|
+
{
|
|
426
|
+
displayName: "Reader",
|
|
427
|
+
name: "reader",
|
|
428
|
+
permissions: {todo: ["read"]},
|
|
429
|
+
},
|
|
430
|
+
],
|
|
431
|
+
statements: appStatements,
|
|
432
|
+
});
|
|
433
|
+
await access.roles.seedDefaults();
|
|
434
|
+
|
|
435
|
+
const permissions = buildAccessPermissions(access as AnyTerrenoAccess, {
|
|
436
|
+
also: {read: [Permissions.IsAdmin]},
|
|
437
|
+
resource: "todo",
|
|
438
|
+
});
|
|
439
|
+
|
|
440
|
+
assert.lengthOf(permissions.read, 2);
|
|
441
|
+
assert.isFalse(await permissions.read[1]("read", createTestUser(["reader"])));
|
|
442
|
+
});
|
|
443
|
+
|
|
318
444
|
it("returns legacy permissions when access config is absent", () => {
|
|
319
445
|
const permissions = {
|
|
320
446
|
create: [Permissions.IsAdmin],
|
|
@@ -35,7 +35,7 @@ const mergeFilters = (
|
|
|
35
35
|
return {$and: [existing, scopeFilter]};
|
|
36
36
|
};
|
|
37
37
|
|
|
38
|
-
const resolveActionForMethod = (
|
|
38
|
+
export const resolveActionForMethod = (
|
|
39
39
|
method: RESTMethod,
|
|
40
40
|
access: ModelRouterAccessOptions,
|
|
41
41
|
statements: Record<string, readonly string[]>
|
|
@@ -299,7 +299,10 @@ export const resolveModelRouterAccess = <T>(options: {
|
|
|
299
299
|
} => {
|
|
300
300
|
if (!options.access || !options.accessControl) {
|
|
301
301
|
if (!options.permissions) {
|
|
302
|
-
throw new
|
|
302
|
+
throw new APIError({
|
|
303
|
+
status: 500,
|
|
304
|
+
title: "modelRouter requires permissions or access with accessControl",
|
|
305
|
+
});
|
|
303
306
|
}
|
|
304
307
|
return {
|
|
305
308
|
permissions: options.permissions,
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import {APIError} from "../errors";
|
|
1
2
|
import type {PermissionSet} from "./statements";
|
|
2
3
|
|
|
3
4
|
export const unionPermissionSets = (...sets: PermissionSet[]): PermissionSet => {
|
|
@@ -72,11 +73,11 @@ export const validatePermissionSet = (
|
|
|
72
73
|
for (const [resource, actions] of Object.entries(permissions)) {
|
|
73
74
|
const allowedActions = statements[resource];
|
|
74
75
|
if (!allowedActions) {
|
|
75
|
-
throw new
|
|
76
|
+
throw new APIError({status: 500, title: `Unknown resource: ${resource}`});
|
|
76
77
|
}
|
|
77
78
|
for (const action of actions) {
|
|
78
79
|
if (!allowedActions.includes(action)) {
|
|
79
|
-
throw new
|
|
80
|
+
throw new APIError({status: 500, title: `Unknown permission: ${resource}:${action}`});
|
|
80
81
|
}
|
|
81
82
|
}
|
|
82
83
|
}
|
|
@@ -13,7 +13,13 @@ import {
|
|
|
13
13
|
} from "./realtimeAccess";
|
|
14
14
|
import {OwnerScope} from "./scopes";
|
|
15
15
|
import {terrenoStatements} from "./statements";
|
|
16
|
-
import type {
|
|
16
|
+
import type {
|
|
17
|
+
AccessCheckArgs,
|
|
18
|
+
AccessResult,
|
|
19
|
+
AnyTerrenoAccess,
|
|
20
|
+
PermissionRequest,
|
|
21
|
+
Statements,
|
|
22
|
+
} from "./types";
|
|
17
23
|
|
|
18
24
|
const appStatements = {
|
|
19
25
|
...terrenoStatements,
|
|
@@ -41,6 +47,19 @@ const makeEntry = (options: RealtimeRegistryEntry["options"]): RealtimeRegistryE
|
|
|
41
47
|
routePath: "/todos",
|
|
42
48
|
});
|
|
43
49
|
|
|
50
|
+
const makeStubAccess = ({
|
|
51
|
+
allowed,
|
|
52
|
+
onCheck,
|
|
53
|
+
}: {
|
|
54
|
+
allowed: boolean;
|
|
55
|
+
onCheck?: (args: AccessCheckArgs<Statements>) => AccessResult | undefined;
|
|
56
|
+
}): AnyTerrenoAccess =>
|
|
57
|
+
({
|
|
58
|
+
can: async (args: AccessCheckArgs<Statements>): Promise<AccessResult> =>
|
|
59
|
+
onCheck?.(args) ?? {allowed},
|
|
60
|
+
statements: appStatements,
|
|
61
|
+
}) as unknown as AnyTerrenoAccess;
|
|
62
|
+
|
|
44
63
|
describe("realtimeAccess", () => {
|
|
45
64
|
it("uses accessControl permissions for subscriptions", async () => {
|
|
46
65
|
await setupDb();
|
|
@@ -239,4 +258,93 @@ describe("realtimeAccess", () => {
|
|
|
239
258
|
const doc = {title: "Plain"};
|
|
240
259
|
expect(await maskRealtimeDocument(entry, undefined, doc, "read")).toBe(doc);
|
|
241
260
|
});
|
|
261
|
+
|
|
262
|
+
it("falls back to the read action when the resource has no list statement", async () => {
|
|
263
|
+
await setupDb();
|
|
264
|
+
const readOnlyStatements = {
|
|
265
|
+
...terrenoStatements,
|
|
266
|
+
note: ["create", "read", "update", "delete"],
|
|
267
|
+
} as const;
|
|
268
|
+
const access = createAccess({
|
|
269
|
+
connection: mongoose.connection,
|
|
270
|
+
defaultRoles: [
|
|
271
|
+
{
|
|
272
|
+
displayName: "Note Reader",
|
|
273
|
+
name: "note-reader",
|
|
274
|
+
permissions: {note: ["read"]},
|
|
275
|
+
},
|
|
276
|
+
],
|
|
277
|
+
statements: readOnlyStatements,
|
|
278
|
+
});
|
|
279
|
+
await access.roles.seedDefaults();
|
|
280
|
+
|
|
281
|
+
const user = createTestUser({roles: ["note-reader"]});
|
|
282
|
+
const entry = makeEntry({
|
|
283
|
+
access: {resource: "note"},
|
|
284
|
+
accessControl: access as AnyTerrenoAccess,
|
|
285
|
+
});
|
|
286
|
+
|
|
287
|
+
expect(await canSubscribeRealtime(entry, "list", user)).toBe(true);
|
|
288
|
+
});
|
|
289
|
+
|
|
290
|
+
it("returns false for document reads when the read action override is null", async () => {
|
|
291
|
+
const user = createTestUser();
|
|
292
|
+
const entry = makeEntry({
|
|
293
|
+
access: {actions: {read: null}, resource: "todo"},
|
|
294
|
+
accessControl: makeStubAccess({allowed: true}),
|
|
295
|
+
});
|
|
296
|
+
|
|
297
|
+
expect(await canReadDocumentRealtime(entry, user, {title: "Any"})).toBe(false);
|
|
298
|
+
});
|
|
299
|
+
|
|
300
|
+
it("denies scoped document reads for anonymous subscribers", async () => {
|
|
301
|
+
const entry = makeEntry({
|
|
302
|
+
access: {resource: "todo", scope: {check: () => true}},
|
|
303
|
+
accessControl: makeStubAccess({allowed: true}),
|
|
304
|
+
});
|
|
305
|
+
|
|
306
|
+
expect(await canReadDocumentRealtime(entry, undefined, {title: "Any"})).toBe(false);
|
|
307
|
+
});
|
|
308
|
+
|
|
309
|
+
it("re-checks permissions returned by a scope check", async () => {
|
|
310
|
+
const permissionRequests: PermissionRequest<Statements>[] = [];
|
|
311
|
+
const user = createTestUser();
|
|
312
|
+
const entry = makeEntry({
|
|
313
|
+
access: {
|
|
314
|
+
resource: "todo",
|
|
315
|
+
scope: {check: () => ({todo: ["update"]})},
|
|
316
|
+
},
|
|
317
|
+
accessControl: makeStubAccess({
|
|
318
|
+
allowed: true,
|
|
319
|
+
onCheck: (args) => {
|
|
320
|
+
permissionRequests.push(args.permissions);
|
|
321
|
+
return undefined;
|
|
322
|
+
},
|
|
323
|
+
}),
|
|
324
|
+
});
|
|
325
|
+
|
|
326
|
+
expect(await canReadDocumentRealtime(entry, user, {title: "Any"})).toBe(true);
|
|
327
|
+
expect(permissionRequests).toEqual([{todo: ["read"]}, {todo: ["update"]}]);
|
|
328
|
+
});
|
|
329
|
+
|
|
330
|
+
it("denies document reads when scope permissions are not granted", async () => {
|
|
331
|
+
const user = createTestUser();
|
|
332
|
+
const entry = makeEntry({
|
|
333
|
+
access: {
|
|
334
|
+
resource: "todo",
|
|
335
|
+
scope: {check: () => ({todo: ["delete"]})},
|
|
336
|
+
},
|
|
337
|
+
accessControl: makeStubAccess({
|
|
338
|
+
allowed: true,
|
|
339
|
+
onCheck: (args) => {
|
|
340
|
+
if (args.permissions.todo?.includes("delete")) {
|
|
341
|
+
return {allowed: false};
|
|
342
|
+
}
|
|
343
|
+
return undefined;
|
|
344
|
+
},
|
|
345
|
+
}),
|
|
346
|
+
});
|
|
347
|
+
|
|
348
|
+
expect(await canReadDocumentRealtime(entry, user, {title: "Any"})).toBe(false);
|
|
349
|
+
});
|
|
242
350
|
});
|
package/src/rbac/resolve.ts
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import {createAccessControl} from "better-auth/plugins/access";
|
|
2
|
+
import {DateTime} from "luxon";
|
|
2
3
|
|
|
3
4
|
import type {User} from "../auth";
|
|
4
5
|
import {logger} from "../logger";
|
|
@@ -47,7 +48,7 @@ export const createPermissionResolver = <S extends Statements>(args: {
|
|
|
47
48
|
const sourceCache = new Map<string, Map<string, SourceCacheEntry>>();
|
|
48
49
|
|
|
49
50
|
const enforceCacheBound = (): void => {
|
|
50
|
-
const now =
|
|
51
|
+
const now = DateTime.now().toMillis();
|
|
51
52
|
for (const [userId, entry] of permissionCache) {
|
|
52
53
|
if (entry.expiresAt <= now) {
|
|
53
54
|
permissionCache.delete(userId);
|
|
@@ -159,7 +160,7 @@ export const createPermissionResolver = <S extends Statements>(args: {
|
|
|
159
160
|
source: PermissionSource,
|
|
160
161
|
shouldCache = true
|
|
161
162
|
): Promise<PermissionSourceGrants | null> => {
|
|
162
|
-
const now =
|
|
163
|
+
const now = DateTime.now().toMillis();
|
|
163
164
|
const cached = sourceCache.get(user.id)?.get(source.name);
|
|
164
165
|
|
|
165
166
|
if (!shouldCache) {
|
|
@@ -206,7 +207,7 @@ export const createPermissionResolver = <S extends Statements>(args: {
|
|
|
206
207
|
): Promise<PermissionSet> => {
|
|
207
208
|
if (shouldCache) {
|
|
208
209
|
const cached = permissionCache.get(user.id);
|
|
209
|
-
if (cached && cached.expiresAt >
|
|
210
|
+
if (cached && cached.expiresAt > DateTime.now().toMillis()) {
|
|
210
211
|
rememberPermissions(user.id, cached);
|
|
211
212
|
return cached.permissions;
|
|
212
213
|
}
|
|
@@ -251,7 +252,7 @@ export const createPermissionResolver = <S extends Statements>(args: {
|
|
|
251
252
|
|
|
252
253
|
if (shouldCache) {
|
|
253
254
|
rememberPermissions(user.id, {
|
|
254
|
-
expiresAt:
|
|
255
|
+
expiresAt: DateTime.now().plus({milliseconds: cacheTtlMs}).toMillis(),
|
|
255
256
|
permissions,
|
|
256
257
|
});
|
|
257
258
|
}
|
|
@@ -880,6 +880,175 @@ describe("roleManager", () => {
|
|
|
880
880
|
expect(denied).toHaveLength(0);
|
|
881
881
|
});
|
|
882
882
|
|
|
883
|
+
it("requires a configured user model for unassign and modify checks", async () => {
|
|
884
|
+
await setupDb();
|
|
885
|
+
const access = createAccess({
|
|
886
|
+
connection: mongoose.connection,
|
|
887
|
+
statements: appStatements,
|
|
888
|
+
});
|
|
889
|
+
await access.roles.seedDefaults();
|
|
890
|
+
|
|
891
|
+
const actor = createTestUser({roles: ["superadmin"]});
|
|
892
|
+
const userId = new mongoose.Types.ObjectId().toString();
|
|
893
|
+
|
|
894
|
+
await expect(
|
|
895
|
+
access.roles.unassign({actor, roleNames: ["member"], userId})
|
|
896
|
+
).rejects.toMatchObject({status: 500, title: "User model not configured for role assignment"});
|
|
897
|
+
|
|
898
|
+
await expect(access.roles.assertCanModifyUser({actor, userId})).rejects.toMatchObject({
|
|
899
|
+
status: 500,
|
|
900
|
+
title: "User model not configured for role assignment",
|
|
901
|
+
});
|
|
902
|
+
});
|
|
903
|
+
|
|
904
|
+
it("returns 404 for unassign, previewAssignment, and assertCanModifyUser on missing users", async () => {
|
|
905
|
+
await setupDb();
|
|
906
|
+
const UserModel = getRbacTestUserModel();
|
|
907
|
+
const access = createAccess({
|
|
908
|
+
connection: mongoose.connection,
|
|
909
|
+
statements: appStatements,
|
|
910
|
+
userModel: UserModel as unknown as UserModel,
|
|
911
|
+
});
|
|
912
|
+
await access.roles.seedDefaults();
|
|
913
|
+
|
|
914
|
+
const actor = createTestUser({roles: ["superadmin"]});
|
|
915
|
+
const missingId = new mongoose.Types.ObjectId().toString();
|
|
916
|
+
|
|
917
|
+
await expect(
|
|
918
|
+
access.roles.unassign({actor, roleNames: ["member"], userId: missingId})
|
|
919
|
+
).rejects.toMatchObject({status: 404, title: "User not found"});
|
|
920
|
+
|
|
921
|
+
await expect(
|
|
922
|
+
access.roles.previewAssignment({actor, roleNames: ["member"], userId: missingId})
|
|
923
|
+
).rejects.toMatchObject({status: 404, title: "User not found"});
|
|
924
|
+
|
|
925
|
+
await expect(
|
|
926
|
+
access.roles.assertCanModifyUser({actor, userId: missingId})
|
|
927
|
+
).rejects.toMatchObject({status: 404, title: "User not found"});
|
|
928
|
+
});
|
|
929
|
+
|
|
930
|
+
it("rejects conflicting role assignments declared by the second role", async () => {
|
|
931
|
+
await setupDb();
|
|
932
|
+
const UserModel = getRbacTestUserModel();
|
|
933
|
+
const access = createAccess({
|
|
934
|
+
connection: mongoose.connection,
|
|
935
|
+
defaultRoles: [
|
|
936
|
+
{
|
|
937
|
+
displayName: "Role C",
|
|
938
|
+
name: "role-c",
|
|
939
|
+
permissions: {todo: ["read"]},
|
|
940
|
+
},
|
|
941
|
+
{
|
|
942
|
+
displayName: "Role D",
|
|
943
|
+
excludesRoles: ["role-c"],
|
|
944
|
+
name: "role-d",
|
|
945
|
+
permissions: {todo: ["update"]},
|
|
946
|
+
},
|
|
947
|
+
],
|
|
948
|
+
statements: appStatements,
|
|
949
|
+
userModel: UserModel as unknown as UserModel,
|
|
950
|
+
});
|
|
951
|
+
await access.roles.seedDefaults();
|
|
952
|
+
|
|
953
|
+
const actor = createTestUser({roles: ["superadmin"]});
|
|
954
|
+
const target = await UserModel.create({email: "reverse-conflict@example.com", roles: []});
|
|
955
|
+
|
|
956
|
+
await expect(
|
|
957
|
+
access.roles.assign({actor, roleNames: ["role-c", "role-d"], userId: target.id})
|
|
958
|
+
).rejects.toMatchObject({
|
|
959
|
+
status: 409,
|
|
960
|
+
title: "Role role-c conflicts with role-d",
|
|
961
|
+
});
|
|
962
|
+
});
|
|
963
|
+
|
|
964
|
+
it("rejects changing locked fields on a locked role", async () => {
|
|
965
|
+
await setupDb();
|
|
966
|
+
const access = createAccess({
|
|
967
|
+
connection: mongoose.connection,
|
|
968
|
+
statements: appStatements,
|
|
969
|
+
});
|
|
970
|
+
await access.roles.seedDefaults();
|
|
971
|
+
|
|
972
|
+
const actor = createTestUser({roles: ["superadmin"]});
|
|
973
|
+
await expect(
|
|
974
|
+
access.roles.update({
|
|
975
|
+
actor,
|
|
976
|
+
changes: {isSealed: true},
|
|
977
|
+
roleName: "admin",
|
|
978
|
+
})
|
|
979
|
+
).rejects.toMatchObject({status: 400, title: "Cannot change locked fields on a locked role"});
|
|
980
|
+
});
|
|
981
|
+
|
|
982
|
+
it("rejects excludesRoles updates that conflict with existing assignments", async () => {
|
|
983
|
+
await setupDb();
|
|
984
|
+
const UserModel = getRbacTestUserModel();
|
|
985
|
+
const access = createAccess({
|
|
986
|
+
connection: mongoose.connection,
|
|
987
|
+
defaultRoles: [
|
|
988
|
+
{
|
|
989
|
+
displayName: "Writer",
|
|
990
|
+
name: "writer",
|
|
991
|
+
permissions: {todo: ["update"]},
|
|
992
|
+
},
|
|
993
|
+
{
|
|
994
|
+
displayName: "Reader",
|
|
995
|
+
name: "reader",
|
|
996
|
+
permissions: {todo: ["read"]},
|
|
997
|
+
},
|
|
998
|
+
],
|
|
999
|
+
statements: appStatements,
|
|
1000
|
+
userModel: UserModel as unknown as UserModel,
|
|
1001
|
+
});
|
|
1002
|
+
await access.roles.seedDefaults();
|
|
1003
|
+
|
|
1004
|
+
const actor = createTestUser({roles: ["superadmin"]});
|
|
1005
|
+
await UserModel.create({email: "both@example.com", roles: ["writer", "reader"]});
|
|
1006
|
+
|
|
1007
|
+
await expect(
|
|
1008
|
+
access.roles.update({
|
|
1009
|
+
actor,
|
|
1010
|
+
changes: {excludesRoles: ["reader"]},
|
|
1011
|
+
roleName: "writer",
|
|
1012
|
+
})
|
|
1013
|
+
).rejects.toMatchObject({
|
|
1014
|
+
status: 400,
|
|
1015
|
+
title: "excludesRoles conflicts with existing assignments",
|
|
1016
|
+
});
|
|
1017
|
+
});
|
|
1018
|
+
|
|
1019
|
+
it("allows excludesRoles updates when no holder has the excluded role", async () => {
|
|
1020
|
+
await setupDb();
|
|
1021
|
+
const UserModel = getRbacTestUserModel();
|
|
1022
|
+
const access = createAccess({
|
|
1023
|
+
connection: mongoose.connection,
|
|
1024
|
+
defaultRoles: [
|
|
1025
|
+
{
|
|
1026
|
+
displayName: "Solo Writer",
|
|
1027
|
+
name: "solo-writer",
|
|
1028
|
+
permissions: {todo: ["update"]},
|
|
1029
|
+
},
|
|
1030
|
+
{
|
|
1031
|
+
displayName: "Solo Reader",
|
|
1032
|
+
name: "solo-reader",
|
|
1033
|
+
permissions: {todo: ["read"]},
|
|
1034
|
+
},
|
|
1035
|
+
],
|
|
1036
|
+
statements: appStatements,
|
|
1037
|
+
userModel: UserModel as unknown as UserModel,
|
|
1038
|
+
});
|
|
1039
|
+
await access.roles.seedDefaults();
|
|
1040
|
+
|
|
1041
|
+
const actor = createTestUser({roles: ["superadmin"]});
|
|
1042
|
+
await UserModel.create({email: "writer-only@example.com", roles: ["solo-writer"]});
|
|
1043
|
+
|
|
1044
|
+
const updated = await access.roles.update({
|
|
1045
|
+
actor,
|
|
1046
|
+
changes: {excludesRoles: ["solo-reader"]},
|
|
1047
|
+
roleName: "solo-writer",
|
|
1048
|
+
});
|
|
1049
|
+
expect(updated.excludesRoles).toEqual(["solo-reader"]);
|
|
1050
|
+
});
|
|
1051
|
+
|
|
883
1052
|
it("keeps the original escalation error when denied-audit persistence fails", async () => {
|
|
884
1053
|
await setupDb();
|
|
885
1054
|
await createRbacRoleModel(mongoose.connection).seedDefaults({statements: appStatements});
|