@terreno/api 57.16.2 → 57.18.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/dist/actions.d.ts +26 -3
- package/dist/actions.js +102 -16
- package/dist/api.d.ts +7 -0
- package/dist/api.js +59 -3
- package/dist/auth.d.ts +28 -4
- package/dist/auth.js +140 -15
- package/dist/authRecovery.d.ts +31 -0
- package/dist/authRecovery.js +86 -6
- package/dist/betterAuth.d.ts +86 -0
- package/dist/betterAuthApp.d.ts +17 -0
- package/dist/betterAuthApp.js +12 -1
- package/dist/betterAuthOAuthHandoff.d.ts +24 -0
- package/dist/betterAuthOAuthHandoff.js +305 -0
- package/dist/betterAuthSetup.d.ts +37 -2
- package/dist/betterAuthSetup.js +304 -24
- package/dist/expressServer.d.ts +16 -0
- package/dist/expressServer.js +61 -14
- package/dist/githubAuth.d.ts +9 -0
- package/dist/githubAuth.js +230 -31
- package/dist/index.d.ts +9 -1
- package/dist/index.js +27 -3
- package/dist/mcp/actionTools.d.ts +4 -0
- package/dist/mcp/actionTools.js +158 -0
- package/dist/mcp/auth.d.ts +30 -0
- package/dist/mcp/auth.js +83 -28
- package/dist/mcp/createMCPRequest.d.ts +5 -1
- package/dist/mcp/createMCPRequest.js +3 -3
- package/dist/mcp/handlers.d.ts +3 -0
- package/dist/mcp/handlers.js +43 -27
- package/dist/mcp/oauth.d.ts +14 -0
- package/dist/mcp/oauth.js +618 -0
- package/dist/mcp/oauthMetadata.d.ts +89 -0
- package/dist/mcp/oauthMetadata.js +137 -0
- package/dist/mcp/registry.d.ts +5 -0
- package/dist/mcp/registry.js +9 -1
- package/dist/mcp/server.d.ts +6 -0
- package/dist/mcp/server.js +44 -7
- package/dist/mcp/serviceTokens.js +12 -2
- package/dist/mcp/toolExecution.d.ts +12 -0
- package/dist/mcp/toolExecution.js +60 -0
- package/dist/mcp/toolGenerator.d.ts +4 -1
- package/dist/mcp/toolGenerator.js +26 -60
- package/dist/mcp/types.d.ts +4 -4
- package/dist/models/mcpOAuthAuthorization.d.ts +2 -0
- package/dist/models/mcpOAuthAuthorization.js +86 -0
- package/dist/models/mcpOAuthClient.d.ts +2 -0
- package/dist/models/mcpOAuthClient.js +42 -0
- package/dist/models/mcpOAuthRevokedFamily.d.ts +2 -0
- package/dist/models/mcpOAuthRevokedFamily.js +36 -0
- package/dist/models/mcpOAuthToken.d.ts +12 -0
- package/dist/models/mcpOAuthToken.js +159 -0
- package/dist/models/mcpServiceToken.d.ts +1 -0
- package/dist/models/mcpServiceToken.js +21 -4
- package/dist/permissions.d.ts +7 -0
- package/dist/permissions.js +18 -1
- package/dist/rateLimit/policies.d.ts +4 -0
- package/dist/rateLimit/policies.js +46 -7
- package/dist/rbac/access.js +1 -0
- package/dist/rbac/membershipOrgAdminSource.d.ts +4 -0
- package/dist/rbac/membershipOrgAdminSource.js +5 -0
- package/dist/rbac/modelRouterAccess.d.ts +7 -1
- package/dist/rbac/modelRouterAccess.js +37 -24
- package/dist/rbac/realtimeAccess.js +17 -3
- package/dist/rbac/resolve.js +66 -9
- package/dist/rbac/roleManager.js +60 -5
- package/dist/rbac/roleModel.js +1 -1
- package/dist/rbac/statements.d.ts +1 -1
- package/dist/rbac/statements.js +13 -1
- package/dist/rbac/types.d.ts +12 -0
- package/dist/rbac/userWriteGuards.d.ts +50 -0
- package/dist/rbac/userWriteGuards.js +156 -0
- package/dist/realtime/changeStreamWatcher.d.ts +4 -1
- package/dist/realtime/changeStreamWatcher.js +157 -73
- package/dist/realtime/queryMatcher.d.ts +3 -0
- package/dist/realtime/queryMatcher.js +25 -10
- package/dist/realtime/realtimeApp.d.ts +16 -1
- package/dist/realtime/realtimeApp.js +76 -8
- package/dist/realtime/socketAuth.d.ts +17 -6
- package/dist/realtime/socketAuth.js +77 -16
- package/dist/realtime/types.d.ts +8 -5
- package/dist/requestContext.d.ts +22 -0
- package/dist/requestContext.js +22 -1
- package/dist/seedRunner.js +3 -1
- package/dist/sortFields.d.ts +33 -0
- package/dist/sortFields.js +55 -0
- package/dist/sync/executors.js +140 -2
- package/dist/sync/models.d.ts +2 -0
- package/dist/sync/models.js +5 -0
- package/dist/sync/mutationHandler.js +70 -7
- package/dist/sync/routes.js +4 -2
- package/dist/sync/syncSeqPlugin.js +6 -5
- package/dist/terrenoApp.d.ts +14 -0
- package/dist/terrenoApp.js +21 -6
- package/dist/types/mcpOAuth.d.ts +101 -0
- package/dist/types/mcpOAuth.js +2 -0
- package/dist/types/mcpServiceToken.d.ts +8 -0
- package/package.json +3 -3
- package/src/actions.test.ts +118 -0
- package/src/actions.ts +139 -17
- package/src/api.arrayOperations.test.ts +78 -0
- package/src/api.test.ts +36 -0
- package/src/api.ts +76 -4
- package/src/auth.test.ts +521 -3
- package/src/auth.ts +171 -17
- package/src/authRecovery.test.ts +99 -0
- package/src/authRecovery.ts +117 -5
- package/src/authVerification.test.ts +3 -3
- package/src/betterAuth.ts +104 -1
- package/src/betterAuthApp.test.ts +634 -1
- package/src/betterAuthApp.ts +28 -0
- package/src/betterAuthOAuthHandoff.test.ts +946 -0
- package/src/betterAuthOAuthHandoff.ts +375 -0
- package/src/betterAuthSetup.test.ts +393 -4
- package/src/betterAuthSetup.ts +402 -29
- package/src/expressServer.test.ts +93 -0
- package/src/expressServer.ts +81 -14
- package/src/githubAuth.test.ts +448 -6
- package/src/githubAuth.ts +276 -34
- package/src/index.ts +35 -1
- package/src/mcp/actionTools.test.ts +498 -0
- package/src/mcp/actionTools.ts +220 -0
- package/src/mcp/auth.test.ts +114 -1
- package/src/mcp/auth.ts +122 -35
- package/src/mcp/createMCPRequest.ts +8 -2
- package/src/mcp/handlers.test.ts +27 -0
- package/src/mcp/handlers.ts +21 -6
- package/src/mcp/oauth.test.ts +1026 -0
- package/src/mcp/oauth.ts +798 -0
- package/src/mcp/oauthMetadata.ts +234 -0
- package/src/mcp/registry.ts +11 -0
- package/src/mcp/server.ts +54 -14
- package/src/mcp/serviceTokens.ts +16 -3
- package/src/mcp/toolExecution.ts +67 -0
- package/src/mcp/toolGenerator.ts +27 -83
- package/src/mcp/types.ts +4 -4
- package/src/models/mcpOAuthAuthorization.ts +97 -0
- package/src/models/mcpOAuthClient.ts +49 -0
- package/src/models/mcpOAuthRevokedFamily.ts +47 -0
- package/src/models/mcpOAuthToken.test.ts +82 -0
- package/src/models/mcpOAuthToken.ts +195 -0
- package/src/models/mcpServiceToken.ts +26 -2
- package/src/permissions.ts +17 -0
- package/src/rateLimit/policies.ts +54 -10
- package/src/rateLimit/rateLimit.test.ts +41 -0
- package/src/rbac/access.ts +1 -0
- package/src/rbac/membershipOrgAdminSource.ts +5 -0
- package/src/rbac/modelRouterAccess.ts +40 -23
- package/src/rbac/realtimeAccess.test.ts +43 -0
- package/src/rbac/realtimeAccess.ts +23 -3
- package/src/rbac/resolve.test.ts +179 -1
- package/src/rbac/resolve.ts +78 -9
- package/src/rbac/roleManager.test.ts +132 -0
- package/src/rbac/roleManager.ts +69 -5
- package/src/rbac/roleModel.ts +1 -1
- package/src/rbac/statements.ts +14 -1
- package/src/rbac/types.ts +12 -0
- package/src/rbac/userWriteGuards.test.ts +407 -0
- package/src/rbac/userWriteGuards.ts +185 -0
- package/src/realtime/changeStreamWatcher.ts +203 -75
- package/src/realtime/queryMatcher.ts +30 -13
- package/src/realtime/realtime.test.ts +132 -0
- package/src/realtime/realtimeApp.ts +94 -10
- package/src/realtime/realtimeAppSetup.test.ts +282 -1
- package/src/realtime/socketAuth.test.ts +140 -8
- package/src/realtime/socketAuth.ts +90 -19
- package/src/realtime/types.ts +8 -5
- package/src/requestContext.ts +52 -1
- package/src/requestCredential.test.ts +89 -0
- package/src/seedRunner.test.ts +21 -0
- package/src/seedRunner.ts +3 -1
- package/src/sortFields.ts +69 -0
- package/src/sync/executors.test.ts +382 -3
- package/src/sync/executors.ts +179 -4
- package/src/sync/models.ts +8 -0
- package/src/sync/mutationHandler.test.ts +166 -2
- package/src/sync/mutationHandler.ts +97 -5
- package/src/sync/routes.ts +4 -2
- package/src/sync/syncFrontier.test.ts +11 -0
- package/src/sync/syncPhaseC.test.ts +18 -0
- package/src/sync/syncSeqPlugin.ts +6 -5
- package/src/sync/syncSocket.test.ts +92 -0
- package/src/terrenoApp.ts +36 -21
- package/src/types/mcpOAuth.ts +129 -0
- package/src/types/mcpServiceToken.ts +6 -1
|
@@ -0,0 +1,407 @@
|
|
|
1
|
+
import {beforeEach, describe, expect, it} from "bun:test";
|
|
2
|
+
import type express from "express";
|
|
3
|
+
import mongoose from "mongoose";
|
|
4
|
+
|
|
5
|
+
import {modelRouter} from "../api";
|
|
6
|
+
import {addAuthRoutes, setupAuth, type UserModel as UserMongooseModel} from "../auth";
|
|
7
|
+
import {apiErrorMiddleware, apiUnauthorizedMiddleware} from "../errors";
|
|
8
|
+
import {Permissions} from "../permissions";
|
|
9
|
+
import {executeCreate, executeDelete, executeUpdate} from "../sync/executors";
|
|
10
|
+
import {authAsUser, getBaseServer, setupDb, type User, UserModel} from "../tests";
|
|
11
|
+
import {createAccess} from "./access";
|
|
12
|
+
import {terrenoStatements} from "./statements";
|
|
13
|
+
import type {AnyTerrenoAccess} from "./types";
|
|
14
|
+
|
|
15
|
+
const userPermissions = {
|
|
16
|
+
create: [Permissions.IsAuthenticated],
|
|
17
|
+
delete: [Permissions.IsAuthenticated],
|
|
18
|
+
list: [Permissions.IsAuthenticated],
|
|
19
|
+
read: [Permissions.IsAuthenticated],
|
|
20
|
+
update: [Permissions.IsAuthenticated],
|
|
21
|
+
};
|
|
22
|
+
|
|
23
|
+
const buildAccess = async (): Promise<AnyTerrenoAccess> => {
|
|
24
|
+
const access = createAccess({
|
|
25
|
+
connection: mongoose.connection,
|
|
26
|
+
defaultRoles: [
|
|
27
|
+
{
|
|
28
|
+
displayName: "User editor",
|
|
29
|
+
name: "userEditor",
|
|
30
|
+
permissions: {user: ["create", "list", "read", "update"]},
|
|
31
|
+
},
|
|
32
|
+
],
|
|
33
|
+
statements: terrenoStatements,
|
|
34
|
+
userModel: UserModel as unknown as UserMongooseModel,
|
|
35
|
+
});
|
|
36
|
+
await access.roles.seedDefaults();
|
|
37
|
+
return access as unknown as AnyTerrenoAccess;
|
|
38
|
+
};
|
|
39
|
+
|
|
40
|
+
const setRoles = async (userId: unknown, roles: string[]): Promise<void> => {
|
|
41
|
+
await UserModel.updateOne({_id: userId}, {$set: {roles}});
|
|
42
|
+
};
|
|
43
|
+
|
|
44
|
+
describe("RBAC target-privilege check on user model writes", () => {
|
|
45
|
+
let delegate: User;
|
|
46
|
+
let superadmin: User;
|
|
47
|
+
let member: User;
|
|
48
|
+
let access: AnyTerrenoAccess;
|
|
49
|
+
|
|
50
|
+
beforeEach(async () => {
|
|
51
|
+
const [, notAdmin] = await setupDb();
|
|
52
|
+
access = await buildAccess();
|
|
53
|
+
await setRoles(notAdmin._id, ["admin"]);
|
|
54
|
+
const [superadminDoc, memberDoc] = await UserModel.create([
|
|
55
|
+
{email: "target-superadmin@example.com", name: "Super", roles: ["superadmin"]},
|
|
56
|
+
{email: "target-member@example.com", name: "Member", roles: ["member"]},
|
|
57
|
+
]);
|
|
58
|
+
delegate = (await UserModel.findById(notAdmin._id).orFail()) as unknown as User;
|
|
59
|
+
superadmin = superadminDoc as unknown as User;
|
|
60
|
+
member = memberDoc as unknown as User;
|
|
61
|
+
});
|
|
62
|
+
|
|
63
|
+
const options = (): Parameters<typeof executeUpdate>[0]["options"] =>
|
|
64
|
+
({
|
|
65
|
+
accessControl: access,
|
|
66
|
+
permissions: userPermissions,
|
|
67
|
+
}) as unknown as Parameters<typeof executeUpdate>[0]["options"];
|
|
68
|
+
|
|
69
|
+
it("rejects an update to a user whose permissions the actor does not hold", async () => {
|
|
70
|
+
await expect(
|
|
71
|
+
executeUpdate({
|
|
72
|
+
body: {email: "hijack@example.com"},
|
|
73
|
+
id: superadmin.id,
|
|
74
|
+
model: UserModel,
|
|
75
|
+
options: options(),
|
|
76
|
+
user: delegate,
|
|
77
|
+
})
|
|
78
|
+
).rejects.toMatchObject({
|
|
79
|
+
status: 403,
|
|
80
|
+
title: "Cannot modify a user with permissions you do not hold",
|
|
81
|
+
});
|
|
82
|
+
const stored = await UserModel.findById(superadmin.id).lean();
|
|
83
|
+
expect(stored?.email).toBe("target-superadmin@example.com");
|
|
84
|
+
});
|
|
85
|
+
|
|
86
|
+
it("rejects an update over sync admin windows that skip modelRouter permission checks", async () => {
|
|
87
|
+
await expect(
|
|
88
|
+
executeUpdate({
|
|
89
|
+
body: {disabled: true},
|
|
90
|
+
id: superadmin.id,
|
|
91
|
+
model: UserModel,
|
|
92
|
+
options: options(),
|
|
93
|
+
skipPermissionChecks: true,
|
|
94
|
+
user: delegate,
|
|
95
|
+
})
|
|
96
|
+
).rejects.toMatchObject({status: 403});
|
|
97
|
+
});
|
|
98
|
+
|
|
99
|
+
it("rejects a delete of a more privileged user", async () => {
|
|
100
|
+
await expect(
|
|
101
|
+
executeDelete({
|
|
102
|
+
id: superadmin.id,
|
|
103
|
+
model: UserModel,
|
|
104
|
+
options: options(),
|
|
105
|
+
user: delegate,
|
|
106
|
+
})
|
|
107
|
+
).rejects.toMatchObject({status: 403});
|
|
108
|
+
expect(await UserModel.findById(superadmin.id)).toBeTruthy();
|
|
109
|
+
});
|
|
110
|
+
|
|
111
|
+
it("allows updates to users the actor covers, to the actor itself, and by legacy admins", async () => {
|
|
112
|
+
await executeUpdate({
|
|
113
|
+
body: {name: "Member renamed"},
|
|
114
|
+
id: member.id,
|
|
115
|
+
model: UserModel,
|
|
116
|
+
options: options(),
|
|
117
|
+
user: delegate,
|
|
118
|
+
});
|
|
119
|
+
await executeUpdate({
|
|
120
|
+
body: {name: "Delegate renamed"},
|
|
121
|
+
id: delegate.id,
|
|
122
|
+
model: UserModel,
|
|
123
|
+
options: options(),
|
|
124
|
+
user: delegate,
|
|
125
|
+
});
|
|
126
|
+
const legacyAdmin = (await UserModel.findOne({email: "admin@example.com"})
|
|
127
|
+
.orFail()
|
|
128
|
+
.exec()) as unknown as User;
|
|
129
|
+
await executeUpdate({
|
|
130
|
+
body: {name: "Super renamed"},
|
|
131
|
+
id: superadmin.id,
|
|
132
|
+
model: UserModel,
|
|
133
|
+
options: options(),
|
|
134
|
+
user: legacyAdmin,
|
|
135
|
+
});
|
|
136
|
+
expect((await UserModel.findById(member.id).lean())?.name).toBe("Member renamed");
|
|
137
|
+
expect((await UserModel.findById(delegate.id).lean())?.name).toBe("Delegate renamed");
|
|
138
|
+
expect((await UserModel.findById(superadmin.id).lean())?.name).toBe("Super renamed");
|
|
139
|
+
});
|
|
140
|
+
|
|
141
|
+
it("does not check other models", async () => {
|
|
142
|
+
await executeUpdate({
|
|
143
|
+
body: {name: "Renamed elsewhere"},
|
|
144
|
+
id: superadmin.id,
|
|
145
|
+
model: UserModel,
|
|
146
|
+
options: options(),
|
|
147
|
+
user: delegate,
|
|
148
|
+
writeModelName: "NotTheUserModel",
|
|
149
|
+
});
|
|
150
|
+
expect((await UserModel.findById(superadmin.id).lean())?.name).toBe("Renamed elsewhere");
|
|
151
|
+
});
|
|
152
|
+
|
|
153
|
+
it("drops passport credential fields from RBAC user writes", async () => {
|
|
154
|
+
const before = await UserModel.findById(delegate.id).select("+hash +salt").lean();
|
|
155
|
+
await executeUpdate({
|
|
156
|
+
body: {attempts: 0, hash: "attacker-hash", name: "Kept", salt: "attacker-salt"},
|
|
157
|
+
id: delegate.id,
|
|
158
|
+
model: UserModel,
|
|
159
|
+
options: options(),
|
|
160
|
+
user: delegate,
|
|
161
|
+
});
|
|
162
|
+
const after = await UserModel.findById(delegate.id).select("+hash +salt").lean();
|
|
163
|
+
const read = (doc: unknown, key: string): unknown => (doc as Record<string, unknown>)?.[key];
|
|
164
|
+
expect(read(after, "name")).toBe("Kept");
|
|
165
|
+
expect(read(after, "hash")).toBe(read(before, "hash"));
|
|
166
|
+
expect(read(after, "salt")).toBe(read(before, "salt"));
|
|
167
|
+
});
|
|
168
|
+
});
|
|
169
|
+
|
|
170
|
+
describe("RBAC target-privilege check over modelRouter HTTP", () => {
|
|
171
|
+
let app: express.Application;
|
|
172
|
+
let superadminId: string;
|
|
173
|
+
|
|
174
|
+
beforeEach(async () => {
|
|
175
|
+
const [, notAdmin] = await setupDb();
|
|
176
|
+
const access = await buildAccess();
|
|
177
|
+
await setRoles(notAdmin._id, ["admin"]);
|
|
178
|
+
const target = await UserModel.create({
|
|
179
|
+
email: "http-superadmin@example.com",
|
|
180
|
+
name: "Super",
|
|
181
|
+
roles: ["superadmin"],
|
|
182
|
+
});
|
|
183
|
+
superadminId = String(target._id);
|
|
184
|
+
app = getBaseServer();
|
|
185
|
+
setupAuth(app, UserModel as unknown as UserMongooseModel);
|
|
186
|
+
addAuthRoutes(app, UserModel as unknown as UserMongooseModel);
|
|
187
|
+
app.use(
|
|
188
|
+
"/users",
|
|
189
|
+
modelRouter(UserModel, {
|
|
190
|
+
access: {resource: "user"},
|
|
191
|
+
accessControl: access,
|
|
192
|
+
instanceActions: {
|
|
193
|
+
rename: {
|
|
194
|
+
handler: async ({doc}) => {
|
|
195
|
+
await UserModel.updateOne({_id: (doc as {_id: unknown})._id}, {name: "Action"});
|
|
196
|
+
return {ok: true};
|
|
197
|
+
},
|
|
198
|
+
method: "POST",
|
|
199
|
+
permissions: [Permissions.IsAuthenticated],
|
|
200
|
+
},
|
|
201
|
+
summary: {
|
|
202
|
+
handler: async () => ({ok: true}),
|
|
203
|
+
method: "GET",
|
|
204
|
+
permissions: [Permissions.IsAuthenticated],
|
|
205
|
+
},
|
|
206
|
+
},
|
|
207
|
+
permissions: userPermissions,
|
|
208
|
+
})
|
|
209
|
+
);
|
|
210
|
+
app.use(apiUnauthorizedMiddleware);
|
|
211
|
+
app.use(apiErrorMiddleware);
|
|
212
|
+
});
|
|
213
|
+
|
|
214
|
+
it("rejects PATCH, array writes, and write actions on a more privileged user", async () => {
|
|
215
|
+
const agent = await authAsUser(app, "notAdmin");
|
|
216
|
+
await agent
|
|
217
|
+
.patch(`/users/${superadminId}`)
|
|
218
|
+
.send({email: "http-hijack@example.com"})
|
|
219
|
+
.expect(403);
|
|
220
|
+
await agent
|
|
221
|
+
.post(`/users/${superadminId}/organizationIds`)
|
|
222
|
+
.send({organizationIds: "x"})
|
|
223
|
+
.expect(403);
|
|
224
|
+
await agent.post(`/users/${superadminId}/rename`).send({}).expect(403);
|
|
225
|
+
await agent.get(`/users/${superadminId}/summary`).expect(200);
|
|
226
|
+
|
|
227
|
+
const stored = await UserModel.findById(superadminId).lean();
|
|
228
|
+
expect(stored?.email).toBe("http-superadmin@example.com");
|
|
229
|
+
expect(stored?.name).toBe("Super");
|
|
230
|
+
});
|
|
231
|
+
|
|
232
|
+
it("still lets the delegate edit itself", async () => {
|
|
233
|
+
const agent = await authAsUser(app, "notAdmin");
|
|
234
|
+
const self = await UserModel.findOne({email: "notAdmin@example.com"}).orFail();
|
|
235
|
+
await agent
|
|
236
|
+
.patch(`/users/${String(self._id)}`)
|
|
237
|
+
.send({name: "Self edit"})
|
|
238
|
+
.expect(200);
|
|
239
|
+
expect((await UserModel.findById(self._id).lean())?.name).toBe("Self edit");
|
|
240
|
+
});
|
|
241
|
+
});
|
|
242
|
+
|
|
243
|
+
describe("user:updateIdentity on RBAC user model writes", () => {
|
|
244
|
+
let editor: User;
|
|
245
|
+
let identityAdmin: User;
|
|
246
|
+
let member: User;
|
|
247
|
+
let access: AnyTerrenoAccess;
|
|
248
|
+
|
|
249
|
+
beforeEach(async () => {
|
|
250
|
+
const [, notAdmin] = await setupDb();
|
|
251
|
+
access = await buildAccess();
|
|
252
|
+
await setRoles(notAdmin._id, ["userEditor"]);
|
|
253
|
+
const [identityAdminDoc, memberDoc] = await UserModel.create([
|
|
254
|
+
{email: "identity-admin@example.com", name: "Identity admin", roles: ["admin"]},
|
|
255
|
+
{email: "identity-member@example.com", name: "Member", roles: ["member"]},
|
|
256
|
+
]);
|
|
257
|
+
editor = (await UserModel.findById(notAdmin._id).orFail()) as unknown as User;
|
|
258
|
+
identityAdmin = identityAdminDoc as unknown as User;
|
|
259
|
+
member = memberDoc as unknown as User;
|
|
260
|
+
});
|
|
261
|
+
|
|
262
|
+
const options = (): Parameters<typeof executeUpdate>[0]["options"] =>
|
|
263
|
+
({
|
|
264
|
+
accessControl: access,
|
|
265
|
+
permissions: userPermissions,
|
|
266
|
+
}) as unknown as Parameters<typeof executeUpdate>[0]["options"];
|
|
267
|
+
|
|
268
|
+
it("rejects identity-field changes to another user without user:updateIdentity", async () => {
|
|
269
|
+
for (const body of [
|
|
270
|
+
{email: "identity-redirect@example.com"},
|
|
271
|
+
{disabled: true},
|
|
272
|
+
{emailVerified: true},
|
|
273
|
+
{"email.value": "identity-redirect@example.com"},
|
|
274
|
+
]) {
|
|
275
|
+
await expect(
|
|
276
|
+
executeUpdate({body, id: member.id, model: UserModel, options: options(), user: editor})
|
|
277
|
+
).rejects.toMatchObject({status: 403, title: "Missing user:updateIdentity permission"});
|
|
278
|
+
}
|
|
279
|
+
const stored = await UserModel.findById(member.id).lean();
|
|
280
|
+
expect(stored?.email).toBe("identity-member@example.com");
|
|
281
|
+
expect(stored?.disabled).toBe(false);
|
|
282
|
+
});
|
|
283
|
+
|
|
284
|
+
it("rejects identity-field changes over sync admin windows that skip permission checks", async () => {
|
|
285
|
+
await expect(
|
|
286
|
+
executeUpdate({
|
|
287
|
+
body: {disabled: true},
|
|
288
|
+
id: member.id,
|
|
289
|
+
model: UserModel,
|
|
290
|
+
options: options(),
|
|
291
|
+
skipPermissionChecks: true,
|
|
292
|
+
user: editor,
|
|
293
|
+
})
|
|
294
|
+
).rejects.toMatchObject({status: 403, title: "Missing user:updateIdentity permission"});
|
|
295
|
+
expect((await UserModel.findById(member.id).lean())?.disabled).toBe(false);
|
|
296
|
+
});
|
|
297
|
+
|
|
298
|
+
it("allows bodies that echo unchanged identity values", async () => {
|
|
299
|
+
await executeUpdate({
|
|
300
|
+
body: {disabled: false, email: "identity-member@example.com", name: "Renamed"},
|
|
301
|
+
id: member.id,
|
|
302
|
+
model: UserModel,
|
|
303
|
+
options: options(),
|
|
304
|
+
user: editor,
|
|
305
|
+
});
|
|
306
|
+
expect((await UserModel.findById(member.id).lean())?.name).toBe("Renamed");
|
|
307
|
+
});
|
|
308
|
+
|
|
309
|
+
it("allows identity changes by holders, self-writes, legacy admins, and creates", async () => {
|
|
310
|
+
await executeUpdate({
|
|
311
|
+
body: {disabled: true},
|
|
312
|
+
id: member.id,
|
|
313
|
+
model: UserModel,
|
|
314
|
+
options: options(),
|
|
315
|
+
user: identityAdmin,
|
|
316
|
+
});
|
|
317
|
+
expect((await UserModel.findById(member.id).lean())?.disabled).toBe(true);
|
|
318
|
+
|
|
319
|
+
await executeUpdate({
|
|
320
|
+
body: {email: "editor-self@example.com"},
|
|
321
|
+
id: editor.id,
|
|
322
|
+
model: UserModel,
|
|
323
|
+
options: options(),
|
|
324
|
+
user: editor,
|
|
325
|
+
});
|
|
326
|
+
expect((await UserModel.findById(editor.id).lean())?.email).toBe("editor-self@example.com");
|
|
327
|
+
|
|
328
|
+
const legacyAdmin = (await UserModel.findOne({email: "admin@example.com"})
|
|
329
|
+
.orFail()
|
|
330
|
+
.exec()) as unknown as User;
|
|
331
|
+
await executeUpdate({
|
|
332
|
+
body: {disabled: false},
|
|
333
|
+
id: member.id,
|
|
334
|
+
model: UserModel,
|
|
335
|
+
options: options(),
|
|
336
|
+
user: legacyAdmin,
|
|
337
|
+
});
|
|
338
|
+
expect((await UserModel.findById(member.id).lean())?.disabled).toBe(false);
|
|
339
|
+
|
|
340
|
+
const {doc} = await executeCreate({
|
|
341
|
+
body: {email: "identity-new@example.com", name: "New"},
|
|
342
|
+
model: UserModel,
|
|
343
|
+
options: options(),
|
|
344
|
+
user: editor,
|
|
345
|
+
});
|
|
346
|
+
expect((doc as unknown as {email: string}).email).toBe("identity-new@example.com");
|
|
347
|
+
});
|
|
348
|
+
});
|
|
349
|
+
|
|
350
|
+
describe("user:updateIdentity over modelRouter HTTP", () => {
|
|
351
|
+
let app: express.Application;
|
|
352
|
+
let memberId: string;
|
|
353
|
+
|
|
354
|
+
beforeEach(async () => {
|
|
355
|
+
const [, notAdmin] = await setupDb();
|
|
356
|
+
const access = await buildAccess();
|
|
357
|
+
await setRoles(notAdmin._id, ["userEditor"]);
|
|
358
|
+
const target = await UserModel.create({
|
|
359
|
+
email: "http-identity-member@example.com",
|
|
360
|
+
name: "Member",
|
|
361
|
+
roles: ["member"],
|
|
362
|
+
});
|
|
363
|
+
memberId = String(target._id);
|
|
364
|
+
app = getBaseServer();
|
|
365
|
+
setupAuth(app, UserModel as unknown as UserMongooseModel);
|
|
366
|
+
addAuthRoutes(app, UserModel as unknown as UserMongooseModel);
|
|
367
|
+
app.use(
|
|
368
|
+
"/users",
|
|
369
|
+
modelRouter(UserModel, {
|
|
370
|
+
access: {resource: "user"},
|
|
371
|
+
accessControl: access,
|
|
372
|
+
instanceActions: {
|
|
373
|
+
changeEmail: {
|
|
374
|
+
handler: async ({body, doc}) => {
|
|
375
|
+
await UserModel.updateOne(
|
|
376
|
+
{_id: (doc as {_id: unknown})._id},
|
|
377
|
+
{email: (body as {email: string}).email}
|
|
378
|
+
);
|
|
379
|
+
return {ok: true};
|
|
380
|
+
},
|
|
381
|
+
method: "POST",
|
|
382
|
+
permissions: [Permissions.IsAuthenticated],
|
|
383
|
+
},
|
|
384
|
+
},
|
|
385
|
+
permissions: userPermissions,
|
|
386
|
+
})
|
|
387
|
+
);
|
|
388
|
+
app.use(apiUnauthorizedMiddleware);
|
|
389
|
+
app.use(apiErrorMiddleware);
|
|
390
|
+
});
|
|
391
|
+
|
|
392
|
+
it("rejects PATCH and write actions that change another user's identity fields", async () => {
|
|
393
|
+
const agent = await authAsUser(app, "notAdmin");
|
|
394
|
+
const patch = await agent.patch(`/users/${memberId}`).send({disabled: true}).expect(403);
|
|
395
|
+
expect(patch.body.title).toBe("Missing user:updateIdentity permission");
|
|
396
|
+
await agent
|
|
397
|
+
.post(`/users/${memberId}/changeEmail`)
|
|
398
|
+
.send({email: "http-identity-redirect@example.com"})
|
|
399
|
+
.expect(403);
|
|
400
|
+
await agent.patch(`/users/${memberId}`).send({name: "Renamed"}).expect(200);
|
|
401
|
+
|
|
402
|
+
const stored = await UserModel.findById(memberId).lean();
|
|
403
|
+
expect(stored?.email).toBe("http-identity-member@example.com");
|
|
404
|
+
expect(stored?.disabled).toBe(false);
|
|
405
|
+
expect(stored?.name).toBe("Renamed");
|
|
406
|
+
});
|
|
407
|
+
});
|
|
@@ -0,0 +1,185 @@
|
|
|
1
|
+
import isEqual from "lodash/isEqual";
|
|
2
|
+
import type {User} from "../auth";
|
|
3
|
+
import {APIError} from "../errors";
|
|
4
|
+
import {logger} from "../logger";
|
|
5
|
+
import {isPermissionSubset} from "./permissionUtils";
|
|
6
|
+
import type {PermissionSet} from "./statements";
|
|
7
|
+
|
|
8
|
+
/**
|
|
9
|
+
* True when a write-body key addresses `field` itself or a path inside it. Mongoose `set`,
|
|
10
|
+
* `create`, and the document constructor treat a dotted key such as `roles.0` as a path into
|
|
11
|
+
* `roles`, so field filters must match the first path segment, not only the exact key.
|
|
12
|
+
*/
|
|
13
|
+
export const isWriteKeyForField = (key: string, field: string): boolean => {
|
|
14
|
+
return key === field || key.startsWith(`${field}.`);
|
|
15
|
+
};
|
|
16
|
+
|
|
17
|
+
/**
|
|
18
|
+
* User fields that identify the account or control whether it can sign in. Changing them on
|
|
19
|
+
* another user through generic RBAC user-model writes needs `user:updateIdentity` on top of
|
|
20
|
+
* `user:update`; see {@link assertCanWriteUserIdentity}.
|
|
21
|
+
*/
|
|
22
|
+
export const USER_IDENTITY_FIELDS = [
|
|
23
|
+
"email",
|
|
24
|
+
"disabled",
|
|
25
|
+
"betterAuthId",
|
|
26
|
+
"githubId",
|
|
27
|
+
"emailVerified",
|
|
28
|
+
] as const;
|
|
29
|
+
|
|
30
|
+
/** RBAC action on the `user` resource that allows changing {@link USER_IDENTITY_FIELDS}. */
|
|
31
|
+
export const USER_UPDATE_IDENTITY_ACTION = "updateIdentity" as const;
|
|
32
|
+
|
|
33
|
+
const IDENTITY_PERMISSION_TITLE = `Missing user:${USER_UPDATE_IDENTITY_ACTION} permission`;
|
|
34
|
+
|
|
35
|
+
/**
|
|
36
|
+
* True when RBAC is enabled and `modelName` names the user model: `"User"`, or the compiled
|
|
37
|
+
* name of the `userModel` passed to `createAccess`.
|
|
38
|
+
*/
|
|
39
|
+
export const isRbacUserModelName = (modelName: string, accessControl: unknown): boolean => {
|
|
40
|
+
if (!accessControl) {
|
|
41
|
+
return false;
|
|
42
|
+
}
|
|
43
|
+
if (modelName === "User") {
|
|
44
|
+
return true;
|
|
45
|
+
}
|
|
46
|
+
const userModelName = (accessControl as {userModel?: {modelName?: unknown}}).userModel?.modelName;
|
|
47
|
+
return typeof userModelName === "string" && userModelName === modelName;
|
|
48
|
+
};
|
|
49
|
+
|
|
50
|
+
/**
|
|
51
|
+
* Enforces RoleManager's target-privilege rule on generic writes to the RBAC user model: an actor
|
|
52
|
+
* may change or delete another user only when the actor holds every permission that user holds.
|
|
53
|
+
* REST, array subroutes, write instance actions, sync, and MCP all call this, so a `user:update`
|
|
54
|
+
* holder cannot take over or lock out a more privileged account. Self-writes and legacy
|
|
55
|
+
* `admin: true` actors (the plane above RBAC) are not checked, and neither are writes without an
|
|
56
|
+
* authenticated actor (internal server calls).
|
|
57
|
+
*/
|
|
58
|
+
export const assertCanWriteTargetUser = async ({
|
|
59
|
+
accessControl,
|
|
60
|
+
actor,
|
|
61
|
+
modelName,
|
|
62
|
+
target,
|
|
63
|
+
}: {
|
|
64
|
+
accessControl: unknown;
|
|
65
|
+
actor?: User;
|
|
66
|
+
modelName: string;
|
|
67
|
+
target: unknown;
|
|
68
|
+
}): Promise<void> => {
|
|
69
|
+
if (!actor || actor.admin === true) {
|
|
70
|
+
return;
|
|
71
|
+
}
|
|
72
|
+
if (!isRbacUserModelName(modelName, accessControl)) {
|
|
73
|
+
return;
|
|
74
|
+
}
|
|
75
|
+
const getPermissions = (
|
|
76
|
+
accessControl as {getPermissions?: (args: {user: User}) => Promise<PermissionSet>}
|
|
77
|
+
).getPermissions;
|
|
78
|
+
// Test doubles without a resolver have no permissions to compare.
|
|
79
|
+
if (typeof getPermissions !== "function") {
|
|
80
|
+
return;
|
|
81
|
+
}
|
|
82
|
+
const targetRecord = target as {_id?: unknown; id?: unknown};
|
|
83
|
+
const targetId = String(targetRecord?.id ?? targetRecord?._id ?? "");
|
|
84
|
+
if (!targetId || targetId === String(actor.id)) {
|
|
85
|
+
return;
|
|
86
|
+
}
|
|
87
|
+
const actorPermissions = await getPermissions({user: actor});
|
|
88
|
+
const targetPermissions = await getPermissions({user: target as User});
|
|
89
|
+
if (isPermissionSubset(actorPermissions, targetPermissions)) {
|
|
90
|
+
return;
|
|
91
|
+
}
|
|
92
|
+
logger.warn("RBAC privileged-user write denied", {actorId: actor.id, modelName, targetId});
|
|
93
|
+
throw new APIError({
|
|
94
|
+
status: 403,
|
|
95
|
+
title: "Cannot modify a user with permissions you do not hold",
|
|
96
|
+
});
|
|
97
|
+
};
|
|
98
|
+
|
|
99
|
+
// Unset, null, empty, and false all mean "no value" for identity fields, so a form that echoes
|
|
100
|
+
// `disabled: false` or `githubId: null` back for a user without them is not a change.
|
|
101
|
+
const isEmptyIdentityValue = (value: unknown): boolean => {
|
|
102
|
+
return value === undefined || value === null || value === "" || value === false;
|
|
103
|
+
};
|
|
104
|
+
|
|
105
|
+
const changedIdentityKeys = (body: Record<string, unknown>, target: unknown): string[] => {
|
|
106
|
+
const current = (target ?? {}) as Record<string, unknown>;
|
|
107
|
+
return Object.keys(body).filter((key) => {
|
|
108
|
+
const field = USER_IDENTITY_FIELDS.find((identityField) =>
|
|
109
|
+
isWriteKeyForField(key, identityField)
|
|
110
|
+
);
|
|
111
|
+
if (!field) {
|
|
112
|
+
return false;
|
|
113
|
+
}
|
|
114
|
+
// A dotted path into an identity field always counts as a change.
|
|
115
|
+
if (key !== field) {
|
|
116
|
+
return true;
|
|
117
|
+
}
|
|
118
|
+
const next = body[key];
|
|
119
|
+
const previous = current[key];
|
|
120
|
+
if (isEmptyIdentityValue(next) && isEmptyIdentityValue(previous)) {
|
|
121
|
+
return false;
|
|
122
|
+
}
|
|
123
|
+
return !isEqual(next, previous);
|
|
124
|
+
});
|
|
125
|
+
};
|
|
126
|
+
|
|
127
|
+
/**
|
|
128
|
+
* Requires `user:updateIdentity` for generic writes that change another user's
|
|
129
|
+
* {@link USER_IDENTITY_FIELDS} on the RBAC user model, so `user:update` alone cannot redirect a
|
|
130
|
+
* user's email, rebind their external login, or disable them. Keys whose value matches the
|
|
131
|
+
* target's current value do not count, so clients that echo the whole record still work. The
|
|
132
|
+
* write is rejected with 403, not stripped. Exempt, like {@link assertCanWriteTargetUser}:
|
|
133
|
+
* self-writes, writes without an actor (internal server calls), and legacy `admin: true` actors.
|
|
134
|
+
* Creates are not checked; this guards existing users only.
|
|
135
|
+
*/
|
|
136
|
+
export const assertCanWriteUserIdentity = async ({
|
|
137
|
+
accessControl,
|
|
138
|
+
actor,
|
|
139
|
+
body,
|
|
140
|
+
modelName,
|
|
141
|
+
target,
|
|
142
|
+
}: {
|
|
143
|
+
accessControl: unknown;
|
|
144
|
+
actor?: User;
|
|
145
|
+
body: unknown;
|
|
146
|
+
modelName: string;
|
|
147
|
+
target: unknown;
|
|
148
|
+
}): Promise<void> => {
|
|
149
|
+
if (!actor || actor.admin === true) {
|
|
150
|
+
return;
|
|
151
|
+
}
|
|
152
|
+
if (!isRbacUserModelName(modelName, accessControl)) {
|
|
153
|
+
return;
|
|
154
|
+
}
|
|
155
|
+
if (!body || typeof body !== "object" || Array.isArray(body)) {
|
|
156
|
+
return;
|
|
157
|
+
}
|
|
158
|
+
const targetRecord = target as {_id?: unknown; id?: unknown};
|
|
159
|
+
const targetId = String(targetRecord?.id ?? targetRecord?._id ?? "");
|
|
160
|
+
if (targetId && targetId === String(actor.id)) {
|
|
161
|
+
return;
|
|
162
|
+
}
|
|
163
|
+
const changed = changedIdentityKeys(body as Record<string, unknown>, target);
|
|
164
|
+
if (changed.length === 0) {
|
|
165
|
+
return;
|
|
166
|
+
}
|
|
167
|
+
const getPermissions = (
|
|
168
|
+
accessControl as {getPermissions?: (args: {user: User}) => Promise<PermissionSet>}
|
|
169
|
+
).getPermissions;
|
|
170
|
+
// Test doubles without a resolver have no permissions to compare.
|
|
171
|
+
if (typeof getPermissions !== "function") {
|
|
172
|
+
return;
|
|
173
|
+
}
|
|
174
|
+
const actorPermissions = await getPermissions({user: actor});
|
|
175
|
+
if ((actorPermissions.user ?? []).includes(USER_UPDATE_IDENTITY_ACTION)) {
|
|
176
|
+
return;
|
|
177
|
+
}
|
|
178
|
+
logger.warn("RBAC user identity write denied", {
|
|
179
|
+
actorId: actor.id,
|
|
180
|
+
fields: changed,
|
|
181
|
+
modelName,
|
|
182
|
+
targetId,
|
|
183
|
+
});
|
|
184
|
+
throw new APIError({status: 403, title: IDENTITY_PERMISSION_TITLE});
|
|
185
|
+
};
|