-
Notifications
You must be signed in to change notification settings - Fork 125
Expand file tree
/
Copy pathpermissions.ts
More file actions
823 lines (777 loc) · 31.2 KB
/
permissions.ts
File metadata and controls
823 lines (777 loc) · 31.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
import { z } from "zod";
import { getCloudBaseManager, getEnvId, logCloudBaseResult } from "../cloudbase-manager.js";
import type { ExtendedMcpServer } from "../server.js";
import { jsonContent } from "../utils/json-content.js";
const QUERY_PERMISSION_ACTIONS = [
"getResourcePermission",
"listResourcePermissions",
"listRoles",
"getRole",
"listUsers",
"getUser",
] as const;
const MANAGE_PERMISSION_ACTIONS = [
"updateResourcePermission",
"createRole",
"updateRole",
"deleteRoles",
"addRoleMembers",
"removeRoleMembers",
"addRolePolicies",
"removeRolePolicies",
"createUser",
"updateUser",
"deleteUsers",
] as const;
type QueryPermissionAction = (typeof QUERY_PERMISSION_ACTIONS)[number];
type ManagePermissionAction = (typeof MANAGE_PERMISSION_ACTIONS)[number];
type LegacyResourceType = "noSqlDatabase" | "sqlDatabase" | "function" | "storage";
type ToolEnvelope = {
success: boolean;
data: Record<string, unknown>;
message: string;
};
function buildWriteVerificationHint(resourceId: string) {
return `对于 ${resourceId} 这类有后端权限控制的集合,前端调用 .doc(id).update() / .doc(id).remove() 后,不能只看是否没有抛异常。请显式检查返回结果中的 updated / deleted 是否大于 0;如果 result.code、result.message 存在,或 updated / deleted 为 0,要把它当作真实失败并向上抛错。`;
}
function buildPermissionPropagationHint(resourceId: string) {
return `刚更新完 ${resourceId} 的安全规则时,后端权限可能需要一小段传播时间。若紧接着的真实写操作仍返回 DATABASE_PERMISSION_DENIED,请先等待一小段时间,再用同一登录态重试同一条 .doc(id).update() / .doc(id).remove();不要立刻连续重写规则,也不要在传播窗口里把旧拒绝直接当成规则表达式仍然错误。`;
}
type CreateRuleHint = {
type: "createRuleDocWarning";
severity: "warning";
summary: string;
detail: string;
recommendedRulePattern: string;
recommendedPermission?: string;
recommendedSecurityRule?: string;
};
type PermissionHint =
| CreateRuleHint
| { type: "docIdWriteRuleWarning"; severity: "warning"; appliesTo: Array<"update" | "delete">; summary: string; detail: string; recommendedRulePattern: string; recommendedPermission?: string; recommendedSecurityRule?: string; recommendedClientWritePattern?: string; roleLookupNote?: string }
| { type: "invalidGetPathWarning"; severity: "warning"; summary: string; detail: string; recommendedRulePattern: string; recommendedPermission?: string; recommendedSecurityRule?: string; recommendedClientWritePattern?: string; roleLookupNote?: string }
| { type: "templateLiteralRuleWarning"; severity: "warning"; summary: string; detail: string; recommendedRulePattern: string; recommendedPermission?: string; recommendedSecurityRule?: string; recommendedClientWritePattern?: string; roleLookupNote?: string };
type GetPathHint = {
type: "invalidGetPathWarning";
severity: "warning";
summary: string;
detail: string;
recommendedRulePattern: string;
recommendedPermission?: string;
recommendedSecurityRule?: string;
recommendedClientWritePattern?: string;
roleLookupNote?: string;
};
type TemplateLiteralHint = {
type: "templateLiteralRuleWarning";
severity: "warning";
summary: string;
detail: string;
recommendedRulePattern: string;
recommendedPermission?: string;
recommendedSecurityRule?: string;
recommendedClientWritePattern?: string;
roleLookupNote?: string;
};
function buildEnvelope(data: Record<string, unknown>, message: string): ToolEnvelope {
return {
success: true,
data,
message,
};
}
function buildErrorEnvelope(error: unknown): ToolEnvelope {
return {
success: false,
data: {},
message: error instanceof Error ? error.message : String(error),
};
}
function mapResourceType(resourceType: LegacyResourceType) {
const resourceTypeMap = {
noSqlDatabase: "collection",
sqlDatabase: "table",
function: "function",
storage: "storage",
} as const;
return resourceTypeMap[resourceType];
}
function normalizeRecordArray(value: unknown, label: string) {
if (value === undefined) {
return undefined;
}
if (!Array.isArray(value)) {
throw new Error(`${label} 必须是数组`);
}
return value as Array<Record<string, unknown>>;
}
function extractRiskyDocFieldOperations(securityRule: string | undefined): Array<"update" | "delete"> {
if (!securityRule) {
return [];
}
const operations: Array<"update" | "delete"> = [];
const operationPatterns: Array<["update" | "delete", RegExp]> = [
["update", /"update"\s*:\s*"([^"]*)"/],
["delete", /"delete"\s*:\s*"([^"]*)"/],
];
for (const [operation, pattern] of operationPatterns) {
const match = securityRule.match(pattern);
const expression = match?.[1];
if (!expression) {
continue;
}
const referencesNonIdDocField = /doc\.(?!_id\b)[A-Za-z_][A-Za-z0-9_]*/.test(expression);
const usesGetByDocId = /get\('database\.[^']+'\s*\+\s*doc\._id\)/.test(expression);
if (referencesNonIdDocField && !usesGetByDocId) {
operations.push(operation);
}
}
return operations;
}
function buildRecommendedOwnerWriteRule(resourceId: string): string {
return JSON.stringify({
create: "auth.uid != null",
update:
"auth.uid != null && (get('database.user_roles.' + auth.uid).role == 'admin' || doc.authorId == auth.uid)",
delete:
"auth.uid != null && (get('database.user_roles.' + auth.uid).role == 'admin' || doc.authorId == auth.uid)",
});
}
function buildRoleLookupNote() {
return "如果你需要 app-level admin override(例如 CMS 中 admin 可编辑所有文章,而 editor 只能编辑自己的文章),CUSTOM 规则通常是必要的。一个已验证可用的模式是:角色集合文档主键就是 auth.uid,并在文章权限里写 get('database.user_roles.' + auth.uid).role == 'admin' || doc.authorId == auth.uid。若现有 schema 已经有 users / profiles / user_roles 其一,请复用已存在且能通过 _id == auth.uid 直接 get() 到的那一份;不要把 where({ uid }) 查询得到的集合误写成 get('database.users.' + auth.uid)。";
}
function buildRecommendedClientWritePattern(resourceId: string) {
return `对于 CMS 文章这类使用 app-level admin override 的 CUSTOM 规则,前端可继续使用 db.collection('${resourceId}').doc(id).update(...) / remove(...)。关键是安全规则要采用已验证模式:get('database.user_roles.' + auth.uid).role == 'admin' || doc.authorId == auth.uid,并且文章文档中要真实写入 authorId。`;
}
function buildCreateRuleHint(
securityRule: string | undefined,
resourceId: string,
): CreateRuleHint | undefined {
if (!securityRule) {
return undefined;
}
const createMatch = securityRule.match(/"create"\s*:\s*"([^"]*)"/);
const writeMatch = securityRule.match(/"write"\s*:\s*"([^"]*)"/);
const createExpression = createMatch?.[1];
const writeExpression = writeMatch?.[1];
if (!createExpression && !writeExpression) {
return undefined;
}
const referencesDoc =
(createExpression && /doc\.[A-Za-z_]/.test(createExpression)) ||
(writeExpression && /doc\.[A-Za-z_]/.test(writeExpression));
if (!referencesDoc) {
return undefined;
}
return {
type: "createRuleDocWarning",
severity: "warning",
summary:
"create 规则不应引用 doc.*,因为 create 时文档尚未存在。",
detail:
"CloudBase 的 create 规则验证的是写入数据(request.data),此时文档尚不存在,doc.* 不可用。" +
"请将 create 规则改为仅使用 auth.* 检查(如 auth.uid != null && auth.loginType != 'ANONYMOUS')," +
"或在写入时将 owner 字段(如 _openid / authorId)写入 request.data,然后在 create 规则中用 request.data._openid == auth.openid 做校验。" +
"read / update / delete 规则可以使用 doc.* 引用已有文档字段,且客户端查询条件必须是规则约束的子集(如 _openid: '{openid}')。",
recommendedRulePattern: "auth.uid != null && auth.loginType != 'ANONYMOUS'",
recommendedPermission: "CUSTOM",
recommendedSecurityRule: JSON.stringify({
read: "auth.uid != null && auth.loginType != 'ANONYMOUS'",
create: "auth.uid != null && auth.loginType != 'ANONYMOUS'",
update: "auth.uid != null && auth.loginType != 'ANONYMOUS' && doc._openid == auth.openid",
delete: "auth.uid != null && auth.loginType != 'ANONYMOUS' && doc._openid == auth.openid",
}),
};
}
function buildDocIdWriteRuleHint(
securityRule: string | undefined,
resourceId: string,
): PermissionHint | undefined {
const appliesTo = extractRiskyDocFieldOperations(securityRule);
if (!appliesTo.length) {
return undefined;
}
return {
type: "docIdWriteRuleWarning",
severity: "warning",
appliesTo,
summary:
"当前安全规则在 document-id 写入场景下可能被后端直接拒绝。",
detail:
"这类规则经常在 owner-only 集合里被写错,但对于 CMS 文章这种“admin 可编辑所有文章、editor 只能编辑自己的文章”的场景,已验证可用的做法是保留 doc.authorId,并通过独立角色集合做 admin override:get('database.user_roles.' + auth.uid).role == 'admin' || doc.authorId == auth.uid。不要默认改成 where(...),也不要把同集合 owner 判断重写成 get('database.collection.' + doc._id)。",
recommendedRulePattern: "doc.authorId == auth.uid",
recommendedPermission: "CUSTOM",
recommendedSecurityRule: buildRecommendedOwnerWriteRule(resourceId),
recommendedClientWritePattern: buildRecommendedClientWritePattern(resourceId),
roleLookupNote: buildRoleLookupNote(),
};
}
function buildInvalidGetPathHint(
securityRule: string | undefined,
resourceId: string,
): GetPathHint | undefined {
if (!securityRule) {
return undefined;
}
const hasFieldEmbeddedInsideGetPath =
/get\('database\.[^']+'\s*\+\s*[^)]*\+\s*'\.[A-Za-z_][A-Za-z0-9_]*'\)/.test(securityRule);
if (!hasFieldEmbeddedInsideGetPath) {
return undefined;
}
return {
type: "invalidGetPathWarning",
severity: "warning",
summary: "get() 的 path 只应包含 collection 和 documentId,不应把字段名拼进 path 字符串。",
detail:
"请写成 get('database.collection.' + doc._id).fieldName,而不是 get('database.collection.' + doc._id + '.fieldName')。但在 CMS 文章权限里,不要把 get('database.collection.' + doc._id) 当成默认首选方案;更稳的已验证模式是读取单独的角色集合:get('database.user_roles.' + auth.uid).role == 'admin' || doc.authorId == auth.uid。",
recommendedRulePattern: "doc.authorId == auth.uid",
recommendedPermission: "CUSTOM",
recommendedSecurityRule: buildRecommendedOwnerWriteRule(resourceId),
recommendedClientWritePattern: buildRecommendedClientWritePattern(resourceId),
roleLookupNote: buildRoleLookupNote(),
};
}
function buildTemplateLiteralRuleHint(
securityRule: string | undefined,
resourceId: string,
): TemplateLiteralHint | undefined {
if (!securityRule) {
return undefined;
}
const usesTemplateLiteralPlaceholderInRule = /\$\{(?:auth\.uid|doc\._id|doc\.[A-Za-z_][A-Za-z0-9_]*)\}/.test(
securityRule,
);
if (!usesTemplateLiteralPlaceholderInRule) {
return undefined;
}
return {
type: "templateLiteralRuleWarning",
severity: "warning",
summary: "CloudBase security rule 表达式不支持把 ${...} 当作 JS 模板字符串插值。",
detail:
"在 securityRule 字符串里,请使用表达式拼接,例如 get('database.user_roles.' + auth.uid).role,而不是 get('database.user_roles.${auth.uid}').role。对于 CMS 文章这类需要 app-level admin override 的规则,请优先使用已验证的 user_roles + doc.authorId 模式。",
recommendedRulePattern: "doc.authorId == auth.uid",
recommendedPermission: "CUSTOM",
recommendedSecurityRule: buildRecommendedOwnerWriteRule(resourceId),
recommendedClientWritePattern: buildRecommendedClientWritePattern(resourceId),
roleLookupNote: buildRoleLookupNote(),
};
}
function buildPermissionHints(securityRule: string | undefined, resourceId: string) {
return [
buildCreateRuleHint(securityRule, resourceId),
buildDocIdWriteRuleHint(securityRule, resourceId),
buildInvalidGetPathHint(securityRule, resourceId),
buildTemplateLiteralRuleHint(securityRule, resourceId),
].filter(Boolean) as PermissionHint[];
}
async function ensureStorageBucketsExist(cloudbase: any, resourceIds: string[]) {
if (!resourceIds.length) {
return;
}
const envInfo = await cloudbase.env.getEnvInfo();
const existingBuckets = new Set(
(envInfo?.EnvInfo?.Storages ?? [])
.map((item: { Bucket?: string }) => item?.Bucket)
.filter((bucket: string | undefined): bucket is string => Boolean(bucket)),
);
const missingBuckets = resourceIds.filter((resourceId) => !existingBuckets.has(resourceId));
if (missingBuckets.length === 0) {
return;
}
if (missingBuckets.length === 1) {
throw new Error(`存储 Bucket ${missingBuckets[0]} 不存在`);
}
throw new Error(`以下存储 Bucket 不存在: ${missingBuckets.join(", ")}`);
}
export function registerPermissionTools(server: ExtendedMcpServer) {
const cloudBaseOptions = server.cloudBaseOptions;
const getManager = () => getCloudBaseManager({ cloudBaseOptions });
const withEnvelope = async (handler: () => Promise<ToolEnvelope>) => {
try {
return jsonContent(await handler());
} catch (error) {
return jsonContent(buildErrorEnvelope(error));
}
};
server.registerTool?.(
"queryPermissions",
{
title: "查询权限与用户配置",
description:
"权限域统一只读入口。支持查询资源权限、角色列表/详情、应用用户列表/详情。",
inputSchema: {
action: z.enum(QUERY_PERMISSION_ACTIONS),
resourceType: z
.enum(["noSqlDatabase", "sqlDatabase", "function", "storage"])
.optional(),
resourceId: z.string().optional(),
resourceIds: z.array(z.string()).optional(),
roleId: z.string().optional(),
roleIdentity: z.string().optional(),
roleName: z.string().optional(),
uid: z.string().optional(),
username: z.string().optional(),
pageNo: z.number().optional(),
pageSize: z.number().optional(),
},
annotations: {
readOnlyHint: true,
openWorldHint: true,
category: "permissions",
},
},
async ({
action,
resourceType,
resourceId,
resourceIds,
roleId,
roleIdentity,
roleName,
uid,
username,
pageNo,
pageSize,
}: {
action: QueryPermissionAction;
resourceType?: LegacyResourceType;
resourceId?: string;
resourceIds?: string[];
roleId?: string;
roleIdentity?: string;
roleName?: string;
uid?: string;
username?: string;
pageNo?: number;
pageSize?: number;
}) =>
withEnvelope(async () => {
const envId = await getEnvId(cloudBaseOptions);
const cloudbase = await getManager();
switch (action) {
case "getResourcePermission": {
if (!resourceType || !resourceId) {
throw new Error("action=getResourcePermission 时必须提供 resourceType 和 resourceId");
}
if (resourceType === "storage") {
await ensureStorageBucketsExist(cloudbase, [resourceId]);
}
const result = await cloudbase.permission.describeResourcePermission({
resourceType: mapResourceType(resourceType),
resources: [resourceId],
});
logCloudBaseResult(server.logger, result);
const permissions = result.Data.PermissionList ?? [];
const matchedPermission =
permissions.find((item) => item.Resource === resourceId) ?? permissions[0];
const securityRule =
matchedPermission?.SecurityRule;
const hints = buildPermissionHints(securityRule, resourceId);
return buildEnvelope(
{
action,
envId,
resourceType,
resourceId,
aclTag: matchedPermission?.Permission,
permissions,
hints,
raw: result,
},
"资源权限查询成功",
);
}
case "listResourcePermissions": {
if (!resourceType) {
throw new Error("action=listResourcePermissions 时必须提供 resourceType");
}
if (resourceType === "storage" && resourceIds?.length) {
await ensureStorageBucketsExist(cloudbase, resourceIds);
}
const result = await cloudbase.permission.describeResourcePermission({
resourceType: mapResourceType(resourceType),
resources: resourceIds,
});
logCloudBaseResult(server.logger, result);
const permissions = result.Data.PermissionList ?? [];
const resourceHints = permissions
.map((item) => ({
resourceId: item.Resource ?? "",
permission: item.Permission,
hints:
item.Permission === "CUSTOM" && item.Resource
? buildPermissionHints(item.SecurityRule, item.Resource)
: [],
}))
.filter((item) => item.resourceId && item.hints.length > 0);
return buildEnvelope(
{
action,
envId,
resourceType,
permissions,
resourceHints,
total: result.Data.TotalCount ?? 0,
raw: result,
},
"资源权限列表查询成功",
);
}
case "listRoles": {
const result = await cloudbase.permission.describeRoleList({
pageNumber: pageNo ?? 1,
pageSize: pageSize ?? 20,
loadDetails: true,
});
logCloudBaseResult(server.logger, result);
return buildEnvelope(
{
action,
envId,
systemRoles: result.Data.SystemRoles ?? [],
customRoles: result.Data.CustomRoles ?? [],
total: result.Data.TotalCount ?? 0,
raw: result,
},
"角色列表查询成功",
);
}
case "getRole": {
const result = await cloudbase.permission.describeRoleList({
roleId,
roleIdentity,
roleName,
pageNumber: 1,
pageSize: 20,
loadDetails: true,
});
logCloudBaseResult(server.logger, result);
const roles = [
...(result.Data.SystemRoles ?? []),
...(result.Data.CustomRoles ?? []),
];
const role =
roles.find(
(item) =>
(roleId && item.RoleId === roleId) ||
(roleIdentity && item.RoleIdentity === roleIdentity) ||
(roleName && item.RoleName === roleName),
) ?? null;
return buildEnvelope(
{
action,
envId,
role,
raw: result,
},
"角色详情查询成功",
);
}
case "listUsers": {
const result = await cloudbase.user.describeUserList({
pageNo: pageNo ?? 1,
pageSize: pageSize ?? 20,
name: username,
});
logCloudBaseResult(server.logger, result);
return buildEnvelope(
{
action,
envId,
users: result.Data.UserList ?? [],
total: result.Data.Total ?? 0,
raw: result,
},
"应用用户列表查询成功",
);
}
case "getUser": {
if (!uid && !username) {
throw new Error("action=getUser 时必须提供 uid 或 username");
}
const result = await cloudbase.user.describeUserList({
pageNo: 1,
pageSize: 20,
name: username,
});
logCloudBaseResult(server.logger, result);
const user =
(result.Data.UserList ?? []).find(
(item) => (uid && item.Uid === uid) || (username && item.Name === username),
) ?? null;
return buildEnvelope(
{
action,
envId,
user,
raw: result,
},
"应用用户详情查询成功",
);
}
}
}),
);
server.registerTool?.(
"managePermissions",
{
title: "管理权限与用户配置",
description:
"权限域统一写入口。支持修改资源权限、角色管理、成员与策略增删、应用用户 CRUD。`createUser` / `updateUser` 是环境侧应用用户管理能力,适合测试账号、管理员或预置用户,不应替代浏览器里的 Web SDK 注册表单;前端用户名密码注册应使用 `auth.signUp({ username, password })`,登录应使用 `auth.signInWithPassword({ username, password })`。注意:`securityRule` 的详细语义取决于 `resourceType`;`doc._openid`、`auth.openid`、查询条件子集校验,以及 `create` / `update` / `delete` JSON 模板仅适用于 `resourceType=\"noSqlDatabase\"` 的文档数据库安全规则。配置 `function` 或 `storage` 时,请参考各自官方安全规则文档,而不是复用 NoSQL 模板。",
inputSchema: {
action: z.enum(MANAGE_PERMISSION_ACTIONS),
resourceType: z
.enum(["noSqlDatabase", "sqlDatabase", "function", "storage"])
.optional()
.describe("目标资源类型。`securityRule` 的具体语义依赖这个值;`noSqlDatabase` 使用集合安全规则,`function` 与 `storage` 也有各自独立的安全规则语义,不要套用 NoSQL 规则语法。"),
resourceId: z.string().optional(),
permission: z
.enum(["READONLY", "PRIVATE", "ADMINWRITE", "ADMINONLY", "CUSTOM"])
.optional(),
securityRule: z
.string()
.optional()
.describe(
"资源类型特定的规则内容,详细语义依赖 `resourceType`。当 `resourceType=\"noSqlDatabase\"` 且 `permission=\"CUSTOM\"` 时,应传文档数据库安全规则 JSON(文档型数据库规则:`https://docs.cloudbase.net/database/security-rules`);键通常为 `read` / `create` / `update` / `delete`,值为表达式。" +
"重要:`create` 规则验证写入数据,此时文档尚不存在,不能使用 `doc.*`;`read` / `update` / `delete` 规则可使用 `doc.*` 引用已有文档字段。" +
"不要把 `doc._openid`、`auth.openid`、查询条件子集校验或 `create` / `update` / `delete` 模板误用于 `function`、`storage` 或 `sqlDatabase`。" +
'如需配置 `function` 或 `storage`,请改查官方安全规则文档:云函数 `https://docs.cloudbase.net/cloud-function/security-rules`,云存储 `https://docs.cloudbase.net/storage/security-rules`。示例:{"read":"auth.uid != null","create":"auth.uid != null && auth.loginType != "ANONYMOUS"","update":"auth.uid != null && doc._openid == auth.openid","delete":"auth.uid != null && doc._openid == auth.openid"}',
),
roleId: z.string().optional(),
roleIds: z.array(z.string()).optional(),
roleName: z.string().optional(),
roleIdentity: z.string().optional(),
description: z.string().optional(),
memberUids: z.array(z.string()).optional(),
policies: z.array(z.record(z.any())).optional(),
uid: z.string().optional(),
uids: z.array(z.string()).optional(),
username: z.string().optional().describe("用户名。action=createUser 时必填。"),
password: z.string().optional().describe("用户密码。action=createUser 时必填。"),
userStatus: z.enum(["ACTIVE", "BLOCKED"]).optional(),
},
annotations: {
readOnlyHint: false,
destructiveHint: true,
idempotentHint: false,
openWorldHint: true,
category: "permissions",
},
},
async ({
action,
resourceType,
resourceId,
permission,
securityRule,
roleId,
roleIds,
roleName,
roleIdentity,
description,
memberUids,
policies,
uid,
uids,
username,
password,
userStatus,
}: {
action: ManagePermissionAction;
resourceType?: LegacyResourceType;
resourceId?: string;
permission?: "READONLY" | "PRIVATE" | "ADMINWRITE" | "ADMINONLY" | "CUSTOM";
securityRule?: string;
roleId?: string;
roleIds?: string[];
roleName?: string;
roleIdentity?: string;
description?: string;
memberUids?: string[];
policies?: Array<Record<string, unknown>>;
uid?: string;
uids?: string[];
username?: string;
password?: string;
userStatus?: "ACTIVE" | "BLOCKED";
}) =>
withEnvelope(async () => {
const envId = await getEnvId(cloudBaseOptions);
const cloudbase = await getManager();
const normalizedPolicies = normalizeRecordArray(policies, "policies");
switch (action) {
case "updateResourcePermission": {
if (!resourceType || !resourceId || !permission) {
throw new Error("action=updateResourcePermission 时必须提供 resourceType、resourceId 和 permission");
}
const result = await cloudbase.permission.modifyResourcePermission({
resourceType: mapResourceType(resourceType),
resource: resourceId,
permission,
securityRule,
});
logCloudBaseResult(server.logger, result);
const hints = permission === "CUSTOM" ? buildPermissionHints(securityRule, resourceId) : [];
return buildEnvelope(
{
action,
envId,
resourceType,
resourceId,
permission,
hints,
verificationHint:
resourceType === "noSqlDatabase" && permission === "CUSTOM"
? buildWriteVerificationHint(resourceId)
: undefined,
propagationHint:
resourceType === "noSqlDatabase" && permission === "CUSTOM"
? buildPermissionPropagationHint(resourceId)
: undefined,
raw: result,
},
"资源权限更新成功",
);
}
case "createRole": {
if (!roleName || !roleIdentity) {
throw new Error("action=createRole 时必须提供 roleName 和 roleIdentity");
}
const result = await cloudbase.permission.createRole({
roleName,
roleIdentity,
description,
memberUids,
policies: normalizedPolicies as any,
});
logCloudBaseResult(server.logger, result);
return buildEnvelope(
{
action,
envId,
roleName,
raw: result,
},
"角色创建成功",
);
}
case "updateRole":
case "addRoleMembers":
case "removeRoleMembers":
case "addRolePolicies":
case "removeRolePolicies": {
if (!roleId) {
throw new Error(`action=${action} 时必须提供 roleId`);
}
const result = await cloudbase.permission.modifyRole({
roleId,
...(action === "updateRole"
? {
roleName,
description,
addMemberUids: memberUids,
addPolicies: normalizedPolicies as any,
}
: {}),
...(action === "addRoleMembers" ? { addMemberUids: memberUids } : {}),
...(action === "removeRoleMembers" ? { removeMemberUids: memberUids } : {}),
...(action === "addRolePolicies" ? { addPolicies: normalizedPolicies as any } : {}),
...(action === "removeRolePolicies"
? { removePolicies: normalizedPolicies as any }
: {}),
});
logCloudBaseResult(server.logger, result);
return buildEnvelope(
{
action,
envId,
roleId,
raw: result,
},
"角色更新成功",
);
}
case "deleteRoles": {
if (!roleIds?.length) {
throw new Error("action=deleteRoles 时必须提供 roleIds");
}
const result = await cloudbase.permission.deleteRoles({
roleIds,
});
logCloudBaseResult(server.logger, result);
return buildEnvelope(
{
action,
envId,
roleIds,
raw: result,
},
"角色删除成功",
);
}
case "createUser": {
if (!username || !password) {
throw new Error("action=createUser 时必须提供 username 和 password");
}
const result = await cloudbase.user.createUser({
name: username,
password,
userStatus,
description,
});
logCloudBaseResult(server.logger, result);
return buildEnvelope(
{
action,
envId,
username,
raw: result,
},
"应用用户创建成功",
);
}
case "updateUser": {
if (!uid) {
throw new Error("action=updateUser 时必须提供 uid");
}
const result = await cloudbase.user.modifyUser({
uid,
name: username,
password,
userStatus,
description,
});
logCloudBaseResult(server.logger, result);
return buildEnvelope(
{
action,
envId,
uid,
raw: result,
},
"应用用户更新成功",
);
}
case "deleteUsers": {
if (!uids?.length) {
throw new Error("action=deleteUsers 时必须提供 uids");
}
const result = await cloudbase.user.deleteUsers({
uids,
});
logCloudBaseResult(server.logger, result);
return buildEnvelope(
{
action,
envId,
uids,
raw: result,
},
"应用用户删除成功",
);
}
}
}),
);
}