Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion bun.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 12 additions & 0 deletions packages/opencode/src/cli/cmd/tui/component/prompt/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -782,6 +782,18 @@ export function Prompt(props: PromptProps) {
e.preventDefault()
return
}
if (keybind.match("input_copy", e)) {
const selection = input.visualCursor.selection
if (selection) {
const start = Math.min(selection.start, selection.end)
const end = Math.max(selection.start, selection.end)
const text = input.plainText.slice(start, end)
if (text) {
await Clipboard.write(text)
return
}
}
}
// Handle clipboard paste (Ctrl+V) - check for images first on Windows
// This is needed because Windows terminal doesn't properly send image data
// through bracketed paste, so we need to intercept the keypress and
Expand Down
13 changes: 7 additions & 6 deletions packages/opencode/src/config/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -645,7 +645,7 @@ export namespace Config {
session_rename: z.string().optional().default("ctrl+r").describe("Rename session"),
session_delete: z.string().optional().default("ctrl+d").describe("Delete session"),
stash_delete: z.string().optional().default("ctrl+d").describe("Delete stash entry"),
model_provider_list: z.string().optional().default("ctrl+a").describe("Open provider list from model dialog"),
model_provider_list: z.string().optional().default("ctrl+alt+m").describe("Open provider list from model dialog"),
model_favorite_toggle: z.string().optional().default("ctrl+f").describe("Toggle model favorite status"),
session_share: z.string().optional().default("none").describe("Share current session"),
session_unshare: z.string().optional().default("none").describe("Unshare current session"),
Expand Down Expand Up @@ -690,7 +690,8 @@ export namespace Config {
agent_cycle_reverse: z.string().optional().default("shift+tab").describe("Previous agent"),
variant_cycle: z.string().optional().default("ctrl+t").describe("Cycle model variants"),
input_clear: z.string().optional().default("ctrl+c").describe("Clear input field"),
input_paste: z.string().optional().default("ctrl+v").describe("Paste from clipboard"),
input_copy: z.string().optional().default("ctrl+c,super+c").describe("Copy from input"),
input_paste: z.string().optional().default("ctrl+v,super+v").describe("Paste from clipboard"),
input_submit: z.string().optional().default("return").describe("Submit input"),
input_newline: z
.string()
Expand All @@ -699,8 +700,8 @@ export namespace Config {
.describe("Insert newline in input"),
input_move_left: z.string().optional().default("left,ctrl+b").describe("Move cursor left in input"),
input_move_right: z.string().optional().default("right,ctrl+f").describe("Move cursor right in input"),
input_move_up: z.string().optional().default("up").describe("Move cursor up in input"),
input_move_down: z.string().optional().default("down").describe("Move cursor down in input"),
input_move_up: z.string().optional().default("up,ctrl+p").describe("Move cursor up in input"),
input_move_down: z.string().optional().default("down,ctrl+n").describe("Move cursor down in input"),
input_select_left: z.string().optional().default("shift+left").describe("Select left in input"),
input_select_right: z.string().optional().default("shift+right").describe("Select right in input"),
input_select_up: z.string().optional().default("shift+up").describe("Select up in input"),
Expand Down Expand Up @@ -770,8 +771,8 @@ export namespace Config {
.optional()
.default("ctrl+w,ctrl+backspace,alt+backspace")
.describe("Delete word backward in input"),
history_previous: z.string().optional().default("up").describe("Previous history item"),
history_next: z.string().optional().default("down").describe("Next history item"),
history_previous: z.string().optional().default("up,ctrl+p").describe("Previous history item"),
history_next: z.string().optional().default("down,ctrl+n").describe("Next history item"),
session_child_cycle: z.string().optional().default("<leader>right").describe("Next child session"),
session_child_cycle_reverse: z.string().optional().default("<leader>left").describe("Previous child session"),
session_parent: z.string().optional().default("<leader>up").describe("Go to parent session"),
Expand Down
20 changes: 16 additions & 4 deletions packages/opencode/src/file/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -277,8 +277,7 @@ export namespace File {
const project = Instance.project
const full = path.join(Instance.directory, file)

// TODO: Filesystem.contains is lexical only - symlinks inside the project can escape.
// TODO: On Windows, cross-drive paths bypass this check. Consider realpath canonicalization.
// Check if path is lexically contained first (fast check)
if (!Instance.containsPath(full)) {
throw new Error(`Access denied: path escapes project directory`)
}
Expand All @@ -289,6 +288,11 @@ export namespace File {
return { type: "text", content: "" }
}

const real = await fs.promises.realpath(full)
if (!Instance.containsPath(real)) {
throw new Error(`Access denied: path escapes project directory`)
}

const encode = await shouldEncode(bunFile)

if (encode) {
Expand Down Expand Up @@ -337,12 +341,20 @@ export namespace File {
}
const resolved = dir ? path.join(Instance.directory, dir) : Instance.directory

// TODO: Filesystem.contains is lexical only - symlinks inside the project can escape.
// TODO: On Windows, cross-drive paths bypass this check. Consider realpath canonicalization.
// Check if path is lexically contained first (fast check)
if (!Instance.containsPath(resolved)) {
throw new Error(`Access denied: path escapes project directory`)
}

try {
const real = await fs.promises.realpath(resolved)
if (!Instance.containsPath(real)) {
throw new Error(`Access denied: path escapes project directory`)
}
} catch (err: any) {
if (err.message && err.message.startsWith("Access denied")) throw err
}

const nodes: Node[] = []
for (const entry of await fs.promises
.readdir(resolved, {
Expand Down
104 changes: 76 additions & 28 deletions packages/opencode/src/tool/task.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,52 @@ import { defer } from "@/util/defer"
import { Config } from "../config/config"
import { PermissionNext } from "@/permission/next"

// Check if caller has Plan mode restrictions (edit="deny" globally)
function hasPlanRestrictions(permissions: PermissionNext.Ruleset): boolean {
const rule = permissions.findLast((r) => r.permission === "edit" && r.pattern === "*")
return rule?.action === "deny"
}

// Read-only bash commands allowed in Plan mode
const PLAN_BASH_WHITELIST = [
"cat *",
"head *",
"tail *",
"grep *",
"ls *",
"find *",
"wc *",
"diff *",
"git status*",
"git log*",
"git diff*",
"git show*",
"git branch*",
"git remote*",
"git rev-parse*",
"echo *",
"pwd",
"which *",
"env",
"printenv*",
]

// Build permission rules for Plan mode inheritance
function planPermissions(): PermissionNext.Ruleset {
return [
{ permission: "edit", pattern: "*", action: "deny" as const },
{ permission: "write", pattern: "*", action: "deny" as const },
{ permission: "patch", pattern: "*", action: "deny" as const },
{ permission: "multiedit", pattern: "*", action: "deny" as const },
{ permission: "bash", pattern: "*", action: "deny" as const },
...PLAN_BASH_WHITELIST.map((pattern) => ({
permission: "bash" as const,
pattern,
action: "allow" as const,
})),
]
}

const parameters = z.object({
description: z.string().describe("A short (3-5 words) description of the task"),
prompt: z.string().describe("The task for the agent to perform"),
Expand All @@ -23,15 +69,17 @@ const parameters = z.object({
export const TaskTool = Tool.define("task", async (ctx) => {
const agents = await Agent.list().then((x) => x.filter((a) => a.mode !== "primary"))

// Filter agents by permissions if agent provided
const caller = ctx?.agent
const accessibleAgents = caller
const accessible = caller
? agents.filter((a) => PermissionNext.evaluate("task", a.name, caller.permission).action !== "deny")
: agents

// Security: sub-agents must inherit Plan mode restrictions
const restricted = caller ? hasPlanRestrictions(caller.permission) : false

const description = DESCRIPTION.replace(
"{agents}",
accessibleAgents
accessible
.map((a) => `- ${a.name}: ${a.description ?? "This subagent should only be called manually by the user."}`)
.join("\n"),
)
Expand All @@ -41,7 +89,6 @@ export const TaskTool = Tool.define("task", async (ctx) => {
async execute(params: z.infer<typeof parameters>, ctx) {
const config = await Config.get()

// Skip permission check when user explicitly invoked via @ or command subtask
if (!ctx.extra?.bypassAgentCheck) {
await ctx.ask({
permission: "task",
Expand All @@ -54,10 +101,21 @@ export const TaskTool = Tool.define("task", async (ctx) => {
})
}

const agent = await Agent.get(params.subagent_type)
if (!agent) throw new Error(`Unknown agent type: ${params.subagent_type} is not a valid agent type`)
// Force plan agent when parent has Plan mode restrictions
let name = params.subagent_type
if (restricted) {
const plan = await Agent.get("plan")
if (!plan) {
throw new Error("Cannot spawn sub-agent from Plan mode parent - 'plan' agent is not available")
}
name = "plan"
}

const agent = await Agent.get(name)
if (!agent) throw new Error(`Unknown agent type: ${name} is not a valid agent type`)

const hasTaskPermission = agent.permission.some((rule) => rule.permission === "task")
const hasTask = agent.permission.some((rule) => rule.permission === "task")
const inherited = restricted ? planPermissions() : []

const session = await iife(async () => {
if (params.session_id) {
Expand All @@ -67,32 +125,17 @@ export const TaskTool = Tool.define("task", async (ctx) => {

return await Session.create({
parentID: ctx.sessionID,
title: params.description + ` (@${agent.name} subagent)`,
title: params.description + ` (@${agent.name} subagent${restricted ? ", Plan mode" : ""})`,
permission: [
{
permission: "todowrite",
pattern: "*",
action: "deny",
},
{
permission: "todoread",
pattern: "*",
action: "deny",
},
...(hasTaskPermission
? []
: [
{
permission: "task" as const,
pattern: "*" as const,
action: "deny" as const,
},
]),
{ permission: "todowrite", pattern: "*", action: "deny" },
{ permission: "todoread", pattern: "*", action: "deny" },
...(hasTask ? [] : [{ permission: "task" as const, pattern: "*" as const, action: "deny" as const }]),
...(config.experimental?.primary_tools?.map((t) => ({
pattern: "*",
action: "allow" as const,
permission: t,
})) ?? []),
...inherited,
],
})
})
Expand Down Expand Up @@ -142,6 +185,10 @@ export const TaskTool = Tool.define("task", async (ctx) => {
using _ = defer(() => ctx.abort.removeEventListener("abort", cancel))
const promptParts = await SessionPrompt.resolvePromptParts(params.prompt)

const disabled: Record<string, boolean> = restricted
? { edit: false, write: false, patch: false, multiedit: false }
: {}

const result = await SessionPrompt.prompt({
messageID,
sessionID: session.id,
Expand All @@ -153,8 +200,9 @@ export const TaskTool = Tool.define("task", async (ctx) => {
tools: {
todowrite: false,
todoread: false,
...(hasTaskPermission ? {} : { task: false }),
...(hasTask ? {} : { task: false }),
...Object.fromEntries((config.experimental?.primary_tools ?? []).map((t) => [t, false])),
...disabled,
},
parts: promptParts,
})
Expand Down
45 changes: 45 additions & 0 deletions packages/opencode/test/security/symlink.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
import { describe, expect, test } from "bun:test"
import path from "path"
import fs from "fs/promises"
import os from "os"
import { tmpdir } from "../fixture/fixture"
import { Instance } from "../../src/project/instance"
import { File } from "../../src/file"

describe("security", () => {
test("prevents reading files outside project via symlink", async () => {
// Create a "secret" file outside the project
const secretDir = path.join(os.tmpdir(), "secret-" + Math.random().toString(36).slice(2))
await fs.mkdir(secretDir, { recursive: true })
const secretFile = path.join(secretDir, "passwd")
await Bun.write(secretFile, "secret-data")

try {
await using tmp = await tmpdir({
init: async (dir) => {
// Create a symlink to the secret file
await fs.symlink(secretFile, path.join(dir, "link-to-secret"))
},
})

await Instance.provide({
directory: tmp.path,
fn: async () => {
// Try to read the symlink
// This should FAIL (throw error) if security check works
// We expect "Access denied: path escapes project directory"
try {
await File.read("link-to-secret")
// If we get here, it failed to throw
throw new Error("Security check failed: File.read succeeded but should have failed")
} catch (err: any) {
expect(err.message).toContain("Access denied")
}
},
})
} finally {
// Clean up secret dir
await fs.rm(secretDir, { recursive: true, force: true })
}
})
})
Loading