From 45a2ed9a97f23167d8af0af9db5f7f5d6d5d9d36 Mon Sep 17 00:00:00 2001 From: Shoubhit Dash Date: Thu, 10 Sep 2026 22:30:53 +0530 Subject: [PATCH] feat(core): per-session permission rules (#48351) --- packages/client/src/effect/api/api.ts | 20 ++- .../client/src/effect/generated/client.ts | 12 ++ .../client/src/promise/generated/client.ts | 15 ++ .../client/src/promise/generated/types.ts | 169 +++++++++++++----- packages/client/src/solid/data.ts | 4 + packages/core/src/database/migration.gen.ts | 2 + ...60910120000_clear_v1_session_permission.ts | 13 ++ .../core/src/database/v1-migration.bun.ts | 2 +- packages/core/src/permission.ts | 2 +- packages/core/src/plugin/host.ts | 3 + packages/core/src/session.ts | 12 +- packages/core/src/session/context.ts | 3 +- packages/core/src/session/info.ts | 1 + packages/core/src/session/message-updater.ts | 1 + packages/core/src/session/projector.ts | 10 ++ packages/core/src/session/session.ts | 11 ++ packages/core/src/session/sql.ts | 4 +- packages/core/src/session/transfer.ts | 1 + packages/core/test/permission.test.ts | 28 +++ packages/core/test/plugin/host.ts | 1 + packages/core/test/session-create.test.ts | 41 ++++- packages/plugin/src/effect/permission.ts | 2 +- packages/plugin/src/promise/adapter.ts | 1 + packages/plugin/src/promise/permission.ts | 2 +- packages/protocol/src/groups/permission.ts | 17 ++ packages/protocol/src/groups/session.ts | 2 + packages/schema/src/session-event.ts | 13 ++ packages/schema/src/session.ts | 3 + packages/schema/test/event-manifest.test.ts | 1 + packages/server/src/handlers/permission.ts | 9 + packages/server/src/handlers/session.ts | 1 + .../src/docs/content/build/plugins/index.mdx | 10 ++ 32 files changed, 362 insertions(+), 54 deletions(-) create mode 100644 packages/core/src/database/migration/20260910120000_clear_v1_session_permission.ts diff --git a/packages/client/src/effect/api/api.ts b/packages/client/src/effect/api/api.ts index dce80880878..c926159b226 100644 --- a/packages/client/src/effect/api/api.ts +++ b/packages/client/src/effect/api/api.ts @@ -11,6 +11,7 @@ import type { RelativePath } from "@opencode/schema/schema" import type { Brand } from "effect" import type { Model } from "@opencode/schema/model" import type { DateTime } from "effect" +import type { Permission } from "@opencode/schema/permission" import type { SessionMessage } from "@opencode/schema/session-message" import type { SessionInbox } from "@opencode/schema/session-inbox" import type { PromptInput } from "@opencode/schema/prompt-input" @@ -26,7 +27,6 @@ import type { Integration } from "@opencode/schema/integration" import type { Form } from "@opencode/schema/form" import type { Mcp } from "@opencode/schema/mcp" import type { Credential } from "@opencode/schema/credential" -import type { Permission } from "@opencode/schema/permission" import type { PermissionSaved } from "@opencode/schema/permission-saved" import type { FileSystem } from "@opencode/schema/filesystem" import type { Command } from "@opencode/schema/command" @@ -209,6 +209,7 @@ export type SessionCreateInput = { readonly model?: Model.Ref | undefined readonly location?: Location.Ref | undefined readonly metadata?: Session.Metadata | undefined + readonly permissions?: Permission.Ruleset | undefined } export type SessionCreateOutput = Session.Info export type SessionCreateOperation = (input?: SessionCreateInput) => Effect.Effect @@ -437,6 +438,7 @@ export type SessionLogOutput = readonly agent?: Agent.ID | undefined readonly model?: Model.Ref | undefined readonly metadata?: Session.Metadata | undefined + readonly permissions?: Permission.Ruleset | undefined readonly version: string } } @@ -489,6 +491,15 @@ export type SessionLogOutput = readonly location?: Location.Ref | undefined readonly data: { readonly sessionID: Session.ID; readonly title: string } } + | { + readonly id: Event.ID + readonly created: number + readonly metadata?: { readonly [x: string]: unknown } | undefined + readonly type: "session.permissions.updated" + readonly durable: { readonly aggregateID: string; readonly seq: Event.Seq; readonly version: Event.Version } + readonly location?: Location.Ref | undefined + readonly data: { readonly sessionID: Session.ID; readonly permissions: Permission.Ruleset } + } | { readonly id: Event.ID readonly created: number @@ -1585,6 +1596,12 @@ export type PermissionReplyOperation = ( input: PermissionReplyInput, ) => Effect.Effect +export type PermissionRulesInput = { readonly sessionID: Session.ID; readonly permissions: Permission.Ruleset } +export type PermissionRulesOutput = void +export type PermissionRulesOperation = ( + input: PermissionRulesInput, +) => Effect.Effect + export interface PermissionApi { readonly request: { readonly list: PermissionRequestListOperation } readonly saved: { readonly list: PermissionSavedListOperation; readonly remove: PermissionSavedRemoveOperation } @@ -1592,6 +1609,7 @@ export interface PermissionApi { readonly list: PermissionListOperation readonly get: PermissionGetOperation readonly reply: PermissionReplyOperation + readonly rules: PermissionRulesOperation } export type FileListInput = { diff --git a/packages/client/src/effect/generated/client.ts b/packages/client/src/effect/generated/client.ts index aab4a78999a..c5dac506a21 100644 --- a/packages/client/src/effect/generated/client.ts +++ b/packages/client/src/effect/generated/client.ts @@ -181,6 +181,8 @@ import type { PermissionGetOutput, PermissionReplyInput, PermissionReplyOutput, + PermissionRulesInput, + PermissionRulesOutput, FileListInput, FileListOutput, FileFindInput, @@ -395,6 +397,7 @@ const EndpointSessionCreate = (raw: RawClient["server.session"]) => (input?: Ses model: input?.["model"], location: input?.["location"], metadata: input?.["metadata"], + permissions: input?.["permissions"], }, }).pipe( Effect.mapError(mapClientError), @@ -1145,6 +1148,14 @@ const EndpointPermissionReply = (raw: RawClient["server.permission"]) => (input: }).pipe(Effect.mapError(mapClientError)), ) +const EndpointPermissionRules = (raw: RawClient["server.permission"]) => (input: PermissionRulesInput) => + preserveEffect()( + raw["session.permission.rules"]({ + params: { sessionID: input["sessionID"] }, + payload: { permissions: input["permissions"] }, + }).pipe(Effect.mapError(mapClientError)), + ) + const adaptGroupPermission = (raw: RawClient["server.permission"]) => ({ request: { list: EndpointPermissionRequestList(raw) }, saved: { list: EndpointPermissionSavedList(raw), remove: EndpointPermissionSavedRemove(raw) }, @@ -1152,6 +1163,7 @@ const adaptGroupPermission = (raw: RawClient["server.permission"]) => ({ list: EndpointPermissionList(raw), get: EndpointPermissionGet(raw), reply: EndpointPermissionReply(raw), + rules: EndpointPermissionRules(raw), }) const EndpointFileList = (raw: RawClient["server.fs"]) => (input?: FileListInput) => diff --git a/packages/client/src/promise/generated/client.ts b/packages/client/src/promise/generated/client.ts index ef1e8bf218a..cf0ce2e89c4 100644 --- a/packages/client/src/promise/generated/client.ts +++ b/packages/client/src/promise/generated/client.ts @@ -175,6 +175,8 @@ import type { PermissionGetOutput, PermissionReplyInput, PermissionReplyOutput, + PermissionRulesInput, + PermissionRulesOutput, FileReadInput, FileReadOutput, FileListInput, @@ -565,6 +567,7 @@ export function make(options: ClientOptions) { model: input?.["model"], location: input?.["location"], metadata: input?.["metadata"], + permissions: input?.["permissions"], }, successStatus: 200, declaredStatuses: [400, 401], @@ -1566,6 +1569,18 @@ export function make(options: ClientOptions) { }, requestOptions, ), + rules: (input: PermissionRulesInput, requestOptions?: RequestOptions) => + request( + { + method: "PUT", + path: `/api/session/${encodeURIComponent(input.sessionID)}/permission/rules`, + body: { permissions: input["permissions"] }, + successStatus: 204, + declaredStatuses: [400, 401, 404], + empty: true, + }, + requestOptions, + ), }, file: { read: (input: FileReadInput, requestOptions?: RequestOptions) => diff --git a/packages/client/src/promise/generated/types.ts b/packages/client/src/promise/generated/types.ts index c60b9410897..14409ac5c4d 100644 --- a/packages/client/src/promise/generated/types.ts +++ b/packages/client/src/promise/generated/types.ts @@ -551,28 +551,6 @@ export type InstructionEntryInfo = { key: InstructionEntryKey; value: JsonValue export type InstructionEntrySnapshot = Array<{ key: InstructionEntryKey; value: JsonValue; removed: boolean }> -export type SessionCreated = { - id: string - created: number - metadata?: { [x: string]: any } - type: "session.created" - durable: { aggregateID: string; seq: number; version: 1 } - location?: LocationRef - data: { - sessionID: string - projectID: string - location: LocationRef - subpath?: string - parentID?: string - slug: string - title?: string - agent?: string - model?: ModelRef - metadata?: SessionMetadata - version: string - } -} - export type SessionAgentSelected = { id: string created: number @@ -1651,24 +1629,6 @@ export type SessionInboxMove = { delivery: SessionInboxDelivery } -export type SessionInfo = { - id: string - parentID?: string - fork?: { sessionID: string; boundary: SessionForkBoundary } - projectID: string - agent?: string - model?: ModelRef - cost: MoneyUSD - tokens: TokenUsageInfo - outcome?: "succeeded" | "failed" | "interrupted" - time: { created: number; updated: number; idle?: number; viewed?: number; archived?: number } - title?: string - location: LocationRef - subpath?: string - metadata?: SessionMetadata - revert?: SessionRevert -} - export type SessionRevertStaged = { id: string created: number @@ -1912,6 +1872,58 @@ export type AgentInfo = { permissions: PermissionRuleset } +export type SessionPermissionsUpdated = { + id: string + created: number + metadata?: { [x: string]: any } + type: "session.permissions.updated" + durable: { aggregateID: string; seq: number; version: 1 } + location?: LocationRef + data: { sessionID: string; permissions: PermissionRuleset } +} + +export type SessionInfo = { + id: string + parentID?: string + fork?: { sessionID: string; boundary: SessionForkBoundary } + projectID: string + agent?: string + model?: ModelRef + cost: MoneyUSD + tokens: TokenUsageInfo + outcome?: "succeeded" | "failed" | "interrupted" + time: { created: number; updated: number; idle?: number; viewed?: number; archived?: number } + title?: string + location: LocationRef + subpath?: string + metadata?: SessionMetadata + permissions?: PermissionRuleset + revert?: SessionRevert +} + +export type SessionCreated = { + id: string + created: number + metadata?: { [x: string]: any } + type: "session.created" + durable: { aggregateID: string; seq: number; version: 1 } + location?: LocationRef + data: { + sessionID: string + projectID: string + location: LocationRef + subpath?: string + parentID?: string + slug: string + title?: string + agent?: string + model?: ModelRef + metadata?: SessionMetadata + permissions?: PermissionRuleset + version: string + } +} + export type ConfigEntry = | { type: "document" @@ -2084,8 +2096,6 @@ export type ConfigEntry = | { type: "agents"; path: string } | { type: "claude"; path: string } -export type SessionsResponse = { data: Array; cursor: { previous?: string | null; next?: string | null } } - export type SessionInboxUser = { id: string sessionID: string @@ -2140,6 +2150,8 @@ export type FormFields = [FormField, ...Array] export type FormFields2 = [FormField1, ...Array] +export type SessionsResponse = { data: Array; cursor: { previous?: string | null; next?: string | null } } + export type SessionInboxInfo = SessionInboxUser | SessionInboxSynthetic | SessionInboxCompaction | SessionInboxMove export type SessionInboxEnqueued = { @@ -2233,6 +2245,7 @@ export type SessionEventDurable = | SessionModelSelected | SessionMoved | SessionRenamed + | SessionPermissionsUpdated | SessionViewed | SessionDeleted | SessionForked @@ -2292,6 +2305,7 @@ export type V2Event = | SessionModelSelected | SessionMoved | SessionRenamed + | SessionPermissionsUpdated | SessionViewed | SessionUsageUpdated | SessionDeleted @@ -2804,6 +2818,11 @@ export type SessionCreateInput = { readonly model?: { readonly id: string; readonly providerID: string; readonly variant?: string } | null readonly location?: { readonly directory: string; readonly workspaceID?: string } | null readonly metadata?: { readonly [x: string]: JsonValue } | null + readonly permissions?: ReadonlyArray<{ + readonly action: string + readonly resource: string + readonly effect: "allow" | "deny" | "ask" + }> | null }["id"] readonly title?: { readonly id?: string | null @@ -2812,6 +2831,11 @@ export type SessionCreateInput = { readonly model?: { readonly id: string; readonly providerID: string; readonly variant?: string } | null readonly location?: { readonly directory: string; readonly workspaceID?: string } | null readonly metadata?: { readonly [x: string]: JsonValue } | null + readonly permissions?: ReadonlyArray<{ + readonly action: string + readonly resource: string + readonly effect: "allow" | "deny" | "ask" + }> | null }["title"] readonly agent?: { readonly id?: string | null @@ -2820,6 +2844,11 @@ export type SessionCreateInput = { readonly model?: { readonly id: string; readonly providerID: string; readonly variant?: string } | null readonly location?: { readonly directory: string; readonly workspaceID?: string } | null readonly metadata?: { readonly [x: string]: JsonValue } | null + readonly permissions?: ReadonlyArray<{ + readonly action: string + readonly resource: string + readonly effect: "allow" | "deny" | "ask" + }> | null }["agent"] readonly model?: { readonly id?: string | null @@ -2828,6 +2857,11 @@ export type SessionCreateInput = { readonly model?: { readonly id: string; readonly providerID: string; readonly variant?: string } | null readonly location?: { readonly directory: string; readonly workspaceID?: string } | null readonly metadata?: { readonly [x: string]: JsonValue } | null + readonly permissions?: ReadonlyArray<{ + readonly action: string + readonly resource: string + readonly effect: "allow" | "deny" | "ask" + }> | null }["model"] readonly location?: { readonly id?: string | null @@ -2836,6 +2870,11 @@ export type SessionCreateInput = { readonly model?: { readonly id: string; readonly providerID: string; readonly variant?: string } | null readonly location?: { readonly directory: string; readonly workspaceID?: string } | null readonly metadata?: { readonly [x: string]: JsonValue } | null + readonly permissions?: ReadonlyArray<{ + readonly action: string + readonly resource: string + readonly effect: "allow" | "deny" | "ask" + }> | null }["location"] readonly metadata?: { readonly id?: string | null @@ -2844,7 +2883,25 @@ export type SessionCreateInput = { readonly model?: { readonly id: string; readonly providerID: string; readonly variant?: string } | null readonly location?: { readonly directory: string; readonly workspaceID?: string } | null readonly metadata?: { readonly [x: string]: JsonValue } | null + readonly permissions?: ReadonlyArray<{ + readonly action: string + readonly resource: string + readonly effect: "allow" | "deny" | "ask" + }> | null }["metadata"] + readonly permissions?: { + readonly id?: string | null + readonly title?: string | null + readonly agent?: string | null + readonly model?: { readonly id: string; readonly providerID: string; readonly variant?: string } | null + readonly location?: { readonly directory: string; readonly workspaceID?: string } | null + readonly metadata?: { readonly [x: string]: JsonValue } | null + readonly permissions?: ReadonlyArray<{ + readonly action: string + readonly resource: string + readonly effect: "allow" | "deny" | "ask" + }> | null + }["permissions"] } export type SessionCreateOutput = { data: SessionInfo }["data"] @@ -2882,6 +2939,11 @@ export type SessionImportInput = { readonly location: { readonly directory: string; readonly workspaceID?: string } readonly subpath?: string readonly metadata?: { readonly [x: string]: JsonValue } + readonly permissions?: ReadonlyArray<{ + readonly action: string + readonly resource: string + readonly effect: "allow" | "deny" | "ask" + }> readonly revert?: { readonly messageID: string readonly partID?: string @@ -3187,6 +3249,11 @@ export type SessionImportInput = { readonly location: { readonly directory: string; readonly workspaceID?: string } readonly subpath?: string readonly metadata?: { readonly [x: string]: JsonValue } + readonly permissions?: ReadonlyArray<{ + readonly action: string + readonly resource: string + readonly effect: "allow" | "deny" | "ask" + }> readonly revert?: { readonly messageID: string readonly partID?: string @@ -3492,6 +3559,11 @@ export type SessionImportInput = { readonly location: { readonly directory: string; readonly workspaceID?: string } readonly subpath?: string readonly metadata?: { readonly [x: string]: JsonValue } + readonly permissions?: ReadonlyArray<{ + readonly action: string + readonly resource: string + readonly effect: "allow" | "deny" | "ask" + }> readonly revert?: { readonly messageID: string readonly partID?: string @@ -5753,6 +5825,19 @@ export type PermissionReplyInput = { export type PermissionReplyOutput = void +export type PermissionRulesInput = { + readonly sessionID: { readonly sessionID: string }["sessionID"] + readonly permissions: { + readonly permissions: ReadonlyArray<{ + readonly action: string + readonly resource: string + readonly effect: "allow" | "deny" | "ask" + }> + }["permissions"] +} + +export type PermissionRulesOutput = void + export type FileReadInput = { readonly location?: { readonly location?: { readonly directory?: string | undefined; readonly workspace?: string | undefined } | undefined diff --git a/packages/client/src/solid/data.ts b/packages/client/src/solid/data.ts index a3617b86607..83c6eeb32ec 100644 --- a/packages/client/src/solid/data.ts +++ b/packages/client/src/solid/data.ts @@ -695,6 +695,10 @@ export function createData(config: CreateDataInput) { }) return } + case "session.permissions.updated": + if (store.session.info[event.data.sessionID]) + setStore("session", "info", event.data.sessionID, "permissions", event.data.permissions) + return case "session.moved": { const current = store.session.info[event.data.sessionID] if (current) { diff --git a/packages/core/src/database/migration.gen.ts b/packages/core/src/database/migration.gen.ts index 382849b4ce5..0d6a015dc27 100644 --- a/packages/core/src/database/migration.gen.ts +++ b/packages/core/src/database/migration.gen.ts @@ -45,6 +45,7 @@ import m42 from "./migration/20260812181746_session_inbox.js" import m43 from "./migration/20260812213948_worktree.js" import m44 from "./migration/20260819222447_session_viewed_state.js" import m45 from "./migration/20260823191254_nullable_workspace_binding.js" +import m46 from "./migration/20260910120000_clear_v1_session_permission.js" export const migrations = [ m00, @@ -93,4 +94,5 @@ export const migrations = [ m43, m44, m45, + m46, ] satisfies DatabaseMigration.Migration[] diff --git a/packages/core/src/database/migration/20260910120000_clear_v1_session_permission.ts b/packages/core/src/database/migration/20260910120000_clear_v1_session_permission.ts new file mode 100644 index 00000000000..65a13bebb87 --- /dev/null +++ b/packages/core/src/database/migration/20260910120000_clear_v1_session_permission.ts @@ -0,0 +1,13 @@ +import { Effect } from "effect" +import type { DatabaseMigration } from "../migration.js" + +const migration: DatabaseMigration.Migration = { + id: "20260910120000_clear_v1_session_permission", + up(tx) { + return Effect.gen(function* () { + yield* tx.run(`UPDATE \`session_v2\` SET \`permission\` = NULL;`) + }) + }, +} + +export default migration diff --git a/packages/core/src/database/v1-migration.bun.ts b/packages/core/src/database/v1-migration.bun.ts index 4609b03af99..8378b5d8a24 100644 --- a/packages/core/src/database/v1-migration.bun.ts +++ b/packages/core/src/database/v1-migration.bun.ts @@ -600,7 +600,7 @@ export function run(options: Options = {}): Effect.Effect, rules: Permission.Ruleset) { diff --git a/packages/core/src/plugin/host.ts b/packages/core/src/plugin/host.ts index 44beadcc6cc..bd95149db81 100644 --- a/packages/core/src/plugin/host.ts +++ b/packages/core/src/plugin/host.ts @@ -404,6 +404,7 @@ export const make = Effect.fn("PluginHost.make")(function* ( : Effect.fail(new Error(`Permission request not found: ${input.requestID}`)), ), ), + rules: sessions.setPermissions, }, plugin: { list: () => response(plugin.list()), @@ -509,6 +510,8 @@ export const make = Effect.fn("PluginHost.make")(function* ( title: input?.title, agent: input?.agent, model: input?.model, + metadata: input?.metadata, + permissions: input?.permissions, location: input?.location ?? Location.Ref.make({ directory: location.directory, workspaceID: location.workspaceID }), }), diff --git a/packages/core/src/session.ts b/packages/core/src/session.ts index cd746c6e7ee..89cae632614 100644 --- a/packages/core/src/session.ts +++ b/packages/core/src/session.ts @@ -18,6 +18,7 @@ import { SessionMessageTable } from "./session/sql.js" import { SessionSchema } from "./session/schema.js" import { RelativePath } from "./schema.js" import { Agent } from "@opencode/schema/agent" +import type { Permission } from "@opencode/schema/permission" import { App } from "./app.js" import { Slug } from "./util/slug.js" import path from "path" @@ -81,6 +82,7 @@ type CreateBaseInput = { agent?: Agent.ID model?: Model.Ref metadata?: SessionSchema.Metadata + permissions?: Permission.Ruleset } type CreateInput = CreateBaseInput & ({ location: Location.Ref; parentID?: never } | { parentID: SessionSchema.ID; location?: never }) @@ -157,6 +159,10 @@ export interface Interface { readonly switchAgent: (input: { sessionID: SessionSchema.ID; agent: Agent.ID }) => Effect.Effect readonly switchModel: (input: { sessionID: SessionSchema.ID; model: Model.Ref }) => Effect.Effect readonly rename: (input: { sessionID: SessionSchema.ID; title: string }) => Effect.Effect + readonly setPermissions: (input: { + sessionID: SessionSchema.ID + permissions: Permission.Ruleset + }) => Effect.Effect readonly move: SessionMove.Interface["move"] readonly prompt: ( input: Parameters[0] & { sessionID: SessionSchema.ID }, @@ -248,9 +254,10 @@ const layer = Layer.effect( subpath: RelativePath.make(path.relative(project.directory, location.directory).replaceAll("\\", "/")), title: input.title, agent: input.agent, - // Children inherit metadata the way they inherit location, so - // host policies that read it treat the family uniformly. + // Children inherit metadata and permissions the way they inherit + // location, so host policies that read them treat the family uniformly. metadata: input.metadata ?? parent?.metadata, + permissions: input.permissions ?? parent?.permissions, model: input.model ? { id: Model.ID.make(input.model.id), @@ -387,6 +394,7 @@ const layer = Layer.effect( switchAgent: (input) => sessions.forSession(input.sessionID).switchAgent(input), switchModel: (input) => sessions.forSession(input.sessionID).switchModel(input), rename: (input) => sessions.forSession(input.sessionID).rename(input), + setPermissions: (input) => sessions.forSession(input.sessionID).setPermissions(input), move: moves.move, compact: (input) => sessions.forSession(input.sessionID).compact(input), wait: (sessionID) => sessions.forSession(sessionID).wait(), diff --git a/packages/core/src/session/context.ts b/packages/core/src/session/context.ts index 62df1219a70..63b7a3f4b22 100644 --- a/packages/core/src/session/context.ts +++ b/packages/core/src/session/context.ts @@ -1,6 +1,7 @@ export * as SessionContext from "./context.js" import { Model } from "@opencode/schema/model" +import { Permission } from "../permission.js" import { Context, Effect, Layer } from "effect" import { Agent } from "../agent.js" import { Catalog } from "../catalog.js" @@ -129,7 +130,7 @@ const layer = Layer.effect( if (!agent.info) return yield* new AgentNotFoundError({ sessionID: session.id, agent: session.agent ?? agent.id }) const loaded = yield* Effect.all( { - tools: registry.snapshot(agent.info.permissions), + tools: registry.snapshot(Permission.merge(agent.info.permissions, session.permissions ?? [])), builtins: builtins.load(sessionID), discovery: discovery.load(), skills: skillInstructions.load(agent), diff --git a/packages/core/src/session/info.ts b/packages/core/src/session/info.ts index 1ae8adc3a20..1cab33c27aa 100644 --- a/packages/core/src/session/info.ts +++ b/packages/core/src/session/info.ts @@ -50,6 +50,7 @@ export function fromRow(row: typeof SessionTable.$inferSelect): SessionSchema.In }), subpath: row.path ? RelativePath.make(row.path) : undefined, metadata: row.metadata ?? undefined, + permissions: row.permission ?? undefined, revert: row.revert ? decodeRevert(row.revert) : undefined, outcome: row.idle_outcome ?? undefined, time: { diff --git a/packages/core/src/session/message-updater.ts b/packages/core/src/session/message-updater.ts index eaf5ecaca12..e78b656ab96 100644 --- a/packages/core/src/session/message-updater.ts +++ b/packages/core/src/session/message-updater.ts @@ -116,6 +116,7 @@ export function update(adapter: Adapter, event: SessionEvent.DurableEvent) { ) }), "session.renamed": () => Effect.void, + "session.permissions.updated": () => Effect.void, "session.deleted": () => Effect.void, "session.forked": () => Effect.void, "session.inbox.delivered": () => Effect.void, diff --git a/packages/core/src/session/projector.ts b/packages/core/src/session/projector.ts index dbc9d90950d..2baf71a610b 100644 --- a/packages/core/src/session/projector.ts +++ b/packages/core/src/session/projector.ts @@ -160,6 +160,7 @@ const projectFork = Effect.fn("SessionProjector.projectFork")(function* ( agent: parent.agent, model: parent.model, metadata: parent.metadata, + permission: parent.permission, version: parent.version, cost: 0, tokens_input: 0, @@ -450,6 +451,7 @@ const layer = Layer.effectDiscard( agent: event.data.agent, model: event.data.model, metadata: event.data.metadata, + permission: event.data.permissions, version: event.data.version, time_created: event.created, time_updated: event.created, @@ -571,6 +573,14 @@ const layer = Layer.effectDiscard( .run() .pipe(Effect.orDie), ) + yield* bus.project(SessionEvent.PermissionsUpdated, (event) => + db + .update(SessionTable) + .set({ permission: event.data.permissions, time_updated: event.created }) + .where(eq(SessionTable.id, event.data.sessionID)) + .run() + .pipe(Effect.orDie), + ) yield* bus.project(SessionEvent.Viewed, (event) => { const idle = event.data.idle return db diff --git a/packages/core/src/session/session.ts b/packages/core/src/session/session.ts index dce27961503..c8bac4bf632 100644 --- a/packages/core/src/session/session.ts +++ b/packages/core/src/session/session.ts @@ -3,6 +3,7 @@ export * as Session from "./session.js" import { DateTime, Effect, Fiber, Scope } from "effect" import type { Agent } from "@opencode/schema/agent" import type { Model } from "@opencode/schema/model" +import type { Permission } from "@opencode/schema/permission" import { Event } from "@opencode/schema/event" import { FSUtil } from "@opencode/util/fs-util" import { Bus } from "../bus.js" @@ -72,6 +73,13 @@ export const make = Effect.fn("Session.make")(function* () { yield* get(sessionID) yield* bus.publish(SessionEvent.Renamed, { sessionID, title: input.title }) }) + const setPermissions = Effect.fn("Session.setPermissions")(function* ( + sessionID: SessionSchema.ID, + input: { permissions: Permission.Ruleset }, + ) { + yield* get(sessionID) + yield* bus.publish(SessionEvent.PermissionsUpdated, { sessionID, permissions: input.permissions }) + }) const switchAgent = Effect.fn("Session.switchAgent")(function* ( sessionID: SessionSchema.ID, input: { agent: Agent.ID }, @@ -334,6 +342,7 @@ export const make = Effect.fn("Session.make")(function* () { message, view, rename, + setPermissions, switchAgent, switchModel, inbox, @@ -356,6 +365,7 @@ export const make = Effect.fn("Session.make")(function* () { const message = operations.message.bind(undefined, sessionID) const view = operations.view.bind(undefined, sessionID) const rename = operations.rename.bind(undefined, sessionID) + const setPermissions = operations.setPermissions.bind(undefined, sessionID) const switchAgent = operations.switchAgent.bind(undefined, sessionID) const switchModel = operations.switchModel.bind(undefined, sessionID) const inbox = operations.inbox.bind(undefined, sessionID) @@ -381,6 +391,7 @@ export const make = Effect.fn("Session.make")(function* () { message, view, rename, + setPermissions, switchAgent, switchModel, inbox, diff --git a/packages/core/src/session/sql.ts b/packages/core/src/session/sql.ts index 59d3a7231da..4465d885b33 100644 --- a/packages/core/src/session/sql.ts +++ b/packages/core/src/session/sql.ts @@ -5,7 +5,7 @@ import { ProjectTable } from "../project/sql.js" import type { SessionMessage } from "./message.js" import type { SessionInbox } from "./inbox.js" import type { FileDiff } from "@opencode/schema/file-diff" -import type { PermissionV1 } from "@opencode/schema/permission-v1" +import type { Permission } from "@opencode/schema/permission" import type { Project } from "@opencode/schema/project" import type { SessionSchema } from "./schema.js" import type { Workspace } from "@opencode/schema/workspace" @@ -49,7 +49,7 @@ export const SessionTable = sqliteTable( tokens_cache_read: integer().notNull().default(0), tokens_cache_write: integer().notNull().default(0), revert: text({ mode: "json" }).$type(), - permission: text({ mode: "json" }).$type(), + permission: text({ mode: "json" }).$type(), agent: text(), model: text({ mode: "json" }).$type<{ id: string diff --git a/packages/core/src/session/transfer.ts b/packages/core/src/session/transfer.ts index 9f018c66b12..ba7c296fd50 100644 --- a/packages/core/src/session/transfer.ts +++ b/packages/core/src/session/transfer.ts @@ -103,6 +103,7 @@ const layer = Layer.effect( agent: input.data.info.agent, model: input.data.info.model, metadata: input.data.info.metadata, + permissions: input.data.info.permissions, }, { location: input.location, diff --git a/packages/core/test/permission.test.ts b/packages/core/test/permission.test.ts index 54ae17bb28a..d7298cfdd85 100644 --- a/packages/core/test/permission.test.ts +++ b/packages/core/test/permission.test.ts @@ -224,6 +224,34 @@ describe("Permission", () => { }), ) + it.effect("merges session rules after agent rules and before saved approvals", () => + Effect.gen(function* () { + yield* setup([{ action: "*", resource: "*", effect: "allow" }]) + const { db } = yield* Database.Service + const service = yield* Permission.Service + const setSession = (permission: Permission.Ruleset) => + db + .update(SessionTable) + .set({ permission }) + .where(eq(SessionTable.id, Session.ID.make("ses_test"))) + .run() + .pipe(Effect.orDie) + + yield* setSession([{ action: "edit", resource: "/original/**", effect: "deny" }]) + expect(yield* service.ask(assertion({ action: "edit", resources: ["/original/src/index.ts"] }))).toMatchObject({ + effect: "deny", + }) + + yield* setRules([]) + const saved = yield* PermissionSaved.Service + yield* saved.add({ projectID: Project.ID.global, action: "bash", resources: ["pwd"] }) + yield* setSession([{ action: "bash", resource: "*", effect: "deny" }]) + expect(yield* service.ask(assertion({ action: "bash", resources: ["pwd"] }))).toMatchObject({ effect: "deny" }) + yield* setSession([{ action: "bash", resource: "*", effect: "ask" }]) + expect(yield* service.ask(assertion({ action: "bash", resources: ["pwd"] }))).toMatchObject({ effect: "allow" }) + }), + ) + it.effect("uses saved bash approvals while preserving configured deny precedence", () => Effect.gen(function* () { yield* setup() diff --git a/packages/core/test/plugin/host.ts b/packages/core/test/plugin/host.ts index 3cbe696ab4e..470f8fc519e 100644 --- a/packages/core/test/plugin/host.ts +++ b/packages/core/test/plugin/host.ts @@ -108,6 +108,7 @@ export function host(overrides: Overrides = {}): Plugin.Context { list: () => Effect.die("unused permission.list"), get: () => Effect.die("unused permission.get"), reply: () => Effect.die("unused permission.reply"), + rules: () => Effect.die("unused permission.rules"), }, plugin: overrides.plugin ?? { list: () => Effect.die("unused plugin.list"), diff --git a/packages/core/test/session-create.test.ts b/packages/core/test/session-create.test.ts index dc2f31ee5ea..bcd5b81cc40 100644 --- a/packages/core/test/session-create.test.ts +++ b/packages/core/test/session-create.test.ts @@ -388,6 +388,32 @@ describe("Session.create", () => { }), ) + it.effect("stores permission rules, inherits them through children and forks, and replaces them", () => + Effect.gen(function* () { + const session = yield* Session.Service + const bus = yield* Bus.Service + const { db } = yield* Database.Service + const permissions = [{ action: "edit", resource: "/original/**", effect: "deny" as const }] + + const created = yield* session.create({ location, permissions }) + expect(created.permissions).toEqual(permissions) + expect((yield* session.create({ parentID: created.id })).permissions).toEqual(permissions) + expect((yield* session.create({ parentID: created.id, permissions: [] })).permissions).toEqual([]) + + yield* session.prompt({ sessionID: created.id, text: "Fork context", resume: false }) + yield* SessionInbox.promote(db, bus, created.id, "steer") + const forked = yield* session.fork({ sessionID: created.id, boundary: { type: "through" } }) + expect(forked.permissions).toEqual(permissions) + + const replaced = [{ action: "shell", resource: "*", effect: "ask" as const }] + yield* session.setPermissions({ sessionID: created.id, permissions: replaced }) + expect((yield* session.get(created.id)).permissions).toEqual(replaced) + expect( + yield* session.setPermissions({ sessionID: Session.ID.create(), permissions: replaced }).pipe(Effect.flip), + ).toBeInstanceOf(Session.NotFoundError) + }), + ) + it.effect("inherits location from an existing parent when omitted", () => Effect.gen(function* () { const session = yield* Session.Service @@ -1330,7 +1356,12 @@ describe("SessionTransfer", () => { const transfer = yield* SessionTransfer.Service const bus = yield* Bus.Service const { db } = yield* Database.Service - const template = yield* session.create({ location, title: "Exported", metadata: { channel: "C123" } }) + const template = yield* session.create({ + location, + title: "Exported", + metadata: { channel: "C123" }, + permissions: [{ action: "edit", resource: "*", effect: "deny" }], + }) const sessionID = Session.ID.create() const sourceMessageID = SessionMessage.ID.create() const errorMessageID = SessionMessage.ID.create() @@ -1376,7 +1407,13 @@ describe("SessionTransfer", () => { }) const messages = yield* session.messages({ sessionID, order: "asc" }) - expect(imported).toMatchObject({ id: sessionID, title: "Exported", location, metadata: { channel: "C123" } }) + expect(imported).toMatchObject({ + id: sessionID, + title: "Exported", + location, + metadata: { channel: "C123" }, + permissions: [{ action: "edit", resource: "*", effect: "deny" }], + }) expect(imported.time).toMatchObject({ updated: DateTime.makeUnsafe(1_000), idle: DateTime.makeUnsafe(200), diff --git a/packages/plugin/src/effect/permission.ts b/packages/plugin/src/effect/permission.ts index e97fbf3ebe5..086ba994bf2 100644 --- a/packages/plugin/src/effect/permission.ts +++ b/packages/plugin/src/effect/permission.ts @@ -19,6 +19,6 @@ export interface PermissionHooks { readonly evaluate: PermissionEvaluation } -export type PermissionDomain = Pick, "list" | "get" | "reply"> & { +export type PermissionDomain = Pick, "list" | "get" | "reply" | "rules"> & { readonly hook: Hooks } diff --git a/packages/plugin/src/promise/adapter.ts b/packages/plugin/src/promise/adapter.ts index 4b94209cd5f..ca6373cd2f3 100644 --- a/packages/plugin/src/promise/adapter.ts +++ b/packages/plugin/src/promise/adapter.ts @@ -438,6 +438,7 @@ export function fromPromise(plugin: Plugin) { list: adaptApiMethod(PermissionEndpoints["session.permission.list"], host.permission.list), get: adaptApiMethod(PermissionEndpoints["session.permission.get"], host.permission.get), reply: adaptApiMethod(PermissionEndpoints["session.permission.reply"], host.permission.reply), + rules: adaptApiMethod(PermissionEndpoints["session.permission.rules"], host.permission.rules), }, plugin: { list: adaptApiMethod(PluginEndpoints["plugin.list"], host.plugin.list), diff --git a/packages/plugin/src/promise/permission.ts b/packages/plugin/src/promise/permission.ts index 1729cac29b5..daf920f5f5c 100644 --- a/packages/plugin/src/promise/permission.ts +++ b/packages/plugin/src/promise/permission.ts @@ -19,6 +19,6 @@ export interface PermissionHooks { readonly evaluate: PermissionEvaluation } -export type PermissionDomain = Pick & { +export type PermissionDomain = Pick & { readonly hook: Hooks } diff --git a/packages/protocol/src/groups/permission.ts b/packages/protocol/src/groups/permission.ts index 64cf8a81898..9ab14b77760 100644 --- a/packages/protocol/src/groups/permission.ts +++ b/packages/protocol/src/groups/permission.ts @@ -132,4 +132,21 @@ export const makePermissionGroup = < }), ), ) + .add( + HttpApiEndpoint.put("session.permission.rules", "/api/session/:sessionID/permission/rules", { + params: { sessionID: Session.ID }, + payload: Schema.Struct({ permissions: Permission.Ruleset }), + success: HttpApiSchema.NoContent, + error: SessionNotFoundError, + }) + .middleware(sessionLocationMiddleware) + .annotateMerge( + OpenApi.annotations({ + identifier: "v2.session.permission.rules", + summary: "Replace session permission rules", + description: + "Replace the session-scoped permission rules. Rules are evaluated after the agent's rules, and the last matching rule wins.", + }), + ), + ) .annotateMerge(OpenApi.annotations({ title: "permission", description: "Experimental permission routes." })) diff --git a/packages/protocol/src/groups/session.ts b/packages/protocol/src/groups/session.ts index 9a1182ad349..df377b3f11a 100644 --- a/packages/protocol/src/groups/session.ts +++ b/packages/protocol/src/groups/session.ts @@ -27,6 +27,7 @@ import { import { Agent } from "@opencode/schema/agent" import { Skill } from "@opencode/schema/skill" import { Model } from "@opencode/schema/model" +import { Permission } from "@opencode/schema/permission" import { Location } from "@opencode/schema/location" import { SessionEvent } from "@opencode/schema/session-event" import { EventLog } from "@opencode/schema/event-log" @@ -175,6 +176,7 @@ export const makeSessionGroup = (sessionLo model: Model.Ref.pipe(Schema.optional), location: Location.Ref.pipe(Schema.optional), metadata: Session.Metadata.pipe(Schema.optional), + permissions: Permission.Ruleset.pipe(Schema.optional), }), success: Schema.Struct({ data: Session.Info }), }).annotateMerge( diff --git a/packages/schema/src/session-event.ts b/packages/schema/src/session-event.ts index c22a901ce40..6e43890ff8a 100644 --- a/packages/schema/src/session-event.ts +++ b/packages/schema/src/session-event.ts @@ -25,6 +25,7 @@ import { TokenUsage } from "./token-usage.js" import { SessionInbox } from "./session-inbox.js" import { Project } from "./project.js" import { SessionFork } from "./session-fork.js" +import { Permission } from "./permission.js" export { FileAttachment } @@ -62,6 +63,7 @@ export const Created = Event.durable({ model: Model.Ref.pipe(optional), /** Host-supplied annotations resolved at creation, including any inherited from a parent. */ metadata: SessionMetadata.pipe(optional), + permissions: Permission.Ruleset.pipe(optional), version: Schema.String, }, }) @@ -109,6 +111,16 @@ export const Renamed = Event.durable({ }) export type Renamed = typeof Renamed.Type +export const PermissionsUpdated = Event.durable({ + type: "session.permissions.updated", + ...options, + schema: { + ...Base, + permissions: Permission.Ruleset, + }, +}) +export type PermissionsUpdated = typeof PermissionsUpdated.Type + export const Viewed = Event.durable({ type: "session.viewed", ...options, @@ -634,6 +646,7 @@ export const Definitions = Event.inventory( ModelSelected, Moved, Renamed, + PermissionsUpdated, Viewed, UsageUpdated, Deleted, diff --git a/packages/schema/src/session.ts b/packages/schema/src/session.ts index 530b1ac9be3..c36a8c519e5 100644 --- a/packages/schema/src/session.ts +++ b/packages/schema/src/session.ts @@ -10,6 +10,7 @@ import { SessionEvent } from "./session-event.js" import { SessionID } from "./session-id.js" import { SessionMetadata } from "./session-metadata.js" import { Money } from "./money.js" +import { Permission } from "./permission.js" import { TokenUsage } from "./token-usage.js" import { Revert } from "./session-revert.js" import { SessionFork } from "./session-fork.js" @@ -54,6 +55,8 @@ export const Info = Schema.Struct({ location: Location.Ref, subpath: RelativePath.pipe(optional), metadata: Metadata.pipe(optional), + /** Evaluated after the agent's rules; the last matching rule wins. */ + permissions: Permission.Ruleset.pipe(optional), revert: Revert.pipe(optional), }).annotate({ identifier: "Session.Info" }) diff --git a/packages/schema/test/event-manifest.test.ts b/packages/schema/test/event-manifest.test.ts index af19dd2c9e2..05019c28c1b 100644 --- a/packages/schema/test/event-manifest.test.ts +++ b/packages/schema/test/event-manifest.test.ts @@ -115,6 +115,7 @@ describe("public event manifest", () => { "session.model.selected.1", "session.moved.1", "session.renamed.1", + "session.permissions.updated.1", "session.viewed.1", "session.message.content.updated.1", "session.usage.recorded.1", diff --git a/packages/server/src/handlers/permission.ts b/packages/server/src/handlers/permission.ts index 823b5fcac97..bd2bc6b09c3 100644 --- a/packages/server/src/handlers/permission.ts +++ b/packages/server/src/handlers/permission.ts @@ -83,6 +83,15 @@ export const PermissionHandler = HttpApiBuilder.group(Api, "server.permission", return HttpApiSchema.NoContent.make() }), ) + .handle( + "session.permission.rules", + Effect.fn(function* (ctx) { + yield* sessions + .setPermissions({ sessionID: ctx.params.sessionID, permissions: ctx.payload.permissions }) + .pipe(Effect.catchTag("Session.NotFoundError", missingSession)) + return HttpApiSchema.NoContent.make() + }), + ) .handle( "permission.saved.list", Effect.fn(function* (ctx) { diff --git a/packages/server/src/handlers/session.ts b/packages/server/src/handlers/session.ts index 6646a1b486f..710647d2e03 100644 --- a/packages/server/src/handlers/session.ts +++ b/packages/server/src/handlers/session.ts @@ -120,6 +120,7 @@ export const SessionHandler = HttpApiBuilder.group(Api, "server.session", (handl agent: ctx.payload.agent, model: ctx.payload.model, metadata: ctx.payload.metadata, + permissions: ctx.payload.permissions, location: ctx.payload.location ?? { directory: AbsolutePath.make(process.cwd()) }, }) .pipe(Effect.orDie), diff --git a/services/www/src/docs/content/build/plugins/index.mdx b/services/www/src/docs/content/build/plugins/index.mdx index ab756b93c18..38672d81287 100644 --- a/services/www/src/docs/content/build/plugins/index.mdx +++ b/services/www/src/docs/content/build/plugins/index.mdx @@ -656,6 +656,16 @@ const request = await ctx.permission.get({ sessionID, requestID }) await ctx.permission.reply({ sessionID, requestID, reply: "once" }) ``` +Replace the session-scoped permission rules. They are evaluated after the agent's rules, and the +last matching rule wins. Child sessions inherit the rules in effect when they are created. + +```ts +await ctx.permission.rules({ + sessionID, + permissions: [{ action: "edit", resource: "/path/to/original/checkout/**", effect: "deny" }], +}) +``` + ### Sessions Create or read a session.