@terreno/api 57.0.0 → 57.2.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 +182 -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 +30 -0
- package/dist/rbac/statements.js +126 -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 +17 -13
- 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 +206 -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 +67 -0
- package/src/rbac/statements.ts +73 -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
package/src/openApi.ts
CHANGED
|
@@ -7,6 +7,7 @@ import m2s from "mongoose-to-swagger";
|
|
|
7
7
|
import type {ModelRouterOptions, OpenApiMiddleware} from "./api";
|
|
8
8
|
import {logger} from "./logger";
|
|
9
9
|
import {getOpenApiSpecForModel} from "./populate";
|
|
10
|
+
import type {SyncConfig, SyncScope} from "./sync/types";
|
|
10
11
|
|
|
11
12
|
const noop = (_a: unknown, _b: unknown, next: () => void) => next();
|
|
12
13
|
|
|
@@ -160,9 +161,38 @@ export const getOpenApiMiddleware = <T>(
|
|
|
160
161
|
);
|
|
161
162
|
};
|
|
162
163
|
|
|
164
|
+
const resolveSyncScopeLabel = (scope: SyncScope): "owner" | "tenant" | "broadcast" | "custom" => {
|
|
165
|
+
if (typeof scope === "function") {
|
|
166
|
+
return "custom";
|
|
167
|
+
}
|
|
168
|
+
return scope.type;
|
|
169
|
+
};
|
|
170
|
+
|
|
171
|
+
const buildTerrenoSyncExtension = (
|
|
172
|
+
sync: SyncConfig | undefined,
|
|
173
|
+
routePath: string | undefined,
|
|
174
|
+
fallbackCollection?: string
|
|
175
|
+
): Record<string, unknown> => {
|
|
176
|
+
if (!sync) {
|
|
177
|
+
return {};
|
|
178
|
+
}
|
|
179
|
+
const rawPath = routePath ?? (fallbackCollection ? `/${fallbackCollection}` : undefined);
|
|
180
|
+
if (!rawPath) {
|
|
181
|
+
return {};
|
|
182
|
+
}
|
|
183
|
+
const collection = rawPath.replace(/^\//, "");
|
|
184
|
+
return {
|
|
185
|
+
"x-terreno-sync": {
|
|
186
|
+
collection,
|
|
187
|
+
scope: resolveSyncScopeLabel(sync.scope),
|
|
188
|
+
},
|
|
189
|
+
};
|
|
190
|
+
};
|
|
191
|
+
|
|
163
192
|
export const listOpenApiMiddleware = <T>(
|
|
164
193
|
model: Model<T>,
|
|
165
|
-
options: Partial<ModelRouterOptions<T
|
|
194
|
+
options: Partial<ModelRouterOptions<T>>,
|
|
195
|
+
routePath?: string
|
|
166
196
|
): express.RequestHandler => {
|
|
167
197
|
if (!options.openApi?.path) {
|
|
168
198
|
return noop;
|
|
@@ -258,6 +288,7 @@ export const listOpenApiMiddleware = <T>(
|
|
|
258
288
|
return options.openApi.path(
|
|
259
289
|
merge(
|
|
260
290
|
{
|
|
291
|
+
...buildTerrenoSyncExtension(options.sync, routePath, model.collection.collectionName),
|
|
261
292
|
parameters: [
|
|
262
293
|
...defaultQueryParams,
|
|
263
294
|
...(modelQueryParams ?? []),
|
package/src/permissions.ts
CHANGED
|
@@ -180,7 +180,8 @@ export const permissionMiddleware = <T>(
|
|
|
180
180
|
}
|
|
181
181
|
|
|
182
182
|
// All methods check for permissions.
|
|
183
|
-
|
|
183
|
+
const methodPermissions = options.permissions?.[method] ?? [];
|
|
184
|
+
if (!(await checkPermissions(method, methodPermissions, req.user))) {
|
|
184
185
|
throw new APIError({
|
|
185
186
|
status: 405,
|
|
186
187
|
title:
|
|
@@ -195,7 +196,7 @@ export const permissionMiddleware = <T>(
|
|
|
195
196
|
|
|
196
197
|
const data = await loadDocOr404<T>(model, req.params.id as string, options.populatePaths);
|
|
197
198
|
|
|
198
|
-
if (!(await checkPermissions(method,
|
|
199
|
+
if (!(await checkPermissions(method, methodPermissions, req.user, data))) {
|
|
199
200
|
throw new APIError({
|
|
200
201
|
status: 403,
|
|
201
202
|
title: `Access to GET on ${model.modelName}:${req.params.id} denied for ${req.user?.id}`,
|
|
@@ -0,0 +1,357 @@
|
|
|
1
|
+
import {describe, expect, it} from "bun:test";
|
|
2
|
+
import {createAccessControl} from "better-auth/plugins/access";
|
|
3
|
+
import mongoose from "mongoose";
|
|
4
|
+
import type {User} from "../auth";
|
|
5
|
+
import {setupDb} from "../tests";
|
|
6
|
+
import {createAccess} from "./access";
|
|
7
|
+
import {createRbacRoleModel} from "./roleModel";
|
|
8
|
+
import {terrenoStatements} from "./statements";
|
|
9
|
+
|
|
10
|
+
const appStatements = {
|
|
11
|
+
...terrenoStatements,
|
|
12
|
+
todo: ["create", "read", "update", "delete", "list"],
|
|
13
|
+
} as const;
|
|
14
|
+
|
|
15
|
+
const createTestUser = (
|
|
16
|
+
overrides: Partial<User & {roles: string[]}> = {}
|
|
17
|
+
): User & {
|
|
18
|
+
roles: string[];
|
|
19
|
+
} => {
|
|
20
|
+
const id = new mongoose.Types.ObjectId();
|
|
21
|
+
return {
|
|
22
|
+
_id: id as unknown as User["_id"],
|
|
23
|
+
admin: false,
|
|
24
|
+
id: id.toString(),
|
|
25
|
+
roles: [],
|
|
26
|
+
...overrides,
|
|
27
|
+
};
|
|
28
|
+
};
|
|
29
|
+
|
|
30
|
+
describe("createAccess", () => {
|
|
31
|
+
it("allows a user with a matching role permission", async () => {
|
|
32
|
+
await setupDb();
|
|
33
|
+
const RbacRole = createRbacRoleModel(mongoose.connection);
|
|
34
|
+
const access = createAccess({
|
|
35
|
+
connection: mongoose.connection,
|
|
36
|
+
defaultRoles: [
|
|
37
|
+
{
|
|
38
|
+
displayName: "Editor",
|
|
39
|
+
name: "editor",
|
|
40
|
+
permissions: {todo: ["read", "update"]},
|
|
41
|
+
},
|
|
42
|
+
],
|
|
43
|
+
statements: appStatements,
|
|
44
|
+
});
|
|
45
|
+
await access.roles.seedDefaults();
|
|
46
|
+
|
|
47
|
+
const user = createTestUser({roles: ["editor"]});
|
|
48
|
+
const result = await access.can({
|
|
49
|
+
permissions: {todo: ["read"]},
|
|
50
|
+
user,
|
|
51
|
+
});
|
|
52
|
+
|
|
53
|
+
expect(result.allowed).toBe(true);
|
|
54
|
+
expect(RbacRole).toBeDefined();
|
|
55
|
+
});
|
|
56
|
+
|
|
57
|
+
it("denies when the user lacks the required permission", async () => {
|
|
58
|
+
await setupDb();
|
|
59
|
+
const access = createAccess({
|
|
60
|
+
connection: mongoose.connection,
|
|
61
|
+
defaultRoles: [
|
|
62
|
+
{
|
|
63
|
+
displayName: "Viewer",
|
|
64
|
+
name: "viewer",
|
|
65
|
+
permissions: {todo: ["read"]},
|
|
66
|
+
},
|
|
67
|
+
],
|
|
68
|
+
statements: appStatements,
|
|
69
|
+
});
|
|
70
|
+
await access.roles.seedDefaults();
|
|
71
|
+
|
|
72
|
+
const user = createTestUser({roles: ["viewer"]});
|
|
73
|
+
const result = await access.can({
|
|
74
|
+
permissions: {todo: ["update"]},
|
|
75
|
+
user,
|
|
76
|
+
});
|
|
77
|
+
|
|
78
|
+
expect(result.allowed).toBe(false);
|
|
79
|
+
expect(result.deniedBy).toBe("role");
|
|
80
|
+
});
|
|
81
|
+
|
|
82
|
+
it("returns effective permissions as a union across roles", async () => {
|
|
83
|
+
await setupDb();
|
|
84
|
+
const access = createAccess({
|
|
85
|
+
connection: mongoose.connection,
|
|
86
|
+
defaultRoles: [
|
|
87
|
+
{
|
|
88
|
+
displayName: "Reader",
|
|
89
|
+
name: "reader",
|
|
90
|
+
permissions: {todo: ["read"]},
|
|
91
|
+
},
|
|
92
|
+
{
|
|
93
|
+
displayName: "Writer",
|
|
94
|
+
name: "writer",
|
|
95
|
+
permissions: {todo: ["update"]},
|
|
96
|
+
},
|
|
97
|
+
],
|
|
98
|
+
statements: appStatements,
|
|
99
|
+
});
|
|
100
|
+
await access.roles.seedDefaults();
|
|
101
|
+
|
|
102
|
+
const user = createTestUser({roles: ["reader", "writer"]});
|
|
103
|
+
const permissions = await access.getPermissions({user});
|
|
104
|
+
|
|
105
|
+
expect(permissions.todo).toEqual(expect.arrayContaining(["read", "update"]));
|
|
106
|
+
});
|
|
107
|
+
|
|
108
|
+
it("exposes the better-auth access controller", () => {
|
|
109
|
+
const access = createAccess({
|
|
110
|
+
connection: mongoose.connection,
|
|
111
|
+
statements: appStatements,
|
|
112
|
+
});
|
|
113
|
+
|
|
114
|
+
expect(access.ac).toBeDefined();
|
|
115
|
+
expect(access.ac.statements).toEqual(appStatements);
|
|
116
|
+
expect(createAccessControl(appStatements)).toBeDefined();
|
|
117
|
+
});
|
|
118
|
+
|
|
119
|
+
it("denies unauthenticated access checks", async () => {
|
|
120
|
+
const access = createAccess({
|
|
121
|
+
connection: mongoose.connection,
|
|
122
|
+
statements: appStatements,
|
|
123
|
+
});
|
|
124
|
+
|
|
125
|
+
const result = await access.can({
|
|
126
|
+
permissions: {todo: ["read"]},
|
|
127
|
+
user: undefined,
|
|
128
|
+
});
|
|
129
|
+
|
|
130
|
+
expect(result).toEqual({
|
|
131
|
+
allowed: false,
|
|
132
|
+
deniedBy: "role",
|
|
133
|
+
reason: "Unauthenticated",
|
|
134
|
+
});
|
|
135
|
+
});
|
|
136
|
+
|
|
137
|
+
it("applies scope checks and filters on documents and queries", async () => {
|
|
138
|
+
await setupDb();
|
|
139
|
+
const access = createAccess({
|
|
140
|
+
connection: mongoose.connection,
|
|
141
|
+
defaultRoles: [
|
|
142
|
+
{
|
|
143
|
+
displayName: "Reader",
|
|
144
|
+
name: "reader",
|
|
145
|
+
permissions: {todo: ["read", "list"]},
|
|
146
|
+
},
|
|
147
|
+
],
|
|
148
|
+
scopes: {
|
|
149
|
+
"todo.*": {
|
|
150
|
+
check: async ({doc, user}) => {
|
|
151
|
+
if (!doc || !user) {
|
|
152
|
+
return true;
|
|
153
|
+
}
|
|
154
|
+
return (doc as {ownerId?: string}).ownerId === user.id;
|
|
155
|
+
},
|
|
156
|
+
filter: async ({user}) => ({ownerId: user.id}),
|
|
157
|
+
},
|
|
158
|
+
},
|
|
159
|
+
statements: appStatements,
|
|
160
|
+
});
|
|
161
|
+
await access.roles.seedDefaults();
|
|
162
|
+
|
|
163
|
+
const user = createTestUser({roles: ["reader"]});
|
|
164
|
+
const ownDoc = {ownerId: user.id, title: "Mine"};
|
|
165
|
+
const otherDoc = {ownerId: new mongoose.Types.ObjectId().toString(), title: "Other"};
|
|
166
|
+
|
|
167
|
+
expect(
|
|
168
|
+
await access.can({
|
|
169
|
+
doc: ownDoc,
|
|
170
|
+
permissions: {todo: ["read"]},
|
|
171
|
+
user,
|
|
172
|
+
})
|
|
173
|
+
).toEqual({allowed: true});
|
|
174
|
+
|
|
175
|
+
expect(
|
|
176
|
+
await access.can({
|
|
177
|
+
doc: otherDoc,
|
|
178
|
+
permissions: {todo: ["read"]},
|
|
179
|
+
user,
|
|
180
|
+
})
|
|
181
|
+
).toEqual({allowed: false, deniedBy: "scope", reason: "Denied by todo.read"});
|
|
182
|
+
|
|
183
|
+
expect(await access.queryFilter({action: "list", resource: "todo", user})).toEqual({
|
|
184
|
+
ownerId: user.id,
|
|
185
|
+
});
|
|
186
|
+
expect(await access.queryFilter({action: "list", resource: "todo", user: undefined})).toBe(
|
|
187
|
+
null
|
|
188
|
+
);
|
|
189
|
+
});
|
|
190
|
+
|
|
191
|
+
it("denies scope checks that require extra permissions", async () => {
|
|
192
|
+
await setupDb();
|
|
193
|
+
const access = createAccess({
|
|
194
|
+
connection: mongoose.connection,
|
|
195
|
+
defaultRoles: [
|
|
196
|
+
{
|
|
197
|
+
displayName: "Reader",
|
|
198
|
+
name: "reader",
|
|
199
|
+
permissions: {todo: ["read"]},
|
|
200
|
+
},
|
|
201
|
+
],
|
|
202
|
+
scopes: {
|
|
203
|
+
"todo.read": {
|
|
204
|
+
check: async () => ({todo: ["update"]}),
|
|
205
|
+
},
|
|
206
|
+
},
|
|
207
|
+
statements: appStatements,
|
|
208
|
+
});
|
|
209
|
+
await access.roles.seedDefaults();
|
|
210
|
+
|
|
211
|
+
const user = createTestUser({roles: ["reader"]});
|
|
212
|
+
const result = await access.can({
|
|
213
|
+
doc: {title: "Todo"},
|
|
214
|
+
permissions: {todo: ["read"]},
|
|
215
|
+
user,
|
|
216
|
+
});
|
|
217
|
+
|
|
218
|
+
expect(result.allowed).toBe(false);
|
|
219
|
+
expect(result.deniedBy).toBe("scope");
|
|
220
|
+
});
|
|
221
|
+
|
|
222
|
+
it("returns empty query filters when scopes have no filter", async () => {
|
|
223
|
+
await setupDb();
|
|
224
|
+
const access = createAccess({
|
|
225
|
+
connection: mongoose.connection,
|
|
226
|
+
defaultRoles: [
|
|
227
|
+
{
|
|
228
|
+
displayName: "Reader",
|
|
229
|
+
name: "reader",
|
|
230
|
+
permissions: {todo: ["read"]},
|
|
231
|
+
},
|
|
232
|
+
],
|
|
233
|
+
statements: appStatements,
|
|
234
|
+
});
|
|
235
|
+
await access.roles.seedDefaults();
|
|
236
|
+
|
|
237
|
+
const user = createTestUser({roles: ["reader"]});
|
|
238
|
+
expect(await access.queryFilter({action: "read", resource: "todo", user})).toEqual({});
|
|
239
|
+
});
|
|
240
|
+
|
|
241
|
+
it("applies field views for read and write phases", async () => {
|
|
242
|
+
await setupDb();
|
|
243
|
+
const access = createAccess({
|
|
244
|
+
connection: mongoose.connection,
|
|
245
|
+
defaultRoles: [
|
|
246
|
+
{
|
|
247
|
+
displayName: "Reader",
|
|
248
|
+
name: "reader",
|
|
249
|
+
permissions: {todo: ["read", "update"]},
|
|
250
|
+
},
|
|
251
|
+
],
|
|
252
|
+
fieldViews: {
|
|
253
|
+
todo: {
|
|
254
|
+
select: ({phase}) => (phase === "write" ? "editable" : "public"),
|
|
255
|
+
views: {
|
|
256
|
+
editable: {omit: [], read: ["title"], write: ["title"]},
|
|
257
|
+
public: {omit: [], read: ["title"], write: []},
|
|
258
|
+
},
|
|
259
|
+
},
|
|
260
|
+
},
|
|
261
|
+
statements: appStatements,
|
|
262
|
+
});
|
|
263
|
+
await access.roles.seedDefaults();
|
|
264
|
+
|
|
265
|
+
const user = createTestUser({roles: ["reader"]});
|
|
266
|
+
const readMask = await access.fieldMask({
|
|
267
|
+
doc: {secret: "hidden", title: "Todo"},
|
|
268
|
+
phase: "read",
|
|
269
|
+
resource: "todo",
|
|
270
|
+
user,
|
|
271
|
+
});
|
|
272
|
+
expect(readMask.read).toEqual(["title"]);
|
|
273
|
+
|
|
274
|
+
const writeMask = await access.fieldMask({
|
|
275
|
+
doc: {secret: "hidden", title: "Todo"},
|
|
276
|
+
phase: "write",
|
|
277
|
+
resource: "todo",
|
|
278
|
+
user,
|
|
279
|
+
});
|
|
280
|
+
expect(writeMask.write).toEqual(["title"]);
|
|
281
|
+
|
|
282
|
+
const anonymousMask = await access.fieldMask({
|
|
283
|
+
resource: "todo",
|
|
284
|
+
user: undefined,
|
|
285
|
+
});
|
|
286
|
+
expect(anonymousMask).toEqual({omit: [], read: "*", write: "*"});
|
|
287
|
+
});
|
|
288
|
+
|
|
289
|
+
it("returns custom field masks from select callbacks", async () => {
|
|
290
|
+
await setupDb();
|
|
291
|
+
const access = createAccess({
|
|
292
|
+
connection: mongoose.connection,
|
|
293
|
+
defaultRoles: [
|
|
294
|
+
{
|
|
295
|
+
displayName: "Reader",
|
|
296
|
+
name: "reader",
|
|
297
|
+
permissions: {todo: ["read"]},
|
|
298
|
+
},
|
|
299
|
+
],
|
|
300
|
+
fieldViews: {
|
|
301
|
+
todo: {
|
|
302
|
+
select: () => ({omit: [], read: ["title"], write: ["title"]}),
|
|
303
|
+
views: {},
|
|
304
|
+
},
|
|
305
|
+
},
|
|
306
|
+
statements: appStatements,
|
|
307
|
+
});
|
|
308
|
+
await access.roles.seedDefaults();
|
|
309
|
+
|
|
310
|
+
const user = createTestUser({roles: ["reader"]});
|
|
311
|
+
const mask = await access.fieldMask({
|
|
312
|
+
resource: "todo",
|
|
313
|
+
user,
|
|
314
|
+
});
|
|
315
|
+
expect(mask.read).toEqual(["title"]);
|
|
316
|
+
});
|
|
317
|
+
|
|
318
|
+
it("honors createView deny and unknown view names as empty masks", async () => {
|
|
319
|
+
await setupDb();
|
|
320
|
+
const access = createAccess({
|
|
321
|
+
connection: mongoose.connection,
|
|
322
|
+
defaultRoles: [
|
|
323
|
+
{
|
|
324
|
+
displayName: "Writer",
|
|
325
|
+
name: "writer",
|
|
326
|
+
permissions: {todo: ["create"]},
|
|
327
|
+
},
|
|
328
|
+
],
|
|
329
|
+
fieldViews: {
|
|
330
|
+
todo: {
|
|
331
|
+
createView: "deny",
|
|
332
|
+
select: () => "missing",
|
|
333
|
+
views: {
|
|
334
|
+
public: {omit: [], read: ["title"], write: ["title"]},
|
|
335
|
+
},
|
|
336
|
+
},
|
|
337
|
+
},
|
|
338
|
+
statements: appStatements,
|
|
339
|
+
});
|
|
340
|
+
await access.roles.seedDefaults();
|
|
341
|
+
|
|
342
|
+
const user = createTestUser({roles: ["writer"]});
|
|
343
|
+
const createMask = await access.fieldMask({
|
|
344
|
+
phase: "create",
|
|
345
|
+
resource: "todo",
|
|
346
|
+
user,
|
|
347
|
+
});
|
|
348
|
+
expect(createMask.write).toEqual([]);
|
|
349
|
+
|
|
350
|
+
const readMask = await access.fieldMask({
|
|
351
|
+
phase: "read",
|
|
352
|
+
resource: "todo",
|
|
353
|
+
user,
|
|
354
|
+
});
|
|
355
|
+
expect(readMask.write).toEqual([]);
|
|
356
|
+
});
|
|
357
|
+
});
|
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
import type {User} from "../auth";
|
|
2
|
+
import {normalizeRbacAuditSinks} from "./auditModel";
|
|
3
|
+
import {createIsPermitted, createRequireAccess} from "./middleware";
|
|
4
|
+
import {createPermissionResolver} from "./resolve";
|
|
5
|
+
import {createRoleManager} from "./roleManager";
|
|
6
|
+
import {createRbacRoleModel} from "./roleModel";
|
|
7
|
+
import {mergeStatements, type Statements} from "./statements";
|
|
8
|
+
import type {
|
|
9
|
+
AccessCheckArgs,
|
|
10
|
+
AccessOptions,
|
|
11
|
+
AccessResult,
|
|
12
|
+
FieldMask,
|
|
13
|
+
PermissionRequest,
|
|
14
|
+
TerrenoAccess,
|
|
15
|
+
} from "./types";
|
|
16
|
+
|
|
17
|
+
const FULL_FIELD_MASK: FieldMask = {
|
|
18
|
+
omit: [],
|
|
19
|
+
read: "*",
|
|
20
|
+
write: "*",
|
|
21
|
+
};
|
|
22
|
+
|
|
23
|
+
const EMPTY_FIELD_MASK: FieldMask = {
|
|
24
|
+
omit: [],
|
|
25
|
+
read: [],
|
|
26
|
+
write: [],
|
|
27
|
+
};
|
|
28
|
+
|
|
29
|
+
export const createAccess = <S extends Statements>(options: AccessOptions<S>): TerrenoAccess<S> => {
|
|
30
|
+
const persistAudit = options.persistAudit !== false;
|
|
31
|
+
const auditSinks = normalizeRbacAuditSinks(options.auditSink);
|
|
32
|
+
if (!persistAudit && auditSinks.length === 0) {
|
|
33
|
+
throw new Error("RBAC audit requires persistAudit or at least one auditSink");
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
const mergedStatements = mergeStatements(options.statements) as S;
|
|
37
|
+
const rbacRoleModel = createRbacRoleModel(options.connection);
|
|
38
|
+
|
|
39
|
+
const resolver = createPermissionResolver({
|
|
40
|
+
cacheTtlMs: options.cacheTtlMs,
|
|
41
|
+
rbacRoleModel,
|
|
42
|
+
resolvePermissions: options.resolvePermissions,
|
|
43
|
+
sources: options.sources,
|
|
44
|
+
statements: mergedStatements,
|
|
45
|
+
});
|
|
46
|
+
|
|
47
|
+
const {roleManager} = createRoleManager({
|
|
48
|
+
auditSinks,
|
|
49
|
+
connection: options.connection,
|
|
50
|
+
defaultRoles: options.defaultRoles,
|
|
51
|
+
getActorPermissions: (user) => resolver.resolvePermissionsForUser(user),
|
|
52
|
+
getPreviewPermissions: (user) => resolver.resolvePermissionsForUserUncached(user),
|
|
53
|
+
invalidateCache: resolver.invalidateCache,
|
|
54
|
+
persistAudit,
|
|
55
|
+
statements: mergedStatements,
|
|
56
|
+
userModel: options.userModel,
|
|
57
|
+
});
|
|
58
|
+
|
|
59
|
+
const can = async (args: AccessCheckArgs<S>): Promise<AccessResult> => {
|
|
60
|
+
if (!args.user) {
|
|
61
|
+
return {allowed: false, deniedBy: "role", reason: "Unauthenticated"};
|
|
62
|
+
}
|
|
63
|
+
|
|
64
|
+
const effectivePermissions = await resolver.resolvePermissionsForUser(args.user);
|
|
65
|
+
const roleResult = resolver.authorizePermissions(
|
|
66
|
+
effectivePermissions,
|
|
67
|
+
args.permissions as never
|
|
68
|
+
);
|
|
69
|
+
|
|
70
|
+
if (!roleResult.success) {
|
|
71
|
+
return {
|
|
72
|
+
allowed: false,
|
|
73
|
+
deniedBy: "role",
|
|
74
|
+
reason: roleResult.error,
|
|
75
|
+
};
|
|
76
|
+
}
|
|
77
|
+
|
|
78
|
+
if (options.scopes) {
|
|
79
|
+
for (const [resource, actions] of Object.entries(args.permissions)) {
|
|
80
|
+
for (const action of actions ?? []) {
|
|
81
|
+
const scopeKey = `${resource}.${action}`;
|
|
82
|
+
const wildcardScope = options.scopes[`${resource}.*`];
|
|
83
|
+
const scope = options.scopes[scopeKey] ?? wildcardScope;
|
|
84
|
+
if (!scope?.check) {
|
|
85
|
+
continue;
|
|
86
|
+
}
|
|
87
|
+
|
|
88
|
+
const checkResult = await scope.check({
|
|
89
|
+
action,
|
|
90
|
+
context: args.context,
|
|
91
|
+
doc: args.doc,
|
|
92
|
+
user: args.user,
|
|
93
|
+
});
|
|
94
|
+
|
|
95
|
+
if (checkResult === false) {
|
|
96
|
+
return {allowed: false, deniedBy: "scope", reason: `Denied by ${scopeKey}`};
|
|
97
|
+
}
|
|
98
|
+
|
|
99
|
+
if (checkResult && typeof checkResult === "object") {
|
|
100
|
+
const extraResult = resolver.authorizePermissions(
|
|
101
|
+
effectivePermissions,
|
|
102
|
+
checkResult as never
|
|
103
|
+
);
|
|
104
|
+
if (!extraResult.success) {
|
|
105
|
+
return {
|
|
106
|
+
allowed: false,
|
|
107
|
+
deniedBy: "scope",
|
|
108
|
+
reason: extraResult.error,
|
|
109
|
+
};
|
|
110
|
+
}
|
|
111
|
+
}
|
|
112
|
+
}
|
|
113
|
+
}
|
|
114
|
+
}
|
|
115
|
+
|
|
116
|
+
return {allowed: true};
|
|
117
|
+
};
|
|
118
|
+
|
|
119
|
+
const queryFilter = async (args: {
|
|
120
|
+
user?: User;
|
|
121
|
+
resource: string;
|
|
122
|
+
action: string;
|
|
123
|
+
context?: Record<string, unknown>;
|
|
124
|
+
}): Promise<Record<string, unknown> | null> => {
|
|
125
|
+
if (!args.user) {
|
|
126
|
+
return null;
|
|
127
|
+
}
|
|
128
|
+
|
|
129
|
+
const roleResult = await can({
|
|
130
|
+
context: args.context,
|
|
131
|
+
permissions: {[args.resource]: [args.action]} as PermissionRequest<S>,
|
|
132
|
+
user: args.user,
|
|
133
|
+
});
|
|
134
|
+
if (!roleResult.allowed) {
|
|
135
|
+
return null;
|
|
136
|
+
}
|
|
137
|
+
|
|
138
|
+
const scopeKey = `${args.resource}.${args.action}`;
|
|
139
|
+
const scope = options.scopes?.[scopeKey] ?? options.scopes?.[`${args.resource}.*`];
|
|
140
|
+
if (!scope?.filter) {
|
|
141
|
+
return {};
|
|
142
|
+
}
|
|
143
|
+
|
|
144
|
+
return scope.filter({
|
|
145
|
+
action: args.action,
|
|
146
|
+
context: args.context,
|
|
147
|
+
user: args.user,
|
|
148
|
+
});
|
|
149
|
+
};
|
|
150
|
+
|
|
151
|
+
const fieldMask = async (args: {
|
|
152
|
+
user?: User;
|
|
153
|
+
resource: string;
|
|
154
|
+
doc?: unknown;
|
|
155
|
+
phase?: "read" | "write" | "create";
|
|
156
|
+
}): Promise<FieldMask> => {
|
|
157
|
+
const fieldView = options.fieldViews?.[args.resource];
|
|
158
|
+
if (!fieldView || !args.user) {
|
|
159
|
+
return FULL_FIELD_MASK;
|
|
160
|
+
}
|
|
161
|
+
|
|
162
|
+
const permissions = await resolver.resolvePermissionsForUser(args.user);
|
|
163
|
+
const phase = args.phase ?? "read";
|
|
164
|
+
|
|
165
|
+
if (phase === "create" && fieldView.createView !== undefined) {
|
|
166
|
+
if (fieldView.createView === "deny") {
|
|
167
|
+
return EMPTY_FIELD_MASK;
|
|
168
|
+
}
|
|
169
|
+
if (typeof fieldView.createView === "string") {
|
|
170
|
+
return fieldView.views[fieldView.createView] ?? EMPTY_FIELD_MASK;
|
|
171
|
+
}
|
|
172
|
+
return fieldView.createView;
|
|
173
|
+
}
|
|
174
|
+
|
|
175
|
+
const selected = await fieldView.select({
|
|
176
|
+
doc: args.doc,
|
|
177
|
+
permissions,
|
|
178
|
+
phase,
|
|
179
|
+
user: args.user,
|
|
180
|
+
});
|
|
181
|
+
|
|
182
|
+
if (typeof selected === "string") {
|
|
183
|
+
return fieldView.views[selected] ?? EMPTY_FIELD_MASK;
|
|
184
|
+
}
|
|
185
|
+
|
|
186
|
+
return selected;
|
|
187
|
+
};
|
|
188
|
+
|
|
189
|
+
return {
|
|
190
|
+
ac: resolver.ac,
|
|
191
|
+
can,
|
|
192
|
+
fieldMask,
|
|
193
|
+
getPermissions: ({user}) => resolver.resolvePermissionsForUser(user),
|
|
194
|
+
invalidateCache: resolver.invalidateCache,
|
|
195
|
+
middleware: createRequireAccess({can}),
|
|
196
|
+
permission: createIsPermitted({can}),
|
|
197
|
+
queryFilter,
|
|
198
|
+
roles: roleManager,
|
|
199
|
+
statements: mergedStatements,
|
|
200
|
+
};
|
|
201
|
+
};
|