@terreno/api 57.0.0-beta.1 → 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,196 @@
|
|
|
1
|
+
import type {Document} from "mongoose";
|
|
2
|
+
import mongoose, {type Connection, type Model} from "mongoose";
|
|
3
|
+
import type {APIErrorConstructor} from "../errors";
|
|
4
|
+
import {createdUpdatedPlugin, findExactlyOne, findOneOrNone} from "../plugins";
|
|
5
|
+
import {
|
|
6
|
+
expandRolePermissions as expandRolePermissionSpec,
|
|
7
|
+
type PermissionSet,
|
|
8
|
+
READ_ACTIONS,
|
|
9
|
+
READ_ONLY_ROLE_PERMISSIONS,
|
|
10
|
+
type RolePermissionSpec,
|
|
11
|
+
type Statements,
|
|
12
|
+
} from "./statements";
|
|
13
|
+
|
|
14
|
+
export interface RoleDefinition {
|
|
15
|
+
name: string;
|
|
16
|
+
displayName: string;
|
|
17
|
+
description?: string;
|
|
18
|
+
permissions: RolePermissionSpec;
|
|
19
|
+
excludesRoles?: string[];
|
|
20
|
+
isLocked?: boolean;
|
|
21
|
+
isSealed?: boolean;
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
export interface RbacRoleDocument {
|
|
25
|
+
_id: mongoose.Types.ObjectId;
|
|
26
|
+
name: string;
|
|
27
|
+
displayName: string;
|
|
28
|
+
description?: string;
|
|
29
|
+
permissions: PermissionSet;
|
|
30
|
+
excludesRoles: string[];
|
|
31
|
+
isLocked: boolean;
|
|
32
|
+
isSealed: boolean;
|
|
33
|
+
created: Date;
|
|
34
|
+
updated: Date;
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
export type RbacRoleModel = Model<RbacRoleDocument> & {
|
|
38
|
+
findExactlyOne: (
|
|
39
|
+
query: Record<string, unknown>,
|
|
40
|
+
errorArgs?: Partial<APIErrorConstructor>
|
|
41
|
+
) => Promise<Document & RbacRoleDocument>;
|
|
42
|
+
findOneOrNone: (
|
|
43
|
+
query: Record<string, unknown>,
|
|
44
|
+
errorArgs?: Partial<APIErrorConstructor>
|
|
45
|
+
) => Promise<(Document & RbacRoleDocument) | null>;
|
|
46
|
+
seedDefaults: (args: {statements: Statements; extraRoles?: RoleDefinition[]}) => Promise<void>;
|
|
47
|
+
};
|
|
48
|
+
|
|
49
|
+
export {READ_ONLY_ROLE_PERMISSIONS} from "./statements";
|
|
50
|
+
|
|
51
|
+
/**
|
|
52
|
+
* Insert missing default roles. Existing unsealed roles are left unchanged so admin
|
|
53
|
+
* customizations survive process restarts. Sealed roles are refreshed from code.
|
|
54
|
+
*/
|
|
55
|
+
export const upsertSeededRole = async (
|
|
56
|
+
model: RbacRoleModel,
|
|
57
|
+
role: RoleDefinition,
|
|
58
|
+
statements: Statements
|
|
59
|
+
): Promise<void> => {
|
|
60
|
+
const permissions = expandRolePermissions(role.permissions, statements);
|
|
61
|
+
const existing = await model.findOneOrNone({name: role.name});
|
|
62
|
+
if (existing) {
|
|
63
|
+
if (!existing.isSealed) {
|
|
64
|
+
return;
|
|
65
|
+
}
|
|
66
|
+
existing.description = role.description;
|
|
67
|
+
existing.displayName = role.displayName;
|
|
68
|
+
existing.excludesRoles = role.excludesRoles ?? [];
|
|
69
|
+
existing.isLocked = role.isLocked ?? false;
|
|
70
|
+
existing.isSealed = true;
|
|
71
|
+
existing.permissions = permissions;
|
|
72
|
+
await existing.save();
|
|
73
|
+
return;
|
|
74
|
+
}
|
|
75
|
+
await model.create({
|
|
76
|
+
description: role.description,
|
|
77
|
+
displayName: role.displayName,
|
|
78
|
+
excludesRoles: role.excludesRoles ?? [],
|
|
79
|
+
isLocked: role.isLocked ?? false,
|
|
80
|
+
isSealed: role.isSealed ?? false,
|
|
81
|
+
name: role.name,
|
|
82
|
+
permissions,
|
|
83
|
+
});
|
|
84
|
+
};
|
|
85
|
+
|
|
86
|
+
export const expandRolePermissions = (
|
|
87
|
+
spec: RolePermissionSpec,
|
|
88
|
+
statements: Statements,
|
|
89
|
+
readActions: readonly string[] = READ_ACTIONS
|
|
90
|
+
): PermissionSet => expandRolePermissionSpec(spec, statements, readActions);
|
|
91
|
+
|
|
92
|
+
export const terrenoDefaultRoles: RoleDefinition[] = [
|
|
93
|
+
{
|
|
94
|
+
displayName: "Super Admin",
|
|
95
|
+
isLocked: true,
|
|
96
|
+
isSealed: true,
|
|
97
|
+
name: "superadmin",
|
|
98
|
+
permissions: "*",
|
|
99
|
+
},
|
|
100
|
+
{
|
|
101
|
+
displayName: "Admin",
|
|
102
|
+
isLocked: true,
|
|
103
|
+
name: "admin",
|
|
104
|
+
permissions: {
|
|
105
|
+
admin: ["access"],
|
|
106
|
+
configuration: ["read", "update"],
|
|
107
|
+
user: ["create", "list", "read", "update"],
|
|
108
|
+
},
|
|
109
|
+
},
|
|
110
|
+
{
|
|
111
|
+
displayName: "Auditor",
|
|
112
|
+
isLocked: true,
|
|
113
|
+
name: "auditor",
|
|
114
|
+
permissions: READ_ONLY_ROLE_PERMISSIONS,
|
|
115
|
+
},
|
|
116
|
+
{
|
|
117
|
+
displayName: "Member",
|
|
118
|
+
isLocked: true,
|
|
119
|
+
name: "member",
|
|
120
|
+
permissions: {},
|
|
121
|
+
},
|
|
122
|
+
];
|
|
123
|
+
|
|
124
|
+
const rbacRoleSchema = new mongoose.Schema<RbacRoleDocument, RbacRoleModel>(
|
|
125
|
+
{
|
|
126
|
+
description: {
|
|
127
|
+
description: "Human-readable description of the role",
|
|
128
|
+
type: String,
|
|
129
|
+
},
|
|
130
|
+
displayName: {
|
|
131
|
+
description: "Human-readable name shown in the admin UI",
|
|
132
|
+
required: true,
|
|
133
|
+
trim: true,
|
|
134
|
+
type: String,
|
|
135
|
+
},
|
|
136
|
+
excludesRoles: {
|
|
137
|
+
default: [],
|
|
138
|
+
description: "Role names that cannot be held together with this role",
|
|
139
|
+
type: [String],
|
|
140
|
+
},
|
|
141
|
+
isLocked: {
|
|
142
|
+
default: false,
|
|
143
|
+
description: "Whether the role name is locked from deletion or renaming",
|
|
144
|
+
type: Boolean,
|
|
145
|
+
},
|
|
146
|
+
isSealed: {
|
|
147
|
+
default: false,
|
|
148
|
+
description: "Whether the role is immutable through the admin API",
|
|
149
|
+
type: Boolean,
|
|
150
|
+
},
|
|
151
|
+
name: {
|
|
152
|
+
description: "Stable machine name stored on users",
|
|
153
|
+
index: true,
|
|
154
|
+
required: true,
|
|
155
|
+
trim: true,
|
|
156
|
+
type: String,
|
|
157
|
+
unique: true,
|
|
158
|
+
},
|
|
159
|
+
permissions: {
|
|
160
|
+
description: "Permission JSON validated against access statements",
|
|
161
|
+
required: true,
|
|
162
|
+
type: mongoose.Schema.Types.Mixed,
|
|
163
|
+
},
|
|
164
|
+
},
|
|
165
|
+
{strict: "throw", toJSON: {virtuals: true}, toObject: {virtuals: true}}
|
|
166
|
+
);
|
|
167
|
+
|
|
168
|
+
rbacRoleSchema.plugin(createdUpdatedPlugin);
|
|
169
|
+
rbacRoleSchema.plugin(findOneOrNone);
|
|
170
|
+
rbacRoleSchema.plugin(findExactlyOne);
|
|
171
|
+
|
|
172
|
+
rbacRoleSchema.statics = {
|
|
173
|
+
...rbacRoleSchema.statics,
|
|
174
|
+
async seedDefaults(
|
|
175
|
+
this: RbacRoleModel,
|
|
176
|
+
{statements, extraRoles}: {statements: Statements; extraRoles?: RoleDefinition[]}
|
|
177
|
+
): Promise<void> {
|
|
178
|
+
const terrenoNames = new Set(terrenoDefaultRoles.map((role) => role.name));
|
|
179
|
+
for (const role of terrenoDefaultRoles) {
|
|
180
|
+
await upsertSeededRole(this, role, statements);
|
|
181
|
+
}
|
|
182
|
+
for (const role of extraRoles ?? []) {
|
|
183
|
+
if (terrenoNames.has(role.name)) {
|
|
184
|
+
continue;
|
|
185
|
+
}
|
|
186
|
+
await upsertSeededRole(this, role, statements);
|
|
187
|
+
}
|
|
188
|
+
},
|
|
189
|
+
};
|
|
190
|
+
|
|
191
|
+
export const createRbacRoleModel = (connection: Connection): RbacRoleModel => {
|
|
192
|
+
if (connection.models.RbacRole) {
|
|
193
|
+
return connection.models.RbacRole as RbacRoleModel;
|
|
194
|
+
}
|
|
195
|
+
return connection.model<RbacRoleDocument, RbacRoleModel>("RbacRole", rbacRoleSchema);
|
|
196
|
+
};
|
|
@@ -0,0 +1,170 @@
|
|
|
1
|
+
import express from "express";
|
|
2
|
+
|
|
3
|
+
import {asyncHandler} from "../api";
|
|
4
|
+
import {authenticateMiddleware, type User, type UserModel} from "../auth";
|
|
5
|
+
import {APIError} from "../errors";
|
|
6
|
+
import type {TerrenoPlugin} from "../terrenoPlugin";
|
|
7
|
+
import type {AnyTerrenoAccess} from "./types";
|
|
8
|
+
|
|
9
|
+
export interface RbacRouterOptions {
|
|
10
|
+
access: AnyTerrenoAccess;
|
|
11
|
+
userModel: UserModel;
|
|
12
|
+
basePath?: string;
|
|
13
|
+
}
|
|
14
|
+
|
|
15
|
+
export const rbacRouter = ({
|
|
16
|
+
access,
|
|
17
|
+
userModel,
|
|
18
|
+
basePath = "/rbac",
|
|
19
|
+
}: RbacRouterOptions): TerrenoPlugin => {
|
|
20
|
+
return {
|
|
21
|
+
register: (app: express.Application): void => {
|
|
22
|
+
const router = express.Router();
|
|
23
|
+
|
|
24
|
+
router.get(
|
|
25
|
+
"/statements",
|
|
26
|
+
authenticateMiddleware(),
|
|
27
|
+
access.middleware({rbac: ["read"]}),
|
|
28
|
+
asyncHandler(async (_req, res) => {
|
|
29
|
+
return res.json({
|
|
30
|
+
data: {
|
|
31
|
+
statements: access.statements,
|
|
32
|
+
},
|
|
33
|
+
});
|
|
34
|
+
})
|
|
35
|
+
);
|
|
36
|
+
|
|
37
|
+
router.get(
|
|
38
|
+
"/roles",
|
|
39
|
+
authenticateMiddleware(),
|
|
40
|
+
access.middleware({rbac: ["read"]}),
|
|
41
|
+
asyncHandler(async (_req, res) => {
|
|
42
|
+
const roles = await access.roles.list();
|
|
43
|
+
return res.json({data: roles});
|
|
44
|
+
})
|
|
45
|
+
);
|
|
46
|
+
|
|
47
|
+
router.post(
|
|
48
|
+
"/roles",
|
|
49
|
+
authenticateMiddleware(),
|
|
50
|
+
access.middleware({rbac: ["manageRoles"]}),
|
|
51
|
+
asyncHandler(async (req, res) => {
|
|
52
|
+
const actor = req.user;
|
|
53
|
+
if (!actor) {
|
|
54
|
+
throw new APIError({status: 401, title: "Unauthorized"});
|
|
55
|
+
}
|
|
56
|
+
const role = await access.roles.create({actor, role: req.body});
|
|
57
|
+
return res.status(201).json({data: role});
|
|
58
|
+
})
|
|
59
|
+
);
|
|
60
|
+
|
|
61
|
+
router.patch(
|
|
62
|
+
"/roles/:name",
|
|
63
|
+
authenticateMiddleware(),
|
|
64
|
+
access.middleware({rbac: ["manageRoles"]}),
|
|
65
|
+
asyncHandler(async (req, res) => {
|
|
66
|
+
const actor = req.user;
|
|
67
|
+
if (!actor) {
|
|
68
|
+
throw new APIError({status: 401, title: "Unauthorized"});
|
|
69
|
+
}
|
|
70
|
+
const role = await access.roles.update({
|
|
71
|
+
actor,
|
|
72
|
+
changes: req.body,
|
|
73
|
+
roleName: req.params.name,
|
|
74
|
+
});
|
|
75
|
+
return res.json({data: role});
|
|
76
|
+
})
|
|
77
|
+
);
|
|
78
|
+
|
|
79
|
+
router.delete(
|
|
80
|
+
"/roles/:name",
|
|
81
|
+
authenticateMiddleware(),
|
|
82
|
+
access.middleware({rbac: ["manageRoles"]}),
|
|
83
|
+
asyncHandler(async (req, res) => {
|
|
84
|
+
const actor = req.user;
|
|
85
|
+
if (!actor) {
|
|
86
|
+
throw new APIError({status: 401, title: "Unauthorized"});
|
|
87
|
+
}
|
|
88
|
+
await access.roles.remove({actor, roleName: req.params.name});
|
|
89
|
+
return res.status(204).send();
|
|
90
|
+
})
|
|
91
|
+
);
|
|
92
|
+
|
|
93
|
+
router.post(
|
|
94
|
+
"/roles/:name/preview",
|
|
95
|
+
authenticateMiddleware(),
|
|
96
|
+
access.middleware({rbac: ["manageRoles"]}),
|
|
97
|
+
asyncHandler(async (req, res) => {
|
|
98
|
+
const diff = await access.roles.previewRoleChange({
|
|
99
|
+
permissions: req.body.permissions,
|
|
100
|
+
roleName: req.params.name,
|
|
101
|
+
});
|
|
102
|
+
return res.json({data: diff});
|
|
103
|
+
})
|
|
104
|
+
);
|
|
105
|
+
|
|
106
|
+
router.get(
|
|
107
|
+
"/users/:id/permissions",
|
|
108
|
+
authenticateMiddleware(),
|
|
109
|
+
access.middleware({rbac: ["read"]}),
|
|
110
|
+
asyncHandler(async (req, res) => {
|
|
111
|
+
const user = await userModel.findById(req.params.id);
|
|
112
|
+
if (!user) {
|
|
113
|
+
throw new APIError({status: 404, title: "User not found"});
|
|
114
|
+
}
|
|
115
|
+
const permissions = await access.getPermissions({
|
|
116
|
+
user: user as never,
|
|
117
|
+
});
|
|
118
|
+
const withRoles = user as {roles?: string[]};
|
|
119
|
+
return res.json({
|
|
120
|
+
data: {
|
|
121
|
+
permissions,
|
|
122
|
+
roles: withRoles.roles ?? [],
|
|
123
|
+
},
|
|
124
|
+
});
|
|
125
|
+
})
|
|
126
|
+
);
|
|
127
|
+
|
|
128
|
+
router.put(
|
|
129
|
+
"/users/:id/roles",
|
|
130
|
+
authenticateMiddleware(),
|
|
131
|
+
access.middleware({rbac: ["assignRoles"]}),
|
|
132
|
+
asyncHandler(async (req, res) => {
|
|
133
|
+
const actor = req.user;
|
|
134
|
+
if (!actor) {
|
|
135
|
+
throw new APIError({status: 401, title: "Unauthorized"});
|
|
136
|
+
}
|
|
137
|
+
if (!Array.isArray(req.body.roleNames)) {
|
|
138
|
+
throw new APIError({status: 400, title: "roleNames is required"});
|
|
139
|
+
}
|
|
140
|
+
await access.roles.assign({
|
|
141
|
+
actor,
|
|
142
|
+
roleNames: req.body.roleNames,
|
|
143
|
+
userId: req.params.id,
|
|
144
|
+
});
|
|
145
|
+
return res.json({data: {success: true}});
|
|
146
|
+
})
|
|
147
|
+
);
|
|
148
|
+
|
|
149
|
+
router.post(
|
|
150
|
+
"/users/:id/roles/preview",
|
|
151
|
+
authenticateMiddleware(),
|
|
152
|
+
access.middleware({rbac: ["assignRoles"]}),
|
|
153
|
+
asyncHandler(async (req, res) => {
|
|
154
|
+
if (!Array.isArray(req.body.roleNames)) {
|
|
155
|
+
throw new APIError({status: 400, title: "roleNames is required"});
|
|
156
|
+
}
|
|
157
|
+
const actor = req.user as User;
|
|
158
|
+
const diff = await access.roles.previewAssignment({
|
|
159
|
+
actor,
|
|
160
|
+
roleNames: req.body.roleNames,
|
|
161
|
+
userId: req.params.id,
|
|
162
|
+
});
|
|
163
|
+
return res.json({data: diff});
|
|
164
|
+
})
|
|
165
|
+
);
|
|
166
|
+
|
|
167
|
+
app.use(basePath, router);
|
|
168
|
+
},
|
|
169
|
+
};
|
|
170
|
+
};
|
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
import {describe, expect, it} from "bun:test";
|
|
2
|
+
import mongoose from "mongoose";
|
|
3
|
+
|
|
4
|
+
import type {User} from "../auth";
|
|
5
|
+
import {setupDb} from "../tests";
|
|
6
|
+
import {createAccess} from "./access";
|
|
7
|
+
import {createIsPermitted} from "./middleware";
|
|
8
|
+
import {OwnerScope} from "./scopes";
|
|
9
|
+
import {terrenoStatements} from "./statements";
|
|
10
|
+
|
|
11
|
+
const appStatements = {
|
|
12
|
+
...terrenoStatements,
|
|
13
|
+
todo: ["create", "read", "update", "delete", "list"],
|
|
14
|
+
} as const;
|
|
15
|
+
|
|
16
|
+
const createUser = (
|
|
17
|
+
overrides: Partial<User & {roles: string[]}> = {}
|
|
18
|
+
): User & {
|
|
19
|
+
roles: string[];
|
|
20
|
+
} => {
|
|
21
|
+
const id = new mongoose.Types.ObjectId();
|
|
22
|
+
return {
|
|
23
|
+
_id: id as unknown as User["_id"],
|
|
24
|
+
admin: false,
|
|
25
|
+
id: id.toString(),
|
|
26
|
+
roles: [],
|
|
27
|
+
...overrides,
|
|
28
|
+
};
|
|
29
|
+
};
|
|
30
|
+
|
|
31
|
+
describe("rbac scopes", () => {
|
|
32
|
+
it("OwnerScope allows admins to bypass ownership checks", async () => {
|
|
33
|
+
const scope = OwnerScope();
|
|
34
|
+
const admin = createUser({admin: true});
|
|
35
|
+
const ownerId = new mongoose.Types.ObjectId().toString();
|
|
36
|
+
|
|
37
|
+
const checkResult = await scope.check?.({
|
|
38
|
+
action: "update",
|
|
39
|
+
doc: {ownerId},
|
|
40
|
+
user: admin,
|
|
41
|
+
});
|
|
42
|
+
const filterResult = await scope.filter?.({
|
|
43
|
+
action: "update",
|
|
44
|
+
user: admin,
|
|
45
|
+
});
|
|
46
|
+
|
|
47
|
+
expect(checkResult).toBe(true);
|
|
48
|
+
expect(filterResult).toEqual({});
|
|
49
|
+
});
|
|
50
|
+
|
|
51
|
+
it("OwnerScope restricts non-admin users to their own documents", async () => {
|
|
52
|
+
const scope = OwnerScope();
|
|
53
|
+
const user = createUser();
|
|
54
|
+
const ownDoc = {ownerId: user.id};
|
|
55
|
+
const otherDoc = {ownerId: new mongoose.Types.ObjectId().toString()};
|
|
56
|
+
|
|
57
|
+
expect(
|
|
58
|
+
await scope.check?.({
|
|
59
|
+
action: "update",
|
|
60
|
+
doc: ownDoc,
|
|
61
|
+
user,
|
|
62
|
+
})
|
|
63
|
+
).toBe(true);
|
|
64
|
+
expect(
|
|
65
|
+
await scope.check?.({
|
|
66
|
+
action: "update",
|
|
67
|
+
doc: otherDoc,
|
|
68
|
+
user,
|
|
69
|
+
})
|
|
70
|
+
).toBe(false);
|
|
71
|
+
expect(
|
|
72
|
+
await scope.filter?.({
|
|
73
|
+
action: "list",
|
|
74
|
+
user,
|
|
75
|
+
})
|
|
76
|
+
).toEqual({ownerId: user.id});
|
|
77
|
+
});
|
|
78
|
+
});
|
|
79
|
+
|
|
80
|
+
describe("IsPermitted", () => {
|
|
81
|
+
it("returns a permission method that delegates to access.can", async () => {
|
|
82
|
+
await setupDb();
|
|
83
|
+
const access = createAccess({
|
|
84
|
+
connection: mongoose.connection,
|
|
85
|
+
defaultRoles: [
|
|
86
|
+
{
|
|
87
|
+
displayName: "Reader",
|
|
88
|
+
name: "reader",
|
|
89
|
+
permissions: {todo: ["read"]},
|
|
90
|
+
},
|
|
91
|
+
],
|
|
92
|
+
statements: appStatements,
|
|
93
|
+
});
|
|
94
|
+
await access.roles.seedDefaults();
|
|
95
|
+
|
|
96
|
+
const user = createUser({roles: ["reader"]});
|
|
97
|
+
const isPermitted = createIsPermitted({can: access.can});
|
|
98
|
+
const check = isPermitted({todo: ["read"]});
|
|
99
|
+
|
|
100
|
+
expect(await check("read", user, {_id: "1"})).toBe(true);
|
|
101
|
+
|
|
102
|
+
const updateCheck = isPermitted({todo: ["update"]});
|
|
103
|
+
expect(await updateCheck("update", user, {_id: "1"})).toBe(false);
|
|
104
|
+
});
|
|
105
|
+
});
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
import type {User} from "../auth";
|
|
2
|
+
import {matchesQuery} from "../realtime/queryMatcher";
|
|
3
|
+
import type {ResourceScope, ScopeArgs} from "./types";
|
|
4
|
+
|
|
5
|
+
const projectDocForFieldOf = <TDoc>(
|
|
6
|
+
doc: TDoc,
|
|
7
|
+
fragment: Record<string, unknown>,
|
|
8
|
+
fieldOf: (doc: TDoc, path: string) => unknown
|
|
9
|
+
): Record<string, unknown> => {
|
|
10
|
+
const projected: Record<string, unknown> = {};
|
|
11
|
+
for (const path of Object.keys(fragment)) {
|
|
12
|
+
projected[path] = fieldOf(doc, path);
|
|
13
|
+
}
|
|
14
|
+
return projected;
|
|
15
|
+
};
|
|
16
|
+
|
|
17
|
+
export interface ScopeDefinition<TDoc> {
|
|
18
|
+
matches: (
|
|
19
|
+
args: ScopeArgs<TDoc>
|
|
20
|
+
) => Promise<Record<string, unknown> | null> | Record<string, unknown> | null;
|
|
21
|
+
adminBypass?: (args: ScopeArgs<TDoc>) => boolean | Promise<boolean>;
|
|
22
|
+
fieldOf?: (doc: TDoc, path: string) => unknown;
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
export const defineScope = <TDoc>(def: ScopeDefinition<TDoc>): ResourceScope<TDoc> => {
|
|
26
|
+
return {
|
|
27
|
+
check: async (args) => {
|
|
28
|
+
if (def.adminBypass && (await def.adminBypass(args))) {
|
|
29
|
+
return true;
|
|
30
|
+
}
|
|
31
|
+
const fragment = await def.matches(args);
|
|
32
|
+
if (!fragment) {
|
|
33
|
+
return false;
|
|
34
|
+
}
|
|
35
|
+
if (!args.doc) {
|
|
36
|
+
return true;
|
|
37
|
+
}
|
|
38
|
+
const subject = def.fieldOf
|
|
39
|
+
? projectDocForFieldOf(args.doc as TDoc, fragment, def.fieldOf)
|
|
40
|
+
: (args.doc as Record<string, unknown>);
|
|
41
|
+
return matchesQuery(subject, fragment);
|
|
42
|
+
},
|
|
43
|
+
filter: async (args) => {
|
|
44
|
+
if (def.adminBypass && (await def.adminBypass(args))) {
|
|
45
|
+
return {};
|
|
46
|
+
}
|
|
47
|
+
return def.matches(args);
|
|
48
|
+
},
|
|
49
|
+
};
|
|
50
|
+
};
|
|
51
|
+
|
|
52
|
+
export interface OwnerScopeOptions {
|
|
53
|
+
field?: string;
|
|
54
|
+
adminBypass?: (args: {user?: User}) => boolean | Promise<boolean>;
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
const defaultAdminBypass = ({user}: {user?: User}): boolean => {
|
|
58
|
+
const withRoles = user as (User & {roles?: string[]}) | undefined;
|
|
59
|
+
if (user?.admin) {
|
|
60
|
+
return true;
|
|
61
|
+
}
|
|
62
|
+
return Boolean(withRoles?.roles?.includes("superadmin"));
|
|
63
|
+
};
|
|
64
|
+
|
|
65
|
+
export const OwnerScope = (options: string | OwnerScopeOptions = {}): ResourceScope => {
|
|
66
|
+
const {field = "ownerId", adminBypass = defaultAdminBypass} =
|
|
67
|
+
typeof options === "string" ? {field: options} : options;
|
|
68
|
+
|
|
69
|
+
return defineScope<unknown>({
|
|
70
|
+
adminBypass: (args) => adminBypass({user: args.user}),
|
|
71
|
+
fieldOf: (doc, path) => {
|
|
72
|
+
if (path !== field) {
|
|
73
|
+
return undefined;
|
|
74
|
+
}
|
|
75
|
+
const owner = (doc as Record<string, unknown> | undefined)?.[field];
|
|
76
|
+
const ownerId = (owner as {_id?: unknown} | null | undefined)?._id ?? owner;
|
|
77
|
+
return ownerId == null ? undefined : String(ownerId);
|
|
78
|
+
},
|
|
79
|
+
matches: ({user}) => (user ? {[field]: user.id} : null),
|
|
80
|
+
});
|
|
81
|
+
};
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
import {describe, expect, it} from "bun:test";
|
|
2
|
+
|
|
3
|
+
import {
|
|
4
|
+
expandRolePermissions,
|
|
5
|
+
mergeStatements,
|
|
6
|
+
READ_ACTIONS,
|
|
7
|
+
READ_ONLY_ROLE_PERMISSIONS,
|
|
8
|
+
terrenoStatements,
|
|
9
|
+
} from "./statements";
|
|
10
|
+
|
|
11
|
+
describe("rbac statements", () => {
|
|
12
|
+
it("exports terreno default vocabulary", () => {
|
|
13
|
+
expect(terrenoStatements.admin).toContain("access");
|
|
14
|
+
expect(terrenoStatements.rbac).toContain("manageRoles");
|
|
15
|
+
expect(terrenoStatements.user).toContain("read");
|
|
16
|
+
expect(terrenoStatements.configuration).toContain("update");
|
|
17
|
+
expect(terrenoStatements.featureFlag).toEqual(["create", "list", "read", "update", "delete"]);
|
|
18
|
+
expect(terrenoStatements.consentForm).toEqual(["create", "list", "read", "update", "delete"]);
|
|
19
|
+
expect(terrenoStatements.consentResponse).toEqual(["list", "read"]);
|
|
20
|
+
});
|
|
21
|
+
|
|
22
|
+
it("merges app statements over terreno defaults", () => {
|
|
23
|
+
const merged = mergeStatements({
|
|
24
|
+
patient: ["create", "read", "update"],
|
|
25
|
+
user: ["read"],
|
|
26
|
+
});
|
|
27
|
+
|
|
28
|
+
expect(merged.admin).toEqual(terrenoStatements.admin);
|
|
29
|
+
expect(merged.patient).toEqual(["create", "read", "update"]);
|
|
30
|
+
expect(merged.user).toEqual(["read"]);
|
|
31
|
+
});
|
|
32
|
+
|
|
33
|
+
it("expands wildcard permissions to every action", () => {
|
|
34
|
+
const expanded = expandRolePermissions("*", terrenoStatements, READ_ACTIONS);
|
|
35
|
+
|
|
36
|
+
expect(expanded.admin).toEqual([...terrenoStatements.admin]);
|
|
37
|
+
expect(expanded.user).toEqual([...terrenoStatements.user]);
|
|
38
|
+
expect(expanded.featureFlag).toEqual([...terrenoStatements.featureFlag]);
|
|
39
|
+
expect(expanded.consentForm).toEqual([...terrenoStatements.consentForm]);
|
|
40
|
+
expect(expanded.consentResponse).toEqual([...terrenoStatements.consentResponse]);
|
|
41
|
+
});
|
|
42
|
+
|
|
43
|
+
it("expands read-only sentinel to read-ish actions", () => {
|
|
44
|
+
const expanded = expandRolePermissions(
|
|
45
|
+
READ_ONLY_ROLE_PERMISSIONS,
|
|
46
|
+
terrenoStatements,
|
|
47
|
+
READ_ACTIONS
|
|
48
|
+
);
|
|
49
|
+
|
|
50
|
+
expect(expanded.admin).toBeUndefined();
|
|
51
|
+
expect(expanded.user).toEqual(["list", "read"]);
|
|
52
|
+
expect(expanded.rbac).toEqual(["read"]);
|
|
53
|
+
expect(expanded.configuration).toEqual(["read"]);
|
|
54
|
+
expect(expanded.featureFlag).toEqual(["list", "read"]);
|
|
55
|
+
expect(expanded.consentForm).toEqual(["list", "read"]);
|
|
56
|
+
expect(expanded.consentResponse).toEqual(["list", "read"]);
|
|
57
|
+
});
|
|
58
|
+
|
|
59
|
+
it("returns concrete permission sets unchanged", () => {
|
|
60
|
+
const permissions = {patient: ["read"]};
|
|
61
|
+
const expanded = expandRolePermissions(permissions, terrenoStatements, READ_ACTIONS);
|
|
62
|
+
|
|
63
|
+
expect(expanded).toEqual(permissions);
|
|
64
|
+
});
|
|
65
|
+
});
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
const MODEL_CRUD = ["create", "list", "read", "update", "delete"] as const;
|
|
2
|
+
|
|
3
|
+
export const terrenoStatements = {
|
|
4
|
+
admin: ["access", "runScripts", "viewBackgroundTasks"],
|
|
5
|
+
configuration: ["read", "update"],
|
|
6
|
+
consentForm: MODEL_CRUD,
|
|
7
|
+
consentResponse: ["list", "read"],
|
|
8
|
+
featureFlag: MODEL_CRUD,
|
|
9
|
+
rbac: ["read", "manageRoles", "assignRoles"],
|
|
10
|
+
user: ["create", "list", "read", "update", "delete", "impersonate", "setPassword"],
|
|
11
|
+
} as const;
|
|
12
|
+
|
|
13
|
+
export type Statements = Record<string, readonly string[]>;
|
|
14
|
+
|
|
15
|
+
export type PermissionSet = {[resource: string]: readonly string[]};
|
|
16
|
+
|
|
17
|
+
export const READ_ACTIONS = ["read", "list", "view"] as const;
|
|
18
|
+
|
|
19
|
+
export const READ_ONLY_ROLE_PERMISSIONS = {readOnly: true} as const;
|
|
20
|
+
|
|
21
|
+
export type RolePermissionSpec = PermissionSet | "*" | typeof READ_ONLY_ROLE_PERMISSIONS;
|
|
22
|
+
|
|
23
|
+
const isReadOnlySentinel = (spec: RolePermissionSpec): spec is typeof READ_ONLY_ROLE_PERMISSIONS =>
|
|
24
|
+
typeof spec === "object" &&
|
|
25
|
+
spec !== null &&
|
|
26
|
+
!Array.isArray(spec) &&
|
|
27
|
+
Object.keys(spec).length === 1 &&
|
|
28
|
+
(spec as {readOnly?: unknown}).readOnly === true;
|
|
29
|
+
|
|
30
|
+
export const mergeStatements = <S extends Statements>(appStatements: S): Statements & S => {
|
|
31
|
+
return {
|
|
32
|
+
...terrenoStatements,
|
|
33
|
+
...appStatements,
|
|
34
|
+
};
|
|
35
|
+
};
|
|
36
|
+
|
|
37
|
+
export const expandRolePermissions = (
|
|
38
|
+
spec: RolePermissionSpec,
|
|
39
|
+
statements: Statements,
|
|
40
|
+
readActions: readonly string[]
|
|
41
|
+
): PermissionSet => {
|
|
42
|
+
if (spec === "*") {
|
|
43
|
+
const expanded: PermissionSet = {};
|
|
44
|
+
for (const [resource, actions] of Object.entries(statements)) {
|
|
45
|
+
expanded[resource] = [...actions];
|
|
46
|
+
}
|
|
47
|
+
return expanded;
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
if (isReadOnlySentinel(spec)) {
|
|
51
|
+
const expanded: PermissionSet = {};
|
|
52
|
+
for (const [resource, actions] of Object.entries(statements)) {
|
|
53
|
+
const readish = actions.filter((action) => readActions.includes(action));
|
|
54
|
+
if (readish.length > 0) {
|
|
55
|
+
expanded[resource] = readish;
|
|
56
|
+
}
|
|
57
|
+
}
|
|
58
|
+
return expanded;
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
return spec;
|
|
62
|
+
};
|