Skip to content

fix(server): allow file read/write for absolute paths outside workspace #186

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jeonghun-jj-lee merged 1 commit into from
Aug 11, 2026
Merged

fix(server): allow file read/write for absolute paths outside workspace #186

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
23 changes: 21 additions & 2 deletions packages/opencode/src/server/routes/instance/httpapi/handlers/file.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import { FSUtil } from "@opencode-ai/core/fs-util"
import { Location } from "@opencode-ai/core/location"
import { AbsolutePath, RelativePath } from "@opencode-ai/core/schema"
import { Effect, Layer, Option } from "effect"
import * as fs from "fs/promises"
import ignore from "ignore"
import path from "path"
import { HttpApiBuilder } from "effect/unstable/httpapi"
Expand Down Expand Up @@ -96,8 +97,17 @@ export const fileHandlers = HttpApiBuilder.group(InstanceHttpApi, "file", (handl
const content = Effect.fn("FileHttpApi.content")(function* (ctx: { query: { path: string } }) {
const directory = (yield* InstanceState.context).directory
const file = path.resolve(directory, ctx.query.path)
if (!FSUtil.contains(directory, file)) return yield* Effect.die(new Error("Path escapes the location"))
const isAbsolute = path.isAbsolute(ctx.query.path)
// Allow absolute paths (the session may touch files outside the workspace);
// relative paths must stay within the workspace.
if (!isAbsolute && !FSUtil.contains(directory, file)) return yield* Effect.die(new Error("Path escapes the location"))
if (!(yield* FSUtil.Service.use((fs) => fs.existsSafe(file)))) return { type: "text" as const, content: "" }
if (isAbsolute && !FSUtil.contains(directory, file)) {
// Read directly from disk for absolute paths outside the workspace
const buf = yield* Effect.tryPromise(() => fs.readFile(file)).pipe(Effect.orDie)
const text = new TextDecoder("utf-8", { fatal: true }).decode(buf)
return { type: "text" as const, content: text.trim() }
}
return yield* filesystem(
FileSystem.Service.use((fs) => fs.read({ path: RelativePath.make(ctx.query.path) })),
).pipe(
Expand Down Expand Up @@ -131,7 +141,16 @@ export const fileHandlers = HttpApiBuilder.group(InstanceHttpApi, "file", (handl
const write = Effect.fn("FileHttpApi.write")(function* (ctx: { payload: { path: string; content: string } }) {
const directory = (yield* InstanceState.context).directory
const file = path.resolve(directory, ctx.payload.path)
if (!FSUtil.contains(directory, file)) return yield* Effect.die(new Error("Path escapes the location"))
const isAbsolute = path.isAbsolute(ctx.payload.path)
// Allow absolute paths (the session may touch files outside the workspace);
// relative paths must stay within the workspace.
if (!isAbsolute && !FSUtil.contains(directory, file)) return yield* Effect.die(new Error("Path escapes the location"))
if (isAbsolute && !FSUtil.contains(directory, file)) {
// Write directly for absolute paths outside the workspace
yield* Effect.tryPromise(() => fs.mkdir(path.dirname(file), { recursive: true })).pipe(Effect.orDie)
yield* Effect.tryPromise(() => fs.writeFile(file, ctx.payload.content, "utf-8")).pipe(Effect.orDie)
return { ok: true as const }
}
yield* FSUtil.Service.use((fs) => fs.writeWithDirs(file, ctx.payload.content)).pipe(Effect.orDie)
return { ok: true as const }
})
Expand Down
Loading