@terreno/api 57.0.0 → 57.1.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/.ai/skills/mongoose-schema-safety/SKILL.md +8 -0
- package/dist/actions.d.ts +7 -2
- package/dist/actions.js +60 -25
- package/dist/adminModelRouter.d.ts +14 -0
- package/dist/adminModelRouter.js +199 -0
- package/dist/adminTypes.d.ts +156 -0
- package/dist/adminTypes.js +5 -0
- package/dist/api.d.ts +44 -3
- package/dist/api.js +74 -26
- package/dist/auth.d.ts +18 -1
- package/dist/auth.js +122 -20
- package/dist/consentApp.d.ts +2 -0
- package/dist/consentApp.js +98 -0
- package/dist/index.d.ts +22 -1
- package/dist/index.js +51 -7
- package/dist/mcp/auth.d.ts +11 -0
- package/dist/mcp/auth.js +133 -0
- package/dist/mcp/createMCPRequest.d.ts +16 -0
- package/dist/mcp/createMCPRequest.js +26 -0
- package/dist/mcp/handlers.d.ts +8 -0
- package/dist/mcp/handlers.js +793 -0
- package/dist/mcp/query.d.ts +32 -0
- package/dist/mcp/query.js +232 -0
- package/dist/mcp/registry.d.ts +21 -0
- package/dist/mcp/registry.js +54 -0
- package/dist/mcp/schemaGenerator.d.ts +14 -0
- package/dist/mcp/schemaGenerator.js +379 -0
- package/dist/mcp/server.d.ts +8 -0
- package/dist/mcp/server.js +133 -0
- package/dist/mcp/toolGenerator.d.ts +14 -0
- package/dist/mcp/toolGenerator.js +246 -0
- package/dist/mcp/types.d.ts +85 -0
- package/dist/mcp/types.js +2 -0
- package/dist/openApi.d.ts +1 -1
- package/dist/openApi.js +26 -8
- package/dist/permissions.js +15 -15
- package/dist/rbac/access.d.ts +3 -0
- package/dist/rbac/access.js +294 -0
- package/dist/rbac/auditModel.d.ts +31 -0
- package/dist/rbac/auditModel.js +112 -0
- package/dist/rbac/backfillAdmins.d.ts +18 -0
- package/dist/rbac/backfillAdmins.js +139 -0
- package/dist/rbac/fieldViews.d.ts +3 -0
- package/dist/rbac/fieldViews.js +201 -0
- package/dist/rbac/middleware.d.ts +21 -0
- package/dist/rbac/middleware.js +108 -0
- package/dist/rbac/modelRouterAccess.d.ts +42 -0
- package/dist/rbac/modelRouterAccess.js +388 -0
- package/dist/rbac/permissionUtils.d.ts +8 -0
- package/dist/rbac/permissionUtils.js +209 -0
- package/dist/rbac/realtimeAccess.d.ts +18 -0
- package/dist/rbac/realtimeAccess.js +173 -0
- package/dist/rbac/resolve.d.ts +28 -0
- package/dist/rbac/resolve.js +387 -0
- package/dist/rbac/roleManager.d.ts +20 -0
- package/dist/rbac/roleManager.js +741 -0
- package/dist/rbac/roleModel.d.ts +42 -0
- package/dist/rbac/roleModel.js +267 -0
- package/dist/rbac/routes.d.ts +9 -0
- package/dist/rbac/routes.js +211 -0
- package/dist/rbac/scopes.d.ts +15 -0
- package/dist/rbac/scopes.js +155 -0
- package/dist/rbac/statements.d.ts +20 -0
- package/dist/rbac/statements.js +115 -0
- package/dist/rbac/types.d.ts +202 -0
- package/dist/rbac/types.js +2 -0
- package/dist/rbac/userPlugin.d.ts +12 -0
- package/dist/rbac/userPlugin.js +41 -0
- package/dist/realtime/changeStreamWatcher.d.ts +1 -1
- package/dist/realtime/changeStreamWatcher.js +48 -39
- package/dist/realtime/realtimeApp.js +4 -8
- package/dist/realtime/registry.d.ts +5 -0
- package/dist/realtime/registry.js +13 -1
- package/dist/scrubAdminFields.d.ts +17 -0
- package/dist/scrubAdminFields.js +192 -0
- package/dist/sync/executors.d.ts +1 -1
- package/dist/sync/executors.js +63 -40
- package/dist/sync/loadHarness.js +4 -5
- package/dist/sync/registry.d.ts +5 -0
- package/dist/sync/registry.js +13 -1
- package/dist/sync/routes.js +41 -36
- package/dist/sync/serialize.js +5 -6
- package/dist/terrenoApp.d.ts +18 -0
- package/dist/terrenoApp.js +46 -3
- package/dist/terrenoPlugin.d.ts +8 -1
- package/dist/tests/createTestData.js +8 -0
- package/dist/tests/models.d.ts +1 -0
- package/dist/tests/models.js +5 -0
- package/dist/tests/testHelper.js +1 -2
- package/dist/transformers.js +16 -1
- package/package.json +16 -12
- package/src/__snapshots__/openApi.test.ts.snap +192 -0
- package/src/actions.test.ts +194 -1
- package/src/actions.ts +65 -8
- package/src/adminModelRouter.ts +154 -0
- package/src/adminTypes.ts +183 -0
- package/src/api.test.ts +66 -1
- package/src/api.ts +131 -12
- package/src/auth.test.ts +135 -1
- package/src/auth.ts +81 -3
- package/src/consentApp.test.ts +24 -0
- package/src/consentApp.ts +100 -0
- package/src/index.ts +56 -0
- package/src/mcp/auth.test.ts +197 -0
- package/src/mcp/auth.ts +100 -0
- package/src/mcp/createMCPRequest.test.ts +47 -0
- package/src/mcp/createMCPRequest.ts +32 -0
- package/src/mcp/customTools.test.ts +54 -0
- package/src/mcp/handlers.ts +639 -0
- package/src/mcp/integration.test.ts +1493 -0
- package/src/mcp/query.test.ts +172 -0
- package/src/mcp/query.ts +179 -0
- package/src/mcp/registry.ts +70 -0
- package/src/mcp/schemaGenerator.test.ts +182 -0
- package/src/mcp/schemaGenerator.ts +354 -0
- package/src/mcp/server.test.ts +226 -0
- package/src/mcp/server.ts +86 -0
- package/src/mcp/toolGenerator.test.ts +284 -0
- package/src/mcp/toolGenerator.ts +199 -0
- package/src/mcp/types.ts +95 -0
- package/src/openApi.test.ts +107 -0
- package/src/openApi.ts +32 -1
- package/src/permissions.ts +3 -2
- package/src/rbac/access.test.ts +357 -0
- package/src/rbac/access.ts +201 -0
- package/src/rbac/auditModel.ts +103 -0
- package/src/rbac/backfillAdmins.ts +54 -0
- package/src/rbac/fieldViews.test.ts +39 -0
- package/src/rbac/fieldViews.ts +122 -0
- package/src/rbac/middleware.ts +55 -0
- package/src/rbac/modelRouterAccess.test.ts +336 -0
- package/src/rbac/modelRouterAccess.ts +331 -0
- package/src/rbac/permissionUtils.test.ts +112 -0
- package/src/rbac/permissionUtils.ts +83 -0
- package/src/rbac/realtimeAccess.test.ts +242 -0
- package/src/rbac/realtimeAccess.ts +138 -0
- package/src/rbac/resolve.test.ts +358 -0
- package/src/rbac/resolve.ts +285 -0
- package/src/rbac/roleManager.test.ts +915 -0
- package/src/rbac/roleManager.ts +440 -0
- package/src/rbac/roleModel.test.ts +114 -0
- package/src/rbac/roleModel.ts +196 -0
- package/src/rbac/routes.ts +170 -0
- package/src/rbac/scopes.test.ts +105 -0
- package/src/rbac/scopes.ts +81 -0
- package/src/rbac/statements.test.ts +65 -0
- package/src/rbac/statements.ts +62 -0
- package/src/rbac/types.ts +198 -0
- package/src/rbac/userPlugin.test.ts +55 -0
- package/src/rbac/userPlugin.ts +25 -0
- package/src/realtime/changeStreamWatcher.ts +20 -15
- package/src/realtime/realtime.test.ts +25 -1
- package/src/realtime/realtimeApp.ts +2 -5
- package/src/realtime/registry.ts +15 -0
- package/src/scrubAdminFields.test.ts +113 -0
- package/src/scrubAdminFields.ts +158 -0
- package/src/sync/executors.ts +31 -1
- package/src/sync/loadHarness.ts +8 -7
- package/src/sync/models.test.ts +262 -0
- package/src/sync/registry.ts +15 -0
- package/src/sync/routes.ts +25 -11
- package/src/sync/scripts/compactTombstones.test.ts +4 -6
- package/src/sync/serialize.ts +17 -9
- package/src/sync/sync.test.ts +52 -0
- package/src/sync/syncRoutes.test.ts +5 -2
- package/src/sync/syncSocket.test.ts +28 -0
- package/src/terrenoApp.test.ts +100 -0
- package/src/terrenoApp.ts +65 -3
- package/src/terrenoPlugin.ts +10 -1
- package/src/tests/bunSetup.ts +2 -0
- package/src/tests/createTestData.ts +5 -1
- package/src/tests/models.ts +6 -0
- package/src/tests/testHelper.ts +1 -3
- package/src/transformers.test.ts +12 -0
- package/src/transformers.ts +7 -1
|
@@ -0,0 +1,358 @@
|
|
|
1
|
+
import {describe, expect, it, mock} from "bun:test";
|
|
2
|
+
import mongoose from "mongoose";
|
|
3
|
+
|
|
4
|
+
import type {User} from "../auth";
|
|
5
|
+
import {setupDb} from "../tests";
|
|
6
|
+
import {createPermissionResolver} from "./resolve";
|
|
7
|
+
import {createRbacRoleModel} from "./roleModel";
|
|
8
|
+
import {terrenoStatements} from "./statements";
|
|
9
|
+
import type {PermissionSource} from "./types";
|
|
10
|
+
|
|
11
|
+
const appStatements = {
|
|
12
|
+
...terrenoStatements,
|
|
13
|
+
todo: ["create", "read", "update", "delete", "list"],
|
|
14
|
+
} as const;
|
|
15
|
+
|
|
16
|
+
const createTestUser = (
|
|
17
|
+
overrides: Partial<User & {roles: string[]}> = {}
|
|
18
|
+
): User & {roles: string[]} => {
|
|
19
|
+
const id = new mongoose.Types.ObjectId();
|
|
20
|
+
return {
|
|
21
|
+
_id: id as unknown as User["_id"],
|
|
22
|
+
admin: false,
|
|
23
|
+
id: id.toString(),
|
|
24
|
+
roles: [],
|
|
25
|
+
...overrides,
|
|
26
|
+
};
|
|
27
|
+
};
|
|
28
|
+
|
|
29
|
+
describe("createPermissionResolver", () => {
|
|
30
|
+
it("caches resolved permissions until invalidated", async () => {
|
|
31
|
+
await setupDb();
|
|
32
|
+
const RbacRole = createRbacRoleModel(mongoose.connection);
|
|
33
|
+
await RbacRole.seedDefaults({statements: appStatements});
|
|
34
|
+
await RbacRole.findOneAndUpdate(
|
|
35
|
+
{name: "reader"},
|
|
36
|
+
{
|
|
37
|
+
$set: {
|
|
38
|
+
displayName: "Reader",
|
|
39
|
+
name: "reader",
|
|
40
|
+
permissions: {todo: ["read"]},
|
|
41
|
+
},
|
|
42
|
+
},
|
|
43
|
+
{upsert: true}
|
|
44
|
+
);
|
|
45
|
+
|
|
46
|
+
const resolver = createPermissionResolver({
|
|
47
|
+
cacheTtlMs: 60_000,
|
|
48
|
+
rbacRoleModel: RbacRole,
|
|
49
|
+
statements: appStatements,
|
|
50
|
+
});
|
|
51
|
+
|
|
52
|
+
const user = createTestUser({roles: ["reader"]});
|
|
53
|
+
const first = await resolver.resolvePermissionsForUser(user);
|
|
54
|
+
expect(first.todo).toEqual(["read"]);
|
|
55
|
+
|
|
56
|
+
user.roles = [];
|
|
57
|
+
const cached = await resolver.resolvePermissionsForUser(user);
|
|
58
|
+
expect(cached.todo).toEqual(["read"]);
|
|
59
|
+
|
|
60
|
+
resolver.invalidateCache({userId: user.id});
|
|
61
|
+
const refreshed = await resolver.resolvePermissionsForUser(user);
|
|
62
|
+
expect(refreshed.todo).toBeUndefined();
|
|
63
|
+
});
|
|
64
|
+
|
|
65
|
+
it("clears all cached permissions when invalidateCache is called without userId", async () => {
|
|
66
|
+
await setupDb();
|
|
67
|
+
const RbacRole = createRbacRoleModel(mongoose.connection);
|
|
68
|
+
await RbacRole.seedDefaults({statements: appStatements});
|
|
69
|
+
|
|
70
|
+
const resolver = createPermissionResolver({
|
|
71
|
+
cacheTtlMs: 60_000,
|
|
72
|
+
rbacRoleModel: RbacRole,
|
|
73
|
+
statements: appStatements,
|
|
74
|
+
});
|
|
75
|
+
|
|
76
|
+
const userA = createTestUser({roles: ["member"]});
|
|
77
|
+
const userB = createTestUser({roles: ["member"]});
|
|
78
|
+
await resolver.resolvePermissionsForUser(userA);
|
|
79
|
+
await resolver.resolvePermissionsForUser(userB);
|
|
80
|
+
|
|
81
|
+
resolver.invalidateCache();
|
|
82
|
+
userA.roles = ["superadmin"];
|
|
83
|
+
const refreshed = await resolver.resolvePermissionsForUser(userA);
|
|
84
|
+
expect(refreshed.todo).toEqual(expect.arrayContaining(["read", "update"]));
|
|
85
|
+
});
|
|
86
|
+
|
|
87
|
+
it("merges permission source grants and applies deny rules", async () => {
|
|
88
|
+
await setupDb();
|
|
89
|
+
const RbacRole = createRbacRoleModel(mongoose.connection);
|
|
90
|
+
await RbacRole.seedDefaults({statements: appStatements});
|
|
91
|
+
|
|
92
|
+
const source: PermissionSource = {
|
|
93
|
+
getGrants: async () => ({
|
|
94
|
+
deny: {todo: ["update"]},
|
|
95
|
+
permissions: {todo: ["read", "update"]},
|
|
96
|
+
roles: ["member"],
|
|
97
|
+
}),
|
|
98
|
+
name: "test-source",
|
|
99
|
+
};
|
|
100
|
+
|
|
101
|
+
const resolver = createPermissionResolver({
|
|
102
|
+
rbacRoleModel: RbacRole,
|
|
103
|
+
sources: [source],
|
|
104
|
+
statements: appStatements,
|
|
105
|
+
});
|
|
106
|
+
|
|
107
|
+
const user = createTestUser();
|
|
108
|
+
const permissions = await resolver.resolvePermissionsForUser(user);
|
|
109
|
+
expect(permissions.todo).toEqual(["read"]);
|
|
110
|
+
});
|
|
111
|
+
|
|
112
|
+
it("uses resolvePermissions callback for custom grants", async () => {
|
|
113
|
+
await setupDb();
|
|
114
|
+
const RbacRole = createRbacRoleModel(mongoose.connection);
|
|
115
|
+
await RbacRole.seedDefaults({statements: appStatements});
|
|
116
|
+
|
|
117
|
+
const resolver = createPermissionResolver({
|
|
118
|
+
rbacRoleModel: RbacRole,
|
|
119
|
+
resolvePermissions: async () => ({todo: ["create"]}),
|
|
120
|
+
statements: appStatements,
|
|
121
|
+
});
|
|
122
|
+
|
|
123
|
+
const user = createTestUser();
|
|
124
|
+
const permissions = await resolver.resolvePermissionsForUser(user);
|
|
125
|
+
expect(permissions.todo).toEqual(["create"]);
|
|
126
|
+
});
|
|
127
|
+
|
|
128
|
+
it("authorizes and denies permission requests", async () => {
|
|
129
|
+
await setupDb();
|
|
130
|
+
const RbacRole = createRbacRoleModel(mongoose.connection);
|
|
131
|
+
await RbacRole.seedDefaults({statements: appStatements});
|
|
132
|
+
|
|
133
|
+
const resolver = createPermissionResolver({
|
|
134
|
+
rbacRoleModel: RbacRole,
|
|
135
|
+
statements: appStatements,
|
|
136
|
+
});
|
|
137
|
+
|
|
138
|
+
const allowed = resolver.authorizePermissions({todo: ["read"]}, {todo: ["read"]});
|
|
139
|
+
expect(allowed.success).toBe(true);
|
|
140
|
+
|
|
141
|
+
const denied = resolver.authorizePermissions({todo: ["read"]}, {todo: ["delete"]});
|
|
142
|
+
expect(denied.success).toBe(false);
|
|
143
|
+
expect(denied.error).toBeDefined();
|
|
144
|
+
});
|
|
145
|
+
|
|
146
|
+
it("honors staleOnFailure during uncached resolution without writing caches", async () => {
|
|
147
|
+
await setupDb();
|
|
148
|
+
const RbacRole = createRbacRoleModel(mongoose.connection);
|
|
149
|
+
await RbacRole.seedDefaults({statements: appStatements});
|
|
150
|
+
|
|
151
|
+
let shouldFail = false;
|
|
152
|
+
const source: PermissionSource = {
|
|
153
|
+
getGrants: async () => {
|
|
154
|
+
if (shouldFail) {
|
|
155
|
+
throw new Error("source unavailable");
|
|
156
|
+
}
|
|
157
|
+
return {permissions: {todo: ["read"]}};
|
|
158
|
+
},
|
|
159
|
+
name: "uncached-flaky-source",
|
|
160
|
+
staleOnFailure: "use-stale",
|
|
161
|
+
};
|
|
162
|
+
|
|
163
|
+
const resolver = createPermissionResolver({
|
|
164
|
+
cacheTtlMs: 60_000,
|
|
165
|
+
rbacRoleModel: RbacRole,
|
|
166
|
+
sources: [source],
|
|
167
|
+
statements: appStatements,
|
|
168
|
+
});
|
|
169
|
+
|
|
170
|
+
const user = createTestUser();
|
|
171
|
+
const fresh = await resolver.resolvePermissionsForUser(user);
|
|
172
|
+
expect(fresh.todo).toEqual(["read"]);
|
|
173
|
+
|
|
174
|
+
shouldFail = true;
|
|
175
|
+
user.roles = ["member"];
|
|
176
|
+
const preview = await resolver.resolvePermissionsForUserUncached(user);
|
|
177
|
+
expect(preview.todo).toEqual(expect.arrayContaining(["read"]));
|
|
178
|
+
|
|
179
|
+
user.roles = [];
|
|
180
|
+
const live = await resolver.resolvePermissionsForUser(user);
|
|
181
|
+
expect(live.todo).toEqual(["read"]);
|
|
182
|
+
});
|
|
183
|
+
|
|
184
|
+
it("returns stale grants when a source fails with use-stale policy", async () => {
|
|
185
|
+
await setupDb();
|
|
186
|
+
const RbacRole = createRbacRoleModel(mongoose.connection);
|
|
187
|
+
await RbacRole.seedDefaults({statements: appStatements});
|
|
188
|
+
|
|
189
|
+
let shouldFail = false;
|
|
190
|
+
const source: PermissionSource = {
|
|
191
|
+
getGrants: async () => {
|
|
192
|
+
if (shouldFail) {
|
|
193
|
+
throw new Error("source unavailable");
|
|
194
|
+
}
|
|
195
|
+
return {permissions: {todo: ["read"]}};
|
|
196
|
+
},
|
|
197
|
+
name: "flaky-source",
|
|
198
|
+
staleOnFailure: "use-stale",
|
|
199
|
+
};
|
|
200
|
+
|
|
201
|
+
const resolver = createPermissionResolver({
|
|
202
|
+
cacheTtlMs: 0,
|
|
203
|
+
rbacRoleModel: RbacRole,
|
|
204
|
+
sources: [source],
|
|
205
|
+
statements: appStatements,
|
|
206
|
+
});
|
|
207
|
+
|
|
208
|
+
const user = createTestUser();
|
|
209
|
+
const fresh = await resolver.resolvePermissionsForUser(user);
|
|
210
|
+
expect(fresh.todo).toEqual(["read"]);
|
|
211
|
+
|
|
212
|
+
shouldFail = true;
|
|
213
|
+
const stale = await resolver.resolvePermissionsForUser(user);
|
|
214
|
+
expect(stale.todo).toEqual(["read"]);
|
|
215
|
+
});
|
|
216
|
+
|
|
217
|
+
it("returns stale grants within bounded age when use-stale-bounded is configured", async () => {
|
|
218
|
+
await setupDb();
|
|
219
|
+
const RbacRole = createRbacRoleModel(mongoose.connection);
|
|
220
|
+
await RbacRole.seedDefaults({statements: appStatements});
|
|
221
|
+
|
|
222
|
+
let shouldFail = false;
|
|
223
|
+
const source: PermissionSource = {
|
|
224
|
+
getGrants: async () => {
|
|
225
|
+
if (shouldFail) {
|
|
226
|
+
throw new Error("source unavailable");
|
|
227
|
+
}
|
|
228
|
+
return {permissions: {todo: ["list"]}};
|
|
229
|
+
},
|
|
230
|
+
name: "bounded-source",
|
|
231
|
+
staleMaxAgeMs: 60_000,
|
|
232
|
+
staleOnFailure: "use-stale-bounded",
|
|
233
|
+
};
|
|
234
|
+
|
|
235
|
+
const resolver = createPermissionResolver({
|
|
236
|
+
cacheTtlMs: 0,
|
|
237
|
+
rbacRoleModel: RbacRole,
|
|
238
|
+
sources: [source],
|
|
239
|
+
statements: appStatements,
|
|
240
|
+
});
|
|
241
|
+
|
|
242
|
+
const user = createTestUser();
|
|
243
|
+
const fresh = await resolver.resolvePermissionsForUser(user);
|
|
244
|
+
expect(fresh.todo).toEqual(["list"]);
|
|
245
|
+
|
|
246
|
+
shouldFail = true;
|
|
247
|
+
const stale = await resolver.resolvePermissionsForUser(user);
|
|
248
|
+
expect(stale.todo).toEqual(["list"]);
|
|
249
|
+
});
|
|
250
|
+
|
|
251
|
+
it("keeps last-known deny grants when a source fails with deny policy", async () => {
|
|
252
|
+
await setupDb();
|
|
253
|
+
const RbacRole = createRbacRoleModel(mongoose.connection);
|
|
254
|
+
await RbacRole.seedDefaults({statements: appStatements});
|
|
255
|
+
await RbacRole.findOneAndUpdate(
|
|
256
|
+
{name: "writer"},
|
|
257
|
+
{
|
|
258
|
+
$set: {
|
|
259
|
+
displayName: "Writer",
|
|
260
|
+
name: "writer",
|
|
261
|
+
permissions: {todo: ["read", "update"]},
|
|
262
|
+
},
|
|
263
|
+
},
|
|
264
|
+
{upsert: true}
|
|
265
|
+
);
|
|
266
|
+
|
|
267
|
+
let shouldFail = false;
|
|
268
|
+
const source: PermissionSource = {
|
|
269
|
+
getGrants: async () => {
|
|
270
|
+
if (shouldFail) {
|
|
271
|
+
throw new Error("source unavailable");
|
|
272
|
+
}
|
|
273
|
+
return {
|
|
274
|
+
deny: {todo: ["update"]},
|
|
275
|
+
permissions: {todo: ["list"]},
|
|
276
|
+
};
|
|
277
|
+
},
|
|
278
|
+
name: "idp-deny-source",
|
|
279
|
+
staleOnFailure: "deny",
|
|
280
|
+
};
|
|
281
|
+
|
|
282
|
+
const resolver = createPermissionResolver({
|
|
283
|
+
cacheTtlMs: 0,
|
|
284
|
+
rbacRoleModel: RbacRole,
|
|
285
|
+
sources: [source],
|
|
286
|
+
statements: appStatements,
|
|
287
|
+
});
|
|
288
|
+
|
|
289
|
+
const user = createTestUser({roles: ["writer"]});
|
|
290
|
+
const fresh = await resolver.resolvePermissionsForUser(user);
|
|
291
|
+
expect(fresh.todo ?? []).toEqual(expect.arrayContaining(["read", "list"]));
|
|
292
|
+
expect(fresh.todo ?? []).not.toContain("update");
|
|
293
|
+
|
|
294
|
+
shouldFail = true;
|
|
295
|
+
const afterFailure = await resolver.resolvePermissionsForUser(user);
|
|
296
|
+
expect(afterFailure.todo).toEqual(["read"]);
|
|
297
|
+
expect(afterFailure.todo ?? []).not.toContain("list");
|
|
298
|
+
});
|
|
299
|
+
|
|
300
|
+
it("skips failed sources when stale policy is deny", async () => {
|
|
301
|
+
await setupDb();
|
|
302
|
+
const RbacRole = createRbacRoleModel(mongoose.connection);
|
|
303
|
+
await RbacRole.seedDefaults({statements: appStatements});
|
|
304
|
+
|
|
305
|
+
const source: PermissionSource = {
|
|
306
|
+
getGrants: mock(async () => {
|
|
307
|
+
throw new Error("source unavailable");
|
|
308
|
+
}),
|
|
309
|
+
name: "deny-source",
|
|
310
|
+
staleOnFailure: "deny",
|
|
311
|
+
};
|
|
312
|
+
|
|
313
|
+
const resolver = createPermissionResolver({
|
|
314
|
+
rbacRoleModel: RbacRole,
|
|
315
|
+
sources: [source],
|
|
316
|
+
statements: appStatements,
|
|
317
|
+
});
|
|
318
|
+
|
|
319
|
+
const user = createTestUser({roles: ["member"]});
|
|
320
|
+
const permissions = await resolver.resolvePermissionsForUser(user);
|
|
321
|
+
expect(permissions.todo).toBeUndefined();
|
|
322
|
+
});
|
|
323
|
+
|
|
324
|
+
it("evicts the oldest permission cache entry when over maxCacheEntries", async () => {
|
|
325
|
+
await setupDb();
|
|
326
|
+
const RbacRole = createRbacRoleModel(mongoose.connection);
|
|
327
|
+
await RbacRole.seedDefaults({statements: appStatements});
|
|
328
|
+
|
|
329
|
+
const resolver = createPermissionResolver({
|
|
330
|
+
cacheTtlMs: 60_000,
|
|
331
|
+
maxCacheEntries: 2,
|
|
332
|
+
rbacRoleModel: RbacRole,
|
|
333
|
+
statements: appStatements,
|
|
334
|
+
});
|
|
335
|
+
|
|
336
|
+
const userA = createTestUser({roles: ["member"]});
|
|
337
|
+
const userB = createTestUser({roles: ["member"]});
|
|
338
|
+
const userC = createTestUser({roles: ["member"]});
|
|
339
|
+
await resolver.resolvePermissionsForUser(userA);
|
|
340
|
+
await resolver.resolvePermissionsForUser(userB);
|
|
341
|
+
await resolver.resolvePermissionsForUser(userC);
|
|
342
|
+
|
|
343
|
+
await RbacRole.findOneAndUpdate(
|
|
344
|
+
{name: "cache-evict-reader"},
|
|
345
|
+
{
|
|
346
|
+
$set: {
|
|
347
|
+
displayName: "Cache Evict Reader",
|
|
348
|
+
name: "cache-evict-reader",
|
|
349
|
+
permissions: {todo: ["read"]},
|
|
350
|
+
},
|
|
351
|
+
},
|
|
352
|
+
{upsert: true}
|
|
353
|
+
);
|
|
354
|
+
userA.roles = ["cache-evict-reader"];
|
|
355
|
+
const refreshed = await resolver.resolvePermissionsForUser(userA);
|
|
356
|
+
expect(refreshed.todo).toEqual(["read"]);
|
|
357
|
+
});
|
|
358
|
+
});
|
|
@@ -0,0 +1,285 @@
|
|
|
1
|
+
import {createAccessControl} from "better-auth/plugins/access";
|
|
2
|
+
|
|
3
|
+
import type {User} from "../auth";
|
|
4
|
+
import {logger} from "../logger";
|
|
5
|
+
import {unionPermissionSets} from "./permissionUtils";
|
|
6
|
+
import type {RbacRoleModel} from "./roleModel";
|
|
7
|
+
import type {PermissionSet, Statements} from "./statements";
|
|
8
|
+
import type {PermissionSource, PermissionSourceGrants} from "./types";
|
|
9
|
+
|
|
10
|
+
interface CacheEntry {
|
|
11
|
+
permissions: PermissionSet;
|
|
12
|
+
expiresAt: number;
|
|
13
|
+
}
|
|
14
|
+
|
|
15
|
+
interface SourceCacheEntry {
|
|
16
|
+
grants: PermissionSourceGrants | null;
|
|
17
|
+
fetchedAt: number;
|
|
18
|
+
}
|
|
19
|
+
|
|
20
|
+
const DEFAULT_CACHE_TTL_MS = 30_000;
|
|
21
|
+
const DEFAULT_MAX_CACHE_ENTRIES = 10_000;
|
|
22
|
+
|
|
23
|
+
const getUserRoles = (user: User): string[] => {
|
|
24
|
+
const withRoles = user as User & {roles?: string[]};
|
|
25
|
+
return withRoles.roles ?? [];
|
|
26
|
+
};
|
|
27
|
+
|
|
28
|
+
export const createPermissionResolver = <S extends Statements>(args: {
|
|
29
|
+
statements: S;
|
|
30
|
+
rbacRoleModel: RbacRoleModel;
|
|
31
|
+
sources?: PermissionSource[];
|
|
32
|
+
cacheTtlMs?: number;
|
|
33
|
+
maxCacheEntries?: number;
|
|
34
|
+
resolvePermissions?: (args: {user: User}) => Promise<PermissionSet | null>;
|
|
35
|
+
}) => {
|
|
36
|
+
const {
|
|
37
|
+
statements,
|
|
38
|
+
rbacRoleModel,
|
|
39
|
+
sources = [],
|
|
40
|
+
cacheTtlMs = DEFAULT_CACHE_TTL_MS,
|
|
41
|
+
maxCacheEntries = DEFAULT_MAX_CACHE_ENTRIES,
|
|
42
|
+
resolvePermissions,
|
|
43
|
+
} = args;
|
|
44
|
+
|
|
45
|
+
const ac = createAccessControl(statements);
|
|
46
|
+
const permissionCache = new Map<string, CacheEntry>();
|
|
47
|
+
const sourceCache = new Map<string, Map<string, SourceCacheEntry>>();
|
|
48
|
+
|
|
49
|
+
const enforceCacheBound = (): void => {
|
|
50
|
+
const now = Date.now();
|
|
51
|
+
for (const [userId, entry] of permissionCache) {
|
|
52
|
+
if (entry.expiresAt <= now) {
|
|
53
|
+
permissionCache.delete(userId);
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
while (permissionCache.size > maxCacheEntries) {
|
|
57
|
+
const oldestUserId = permissionCache.keys().next().value;
|
|
58
|
+
if (oldestUserId === undefined) {
|
|
59
|
+
break;
|
|
60
|
+
}
|
|
61
|
+
permissionCache.delete(oldestUserId);
|
|
62
|
+
sourceCache.delete(oldestUserId);
|
|
63
|
+
}
|
|
64
|
+
while (sourceCache.size > maxCacheEntries) {
|
|
65
|
+
const oldestUserId = sourceCache.keys().next().value;
|
|
66
|
+
if (oldestUserId === undefined) {
|
|
67
|
+
break;
|
|
68
|
+
}
|
|
69
|
+
sourceCache.delete(oldestUserId);
|
|
70
|
+
}
|
|
71
|
+
};
|
|
72
|
+
|
|
73
|
+
const rememberPermissions = (userId: string, entry: CacheEntry): void => {
|
|
74
|
+
permissionCache.delete(userId);
|
|
75
|
+
permissionCache.set(userId, entry);
|
|
76
|
+
enforceCacheBound();
|
|
77
|
+
};
|
|
78
|
+
|
|
79
|
+
const invalidateCache = (invalidateArgs?: {userId?: string}): void => {
|
|
80
|
+
if (invalidateArgs?.userId) {
|
|
81
|
+
permissionCache.delete(invalidateArgs.userId);
|
|
82
|
+
sourceCache.delete(invalidateArgs.userId);
|
|
83
|
+
return;
|
|
84
|
+
}
|
|
85
|
+
permissionCache.clear();
|
|
86
|
+
sourceCache.clear();
|
|
87
|
+
};
|
|
88
|
+
|
|
89
|
+
const loadRolePermissions = async (roleNames: string[]): Promise<PermissionSet[]> => {
|
|
90
|
+
if (roleNames.length === 0) {
|
|
91
|
+
return [];
|
|
92
|
+
}
|
|
93
|
+
|
|
94
|
+
const roleDocs = await rbacRoleModel.find({name: {$in: roleNames}});
|
|
95
|
+
return roleDocs.map((roleDoc) => roleDoc.permissions ?? {});
|
|
96
|
+
};
|
|
97
|
+
|
|
98
|
+
const applyDenyGrants = (permissions: PermissionSet, deny?: PermissionSet): PermissionSet => {
|
|
99
|
+
if (!deny) {
|
|
100
|
+
return permissions;
|
|
101
|
+
}
|
|
102
|
+
|
|
103
|
+
const result: Record<string, string[]> = {};
|
|
104
|
+
for (const [resource, actions] of Object.entries(permissions)) {
|
|
105
|
+
const denied = new Set(deny[resource] ?? []);
|
|
106
|
+
const remaining = actions.filter((action) => !denied.has(action));
|
|
107
|
+
if (remaining.length > 0) {
|
|
108
|
+
result[resource] = remaining;
|
|
109
|
+
}
|
|
110
|
+
}
|
|
111
|
+
return result;
|
|
112
|
+
};
|
|
113
|
+
|
|
114
|
+
const grantsFromStaleCache = (
|
|
115
|
+
source: PermissionSource,
|
|
116
|
+
cached: SourceCacheEntry | undefined,
|
|
117
|
+
now: number
|
|
118
|
+
): PermissionSourceGrants | null => {
|
|
119
|
+
if (
|
|
120
|
+
source.staleOnFailure === "use-stale-bounded" &&
|
|
121
|
+
cached &&
|
|
122
|
+
source.staleMaxAgeMs &&
|
|
123
|
+
now - cached.fetchedAt < source.staleMaxAgeMs
|
|
124
|
+
) {
|
|
125
|
+
return cached.grants;
|
|
126
|
+
}
|
|
127
|
+
|
|
128
|
+
if (source.staleOnFailure === "use-stale" && cached) {
|
|
129
|
+
return cached.grants;
|
|
130
|
+
}
|
|
131
|
+
|
|
132
|
+
return null;
|
|
133
|
+
};
|
|
134
|
+
|
|
135
|
+
const denyOnlyFromCache = (
|
|
136
|
+
cached: SourceCacheEntry | undefined
|
|
137
|
+
): PermissionSourceGrants | null => {
|
|
138
|
+
const deny = cached?.grants?.deny;
|
|
139
|
+
if (!deny) {
|
|
140
|
+
return null;
|
|
141
|
+
}
|
|
142
|
+
return {deny};
|
|
143
|
+
};
|
|
144
|
+
|
|
145
|
+
const grantsAfterSourceFailure = (
|
|
146
|
+
source: PermissionSource,
|
|
147
|
+
cached: SourceCacheEntry | undefined,
|
|
148
|
+
now: number
|
|
149
|
+
): PermissionSourceGrants | null => {
|
|
150
|
+
const stale = grantsFromStaleCache(source, cached, now);
|
|
151
|
+
if (stale) {
|
|
152
|
+
return stale;
|
|
153
|
+
}
|
|
154
|
+
return denyOnlyFromCache(cached);
|
|
155
|
+
};
|
|
156
|
+
|
|
157
|
+
const fetchSourceGrants = async (
|
|
158
|
+
user: User,
|
|
159
|
+
source: PermissionSource,
|
|
160
|
+
shouldCache = true
|
|
161
|
+
): Promise<PermissionSourceGrants | null> => {
|
|
162
|
+
const now = Date.now();
|
|
163
|
+
const cached = sourceCache.get(user.id)?.get(source.name);
|
|
164
|
+
|
|
165
|
+
if (!shouldCache) {
|
|
166
|
+
try {
|
|
167
|
+
return await source.getGrants({user});
|
|
168
|
+
} catch (error) {
|
|
169
|
+
logger.warn("Permission source refresh failed during uncached resolution", {
|
|
170
|
+
error: error instanceof Error ? error.message : String(error),
|
|
171
|
+
policy: source.staleOnFailure ?? "deny",
|
|
172
|
+
source: source.name,
|
|
173
|
+
});
|
|
174
|
+
return grantsAfterSourceFailure(source, cached, now);
|
|
175
|
+
}
|
|
176
|
+
}
|
|
177
|
+
|
|
178
|
+
const userSources = sourceCache.get(user.id) ?? new Map<string, SourceCacheEntry>();
|
|
179
|
+
sourceCache.delete(user.id);
|
|
180
|
+
sourceCache.set(user.id, userSources);
|
|
181
|
+
|
|
182
|
+
const ttlMs = source.ttlMs ?? cacheTtlMs;
|
|
183
|
+
const cachedAfterTouch = userSources.get(source.name);
|
|
184
|
+
|
|
185
|
+
if (cachedAfterTouch && now - cachedAfterTouch.fetchedAt < ttlMs) {
|
|
186
|
+
return cachedAfterTouch.grants;
|
|
187
|
+
}
|
|
188
|
+
|
|
189
|
+
try {
|
|
190
|
+
const grants = await source.getGrants({user});
|
|
191
|
+
userSources.set(source.name, {fetchedAt: now, grants});
|
|
192
|
+
return grants;
|
|
193
|
+
} catch (error) {
|
|
194
|
+
logger.warn("Permission source refresh failed", {
|
|
195
|
+
error: error instanceof Error ? error.message : String(error),
|
|
196
|
+
policy: source.staleOnFailure ?? "deny",
|
|
197
|
+
source: source.name,
|
|
198
|
+
});
|
|
199
|
+
return grantsAfterSourceFailure(source, cachedAfterTouch, now);
|
|
200
|
+
}
|
|
201
|
+
};
|
|
202
|
+
|
|
203
|
+
const resolveEffectivePermissions = async (
|
|
204
|
+
user: User,
|
|
205
|
+
shouldCache: boolean
|
|
206
|
+
): Promise<PermissionSet> => {
|
|
207
|
+
if (shouldCache) {
|
|
208
|
+
const cached = permissionCache.get(user.id);
|
|
209
|
+
if (cached && cached.expiresAt > Date.now()) {
|
|
210
|
+
rememberPermissions(user.id, cached);
|
|
211
|
+
return cached.permissions;
|
|
212
|
+
}
|
|
213
|
+
}
|
|
214
|
+
|
|
215
|
+
const roleNames = [...getUserRoles(user)];
|
|
216
|
+
const permissionSets: PermissionSet[] = [];
|
|
217
|
+
const sourceResults = new Map<string, PermissionSourceGrants | null>();
|
|
218
|
+
|
|
219
|
+
for (const source of sources) {
|
|
220
|
+
const grants = await fetchSourceGrants(user, source, shouldCache);
|
|
221
|
+
sourceResults.set(source.name, grants);
|
|
222
|
+
if (!grants) {
|
|
223
|
+
continue;
|
|
224
|
+
}
|
|
225
|
+
if (grants.roles?.length) {
|
|
226
|
+
roleNames.push(...grants.roles);
|
|
227
|
+
}
|
|
228
|
+
if (grants.permissions) {
|
|
229
|
+
permissionSets.push(grants.permissions);
|
|
230
|
+
}
|
|
231
|
+
}
|
|
232
|
+
|
|
233
|
+
const uniqueRoleNames = [...new Set(roleNames)];
|
|
234
|
+
permissionSets.push(...(await loadRolePermissions(uniqueRoleNames)));
|
|
235
|
+
|
|
236
|
+
if (resolvePermissions) {
|
|
237
|
+
const custom = await resolvePermissions({user});
|
|
238
|
+
if (custom) {
|
|
239
|
+
permissionSets.push(custom);
|
|
240
|
+
}
|
|
241
|
+
}
|
|
242
|
+
|
|
243
|
+
let permissions = unionPermissionSets(...permissionSets);
|
|
244
|
+
|
|
245
|
+
for (const source of sources) {
|
|
246
|
+
const grants = sourceResults.get(source.name);
|
|
247
|
+
if (grants?.deny) {
|
|
248
|
+
permissions = applyDenyGrants(permissions, grants.deny);
|
|
249
|
+
}
|
|
250
|
+
}
|
|
251
|
+
|
|
252
|
+
if (shouldCache) {
|
|
253
|
+
rememberPermissions(user.id, {
|
|
254
|
+
expiresAt: Date.now() + cacheTtlMs,
|
|
255
|
+
permissions,
|
|
256
|
+
});
|
|
257
|
+
}
|
|
258
|
+
|
|
259
|
+
return permissions;
|
|
260
|
+
};
|
|
261
|
+
|
|
262
|
+
const resolvePermissionsForUser = async (user: User): Promise<PermissionSet> => {
|
|
263
|
+
return resolveEffectivePermissions(user, true);
|
|
264
|
+
};
|
|
265
|
+
|
|
266
|
+
const resolvePermissionsForUserUncached = async (user: User): Promise<PermissionSet> => {
|
|
267
|
+
return resolveEffectivePermissions(user, false);
|
|
268
|
+
};
|
|
269
|
+
|
|
270
|
+
const authorizePermissions = (
|
|
271
|
+
permissions: PermissionSet,
|
|
272
|
+
request: PermissionSet
|
|
273
|
+
): {success: boolean; error?: string} => {
|
|
274
|
+
const role = ac.newRole(permissions as never);
|
|
275
|
+
return role.authorize(request as never);
|
|
276
|
+
};
|
|
277
|
+
|
|
278
|
+
return {
|
|
279
|
+
ac,
|
|
280
|
+
authorizePermissions,
|
|
281
|
+
invalidateCache,
|
|
282
|
+
resolvePermissionsForUser,
|
|
283
|
+
resolvePermissionsForUserUncached,
|
|
284
|
+
};
|
|
285
|
+
};
|