@celljs/ta-permission-gate 0.0.0-stage → 4.5.1
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/README.md +27 -2
- package/esm/node/extension.d.mts +3 -0
- package/esm/node/extension.mjs +45 -0
- package/esm/node/extension.mjs.map +1 -0
- package/esm/node/index.d.ts +1 -0
- package/esm/node/index.js +2 -0
- package/esm/node/index.js.map +1 -0
- package/esm/node/permission-policy.d.ts +28 -0
- package/esm/node/permission-policy.js +49 -0
- package/esm/node/permission-policy.js.map +1 -0
- package/esm/package.json +3 -0
- package/lib/node/extension.d.mts +4 -0
- package/lib/node/extension.d.mts.map +1 -0
- package/lib/node/extension.mjs +45 -0
- package/lib/node/extension.mjs.map +1 -0
- package/lib/node/index.d.ts +2 -0
- package/lib/node/index.d.ts.map +1 -0
- package/lib/node/index.js +18 -0
- package/lib/node/index.js.map +1 -0
- package/lib/node/permission-policy.d.ts +29 -0
- package/lib/node/permission-policy.d.ts.map +1 -0
- package/lib/node/permission-policy.js +52 -0
- package/lib/node/permission-policy.js.map +1 -0
- package/lib/node/permission-policy.spec.d.ts +2 -0
- package/lib/node/permission-policy.spec.d.ts.map +1 -0
- package/lib/node/permission-policy.spec.js +39 -0
- package/lib/node/permission-policy.spec.js.map +1 -0
- package/package.json +65 -4
- package/src/node/extension.mts +47 -0
- package/src/node/index.ts +1 -0
- package/src/node/permission-policy.spec.ts +43 -0
- package/src/node/permission-policy.ts +66 -0
package/README.md
CHANGED
|
@@ -1,3 +1,28 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Cell - ta Permission Gate
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
一个 pi 包:按规则对工具调用放行、询问或拒绝。不依赖 Cell,ta 和 pi 都能安装:
|
|
4
|
+
|
|
5
|
+
```bash
|
|
6
|
+
ta install npm:@celljs/ta-permission-gate
|
|
7
|
+
pi install npm:@celljs/ta-permission-gate
|
|
8
|
+
```
|
|
9
|
+
|
|
10
|
+
规则写在 `permissions.json`,全局(agent 目录下)和项目(`.ta/` 或 `.pi/` 下)各一份:
|
|
11
|
+
|
|
12
|
+
```json
|
|
13
|
+
{
|
|
14
|
+
"default": "allow",
|
|
15
|
+
"rules": [
|
|
16
|
+
{ "tool": "bash", "command": "git push*", "action": "ask" },
|
|
17
|
+
{ "tool": "bash", "command": "*rm -rf*", "action": "deny" },
|
|
18
|
+
{ "path": "*/.env*", "action": "deny" }
|
|
19
|
+
]
|
|
20
|
+
}
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
- 每份文件里第一条匹配的规则生效,都不匹配时取 `default`(默认 `allow`);`*` 匹配任意字符,其余按字面。
|
|
24
|
+
- 两份文件取更严的结果:项目只能收紧、不能放宽,否则不受信任的仓库能给自己开权限。
|
|
25
|
+
- `ask` 调用 `ctx.ui.confirm`,5 分钟无人回答视为拒绝;没有界面(`-p`)时直接拒绝。在 ta serve 下对话框会发给所有已连接的客户端。
|
|
26
|
+
- 文件读不了或格式不对时一律拒绝。
|
|
27
|
+
|
|
28
|
+
没有 `permissions.json` 时什么都不限制,与 pi 的默认行为一致。
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
import { readFileSync } from 'node:fs';
|
|
2
|
+
import { join } from 'node:path';
|
|
3
|
+
import { CONFIG_DIR_NAME, getAgentDir } from '@earendil-works/pi-coding-agent';
|
|
4
|
+
import { PermissionPolicy } from './permission-policy.js';
|
|
5
|
+
const FILE_NAME = 'permissions.json';
|
|
6
|
+
/** How long a question waits for an answer; no answer is a no. */
|
|
7
|
+
const ASK_TIMEOUT_MS = 5 * 60 * 1000;
|
|
8
|
+
function load(path) {
|
|
9
|
+
let text;
|
|
10
|
+
try {
|
|
11
|
+
text = readFileSync(path, 'utf8');
|
|
12
|
+
}
|
|
13
|
+
catch (error) {
|
|
14
|
+
if (error.code === 'ENOENT') {
|
|
15
|
+
return undefined;
|
|
16
|
+
}
|
|
17
|
+
throw error;
|
|
18
|
+
}
|
|
19
|
+
return PermissionPolicy.parse(text);
|
|
20
|
+
}
|
|
21
|
+
function decide(toolName, input, cwd) {
|
|
22
|
+
const files = [load(join(getAgentDir(), FILE_NAME)), load(join(cwd, CONFIG_DIR_NAME, FILE_NAME))].filter(file => file !== undefined);
|
|
23
|
+
return PermissionPolicy.strictest(files.map(file => PermissionPolicy.decide(file, toolName, input)));
|
|
24
|
+
}
|
|
25
|
+
async function ask(toolName, input, ctx) {
|
|
26
|
+
var _a, _b;
|
|
27
|
+
return ctx.hasUI && ctx.ui.confirm(`Allow ${toolName}?`, String((_b = (_a = input.command) !== null && _a !== void 0 ? _a : input.path) !== null && _b !== void 0 ? _b : JSON.stringify(input)), { timeout: ASK_TIMEOUT_MS });
|
|
28
|
+
}
|
|
29
|
+
/** Rules from `permissions.json` in the agent directory and the project's config directory. Nothing is restricted without them. */
|
|
30
|
+
export default function permissionGate(pi) {
|
|
31
|
+
pi.on('tool_call', async (event, ctx) => {
|
|
32
|
+
try {
|
|
33
|
+
const input = event.input;
|
|
34
|
+
const action = decide(event.toolName, input, ctx.cwd);
|
|
35
|
+
if (action === 'allow' || (action === 'ask' && (await ask(event.toolName, input, ctx)))) {
|
|
36
|
+
return undefined;
|
|
37
|
+
}
|
|
38
|
+
return { block: true, reason: action === 'ask' ? 'The user did not allow this tool call.' : `${FILE_NAME} denies this tool call.` };
|
|
39
|
+
}
|
|
40
|
+
catch (error) {
|
|
41
|
+
return { block: true, reason: `Cannot read ${FILE_NAME}, so nothing is allowed: ${error.message}` };
|
|
42
|
+
}
|
|
43
|
+
});
|
|
44
|
+
}
|
|
45
|
+
//# sourceMappingURL=extension.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"extension.mjs","sourceRoot":"","sources":["../../src/node/extension.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,eAAe,EAA4C,WAAW,EAAE,MAAM,iCAAiC,CAAC;AACzH,OAAO,EAA8C,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAEtG,MAAM,SAAS,GAAG,kBAAkB,CAAC;AAErC,kEAAkE;AAClE,MAAM,cAAc,GAAG,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC;AAErC,SAAS,IAAI,CAAC,IAAY;IACtB,IAAI,IAAY,CAAC;IACjB,IAAI,CAAC;QACD,IAAI,GAAG,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IACtC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACb,IAAK,KAA+B,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YACrD,OAAO,SAAS,CAAC;QACrB,CAAC;QACD,MAAM,KAAK,CAAC;IAChB,CAAC;IACD,OAAO,gBAAgB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;AACxC,CAAC;AAED,SAAS,MAAM,CAAC,QAAgB,EAAE,KAA8B,EAAE,GAAW;IACzE,MAAM,KAAK,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,SAAS,CAAC,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,eAAe,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC;IACrI,OAAO,gBAAgB,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,gBAAgB,CAAC,MAAM,CAAC,IAAI,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;AACzG,CAAC;AAED,KAAK,UAAU,GAAG,CAAC,QAAgB,EAAE,KAA8B,EAAE,GAAqB;;IACtF,OAAO,GAAG,CAAC,KAAK,IAAI,GAAG,CAAC,EAAE,CAAC,OAAO,CAAC,SAAS,QAAQ,GAAG,EAAE,MAAM,aAAC,KAAK,CAAC,OAAO,mCAAI,KAAK,CAAC,IAAI,mCAAI,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,OAAO,EAAE,cAAc,EAAE,CAAC,CAAC;AACxJ,CAAC;AAED,mIAAmI;AACnI,MAAM,CAAC,OAAO,UAAU,cAAc,CAAC,EAAgB;IACnD,EAAE,CAAC,EAAE,CAAC,WAAW,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE;QACpC,IAAI,CAAC;YACD,MAAM,KAAK,GAAG,KAAK,CAAC,KAAgC,CAAC;YACrD,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,QAAQ,EAAE,KAAK,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC;YACtD,IAAI,MAAM,KAAK,OAAO,IAAI,CAAC,MAAM,KAAK,KAAK,IAAI,CAAC,MAAM,GAAG,CAAC,KAAK,CAAC,QAAQ,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;gBACtF,OAAO,SAAS,CAAC;YACrB,CAAC;YACD,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,KAAK,KAAK,CAAC,CAAC,CAAC,wCAAwC,CAAC,CAAC,CAAC,GAAG,SAAS,yBAAyB,EAAE,CAAC;QACxI,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACb,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,eAAe,SAAS,4BAA6B,KAAe,CAAC,OAAO,EAAE,EAAE,CAAC;QACnH,CAAC;IACL,CAAC,CAAC,CAAC;AACP,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from './permission-policy.js';
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/node/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAC"}
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
export type PermissionAction = 'allow' | 'ask' | 'deny';
|
|
2
|
+
/** A rule applies when all its patterns match; `*` in a pattern stands for any characters. */
|
|
3
|
+
export interface PermissionRule {
|
|
4
|
+
/** Tool name. Default: any tool. */
|
|
5
|
+
tool?: string;
|
|
6
|
+
/** The command of a bash call. */
|
|
7
|
+
command?: string;
|
|
8
|
+
/** The path of a call of read, edit or write. */
|
|
9
|
+
path?: string;
|
|
10
|
+
action: PermissionAction;
|
|
11
|
+
}
|
|
12
|
+
export interface PermissionFile {
|
|
13
|
+
/** What applies when no rule does. Default: allow. */
|
|
14
|
+
default?: PermissionAction;
|
|
15
|
+
/** The first rule that applies decides. */
|
|
16
|
+
rules?: PermissionRule[];
|
|
17
|
+
}
|
|
18
|
+
export declare namespace PermissionPolicy {
|
|
19
|
+
/** The action on a tool call under one file. */
|
|
20
|
+
function decide(file: PermissionFile, toolName: string, input: Record<string, unknown>): PermissionAction;
|
|
21
|
+
/**
|
|
22
|
+
* The stricter action of the global and the project files: a project can only tighten what the user
|
|
23
|
+
* set, or an untrusted repository could grant itself permissions.
|
|
24
|
+
*/
|
|
25
|
+
function strictest(actions: PermissionAction[]): PermissionAction;
|
|
26
|
+
/** Throws on anything that is not a valid file: the caller must then refuse, not allow. */
|
|
27
|
+
function parse(text: string): PermissionFile;
|
|
28
|
+
}
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
const SEVERITY = { allow: 0, ask: 1, deny: 2 };
|
|
2
|
+
export var PermissionPolicy;
|
|
3
|
+
(function (PermissionPolicy) {
|
|
4
|
+
/** The action on a tool call under one file. */
|
|
5
|
+
function decide(file, toolName, input) {
|
|
6
|
+
var _a;
|
|
7
|
+
var _b, _c;
|
|
8
|
+
const rule = (_a = file.rules) === null || _a === void 0 ? void 0 : _a.find(candidate => applies(candidate, toolName, input));
|
|
9
|
+
return (_c = (_b = rule === null || rule === void 0 ? void 0 : rule.action) !== null && _b !== void 0 ? _b : file.default) !== null && _c !== void 0 ? _c : 'allow';
|
|
10
|
+
}
|
|
11
|
+
PermissionPolicy.decide = decide;
|
|
12
|
+
/**
|
|
13
|
+
* The stricter action of the global and the project files: a project can only tighten what the user
|
|
14
|
+
* set, or an untrusted repository could grant itself permissions.
|
|
15
|
+
*/
|
|
16
|
+
function strictest(actions) {
|
|
17
|
+
return actions.reduce((worst, action) => (SEVERITY[action] > SEVERITY[worst] ? action : worst), 'allow');
|
|
18
|
+
}
|
|
19
|
+
PermissionPolicy.strictest = strictest;
|
|
20
|
+
/** Throws on anything that is not a valid file: the caller must then refuse, not allow. */
|
|
21
|
+
function parse(text) {
|
|
22
|
+
var _a;
|
|
23
|
+
const file = JSON.parse(text);
|
|
24
|
+
const actions = [...(file.default ? [file.default] : []), ...((_a = file.rules) !== null && _a !== void 0 ? _a : []).map(rule => rule.action)];
|
|
25
|
+
const invalid = actions.find(action => !(action in SEVERITY));
|
|
26
|
+
if (invalid !== undefined) {
|
|
27
|
+
throw new Error(`Unknown action ${String(invalid)}: use allow, ask or deny.`);
|
|
28
|
+
}
|
|
29
|
+
return file;
|
|
30
|
+
}
|
|
31
|
+
PermissionPolicy.parse = parse;
|
|
32
|
+
function applies(rule, toolName, input) {
|
|
33
|
+
return matches(rule.tool, toolName) && matches(rule.command, input.command) && matches(rule.path, input.path);
|
|
34
|
+
}
|
|
35
|
+
function matches(pattern, value) {
|
|
36
|
+
if (pattern === undefined) {
|
|
37
|
+
return true;
|
|
38
|
+
}
|
|
39
|
+
if (typeof value !== 'string') {
|
|
40
|
+
return false;
|
|
41
|
+
}
|
|
42
|
+
const body = pattern
|
|
43
|
+
.split('*')
|
|
44
|
+
.map(part => part.replace(/[\\^$.|+?()[\]{}]/g, '\\$&'))
|
|
45
|
+
.join('[\\s\\S]*');
|
|
46
|
+
return new RegExp(`^${body}$`).test(value);
|
|
47
|
+
}
|
|
48
|
+
})(PermissionPolicy || (PermissionPolicy = {}));
|
|
49
|
+
//# sourceMappingURL=permission-policy.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"permission-policy.js","sourceRoot":"","sources":["../../src/node/permission-policy.ts"],"names":[],"mappings":"AAoBA,MAAM,QAAQ,GAAqC,EAAE,KAAK,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC;AAEjF,MAAM,KAAW,gBAAgB,CA2ChC;AA3CD,WAAiB,gBAAgB;IAC7B,gDAAgD;IAChD,SAAgB,MAAM,CAAC,IAAoB,EAAE,QAAgB,EAAE,KAA8B;;;QACzF,MAAM,IAAI,GAAG,MAAA,IAAI,CAAC,KAAK,0CAAE,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,OAAO,CAAC,SAAS,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC;QAChF,mBAAO,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,MAAM,mCAAI,IAAI,CAAC,OAAO,mCAAI,OAAO,CAAC;IACnD,CAAC;IAHe,iBAAA,MAAM,SAGrB,CAAA;IAED;;;OAGG;IACH,SAAgB,SAAS,CAAC,OAA2B;QACjD,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,CAAC;IAC7G,CAAC;IAFe,iBAAA,SAAS,YAExB,CAAA;IAED,2FAA2F;IAC3F,SAAgB,KAAK,CAAC,IAAY;;QAC9B,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAmB,CAAC;QAChD,MAAM,OAAO,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,OAAC,IAAI,CAAC,KAAK,mCAAI,EAAE,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;QAC1G,MAAM,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,IAAI,QAAQ,CAAC,CAAC,CAAC;QAC9D,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YACxB,MAAM,IAAI,KAAK,CAAC,kBAAkB,MAAM,CAAC,OAAO,CAAC,2BAA2B,CAAC,CAAC;QAClF,CAAC;QACD,OAAO,IAAI,CAAC;IAChB,CAAC;IARe,iBAAA,KAAK,QAQpB,CAAA;IAED,SAAS,OAAO,CAAC,IAAoB,EAAE,QAAgB,EAAE,KAA8B;QACnF,OAAO,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;IAClH,CAAC;IAED,SAAS,OAAO,CAAC,OAA2B,EAAE,KAAc;QACxD,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YACxB,OAAO,IAAI,CAAC;QAChB,CAAC;QACD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC5B,OAAO,KAAK,CAAC;QACjB,CAAC;QACD,MAAM,IAAI,GAAG,OAAO;aACf,KAAK,CAAC,GAAG,CAAC;aACV,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,oBAAoB,EAAE,MAAM,CAAC,CAAC;aACvD,IAAI,CAAC,WAAW,CAAC,CAAC;QACvB,OAAO,IAAI,MAAM,CAAC,IAAI,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC/C,CAAC;AACL,CAAC,EA3CgB,gBAAgB,KAAhB,gBAAgB,QA2ChC"}
|
package/esm/package.json
ADDED
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import { type ExtensionAPI } from '@earendil-works/pi-coding-agent';
|
|
2
|
+
/** Rules from `permissions.json` in the agent directory and the project's config directory. Nothing is restricted without them. */
|
|
3
|
+
export default function permissionGate(pi: ExtensionAPI): void;
|
|
4
|
+
//# sourceMappingURL=extension.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"extension.d.mts","sourceRoot":"","sources":["../../src/node/extension.mts"],"names":[],"mappings":"AAEA,OAAO,EAAmB,KAAK,YAAY,EAAsC,MAAM,iCAAiC,CAAC;AA8BzH,mIAAmI;AACnI,MAAM,CAAC,OAAO,UAAU,cAAc,CAAC,EAAE,EAAE,YAAY,GAAG,IAAI,CAa7D"}
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
import { readFileSync } from 'node:fs';
|
|
2
|
+
import { join } from 'node:path';
|
|
3
|
+
import { CONFIG_DIR_NAME, getAgentDir } from '@earendil-works/pi-coding-agent';
|
|
4
|
+
import { PermissionPolicy } from './permission-policy.js';
|
|
5
|
+
const FILE_NAME = 'permissions.json';
|
|
6
|
+
/** How long a question waits for an answer; no answer is a no. */
|
|
7
|
+
const ASK_TIMEOUT_MS = 5 * 60 * 1000;
|
|
8
|
+
function load(path) {
|
|
9
|
+
let text;
|
|
10
|
+
try {
|
|
11
|
+
text = readFileSync(path, 'utf8');
|
|
12
|
+
}
|
|
13
|
+
catch (error) {
|
|
14
|
+
if (error.code === 'ENOENT') {
|
|
15
|
+
return undefined;
|
|
16
|
+
}
|
|
17
|
+
throw error;
|
|
18
|
+
}
|
|
19
|
+
return PermissionPolicy.parse(text);
|
|
20
|
+
}
|
|
21
|
+
function decide(toolName, input, cwd) {
|
|
22
|
+
const files = [load(join(getAgentDir(), FILE_NAME)), load(join(cwd, CONFIG_DIR_NAME, FILE_NAME))].filter(file => file !== undefined);
|
|
23
|
+
return PermissionPolicy.strictest(files.map(file => PermissionPolicy.decide(file, toolName, input)));
|
|
24
|
+
}
|
|
25
|
+
async function ask(toolName, input, ctx) {
|
|
26
|
+
var _a, _b;
|
|
27
|
+
return ctx.hasUI && ctx.ui.confirm(`Allow ${toolName}?`, String((_b = (_a = input.command) !== null && _a !== void 0 ? _a : input.path) !== null && _b !== void 0 ? _b : JSON.stringify(input)), { timeout: ASK_TIMEOUT_MS });
|
|
28
|
+
}
|
|
29
|
+
/** Rules from `permissions.json` in the agent directory and the project's config directory. Nothing is restricted without them. */
|
|
30
|
+
export default function permissionGate(pi) {
|
|
31
|
+
pi.on('tool_call', async (event, ctx) => {
|
|
32
|
+
try {
|
|
33
|
+
const input = event.input;
|
|
34
|
+
const action = decide(event.toolName, input, ctx.cwd);
|
|
35
|
+
if (action === 'allow' || (action === 'ask' && (await ask(event.toolName, input, ctx)))) {
|
|
36
|
+
return undefined;
|
|
37
|
+
}
|
|
38
|
+
return { block: true, reason: action === 'ask' ? 'The user did not allow this tool call.' : `${FILE_NAME} denies this tool call.` };
|
|
39
|
+
}
|
|
40
|
+
catch (error) {
|
|
41
|
+
return { block: true, reason: `Cannot read ${FILE_NAME}, so nothing is allowed: ${error.message}` };
|
|
42
|
+
}
|
|
43
|
+
});
|
|
44
|
+
}
|
|
45
|
+
//# sourceMappingURL=extension.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"extension.mjs","sourceRoot":"","sources":["../../src/node/extension.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,eAAe,EAA4C,WAAW,EAAE,MAAM,iCAAiC,CAAC;AACzH,OAAO,EAA8C,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAEtG,MAAM,SAAS,GAAG,kBAAkB,CAAC;AAErC,kEAAkE;AAClE,MAAM,cAAc,GAAG,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC;AAErC,SAAS,IAAI,CAAC,IAAY;IACtB,IAAI,IAAY,CAAC;IACjB,IAAI,CAAC;QACD,IAAI,GAAG,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IACtC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACb,IAAK,KAA+B,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YACrD,OAAO,SAAS,CAAC;QACrB,CAAC;QACD,MAAM,KAAK,CAAC;IAChB,CAAC;IACD,OAAO,gBAAgB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;AACxC,CAAC;AAED,SAAS,MAAM,CAAC,QAAgB,EAAE,KAA8B,EAAE,GAAW;IACzE,MAAM,KAAK,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,SAAS,CAAC,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,eAAe,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC;IACrI,OAAO,gBAAgB,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,gBAAgB,CAAC,MAAM,CAAC,IAAI,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;AACzG,CAAC;AAED,KAAK,UAAU,GAAG,CAAC,QAAgB,EAAE,KAA8B,EAAE,GAAqB;;IACtF,OAAO,GAAG,CAAC,KAAK,IAAI,GAAG,CAAC,EAAE,CAAC,OAAO,CAAC,SAAS,QAAQ,GAAG,EAAE,MAAM,aAAC,KAAK,CAAC,OAAO,mCAAI,KAAK,CAAC,IAAI,mCAAI,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,OAAO,EAAE,cAAc,EAAE,CAAC,CAAC;AACxJ,CAAC;AAED,mIAAmI;AACnI,MAAM,CAAC,OAAO,UAAU,cAAc,CAAC,EAAgB;IACnD,EAAE,CAAC,EAAE,CAAC,WAAW,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE;QACpC,IAAI,CAAC;YACD,MAAM,KAAK,GAAG,KAAK,CAAC,KAAgC,CAAC;YACrD,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,QAAQ,EAAE,KAAK,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC;YACtD,IAAI,MAAM,KAAK,OAAO,IAAI,CAAC,MAAM,KAAK,KAAK,IAAI,CAAC,MAAM,GAAG,CAAC,KAAK,CAAC,QAAQ,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;gBACtF,OAAO,SAAS,CAAC;YACrB,CAAC;YACD,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,KAAK,KAAK,CAAC,CAAC,CAAC,wCAAwC,CAAC,CAAC,CAAC,GAAG,SAAS,yBAAyB,EAAE,CAAC;QACxI,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACb,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,eAAe,SAAS,4BAA6B,KAAe,CAAC,OAAO,EAAE,EAAE,CAAC;QACnH,CAAC;IACL,CAAC,CAAC,CAAC;AACP,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/node/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAC"}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
+
};
|
|
16
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
+
__exportStar(require("./permission-policy"), exports);
|
|
18
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/node/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,sDAAoC"}
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
export type PermissionAction = 'allow' | 'ask' | 'deny';
|
|
2
|
+
/** A rule applies when all its patterns match; `*` in a pattern stands for any characters. */
|
|
3
|
+
export interface PermissionRule {
|
|
4
|
+
/** Tool name. Default: any tool. */
|
|
5
|
+
tool?: string;
|
|
6
|
+
/** The command of a bash call. */
|
|
7
|
+
command?: string;
|
|
8
|
+
/** The path of a call of read, edit or write. */
|
|
9
|
+
path?: string;
|
|
10
|
+
action: PermissionAction;
|
|
11
|
+
}
|
|
12
|
+
export interface PermissionFile {
|
|
13
|
+
/** What applies when no rule does. Default: allow. */
|
|
14
|
+
default?: PermissionAction;
|
|
15
|
+
/** The first rule that applies decides. */
|
|
16
|
+
rules?: PermissionRule[];
|
|
17
|
+
}
|
|
18
|
+
export declare namespace PermissionPolicy {
|
|
19
|
+
/** The action on a tool call under one file. */
|
|
20
|
+
function decide(file: PermissionFile, toolName: string, input: Record<string, unknown>): PermissionAction;
|
|
21
|
+
/**
|
|
22
|
+
* The stricter action of the global and the project files: a project can only tighten what the user
|
|
23
|
+
* set, or an untrusted repository could grant itself permissions.
|
|
24
|
+
*/
|
|
25
|
+
function strictest(actions: PermissionAction[]): PermissionAction;
|
|
26
|
+
/** Throws on anything that is not a valid file: the caller must then refuse, not allow. */
|
|
27
|
+
function parse(text: string): PermissionFile;
|
|
28
|
+
}
|
|
29
|
+
//# sourceMappingURL=permission-policy.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"permission-policy.d.ts","sourceRoot":"","sources":["../../src/node/permission-policy.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,gBAAgB,GAAG,OAAO,GAAG,KAAK,GAAG,MAAM,CAAC;AAExD,8FAA8F;AAC9F,MAAM,WAAW,cAAc;IAC3B,oCAAoC;IACpC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,kCAAkC;IAClC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,iDAAiD;IACjD,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,gBAAgB,CAAC;CAC5B;AAED,MAAM,WAAW,cAAc;IAC3B,sDAAsD;IACtD,OAAO,CAAC,EAAE,gBAAgB,CAAC;IAC3B,2CAA2C;IAC3C,KAAK,CAAC,EAAE,cAAc,EAAE,CAAC;CAC5B;AAID,yBAAiB,gBAAgB,CAAC;IAC9B,gDAAgD;IAChD,SAAgB,MAAM,CAAC,IAAI,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,gBAAgB,CAG/G;IAED;;;OAGG;IACH,SAAgB,SAAS,CAAC,OAAO,EAAE,gBAAgB,EAAE,GAAG,gBAAgB,CAEvE;IAED,2FAA2F;IAC3F,SAAgB,KAAK,CAAC,IAAI,EAAE,MAAM,GAAG,cAAc,CAQlD;CAmBJ"}
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.PermissionPolicy = void 0;
|
|
4
|
+
const SEVERITY = { allow: 0, ask: 1, deny: 2 };
|
|
5
|
+
var PermissionPolicy;
|
|
6
|
+
(function (PermissionPolicy) {
|
|
7
|
+
/** The action on a tool call under one file. */
|
|
8
|
+
function decide(file, toolName, input) {
|
|
9
|
+
var _a;
|
|
10
|
+
var _b, _c;
|
|
11
|
+
const rule = (_a = file.rules) === null || _a === void 0 ? void 0 : _a.find(candidate => applies(candidate, toolName, input));
|
|
12
|
+
return (_c = (_b = rule === null || rule === void 0 ? void 0 : rule.action) !== null && _b !== void 0 ? _b : file.default) !== null && _c !== void 0 ? _c : 'allow';
|
|
13
|
+
}
|
|
14
|
+
PermissionPolicy.decide = decide;
|
|
15
|
+
/**
|
|
16
|
+
* The stricter action of the global and the project files: a project can only tighten what the user
|
|
17
|
+
* set, or an untrusted repository could grant itself permissions.
|
|
18
|
+
*/
|
|
19
|
+
function strictest(actions) {
|
|
20
|
+
return actions.reduce((worst, action) => (SEVERITY[action] > SEVERITY[worst] ? action : worst), 'allow');
|
|
21
|
+
}
|
|
22
|
+
PermissionPolicy.strictest = strictest;
|
|
23
|
+
/** Throws on anything that is not a valid file: the caller must then refuse, not allow. */
|
|
24
|
+
function parse(text) {
|
|
25
|
+
var _a;
|
|
26
|
+
const file = JSON.parse(text);
|
|
27
|
+
const actions = [...(file.default ? [file.default] : []), ...((_a = file.rules) !== null && _a !== void 0 ? _a : []).map(rule => rule.action)];
|
|
28
|
+
const invalid = actions.find(action => !(action in SEVERITY));
|
|
29
|
+
if (invalid !== undefined) {
|
|
30
|
+
throw new Error(`Unknown action ${String(invalid)}: use allow, ask or deny.`);
|
|
31
|
+
}
|
|
32
|
+
return file;
|
|
33
|
+
}
|
|
34
|
+
PermissionPolicy.parse = parse;
|
|
35
|
+
function applies(rule, toolName, input) {
|
|
36
|
+
return matches(rule.tool, toolName) && matches(rule.command, input.command) && matches(rule.path, input.path);
|
|
37
|
+
}
|
|
38
|
+
function matches(pattern, value) {
|
|
39
|
+
if (pattern === undefined) {
|
|
40
|
+
return true;
|
|
41
|
+
}
|
|
42
|
+
if (typeof value !== 'string') {
|
|
43
|
+
return false;
|
|
44
|
+
}
|
|
45
|
+
const body = pattern
|
|
46
|
+
.split('*')
|
|
47
|
+
.map(part => part.replace(/[\\^$.|+?()[\]{}]/g, '\\$&'))
|
|
48
|
+
.join('[\\s\\S]*');
|
|
49
|
+
return new RegExp(`^${body}$`).test(value);
|
|
50
|
+
}
|
|
51
|
+
})(PermissionPolicy || (exports.PermissionPolicy = PermissionPolicy = {}));
|
|
52
|
+
//# sourceMappingURL=permission-policy.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"permission-policy.js","sourceRoot":"","sources":["../../src/node/permission-policy.ts"],"names":[],"mappings":";;;AAoBA,MAAM,QAAQ,GAAqC,EAAE,KAAK,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC;AAEjF,IAAiB,gBAAgB,CA2ChC;AA3CD,WAAiB,gBAAgB;IAC7B,gDAAgD;IAChD,SAAgB,MAAM,CAAC,IAAoB,EAAE,QAAgB,EAAE,KAA8B;;;QACzF,MAAM,IAAI,GAAG,MAAA,IAAI,CAAC,KAAK,0CAAE,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,OAAO,CAAC,SAAS,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC;QAChF,mBAAO,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,MAAM,mCAAI,IAAI,CAAC,OAAO,mCAAI,OAAO,CAAC;IACnD,CAAC;IAHe,iBAAA,MAAM,SAGrB,CAAA;IAED;;;OAGG;IACH,SAAgB,SAAS,CAAC,OAA2B;QACjD,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,CAAC;IAC7G,CAAC;IAFe,iBAAA,SAAS,YAExB,CAAA;IAED,2FAA2F;IAC3F,SAAgB,KAAK,CAAC,IAAY;;QAC9B,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAmB,CAAC;QAChD,MAAM,OAAO,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,OAAC,IAAI,CAAC,KAAK,mCAAI,EAAE,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;QAC1G,MAAM,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,IAAI,QAAQ,CAAC,CAAC,CAAC;QAC9D,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YACxB,MAAM,IAAI,KAAK,CAAC,kBAAkB,MAAM,CAAC,OAAO,CAAC,2BAA2B,CAAC,CAAC;QAClF,CAAC;QACD,OAAO,IAAI,CAAC;IAChB,CAAC;IARe,iBAAA,KAAK,QAQpB,CAAA;IAED,SAAS,OAAO,CAAC,IAAoB,EAAE,QAAgB,EAAE,KAA8B;QACnF,OAAO,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;IAClH,CAAC;IAED,SAAS,OAAO,CAAC,OAA2B,EAAE,KAAc;QACxD,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YACxB,OAAO,IAAI,CAAC;QAChB,CAAC;QACD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC5B,OAAO,KAAK,CAAC;QACjB,CAAC;QACD,MAAM,IAAI,GAAG,OAAO;aACf,KAAK,CAAC,GAAG,CAAC;aACV,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,oBAAoB,EAAE,MAAM,CAAC,CAAC;aACvD,IAAI,CAAC,WAAW,CAAC,CAAC;QACvB,OAAO,IAAI,MAAM,CAAC,IAAI,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC/C,CAAC;AACL,CAAC,EA3CgB,gBAAgB,aAAhB,gBAAgB,GAAhB,gBAAgB,QA2ChC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"permission-policy.spec.d.ts","sourceRoot":"","sources":["../../src/node/permission-policy.spec.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
const bun_test_1 = require("bun:test");
|
|
4
|
+
const permission_policy_1 = require("./permission-policy");
|
|
5
|
+
const file = {
|
|
6
|
+
default: 'allow',
|
|
7
|
+
rules: [
|
|
8
|
+
{ tool: 'bash', command: 'git push*', action: 'ask' },
|
|
9
|
+
{ tool: 'bash', command: '*rm -rf*', action: 'deny' },
|
|
10
|
+
{ path: '*/.env*', action: 'deny' },
|
|
11
|
+
],
|
|
12
|
+
};
|
|
13
|
+
(0, bun_test_1.describe)('PermissionPolicy', () => {
|
|
14
|
+
(0, bun_test_1.it)('applies the first rule that matches', () => {
|
|
15
|
+
(0, bun_test_1.expect)(permission_policy_1.PermissionPolicy.decide(file, 'bash', { command: 'git push origin main' })).toBe('ask');
|
|
16
|
+
(0, bun_test_1.expect)(permission_policy_1.PermissionPolicy.decide(file, 'bash', { command: 'cd a && rm -rf b' })).toBe('deny');
|
|
17
|
+
(0, bun_test_1.expect)(permission_policy_1.PermissionPolicy.decide(file, 'read', { path: '/repo/.env.local' })).toBe('deny');
|
|
18
|
+
});
|
|
19
|
+
(0, bun_test_1.it)('falls back to the default', () => {
|
|
20
|
+
(0, bun_test_1.expect)(permission_policy_1.PermissionPolicy.decide(file, 'bash', { command: 'ls' })).toBe('allow');
|
|
21
|
+
(0, bun_test_1.expect)(permission_policy_1.PermissionPolicy.decide({ default: 'ask' }, 'bash', {})).toBe('ask');
|
|
22
|
+
(0, bun_test_1.expect)(permission_policy_1.PermissionPolicy.decide({}, 'bash', {})).toBe('allow');
|
|
23
|
+
});
|
|
24
|
+
(0, bun_test_1.it)('does not apply a rule to a call without the field it matches', () => {
|
|
25
|
+
(0, bun_test_1.expect)(permission_policy_1.PermissionPolicy.decide({ rules: [{ command: '*', action: 'deny' }] }, 'read', { path: 'a' })).toBe('allow');
|
|
26
|
+
});
|
|
27
|
+
(0, bun_test_1.it)('takes patterns literally except for the star', () => {
|
|
28
|
+
(0, bun_test_1.expect)(permission_policy_1.PermissionPolicy.decide({ rules: [{ path: 'a.b', action: 'deny' }] }, 'read', { path: 'axb' })).toBe('allow');
|
|
29
|
+
});
|
|
30
|
+
(0, bun_test_1.it)('lets a project tighten, not loosen', () => {
|
|
31
|
+
(0, bun_test_1.expect)(permission_policy_1.PermissionPolicy.strictest(['deny', 'allow'])).toBe('deny');
|
|
32
|
+
(0, bun_test_1.expect)(permission_policy_1.PermissionPolicy.strictest(['allow', 'ask'])).toBe('ask');
|
|
33
|
+
});
|
|
34
|
+
(0, bun_test_1.it)('refuses a file with an unknown action or broken JSON', () => {
|
|
35
|
+
(0, bun_test_1.expect)(() => permission_policy_1.PermissionPolicy.parse('{"default":"maybe"}')).toThrow('maybe');
|
|
36
|
+
(0, bun_test_1.expect)(() => permission_policy_1.PermissionPolicy.parse('{')).toThrow();
|
|
37
|
+
});
|
|
38
|
+
});
|
|
39
|
+
//# sourceMappingURL=permission-policy.spec.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"permission-policy.spec.js","sourceRoot":"","sources":["../../src/node/permission-policy.spec.ts"],"names":[],"mappings":";;AAAA,uCAAgD;AAChD,2DAA4E;AAE5E,MAAM,IAAI,GAAmB;IACzB,OAAO,EAAE,OAAO;IAChB,KAAK,EAAE;QACH,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,KAAK,EAAE;QACrD,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE;QACrD,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE;KACtC;CACJ,CAAC;AAEF,IAAA,mBAAQ,EAAC,kBAAkB,EAAE,GAAG,EAAE;IAC9B,IAAA,aAAE,EAAC,qCAAqC,EAAE,GAAG,EAAE;QAC3C,IAAA,iBAAM,EAAC,oCAAgB,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,sBAAsB,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC/F,IAAA,iBAAM,EAAC,oCAAgB,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC5F,IAAA,iBAAM,EAAC,oCAAgB,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC7F,CAAC,CAAC,CAAC;IAEH,IAAA,aAAE,EAAC,2BAA2B,EAAE,GAAG,EAAE;QACjC,IAAA,iBAAM,EAAC,oCAAgB,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC/E,IAAA,iBAAM,EAAC,oCAAgB,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC5E,IAAA,iBAAM,EAAC,oCAAgB,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAClE,CAAC,CAAC,CAAC;IAEH,IAAA,aAAE,EAAC,8DAA8D,EAAE,GAAG,EAAE;QACpE,IAAA,iBAAM,EAAC,oCAAgB,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACxH,CAAC,CAAC,CAAC;IAEH,IAAA,aAAE,EAAC,8CAA8C,EAAE,GAAG,EAAE;QACpD,IAAA,iBAAM,EAAC,oCAAgB,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACzH,CAAC,CAAC,CAAC;IAEH,IAAA,aAAE,EAAC,oCAAoC,EAAE,GAAG,EAAE;QAC1C,IAAA,iBAAM,EAAC,oCAAgB,CAAC,SAAS,CAAC,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACnE,IAAA,iBAAM,EAAC,oCAAgB,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACrE,CAAC,CAAC,CAAC;IAEH,IAAA,aAAE,EAAC,sDAAsD,EAAE,GAAG,EAAE;QAC5D,IAAA,iBAAM,EAAC,GAAG,EAAE,CAAC,oCAAgB,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAC7E,IAAA,iBAAM,EAAC,GAAG,EAAE,CAAC,oCAAgB,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;IACxD,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,67 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@celljs/ta-permission-gate",
|
|
3
|
-
"version": "
|
|
4
|
-
"
|
|
5
|
-
"
|
|
6
|
-
|
|
3
|
+
"version": "4.5.1",
|
|
4
|
+
"description": "A pi package: allow, ask or deny tool calls by rules. Works in ta and in pi.",
|
|
5
|
+
"keywords": [
|
|
6
|
+
"pi-package"
|
|
7
|
+
],
|
|
8
|
+
"homepage": "https://github.com/cellbang/cell",
|
|
9
|
+
"bugs": {
|
|
10
|
+
"url": "https://github.com/cellbang/cell/issues"
|
|
11
|
+
},
|
|
12
|
+
"repository": {
|
|
13
|
+
"type": "git",
|
|
14
|
+
"url": "https://github.com/cellbang/cell.git"
|
|
15
|
+
},
|
|
16
|
+
"license": "MIT",
|
|
17
|
+
"engines": {
|
|
18
|
+
"node": ">=22.19.0"
|
|
19
|
+
},
|
|
20
|
+
"main": "lib/node/index.js",
|
|
21
|
+
"typings": "lib/node/index.d.ts",
|
|
22
|
+
"files": [
|
|
23
|
+
"lib",
|
|
24
|
+
"esm",
|
|
25
|
+
"src"
|
|
26
|
+
],
|
|
27
|
+
"scripts": {
|
|
28
|
+
"build": "tsc -b && bun ../../scripts/build-esm.ts",
|
|
29
|
+
"clean": "rm -rf lib esm *.tsbuildinfo",
|
|
30
|
+
"test": "bun test ./lib",
|
|
31
|
+
"watch": "tsc -b -w --preserveWatchOutput"
|
|
32
|
+
},
|
|
33
|
+
"peerDependencies": {
|
|
34
|
+
"@earendil-works/pi-coding-agent": "^1.5.0"
|
|
35
|
+
},
|
|
36
|
+
"devDependencies": {
|
|
37
|
+
"@earendil-works/pi-coding-agent": "^1.5.0"
|
|
38
|
+
},
|
|
39
|
+
"publishConfig": {
|
|
40
|
+
"access": "public"
|
|
41
|
+
},
|
|
42
|
+
"pi": {
|
|
43
|
+
"extensions": [
|
|
44
|
+
"./lib/node/index.js"
|
|
45
|
+
]
|
|
46
|
+
},
|
|
47
|
+
"exports": {
|
|
48
|
+
".": {
|
|
49
|
+
"import": "./esm/node/index.js",
|
|
50
|
+
"default": "./lib/node/index.js"
|
|
51
|
+
},
|
|
52
|
+
"./package.json": "./package.json",
|
|
53
|
+
"./lib/node": {
|
|
54
|
+
"import": "./esm/node/index.js",
|
|
55
|
+
"default": "./lib/node/index.js"
|
|
56
|
+
},
|
|
57
|
+
"./lib/*.js": {
|
|
58
|
+
"import": "./esm/*.js",
|
|
59
|
+
"default": "./lib/*.js"
|
|
60
|
+
},
|
|
61
|
+
"./lib/*": {
|
|
62
|
+
"import": "./esm/*.js",
|
|
63
|
+
"default": "./lib/*.js"
|
|
64
|
+
},
|
|
65
|
+
"./*": "./*"
|
|
66
|
+
}
|
|
67
|
+
}
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
import { readFileSync } from 'node:fs';
|
|
2
|
+
import { join } from 'node:path';
|
|
3
|
+
import { CONFIG_DIR_NAME, type ExtensionAPI, type ExtensionContext, getAgentDir } from '@earendil-works/pi-coding-agent';
|
|
4
|
+
import { type PermissionAction, type PermissionFile, PermissionPolicy } from './permission-policy.js';
|
|
5
|
+
|
|
6
|
+
const FILE_NAME = 'permissions.json';
|
|
7
|
+
|
|
8
|
+
/** How long a question waits for an answer; no answer is a no. */
|
|
9
|
+
const ASK_TIMEOUT_MS = 5 * 60 * 1000;
|
|
10
|
+
|
|
11
|
+
function load(path: string): PermissionFile | undefined {
|
|
12
|
+
let text: string;
|
|
13
|
+
try {
|
|
14
|
+
text = readFileSync(path, 'utf8');
|
|
15
|
+
} catch (error) {
|
|
16
|
+
if ((error as NodeJS.ErrnoException).code === 'ENOENT') {
|
|
17
|
+
return undefined;
|
|
18
|
+
}
|
|
19
|
+
throw error;
|
|
20
|
+
}
|
|
21
|
+
return PermissionPolicy.parse(text);
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
function decide(toolName: string, input: Record<string, unknown>, cwd: string): PermissionAction {
|
|
25
|
+
const files = [load(join(getAgentDir(), FILE_NAME)), load(join(cwd, CONFIG_DIR_NAME, FILE_NAME))].filter(file => file !== undefined);
|
|
26
|
+
return PermissionPolicy.strictest(files.map(file => PermissionPolicy.decide(file, toolName, input)));
|
|
27
|
+
}
|
|
28
|
+
|
|
29
|
+
async function ask(toolName: string, input: Record<string, unknown>, ctx: ExtensionContext): Promise<boolean> {
|
|
30
|
+
return ctx.hasUI && ctx.ui.confirm(`Allow ${toolName}?`, String(input.command ?? input.path ?? JSON.stringify(input)), { timeout: ASK_TIMEOUT_MS });
|
|
31
|
+
}
|
|
32
|
+
|
|
33
|
+
/** Rules from `permissions.json` in the agent directory and the project's config directory. Nothing is restricted without them. */
|
|
34
|
+
export default function permissionGate(pi: ExtensionAPI): void {
|
|
35
|
+
pi.on('tool_call', async (event, ctx) => {
|
|
36
|
+
try {
|
|
37
|
+
const input = event.input as Record<string, unknown>;
|
|
38
|
+
const action = decide(event.toolName, input, ctx.cwd);
|
|
39
|
+
if (action === 'allow' || (action === 'ask' && (await ask(event.toolName, input, ctx)))) {
|
|
40
|
+
return undefined;
|
|
41
|
+
}
|
|
42
|
+
return { block: true, reason: action === 'ask' ? 'The user did not allow this tool call.' : `${FILE_NAME} denies this tool call.` };
|
|
43
|
+
} catch (error) {
|
|
44
|
+
return { block: true, reason: `Cannot read ${FILE_NAME}, so nothing is allowed: ${(error as Error).message}` };
|
|
45
|
+
}
|
|
46
|
+
});
|
|
47
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from './permission-policy';
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
import { describe, expect, it } from 'bun:test';
|
|
2
|
+
import { type PermissionFile, PermissionPolicy } from './permission-policy';
|
|
3
|
+
|
|
4
|
+
const file: PermissionFile = {
|
|
5
|
+
default: 'allow',
|
|
6
|
+
rules: [
|
|
7
|
+
{ tool: 'bash', command: 'git push*', action: 'ask' },
|
|
8
|
+
{ tool: 'bash', command: '*rm -rf*', action: 'deny' },
|
|
9
|
+
{ path: '*/.env*', action: 'deny' },
|
|
10
|
+
],
|
|
11
|
+
};
|
|
12
|
+
|
|
13
|
+
describe('PermissionPolicy', () => {
|
|
14
|
+
it('applies the first rule that matches', () => {
|
|
15
|
+
expect(PermissionPolicy.decide(file, 'bash', { command: 'git push origin main' })).toBe('ask');
|
|
16
|
+
expect(PermissionPolicy.decide(file, 'bash', { command: 'cd a && rm -rf b' })).toBe('deny');
|
|
17
|
+
expect(PermissionPolicy.decide(file, 'read', { path: '/repo/.env.local' })).toBe('deny');
|
|
18
|
+
});
|
|
19
|
+
|
|
20
|
+
it('falls back to the default', () => {
|
|
21
|
+
expect(PermissionPolicy.decide(file, 'bash', { command: 'ls' })).toBe('allow');
|
|
22
|
+
expect(PermissionPolicy.decide({ default: 'ask' }, 'bash', {})).toBe('ask');
|
|
23
|
+
expect(PermissionPolicy.decide({}, 'bash', {})).toBe('allow');
|
|
24
|
+
});
|
|
25
|
+
|
|
26
|
+
it('does not apply a rule to a call without the field it matches', () => {
|
|
27
|
+
expect(PermissionPolicy.decide({ rules: [{ command: '*', action: 'deny' }] }, 'read', { path: 'a' })).toBe('allow');
|
|
28
|
+
});
|
|
29
|
+
|
|
30
|
+
it('takes patterns literally except for the star', () => {
|
|
31
|
+
expect(PermissionPolicy.decide({ rules: [{ path: 'a.b', action: 'deny' }] }, 'read', { path: 'axb' })).toBe('allow');
|
|
32
|
+
});
|
|
33
|
+
|
|
34
|
+
it('lets a project tighten, not loosen', () => {
|
|
35
|
+
expect(PermissionPolicy.strictest(['deny', 'allow'])).toBe('deny');
|
|
36
|
+
expect(PermissionPolicy.strictest(['allow', 'ask'])).toBe('ask');
|
|
37
|
+
});
|
|
38
|
+
|
|
39
|
+
it('refuses a file with an unknown action or broken JSON', () => {
|
|
40
|
+
expect(() => PermissionPolicy.parse('{"default":"maybe"}')).toThrow('maybe');
|
|
41
|
+
expect(() => PermissionPolicy.parse('{')).toThrow();
|
|
42
|
+
});
|
|
43
|
+
});
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
export type PermissionAction = 'allow' | 'ask' | 'deny';
|
|
2
|
+
|
|
3
|
+
/** A rule applies when all its patterns match; `*` in a pattern stands for any characters. */
|
|
4
|
+
export interface PermissionRule {
|
|
5
|
+
/** Tool name. Default: any tool. */
|
|
6
|
+
tool?: string;
|
|
7
|
+
/** The command of a bash call. */
|
|
8
|
+
command?: string;
|
|
9
|
+
/** The path of a call of read, edit or write. */
|
|
10
|
+
path?: string;
|
|
11
|
+
action: PermissionAction;
|
|
12
|
+
}
|
|
13
|
+
|
|
14
|
+
export interface PermissionFile {
|
|
15
|
+
/** What applies when no rule does. Default: allow. */
|
|
16
|
+
default?: PermissionAction;
|
|
17
|
+
/** The first rule that applies decides. */
|
|
18
|
+
rules?: PermissionRule[];
|
|
19
|
+
}
|
|
20
|
+
|
|
21
|
+
const SEVERITY: Record<PermissionAction, number> = { allow: 0, ask: 1, deny: 2 };
|
|
22
|
+
|
|
23
|
+
export namespace PermissionPolicy {
|
|
24
|
+
/** The action on a tool call under one file. */
|
|
25
|
+
export function decide(file: PermissionFile, toolName: string, input: Record<string, unknown>): PermissionAction {
|
|
26
|
+
const rule = file.rules?.find(candidate => applies(candidate, toolName, input));
|
|
27
|
+
return rule?.action ?? file.default ?? 'allow';
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
/**
|
|
31
|
+
* The stricter action of the global and the project files: a project can only tighten what the user
|
|
32
|
+
* set, or an untrusted repository could grant itself permissions.
|
|
33
|
+
*/
|
|
34
|
+
export function strictest(actions: PermissionAction[]): PermissionAction {
|
|
35
|
+
return actions.reduce((worst, action) => (SEVERITY[action] > SEVERITY[worst] ? action : worst), 'allow');
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
/** Throws on anything that is not a valid file: the caller must then refuse, not allow. */
|
|
39
|
+
export function parse(text: string): PermissionFile {
|
|
40
|
+
const file = JSON.parse(text) as PermissionFile;
|
|
41
|
+
const actions = [...(file.default ? [file.default] : []), ...(file.rules ?? []).map(rule => rule.action)];
|
|
42
|
+
const invalid = actions.find(action => !(action in SEVERITY));
|
|
43
|
+
if (invalid !== undefined) {
|
|
44
|
+
throw new Error(`Unknown action ${String(invalid)}: use allow, ask or deny.`);
|
|
45
|
+
}
|
|
46
|
+
return file;
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
function applies(rule: PermissionRule, toolName: string, input: Record<string, unknown>): boolean {
|
|
50
|
+
return matches(rule.tool, toolName) && matches(rule.command, input.command) && matches(rule.path, input.path);
|
|
51
|
+
}
|
|
52
|
+
|
|
53
|
+
function matches(pattern: string | undefined, value: unknown): boolean {
|
|
54
|
+
if (pattern === undefined) {
|
|
55
|
+
return true;
|
|
56
|
+
}
|
|
57
|
+
if (typeof value !== 'string') {
|
|
58
|
+
return false;
|
|
59
|
+
}
|
|
60
|
+
const body = pattern
|
|
61
|
+
.split('*')
|
|
62
|
+
.map(part => part.replace(/[\\^$.|+?()[\]{}]/g, '\\$&'))
|
|
63
|
+
.join('[\\s\\S]*');
|
|
64
|
+
return new RegExp(`^${body}$`).test(value);
|
|
65
|
+
}
|
|
66
|
+
}
|