@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
|
@@ -0,0 +1,103 @@
|
|
|
1
|
+
import mongoose from "mongoose";
|
|
2
|
+
|
|
3
|
+
import {createdUpdatedPlugin, findExactlyOne, findOneOrNone} from "../plugins";
|
|
4
|
+
import type {PermissionSet} from "./statements";
|
|
5
|
+
|
|
6
|
+
export interface RbacAuditDocument {
|
|
7
|
+
_id: mongoose.Types.ObjectId;
|
|
8
|
+
action: string;
|
|
9
|
+
actorId: string;
|
|
10
|
+
targetRoleName?: string;
|
|
11
|
+
targetUserId?: string;
|
|
12
|
+
permissionDelta?: {
|
|
13
|
+
gained: PermissionSet;
|
|
14
|
+
lost: PermissionSet;
|
|
15
|
+
};
|
|
16
|
+
denied: boolean;
|
|
17
|
+
created: Date;
|
|
18
|
+
updated: Date;
|
|
19
|
+
}
|
|
20
|
+
|
|
21
|
+
export type RbacAuditModel = mongoose.Model<RbacAuditDocument>;
|
|
22
|
+
|
|
23
|
+
const rbacAuditSchema = new mongoose.Schema<RbacAuditDocument, RbacAuditModel>(
|
|
24
|
+
{
|
|
25
|
+
action: {
|
|
26
|
+
description: "RBAC action that was attempted or performed",
|
|
27
|
+
required: true,
|
|
28
|
+
type: String,
|
|
29
|
+
},
|
|
30
|
+
actorId: {
|
|
31
|
+
description: "User id of the actor who performed the action",
|
|
32
|
+
index: true,
|
|
33
|
+
required: true,
|
|
34
|
+
type: String,
|
|
35
|
+
},
|
|
36
|
+
denied: {
|
|
37
|
+
default: false,
|
|
38
|
+
description: "Whether the action was denied (e.g. escalation attempt)",
|
|
39
|
+
type: Boolean,
|
|
40
|
+
},
|
|
41
|
+
permissionDelta: {
|
|
42
|
+
description: "Permissions gained and lost by the change",
|
|
43
|
+
type: mongoose.Schema.Types.Mixed,
|
|
44
|
+
},
|
|
45
|
+
targetRoleName: {
|
|
46
|
+
description: "Role name affected by the action",
|
|
47
|
+
index: true,
|
|
48
|
+
type: String,
|
|
49
|
+
},
|
|
50
|
+
targetUserId: {
|
|
51
|
+
description: "User id affected by the action",
|
|
52
|
+
index: true,
|
|
53
|
+
type: String,
|
|
54
|
+
},
|
|
55
|
+
},
|
|
56
|
+
{strict: "throw", toJSON: {virtuals: true}, toObject: {virtuals: true}}
|
|
57
|
+
);
|
|
58
|
+
|
|
59
|
+
rbacAuditSchema.plugin(createdUpdatedPlugin);
|
|
60
|
+
rbacAuditSchema.plugin(findOneOrNone);
|
|
61
|
+
rbacAuditSchema.plugin(findExactlyOne);
|
|
62
|
+
|
|
63
|
+
export const createRbacAuditModel = (connection: mongoose.Connection): RbacAuditModel => {
|
|
64
|
+
if (connection.models.RbacAudit) {
|
|
65
|
+
return connection.models.RbacAudit as RbacAuditModel;
|
|
66
|
+
}
|
|
67
|
+
return connection.model<RbacAuditDocument, RbacAuditModel>("RbacAudit", rbacAuditSchema);
|
|
68
|
+
};
|
|
69
|
+
|
|
70
|
+
export interface RbacAuditWrite {
|
|
71
|
+
action: string;
|
|
72
|
+
actorId: string;
|
|
73
|
+
denied?: boolean;
|
|
74
|
+
permissionDelta?: {
|
|
75
|
+
gained: PermissionSet;
|
|
76
|
+
lost: PermissionSet;
|
|
77
|
+
};
|
|
78
|
+
targetRoleName?: string;
|
|
79
|
+
targetUserId?: string;
|
|
80
|
+
}
|
|
81
|
+
|
|
82
|
+
export const recordRbacAudit = async (
|
|
83
|
+
model: RbacAuditModel,
|
|
84
|
+
args: RbacAuditWrite
|
|
85
|
+
): Promise<void> => {
|
|
86
|
+
await model.create({
|
|
87
|
+
action: args.action,
|
|
88
|
+
actorId: args.actorId,
|
|
89
|
+
denied: args.denied ?? false,
|
|
90
|
+
permissionDelta: args.permissionDelta,
|
|
91
|
+
targetRoleName: args.targetRoleName,
|
|
92
|
+
targetUserId: args.targetUserId,
|
|
93
|
+
});
|
|
94
|
+
};
|
|
95
|
+
|
|
96
|
+
export const normalizeRbacAuditSinks = <T extends (record: RbacAuditWrite) => unknown>(
|
|
97
|
+
auditSink?: T | T[]
|
|
98
|
+
): T[] => {
|
|
99
|
+
if (!auditSink) {
|
|
100
|
+
return [];
|
|
101
|
+
}
|
|
102
|
+
return Array.isArray(auditSink) ? auditSink : [auditSink];
|
|
103
|
+
};
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
import type {UserModel} from "../auth";
|
|
2
|
+
import {logger} from "../logger";
|
|
3
|
+
import type {AnyTerrenoAccess} from "./types";
|
|
4
|
+
|
|
5
|
+
export interface BackfillAdminsOptions {
|
|
6
|
+
access: AnyTerrenoAccess;
|
|
7
|
+
userModel: UserModel;
|
|
8
|
+
roleName?: string;
|
|
9
|
+
wetRun?: boolean;
|
|
10
|
+
}
|
|
11
|
+
|
|
12
|
+
export interface BackfillAdminsResult {
|
|
13
|
+
dryRun: boolean;
|
|
14
|
+
matched: number;
|
|
15
|
+
updated: number;
|
|
16
|
+
}
|
|
17
|
+
|
|
18
|
+
/**
|
|
19
|
+
* Assigns a superadmin (or custom) role to users with `admin: true`.
|
|
20
|
+
* Dry-run by default — pass `wetRun: true` to persist changes.
|
|
21
|
+
*/
|
|
22
|
+
export const backfillAdmins = async ({
|
|
23
|
+
access,
|
|
24
|
+
userModel,
|
|
25
|
+
roleName = "superadmin",
|
|
26
|
+
wetRun = false,
|
|
27
|
+
}: BackfillAdminsOptions): Promise<BackfillAdminsResult> => {
|
|
28
|
+
const admins = await userModel.find({admin: true});
|
|
29
|
+
logger.info(
|
|
30
|
+
`[rbac:backfill-admins] Found ${admins.length} admin user(s); target role=${roleName}; wetRun=${wetRun}`
|
|
31
|
+
);
|
|
32
|
+
|
|
33
|
+
let updated = 0;
|
|
34
|
+
for (const user of admins) {
|
|
35
|
+
const rbacUser = user as unknown as {roles?: string[]; save: () => Promise<unknown>};
|
|
36
|
+
const roles = new Set(rbacUser.roles ?? []);
|
|
37
|
+
if (roles.has(roleName)) {
|
|
38
|
+
continue;
|
|
39
|
+
}
|
|
40
|
+
roles.add(roleName);
|
|
41
|
+
if (wetRun) {
|
|
42
|
+
rbacUser.roles = [...roles];
|
|
43
|
+
await user.save();
|
|
44
|
+
access.invalidateCache({userId: user.id});
|
|
45
|
+
}
|
|
46
|
+
updated += 1;
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
return {
|
|
50
|
+
dryRun: !wetRun,
|
|
51
|
+
matched: admins.length,
|
|
52
|
+
updated,
|
|
53
|
+
};
|
|
54
|
+
};
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
import {describe, expect, it} from "bun:test";
|
|
2
|
+
|
|
3
|
+
import {applyReadMask, getDisallowedWriteKeys} from "./fieldViews";
|
|
4
|
+
|
|
5
|
+
describe("fieldViews", () => {
|
|
6
|
+
it("applyReadMask picks only allowed read paths", () => {
|
|
7
|
+
const doc = {name: "Todo", ownerId: "u1", secret: "hidden"};
|
|
8
|
+
const masked = applyReadMask(doc, {omit: [], read: ["name", "ownerId"], write: ["name"]});
|
|
9
|
+
expect(masked).toEqual({name: "Todo", ownerId: "u1"});
|
|
10
|
+
});
|
|
11
|
+
|
|
12
|
+
it("applyReadMask omits nested paths without mutating the original document", () => {
|
|
13
|
+
const profile = {email: "a@b.com", phone: "555"};
|
|
14
|
+
const doc = {profile};
|
|
15
|
+
const masked = applyReadMask(doc, {
|
|
16
|
+
omit: ["profile.phone"],
|
|
17
|
+
read: "*",
|
|
18
|
+
write: "*",
|
|
19
|
+
});
|
|
20
|
+
expect(masked).toEqual({profile: {email: "a@b.com"}});
|
|
21
|
+
expect(profile.phone).toBe("555");
|
|
22
|
+
});
|
|
23
|
+
|
|
24
|
+
it("getDisallowedWriteKeys rejects nested keys outside a dotted write mask", () => {
|
|
25
|
+
const disallowed = getDisallowedWriteKeys(
|
|
26
|
+
{profile: {email: "a@b.com", phone: "555"}},
|
|
27
|
+
{omit: [], read: "*", write: ["profile.email"]}
|
|
28
|
+
);
|
|
29
|
+
expect(disallowed).toEqual(["profile.phone"]);
|
|
30
|
+
});
|
|
31
|
+
|
|
32
|
+
it("getDisallowedWriteKeys rejects keys outside the write mask", () => {
|
|
33
|
+
const disallowed = getDisallowedWriteKeys(
|
|
34
|
+
{admin: true, name: "x"},
|
|
35
|
+
{omit: [], read: "*", write: ["name"]}
|
|
36
|
+
);
|
|
37
|
+
expect(disallowed).toEqual(["admin"]);
|
|
38
|
+
});
|
|
39
|
+
});
|
|
@@ -0,0 +1,122 @@
|
|
|
1
|
+
import cloneDeep from "lodash/cloneDeep";
|
|
2
|
+
|
|
3
|
+
import type {FieldMask} from "./types";
|
|
4
|
+
|
|
5
|
+
const isPlainObject = (value: unknown): value is Record<string, unknown> =>
|
|
6
|
+
typeof value === "object" && value !== null && !Array.isArray(value);
|
|
7
|
+
|
|
8
|
+
const getNestedValue = (doc: Record<string, unknown>, path: string): unknown => {
|
|
9
|
+
const parts = path.split(".");
|
|
10
|
+
let current: unknown = doc;
|
|
11
|
+
for (const part of parts) {
|
|
12
|
+
if (!isPlainObject(current)) {
|
|
13
|
+
return undefined;
|
|
14
|
+
}
|
|
15
|
+
current = current[part];
|
|
16
|
+
}
|
|
17
|
+
return current;
|
|
18
|
+
};
|
|
19
|
+
|
|
20
|
+
const setNestedValue = (doc: Record<string, unknown>, path: string, value: unknown): void => {
|
|
21
|
+
const parts = path.split(".");
|
|
22
|
+
let current: Record<string, unknown> = doc;
|
|
23
|
+
for (let index = 0; index < parts.length - 1; index++) {
|
|
24
|
+
const part = parts[index];
|
|
25
|
+
const next = current[part];
|
|
26
|
+
if (!isPlainObject(next)) {
|
|
27
|
+
current[part] = {};
|
|
28
|
+
}
|
|
29
|
+
current = current[part] as Record<string, unknown>;
|
|
30
|
+
}
|
|
31
|
+
current[parts[parts.length - 1]] = value;
|
|
32
|
+
};
|
|
33
|
+
|
|
34
|
+
const pickPaths = (doc: Record<string, unknown>, paths: string[]): Record<string, unknown> => {
|
|
35
|
+
const result: Record<string, unknown> = {};
|
|
36
|
+
for (const path of paths) {
|
|
37
|
+
const value = getNestedValue(doc, path);
|
|
38
|
+
if (value !== undefined) {
|
|
39
|
+
setNestedValue(result, path, cloneDeep(value));
|
|
40
|
+
}
|
|
41
|
+
}
|
|
42
|
+
return result;
|
|
43
|
+
};
|
|
44
|
+
|
|
45
|
+
const omitPath = (doc: Record<string, unknown>, omitPathName: string): void => {
|
|
46
|
+
const parts = omitPathName.split(".");
|
|
47
|
+
if (parts.length === 1) {
|
|
48
|
+
delete doc[parts[0]];
|
|
49
|
+
return;
|
|
50
|
+
}
|
|
51
|
+
const parent = getNestedValue(doc, parts.slice(0, -1).join("."));
|
|
52
|
+
if (isPlainObject(parent)) {
|
|
53
|
+
delete parent[parts[parts.length - 1]];
|
|
54
|
+
}
|
|
55
|
+
};
|
|
56
|
+
|
|
57
|
+
export const applyReadMask = (value: unknown, mask: FieldMask): unknown => {
|
|
58
|
+
if (!isPlainObject(value) && !Array.isArray(value)) {
|
|
59
|
+
return value;
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
if (Array.isArray(value)) {
|
|
63
|
+
return value.map((item) => applyReadMask(item, mask));
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
const doc = value as Record<string, unknown>;
|
|
67
|
+
let result: Record<string, unknown>;
|
|
68
|
+
if (mask.read === "*") {
|
|
69
|
+
result = cloneDeep(doc);
|
|
70
|
+
} else {
|
|
71
|
+
result = pickPaths(doc, mask.read);
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
for (const pathToOmit of mask.omit ?? []) {
|
|
75
|
+
omitPath(result, pathToOmit);
|
|
76
|
+
}
|
|
77
|
+
|
|
78
|
+
return result;
|
|
79
|
+
};
|
|
80
|
+
|
|
81
|
+
const isWritePathAllowed = (path: string, write: string[]): boolean => {
|
|
82
|
+
for (const allowed of write) {
|
|
83
|
+
if (path === allowed || path.startsWith(`${allowed}.`)) {
|
|
84
|
+
return true;
|
|
85
|
+
}
|
|
86
|
+
}
|
|
87
|
+
return false;
|
|
88
|
+
};
|
|
89
|
+
|
|
90
|
+
const pathHasNestedWriteAllow = (path: string, write: string[]): boolean => {
|
|
91
|
+
return write.some((allowed) => allowed.startsWith(`${path}.`));
|
|
92
|
+
};
|
|
93
|
+
|
|
94
|
+
const collectDisallowedWriteKeys = (
|
|
95
|
+
body: Record<string, unknown>,
|
|
96
|
+
write: string[],
|
|
97
|
+
prefix = ""
|
|
98
|
+
): string[] => {
|
|
99
|
+
const disallowed: string[] = [];
|
|
100
|
+
for (const [key, value] of Object.entries(body)) {
|
|
101
|
+
const path = prefix ? `${prefix}.${key}` : key;
|
|
102
|
+
if (isPlainObject(value) && pathHasNestedWriteAllow(path, write)) {
|
|
103
|
+
disallowed.push(...collectDisallowedWriteKeys(value, write, path));
|
|
104
|
+
continue;
|
|
105
|
+
}
|
|
106
|
+
if (!isWritePathAllowed(path, write)) {
|
|
107
|
+
disallowed.push(path);
|
|
108
|
+
}
|
|
109
|
+
}
|
|
110
|
+
return disallowed;
|
|
111
|
+
};
|
|
112
|
+
|
|
113
|
+
export const getDisallowedWriteKeys = (
|
|
114
|
+
body: Record<string, unknown>,
|
|
115
|
+
mask: FieldMask
|
|
116
|
+
): string[] => {
|
|
117
|
+
if (mask.write === "*") {
|
|
118
|
+
return [];
|
|
119
|
+
}
|
|
120
|
+
|
|
121
|
+
return collectDisallowedWriteKeys(body, mask.write);
|
|
122
|
+
};
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
import type express from "express";
|
|
2
|
+
import type {NextFunction} from "express";
|
|
3
|
+
import type {RESTMethod} from "../api";
|
|
4
|
+
import {APIError} from "../errors";
|
|
5
|
+
import type {PermissionMethod} from "../permissions";
|
|
6
|
+
import type {Statements} from "./statements";
|
|
7
|
+
import type {AccessCheckArgs, AccessResult, PermissionRequest} from "./types";
|
|
8
|
+
|
|
9
|
+
export const createIsPermitted =
|
|
10
|
+
<S extends Statements>({can}: {can: (args: AccessCheckArgs<S>) => Promise<AccessResult>}) =>
|
|
11
|
+
(permissions: PermissionRequest<S>): PermissionMethod<unknown> => {
|
|
12
|
+
return async (_method: RESTMethod, user, obj) => {
|
|
13
|
+
const result = await can({
|
|
14
|
+
doc: obj,
|
|
15
|
+
permissions,
|
|
16
|
+
user,
|
|
17
|
+
});
|
|
18
|
+
return result.allowed;
|
|
19
|
+
};
|
|
20
|
+
};
|
|
21
|
+
|
|
22
|
+
export const IsPermitted = createIsPermitted;
|
|
23
|
+
|
|
24
|
+
export const createRequireAccess =
|
|
25
|
+
<S extends Statements>({can}: {can: (args: AccessCheckArgs<S>) => Promise<AccessResult>}) =>
|
|
26
|
+
(
|
|
27
|
+
permissions: PermissionRequest<S>,
|
|
28
|
+
options?: {getDoc?: (req: express.Request) => Promise<unknown>}
|
|
29
|
+
) => {
|
|
30
|
+
return async (req: express.Request, _res: express.Response, next: NextFunction) => {
|
|
31
|
+
try {
|
|
32
|
+
const doc = options?.getDoc ? await options.getDoc(req) : undefined;
|
|
33
|
+
const result = await can({
|
|
34
|
+
context: {req},
|
|
35
|
+
doc,
|
|
36
|
+
permissions,
|
|
37
|
+
user: req.user,
|
|
38
|
+
});
|
|
39
|
+
|
|
40
|
+
if (!result.allowed) {
|
|
41
|
+
throw new APIError({
|
|
42
|
+
detail: result.reason,
|
|
43
|
+
status: 403,
|
|
44
|
+
title: "Access denied",
|
|
45
|
+
});
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
return next();
|
|
49
|
+
} catch (error) {
|
|
50
|
+
return next(error);
|
|
51
|
+
}
|
|
52
|
+
};
|
|
53
|
+
};
|
|
54
|
+
|
|
55
|
+
export const requireAccess = createRequireAccess;
|
|
@@ -0,0 +1,336 @@
|
|
|
1
|
+
import {describe, expect, it} from "bun:test";
|
|
2
|
+
import mongoose from "mongoose";
|
|
3
|
+
|
|
4
|
+
import type {User} from "../auth";
|
|
5
|
+
import {Permissions} from "../permissions";
|
|
6
|
+
import {setupDb} from "../tests";
|
|
7
|
+
import {createAccess} from "./access";
|
|
8
|
+
import {
|
|
9
|
+
buildAccessPermissions,
|
|
10
|
+
buildAccessQueryFilter,
|
|
11
|
+
resolveModelRouterAccess,
|
|
12
|
+
validateAccessWriteBody,
|
|
13
|
+
wrapAccessResponseHandler,
|
|
14
|
+
} from "./modelRouterAccess";
|
|
15
|
+
import {OwnerScope} from "./scopes";
|
|
16
|
+
import {terrenoStatements} from "./statements";
|
|
17
|
+
import type {AnyTerrenoAccess} from "./types";
|
|
18
|
+
|
|
19
|
+
const appStatements = {
|
|
20
|
+
...terrenoStatements,
|
|
21
|
+
todo: ["create", "read", "update", "delete", "list"],
|
|
22
|
+
} as const;
|
|
23
|
+
|
|
24
|
+
const createTestUser = (
|
|
25
|
+
roles: string[] = []
|
|
26
|
+
): User & {roles: string[]} & {
|
|
27
|
+
[key: string]: unknown;
|
|
28
|
+
} => {
|
|
29
|
+
const id = new mongoose.Types.ObjectId();
|
|
30
|
+
return {
|
|
31
|
+
_id: id as unknown as User["_id"],
|
|
32
|
+
admin: false,
|
|
33
|
+
id: id.toString(),
|
|
34
|
+
roles,
|
|
35
|
+
};
|
|
36
|
+
};
|
|
37
|
+
|
|
38
|
+
describe("modelRouterAccess", () => {
|
|
39
|
+
it("builds permissions from access config", async () => {
|
|
40
|
+
await setupDb();
|
|
41
|
+
const access = createAccess({
|
|
42
|
+
connection: mongoose.connection,
|
|
43
|
+
defaultRoles: [
|
|
44
|
+
{
|
|
45
|
+
displayName: "Editor",
|
|
46
|
+
name: "editor",
|
|
47
|
+
permissions: {todo: ["read", "update", "list"]},
|
|
48
|
+
},
|
|
49
|
+
],
|
|
50
|
+
statements: appStatements,
|
|
51
|
+
});
|
|
52
|
+
await access.roles.seedDefaults();
|
|
53
|
+
|
|
54
|
+
const permissions = buildAccessPermissions(access as AnyTerrenoAccess, {resource: "todo"});
|
|
55
|
+
const user = createTestUser(["editor"]);
|
|
56
|
+
|
|
57
|
+
expect(await permissions.list[0]("list", user)).toBe(true);
|
|
58
|
+
expect(await permissions.delete[0]("delete", user)).toBe(false);
|
|
59
|
+
});
|
|
60
|
+
|
|
61
|
+
it("disables methods when action is null", async () => {
|
|
62
|
+
await setupDb();
|
|
63
|
+
const access = createAccess({
|
|
64
|
+
connection: mongoose.connection,
|
|
65
|
+
statements: appStatements,
|
|
66
|
+
});
|
|
67
|
+
await access.roles.seedDefaults();
|
|
68
|
+
|
|
69
|
+
const resolved = resolveModelRouterAccess({
|
|
70
|
+
access: {actions: {delete: null}, resource: "todo"},
|
|
71
|
+
accessControl: access as AnyTerrenoAccess,
|
|
72
|
+
});
|
|
73
|
+
|
|
74
|
+
expect(resolved.permissions.delete).toEqual([]);
|
|
75
|
+
});
|
|
76
|
+
|
|
77
|
+
it("falls back to read for list when list is not in statements", async () => {
|
|
78
|
+
await setupDb();
|
|
79
|
+
const narrowStatements = {
|
|
80
|
+
...terrenoStatements,
|
|
81
|
+
note: ["read", "update"],
|
|
82
|
+
} as const;
|
|
83
|
+
const access = createAccess({
|
|
84
|
+
connection: mongoose.connection,
|
|
85
|
+
defaultRoles: [
|
|
86
|
+
{
|
|
87
|
+
displayName: "Reader",
|
|
88
|
+
name: "reader",
|
|
89
|
+
permissions: {note: ["read"]},
|
|
90
|
+
},
|
|
91
|
+
],
|
|
92
|
+
statements: narrowStatements,
|
|
93
|
+
});
|
|
94
|
+
await access.roles.seedDefaults();
|
|
95
|
+
|
|
96
|
+
const permissions = buildAccessPermissions(access as AnyTerrenoAccess, {resource: "note"});
|
|
97
|
+
const user = createTestUser(["reader"]);
|
|
98
|
+
expect(await permissions.list[0]("list", user)).toBe(true);
|
|
99
|
+
});
|
|
100
|
+
|
|
101
|
+
it("merges scope filters into query filters", async () => {
|
|
102
|
+
await setupDb();
|
|
103
|
+
const access = createAccess({
|
|
104
|
+
connection: mongoose.connection,
|
|
105
|
+
defaultRoles: [
|
|
106
|
+
{
|
|
107
|
+
displayName: "Reader",
|
|
108
|
+
name: "reader",
|
|
109
|
+
permissions: {todo: ["read", "list"]},
|
|
110
|
+
},
|
|
111
|
+
],
|
|
112
|
+
scopes: {
|
|
113
|
+
"todo.list": OwnerScope(),
|
|
114
|
+
},
|
|
115
|
+
statements: appStatements,
|
|
116
|
+
});
|
|
117
|
+
await access.roles.seedDefaults();
|
|
118
|
+
|
|
119
|
+
const queryFilter = buildAccessQueryFilter(access as AnyTerrenoAccess, {resource: "todo"});
|
|
120
|
+
const user = createTestUser(["reader"]);
|
|
121
|
+
const merged = await queryFilter(user, {completed: false});
|
|
122
|
+
expect(merged).toEqual({
|
|
123
|
+
$and: [{completed: false}, {ownerId: user.id}],
|
|
124
|
+
});
|
|
125
|
+
});
|
|
126
|
+
|
|
127
|
+
it("returns null when an existing query filter rejects the user", async () => {
|
|
128
|
+
await setupDb();
|
|
129
|
+
const access = createAccess({
|
|
130
|
+
connection: mongoose.connection,
|
|
131
|
+
statements: appStatements,
|
|
132
|
+
});
|
|
133
|
+
await access.roles.seedDefaults();
|
|
134
|
+
|
|
135
|
+
const queryFilter = buildAccessQueryFilter(
|
|
136
|
+
access as AnyTerrenoAccess,
|
|
137
|
+
{resource: "todo"},
|
|
138
|
+
async () => null
|
|
139
|
+
);
|
|
140
|
+
const user = createTestUser(["superadmin"]);
|
|
141
|
+
expect(await queryFilter(user, {})).toBeNull();
|
|
142
|
+
});
|
|
143
|
+
|
|
144
|
+
it("validates write bodies against field masks", async () => {
|
|
145
|
+
await setupDb();
|
|
146
|
+
const access = createAccess({
|
|
147
|
+
connection: mongoose.connection,
|
|
148
|
+
defaultRoles: [
|
|
149
|
+
{
|
|
150
|
+
displayName: "Writer",
|
|
151
|
+
name: "writer",
|
|
152
|
+
permissions: {todo: ["update"]},
|
|
153
|
+
},
|
|
154
|
+
],
|
|
155
|
+
fieldViews: {
|
|
156
|
+
todo: {
|
|
157
|
+
select: () => "editable",
|
|
158
|
+
views: {
|
|
159
|
+
editable: {omit: [], read: ["title"], write: ["title"]},
|
|
160
|
+
},
|
|
161
|
+
},
|
|
162
|
+
},
|
|
163
|
+
statements: appStatements,
|
|
164
|
+
});
|
|
165
|
+
await access.roles.seedDefaults();
|
|
166
|
+
|
|
167
|
+
const user = createTestUser(["writer"]);
|
|
168
|
+
await expect(
|
|
169
|
+
validateAccessWriteBody({
|
|
170
|
+
access: {resource: "todo"},
|
|
171
|
+
accessControl: access as AnyTerrenoAccess,
|
|
172
|
+
body: {admin: true, title: "ok"},
|
|
173
|
+
phase: "write",
|
|
174
|
+
user,
|
|
175
|
+
})
|
|
176
|
+
).rejects.toMatchObject({
|
|
177
|
+
meta: {fields: {admin: "Field is not writable"}},
|
|
178
|
+
status: 400,
|
|
179
|
+
title: "Validation failed",
|
|
180
|
+
});
|
|
181
|
+
});
|
|
182
|
+
|
|
183
|
+
it("wraps response handlers with read masks", async () => {
|
|
184
|
+
await setupDb();
|
|
185
|
+
const access = createAccess({
|
|
186
|
+
connection: mongoose.connection,
|
|
187
|
+
defaultRoles: [
|
|
188
|
+
{
|
|
189
|
+
displayName: "Reader",
|
|
190
|
+
name: "reader",
|
|
191
|
+
permissions: {todo: ["read"]},
|
|
192
|
+
},
|
|
193
|
+
],
|
|
194
|
+
fieldViews: {
|
|
195
|
+
todo: {
|
|
196
|
+
select: () => "public",
|
|
197
|
+
views: {
|
|
198
|
+
public: {omit: [], read: ["title"], write: ["title"]},
|
|
199
|
+
},
|
|
200
|
+
},
|
|
201
|
+
},
|
|
202
|
+
statements: appStatements,
|
|
203
|
+
});
|
|
204
|
+
await access.roles.seedDefaults();
|
|
205
|
+
|
|
206
|
+
const handler = wrapAccessResponseHandler(
|
|
207
|
+
access as AnyTerrenoAccess,
|
|
208
|
+
{resource: "todo"},
|
|
209
|
+
(value) => value
|
|
210
|
+
);
|
|
211
|
+
|
|
212
|
+
const masked = await handler(
|
|
213
|
+
[
|
|
214
|
+
{secret: "hidden", title: "One"},
|
|
215
|
+
{secret: "hidden", title: "Two"},
|
|
216
|
+
],
|
|
217
|
+
"list",
|
|
218
|
+
{user: createTestUser(["reader"])} as never,
|
|
219
|
+
{}
|
|
220
|
+
);
|
|
221
|
+
expect(masked).toEqual([{title: "One"}, {title: "Two"}]);
|
|
222
|
+
});
|
|
223
|
+
|
|
224
|
+
it("masks create responses with the read phase, not createView", async () => {
|
|
225
|
+
await setupDb();
|
|
226
|
+
const access = createAccess({
|
|
227
|
+
connection: mongoose.connection,
|
|
228
|
+
defaultRoles: [
|
|
229
|
+
{
|
|
230
|
+
displayName: "Creator",
|
|
231
|
+
name: "creator",
|
|
232
|
+
permissions: {todo: ["create", "read"]},
|
|
233
|
+
},
|
|
234
|
+
],
|
|
235
|
+
fieldViews: {
|
|
236
|
+
todo: {
|
|
237
|
+
createView: "deny",
|
|
238
|
+
select: () => "public",
|
|
239
|
+
views: {
|
|
240
|
+
public: {omit: [], read: ["title"], write: ["title"]},
|
|
241
|
+
},
|
|
242
|
+
},
|
|
243
|
+
},
|
|
244
|
+
statements: appStatements,
|
|
245
|
+
});
|
|
246
|
+
await access.roles.seedDefaults();
|
|
247
|
+
|
|
248
|
+
const handler = wrapAccessResponseHandler(
|
|
249
|
+
access as AnyTerrenoAccess,
|
|
250
|
+
{resource: "todo"},
|
|
251
|
+
(value) => value
|
|
252
|
+
);
|
|
253
|
+
const masked = await handler(
|
|
254
|
+
{secret: "hidden", title: "Created"},
|
|
255
|
+
"create",
|
|
256
|
+
{user: createTestUser(["creator"])} as never,
|
|
257
|
+
{}
|
|
258
|
+
);
|
|
259
|
+
expect(masked).toEqual({title: "Created"});
|
|
260
|
+
});
|
|
261
|
+
|
|
262
|
+
it("evaluates extra PermissionSets returned from per-router scope.check", async () => {
|
|
263
|
+
await setupDb();
|
|
264
|
+
const access = createAccess({
|
|
265
|
+
connection: mongoose.connection,
|
|
266
|
+
defaultRoles: [
|
|
267
|
+
{
|
|
268
|
+
displayName: "Reader",
|
|
269
|
+
name: "reader",
|
|
270
|
+
permissions: {todo: ["read"]},
|
|
271
|
+
},
|
|
272
|
+
{
|
|
273
|
+
displayName: "Editor",
|
|
274
|
+
name: "editor",
|
|
275
|
+
permissions: {todo: ["read", "update"]},
|
|
276
|
+
},
|
|
277
|
+
],
|
|
278
|
+
statements: appStatements,
|
|
279
|
+
});
|
|
280
|
+
await access.roles.seedDefaults();
|
|
281
|
+
|
|
282
|
+
const permissions = buildAccessPermissions(access as AnyTerrenoAccess, {
|
|
283
|
+
resource: "todo",
|
|
284
|
+
scope: {
|
|
285
|
+
check: () => ({todo: ["update"]}),
|
|
286
|
+
},
|
|
287
|
+
});
|
|
288
|
+
const doc = {title: "Scoped"};
|
|
289
|
+
const readerAllowed = await Promise.all(
|
|
290
|
+
permissions.read.map((check) => check("read", createTestUser(["reader"]), doc))
|
|
291
|
+
);
|
|
292
|
+
const editorAllowed = await Promise.all(
|
|
293
|
+
permissions.read.map((check) => check("read", createTestUser(["editor"]), doc))
|
|
294
|
+
);
|
|
295
|
+
expect(readerAllowed.every(Boolean)).toBe(false);
|
|
296
|
+
expect(editorAllowed.every(Boolean)).toBe(true);
|
|
297
|
+
});
|
|
298
|
+
|
|
299
|
+
it("uses scope from resolveModelRouterAccess when access.scope is omitted", async () => {
|
|
300
|
+
await setupDb();
|
|
301
|
+
const access = createAccess({
|
|
302
|
+
connection: mongoose.connection,
|
|
303
|
+
statements: appStatements,
|
|
304
|
+
});
|
|
305
|
+
await access.roles.seedDefaults();
|
|
306
|
+
|
|
307
|
+
const resolved = resolveModelRouterAccess({
|
|
308
|
+
access: {resource: "todo"},
|
|
309
|
+
accessControl: access as AnyTerrenoAccess,
|
|
310
|
+
scope: OwnerScope(),
|
|
311
|
+
});
|
|
312
|
+
|
|
313
|
+
expect(resolved.permissions).toBeDefined();
|
|
314
|
+
expect(resolved.queryFilter).toBeDefined();
|
|
315
|
+
expect(resolved.responseHandler).toBeDefined();
|
|
316
|
+
});
|
|
317
|
+
|
|
318
|
+
it("returns legacy permissions when access config is absent", () => {
|
|
319
|
+
const permissions = {
|
|
320
|
+
create: [Permissions.IsAdmin],
|
|
321
|
+
delete: [],
|
|
322
|
+
list: [Permissions.IsAdmin],
|
|
323
|
+
read: [Permissions.IsAdmin],
|
|
324
|
+
update: [Permissions.IsAdmin],
|
|
325
|
+
};
|
|
326
|
+
|
|
327
|
+
const resolved = resolveModelRouterAccess({permissions});
|
|
328
|
+
expect(resolved.permissions).toBe(permissions);
|
|
329
|
+
});
|
|
330
|
+
|
|
331
|
+
it("throws when neither access nor permissions are provided", () => {
|
|
332
|
+
expect(() => resolveModelRouterAccess({})).toThrow(
|
|
333
|
+
"modelRouter requires permissions or access with accessControl"
|
|
334
|
+
);
|
|
335
|
+
});
|
|
336
|
+
});
|