-
Notifications
You must be signed in to change notification settings - Fork 2.3k
feat(task): verify prompt file digests #712
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.
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
Open
ALV0612
wants to merge
2
commits into
openai:main
Choose a base branch
from
ALV0612:fix/issue-621-verify-prompt-file-digest
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| import crypto from "node:crypto"; | ||
| import fs from "node:fs"; | ||
| import path from "node:path"; | ||
|
|
||
| const SHA256_PATTERN = /^[a-f0-9]{64}$/i; | ||
|
|
||
| function normalizeExpectedSha256(value) { | ||
| if (value == null) { | ||
| return null; | ||
| } | ||
| const normalized = String(value).trim().toLowerCase(); | ||
| if (!SHA256_PATTERN.test(normalized)) { | ||
| throw new Error("`--prompt-file-sha256` must be exactly 64 hexadecimal characters."); | ||
| } | ||
| return normalized; | ||
| } | ||
|
|
||
| function digestsEqual(leftHex, rightHex) { | ||
| const left = Buffer.from(leftHex, "hex"); | ||
| const right = Buffer.from(rightHex, "hex"); | ||
| return left.length === right.length && crypto.timingSafeEqual(left, right); | ||
| } | ||
|
|
||
| export function readTaskPromptInput(cwd, options, positionals, readStdin) { | ||
| const expectedSha256 = normalizeExpectedSha256(options["prompt-file-sha256"]); | ||
| const promptFile = options["prompt-file"]; | ||
| if (expectedSha256 && !promptFile) { | ||
| throw new Error("`--prompt-file-sha256` requires `--prompt-file <path>`."); | ||
| } | ||
|
|
||
| if (promptFile) { | ||
| const resolvedPath = path.resolve(cwd, promptFile); | ||
| const bytes = fs.readFileSync(resolvedPath); | ||
| const sha256 = crypto.createHash("sha256").update(bytes).digest("hex"); | ||
| if (expectedSha256 && !digestsEqual(expectedSha256, sha256)) { | ||
| throw new Error( | ||
| `Prompt file SHA-256 mismatch for ${resolvedPath}: expected ${expectedSha256}, received ${sha256}.` | ||
| ); | ||
| } | ||
| return { | ||
| text: bytes.toString("utf8"), | ||
| source: "file", | ||
| sha256, | ||
| filePath: resolvedPath | ||
| }; | ||
| } | ||
|
|
||
| const positionalPrompt = positionals.join(" "); | ||
| if (positionalPrompt) { | ||
| return { text: positionalPrompt, source: "positional", sha256: null, filePath: null }; | ||
| } | ||
| return { | ||
| text: readStdin(), | ||
| source: "stdin", | ||
| sha256: null, | ||
| filePath: null | ||
| }; | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,102 @@ | ||
| import crypto from "node:crypto"; | ||
| import fs from "node:fs"; | ||
| import path from "node:path"; | ||
| import test from "node:test"; | ||
| import assert from "node:assert/strict"; | ||
|
|
||
| import { readTaskPromptInput } from "../plugins/codex/scripts/lib/task-prompt.mjs"; | ||
| import { makeTempDir } from "./helpers.mjs"; | ||
|
|
||
| function sha256(bytes) { | ||
| return crypto.createHash("sha256").update(bytes).digest("hex"); | ||
| } | ||
|
|
||
| test("readTaskPromptInput verifies and decodes the same prompt-file bytes", () => { | ||
| const cwd = makeTempDir(); | ||
| const bytes = Buffer.from("review $HOME and `ticks`\n", "utf8"); | ||
| fs.writeFileSync(path.join(cwd, "prompt.txt"), bytes); | ||
|
|
||
| const input = readTaskPromptInput( | ||
| cwd, | ||
| { "prompt-file": "prompt.txt", "prompt-file-sha256": sha256(bytes).toUpperCase() }, | ||
| [], | ||
| () => "unused" | ||
| ); | ||
|
|
||
| assert.equal(input.text, bytes.toString("utf8")); | ||
| assert.equal(input.source, "file"); | ||
| assert.equal(input.sha256, sha256(bytes)); | ||
| assert.equal(input.filePath, path.join(cwd, "prompt.txt")); | ||
| }); | ||
|
|
||
| test("readTaskPromptInput rejects changed prompt-file bytes", () => { | ||
| const cwd = makeTempDir(); | ||
| const approved = Buffer.from("approved prompt", "utf8"); | ||
| fs.writeFileSync(path.join(cwd, "prompt.txt"), "substituted prompt", "utf8"); | ||
|
|
||
| assert.throws( | ||
| () => | ||
| readTaskPromptInput( | ||
| cwd, | ||
| { "prompt-file": "prompt.txt", "prompt-file-sha256": sha256(approved) }, | ||
| [], | ||
| () => "unused" | ||
| ), | ||
| /Prompt file SHA-256 mismatch.*expected.*received/ | ||
| ); | ||
| }); | ||
|
|
||
| for (const digest of ["abc", "g".repeat(64), "a".repeat(63), "a".repeat(65)]) { | ||
| test(`readTaskPromptInput rejects malformed digest ${digest.slice(0, 8)}`, () => { | ||
| const cwd = makeTempDir(); | ||
| fs.writeFileSync(path.join(cwd, "prompt.txt"), "prompt", "utf8"); | ||
| assert.throws( | ||
| () => | ||
| readTaskPromptInput( | ||
| cwd, | ||
| { "prompt-file": "prompt.txt", "prompt-file-sha256": digest }, | ||
| [], | ||
| () => "unused" | ||
| ), | ||
| /exactly 64 hexadecimal characters/ | ||
| ); | ||
| }); | ||
| } | ||
|
|
||
| test("readTaskPromptInput rejects digest without prompt-file", () => { | ||
| assert.throws( | ||
| () => | ||
| readTaskPromptInput( | ||
| makeTempDir(), | ||
| { "prompt-file-sha256": "a".repeat(64) }, | ||
| ["do", "not", "leak"], | ||
| () => "unused" | ||
| ), | ||
| /requires `--prompt-file/ | ||
| ); | ||
| }); | ||
|
|
||
| test("readTaskPromptInput records a receipt without enforcing a digest", () => { | ||
| const cwd = makeTempDir(); | ||
| const bytes = Buffer.from("compatible prompt", "utf8"); | ||
| fs.writeFileSync(path.join(cwd, "prompt.txt"), bytes); | ||
|
|
||
| const input = readTaskPromptInput(cwd, { "prompt-file": "prompt.txt" }, [], () => "unused"); | ||
| assert.equal(input.text, "compatible prompt"); | ||
| assert.equal(input.sha256, sha256(bytes)); | ||
| }); | ||
|
|
||
| test("readTaskPromptInput preserves positional and stdin transports", () => { | ||
| assert.deepEqual(readTaskPromptInput(makeTempDir(), {}, ["hello", "world"], () => "unused"), { | ||
| text: "hello world", | ||
| source: "positional", | ||
| sha256: null, | ||
| filePath: null | ||
| }); | ||
| assert.deepEqual(readTaskPromptInput(makeTempDir(), {}, [], () => "stdin prompt"), { | ||
| text: "stdin prompt", | ||
| source: "stdin", | ||
| sha256: null, | ||
| filePath: null | ||
| }); | ||
| }); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.