fix: harden runWrangler against shell injection and silence DEP0190 #1248
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| "@opennextjs/cloudflare": patch | ||
| --- | ||
|
|
||
| fix: harden `runWrangler` against shell injection and silence Node.js DEP0190. |
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
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,83 @@ | ||
| import { afterEach, beforeEach, describe, expect, it } from "vitest"; | ||
|
|
||
| import { quoteShellMeta } from "./helpers.js"; | ||
|
|
||
| describe("quoteShellMeta", () => { | ||
| describe("on Windows", () => { | ||
| let originalPlatform: PropertyDescriptor | undefined; | ||
|
|
||
| beforeEach(() => { | ||
| originalPlatform = Object.getOwnPropertyDescriptor(process, "platform"); | ||
| Object.defineProperty(process, "platform", { value: "win32" }); | ||
| }); | ||
|
|
||
| afterEach(() => { | ||
| if (originalPlatform) { | ||
| Object.defineProperty(process, "platform", originalPlatform); | ||
| } | ||
| }); | ||
|
|
||
| it("escapes empty strings", () => { | ||
| expect(quoteShellMeta("")).toBe('^"^"'); | ||
| }); | ||
|
|
||
| it("escapes simple alphanumeric values", () => { | ||
| expect(quoteShellMeta("simple-value")).toBe('^"simple-value^"'); | ||
| }); | ||
|
|
||
| it("does not leave bare carets in front of metacharacters inside the wrapping quotes", () => { | ||
| // Regression: an earlier implementation produced `"...^(...^)..."` which made the | ||
| // carets literal characters inside cmd.exe quotes, corrupting SQL with parens. | ||
| // The correct algorithm caret-escapes the wrapping quotes themselves, so the inner | ||
| // metacharacters stay un-escaped. | ||
| const sql = "CREATE TABLE foo (x INT);"; | ||
| const escaped = quoteShellMeta(sql); | ||
| expect(escaped).toBe('^"CREATE^ TABLE^ foo^ ^(x^ INT^)^;^"'); | ||
| // No bare `^(` or `^)` sitting inside an un-caret-escaped `"..."`. | ||
| expect(escaped).not.toMatch(/(?<!\^)"[^"]*\^[()][^"]*(?<!\^)"/); | ||
| }); | ||
|
|
||
| it("escapes paths containing spaces", () => { | ||
| expect(quoteShellMeta("C:\\Users\\Some User\\chunk.json")).toBe( | ||
| '^"C:\\Users\\Some^ User\\chunk.json^"' | ||
| ); | ||
| }); | ||
|
|
||
| it("escapes JSON values containing quotes and braces", () => { | ||
| expect(quoteShellMeta('KEY:{"foo":"bar baz"}')).toBe('^"KEY:{\\^"foo\\^":\\^"bar^ baz\\^"}^"'); | ||
| }); | ||
|
|
||
| it("doubles backslashes that precede a quote", () => { | ||
| // A backslash immediately before a quote needs doubling so the receiving program's | ||
| // argument parser sees a single literal backslash followed by an escaped quote. | ||
| expect(quoteShellMeta('\\"')).toBe('^"\\\\\\^"^"'); | ||
| }); | ||
| }); | ||
|
|
||
| describe("on POSIX", () => { | ||
| let originalPlatform: PropertyDescriptor | undefined; | ||
|
|
||
| beforeEach(() => { | ||
| originalPlatform = Object.getOwnPropertyDescriptor(process, "platform"); | ||
| Object.defineProperty(process, "platform", { value: "linux" }); | ||
| }); | ||
|
|
||
| afterEach(() => { | ||
| if (originalPlatform) { | ||
| Object.defineProperty(process, "platform", originalPlatform); | ||
| } | ||
| }); | ||
|
|
||
| it("single-quotes values containing whitespace", () => { | ||
| expect(quoteShellMeta("hello world")).toBe("'hello world'"); | ||
| }); | ||
|
|
||
| it("double-quotes values containing both single and double quotes", () => { | ||
| expect(quoteShellMeta(`it's "quoted"`)).toBe(`"it's \\"quoted\\""`); | ||
| }); | ||
|
|
||
| it("backslash-escapes shell metacharacters in bare values", () => { | ||
| expect(quoteShellMeta("a;b")).toBe("a\\;b"); | ||
| }); | ||
| }); | ||
| }); |
|
devin-ai-integration[bot] marked this conversation as resolved.
|
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 |
|---|---|---|
|
|
@@ -4,6 +4,8 @@ import path from "node:path"; | |
|
|
||
| import { compareSemver } from "@opennextjs/aws/build/helper.js"; | ||
|
|
||
| import { quoteShellMeta } from "./helpers.js"; | ||
|
|
||
| export type PackagerDetails = { | ||
| /** The name of the package manager. */ | ||
| packager: "npm" | "pnpm" | "yarn" | "bun"; | ||
|
|
@@ -96,39 +98,65 @@ export function runWrangler( | |
| ): WranglerCommandResult { | ||
| const noLogs = wranglerOpts.logging === "none"; | ||
| const shouldPipeLogs = wranglerOpts.logging === "error"; | ||
| const isWin = process.platform === "win32"; | ||
|
|
||
| const packagerArgs = [ | ||
| options.packager === "bun" ? "x" : "exec", | ||
| "wrangler", | ||
| ...injectPassthroughFlagForArgs(options, [ | ||
| ...args, | ||
| ...(wranglerOpts.environment ? ["--env", wranglerOpts.environment] : []), | ||
| ...(wranglerOpts.configPath ? ["--config", wranglerOpts.configPath] : []), | ||
| ...(wranglerOpts.target === "remote" ? ["--remote"] : []), | ||
| ...(wranglerOpts.target === "local" ? ["--local"] : []), | ||
| ]), | ||
| ]; | ||
|
|
||
| const stdio: ("inherit" | "ignore" | "pipe")[] = | ||
|
Contributor
There was a problem hiding this comment. Could you please re-add the former comment on this |
||
| shouldPipeLogs || noLogs ? ["ignore", "pipe", "pipe"] : ["inherit", "inherit", "pipe"]; | ||
|
|
||
| const env = { | ||
| ...process.env, | ||
| ...wranglerOpts.env, | ||
| // `.env` files are handled by the adapter. | ||
| // Wrangler would load `.env.<wrangler env>` while we should load `.env.<process.env.NEXTJS_ENV>` | ||
| // See https://opennext.js.org/cloudflare/howtos/env-vars | ||
| CLOUDFLARE_LOAD_DEV_VARS_FROM_DOT_ENV: "false", | ||
| }; | ||
|
|
||
| // On Windows the package manager binary is typically a `.cmd` shim. Per Node.js docs | ||
| // https://nodejs.org/api/child_process.html#spawning-bat-and-cmd-files-on-windows the | ||
| // recommended way to invoke a `.cmd`/`.bat` is to spawn `cmd.exe` directly with `/c`, | ||
| // rather than relying on `shell: true` (which emits DEP0190 and would re-tokenize values). | ||
| // We pre-escape every token with `quoteShellMeta` and pass the joined command line as a | ||
| // single quoted string with `windowsVerbatimArguments: true` so Node does not re-escape it. | ||
| // This mirrors how `cross-spawn` handles non-`.exe` commands on Windows. | ||
| // | ||
| // On POSIX we spawn the package manager directly with `shell: false`, which avoids DEP0190 | ||
| // and lets each value be passed verbatim as its own argv entry. | ||
| const result = isWin | ||
| ? spawnSync( | ||
| "cmd.exe", | ||
| [ | ||
| "/d", | ||
| "/s", | ||
| "/c", | ||
| `"${[options.packager, ...packagerArgs].map((token) => quoteShellMeta(token)).join(" ")}"`, | ||
| ], | ||
| { | ||
| shell: false, | ||
| windowsVerbatimArguments: true, | ||
| stdio, | ||
| env, | ||
| } | ||
| ) | ||
| : spawnSync(options.packager, packagerArgs, { | ||
| // Setting `shell` to `false` to avoid DEP0190. | ||
| // See https://nodejs.org/api/deprecations.html#dep0190-passing-args-to-nodechild-process-execfilespawn-with-shell-option | ||
|
Contributor
There was a problem hiding this comment. Move this up as it is used for both win and non win ands merge with l135/136 |
||
| shell: false, | ||
| stdio, | ||
| env, | ||
| }); | ||
|
|
||
| const success = result.status === 0; | ||
| const stdout = result.stdout?.toString() ?? ""; | ||
|
|
||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
is
quoteShellMetastill use anywhere? If not, we can remove that