Skip to content

Commit d50f692

Browse files
waleedlatif1waleedlatif1
committed
fix(code-placeholders): harden shell placeholder interpolation in arithmetic contexts
1 parent 14e6c0a commit d50f692

3 files changed

Lines changed: 801 additions & 187 deletions

File tree

‎apps/sim/lib/execution/code-placeholders/compiler.test.ts‎

Lines changed: 148 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1053,6 +1053,69 @@ describe('code placeholder compiler', () => {
10531053
'total=$(( $(( 1 + 1 )) + {{KEY}} ))',
10541054
'cat <<PAYLOAD\n$(( {{KEY}} * 2 ))\nPAYLOAD',
10551055
'cat <<PAYLOAD\n$[ {{KEY}} * 2 ]\nPAYLOAD',
1056+
'echo $(( $(cat <<EOF\n{{KEY}}\nEOF\n) + 1 ))',
1057+
"echo $(( $(cat <<'EOF'\n{{KEY}}\nEOF\n) + 1 ))",
1058+
"echo $(( $(cat <<-'EOF'\n\t{{KEY}}\n\tEOF\n) + 1 ))",
1059+
'[[ {{KEY}} -eq 0 ]] && echo zero',
1060+
'[[ "{{KEY}}" -eq 0 ]] && echo zero',
1061+
'if [[ 0 -lt {{KEY}} ]]; then echo positive; fi',
1062+
'[[ -n x && ( "{{KEY}}" -ge 1 ) ]]',
1063+
'[[ $(printf "%s" "{{KEY}}") -ne 0 ]]',
1064+
'[[ $(printf "%s" "{{KEY}}"; echo 1) -le 0 ]]',
1065+
'[[ $(cat <<EOF\n{{KEY}}\nEOF\n) -gt 0 ]]',
1066+
'let "x={{KEY}}"',
1067+
'let x={{KEY}}+1',
1068+
'declare -i x="{{KEY}}"',
1069+
'typeset -i x={{KEY}}',
1070+
'f() { local -i x="{{KEY}}"; }',
1071+
'declare -ai values=("{{KEY}}")',
1072+
'declare -x -i x="{{KEY}}"',
1073+
'let x="$(printf "%s" "{{KEY}}")"',
1074+
'declare -i x="$(printf "%s" "{{KEY}}")"',
1075+
'>/dev/null let x="{{KEY}}"',
1076+
'2>/dev/null let x="{{KEY}}"',
1077+
'builtin let x="{{KEY}}"',
1078+
'command let x="{{KEY}}"',
1079+
'declare "-i" n="{{KEY}}"',
1080+
// biome-ignore lint/suspicious/noTemplateCurlyInString: shell parameter expansion, not a JS template
1081+
'[[ ${missing:-{{KEY}}} -eq 0 ]]',
1082+
'declare -i n; echo "$(declare +i n)"; n="{{KEY}}"',
1083+
// biome-ignore lint/suspicious/noTemplateCurlyInString: shell parameter expansion, not a JS template
1084+
'printf "%s" "${missing:-{text}"; let x="{{KEY}}"',
1085+
'declare -i n; n="$(printf "%s" "{{KEY}}")"',
1086+
// biome-ignore lint/suspicious/noTemplateCurlyInString: shell parameter expansion, not a JS template
1087+
'declare -i n; n="${missing:-{{KEY}}}"',
1088+
'declare -i n; declare n="{{KEY}}"',
1089+
'> /dev/null let x="{{KEY}}"',
1090+
'let x="$(cat <<EOF\n{{KEY}}\nEOF\n)"',
1091+
'unset "a[{{KEY}}]"',
1092+
'unset a[{{KEY}}]',
1093+
// biome-ignore lint/suspicious/noTemplateCurlyInString: shell parameter expansion, not a JS template
1094+
'declare -A m=([key]=abc); printf "%s\\n" "${m[key]:{{KEY}}}"',
1095+
'a[{{KEY}}]=1',
1096+
'a[{{KEY}}]+=1',
1097+
'declare -i n; n="{{KEY}}"',
1098+
'declare -i n\nn="{{KEY}}"',
1099+
// biome-ignore lint/suspicious/noTemplateCurlyInString: shell parameter expansion, not a JS template
1100+
'a=(1 2); echo "${a[{{KEY}}]}"',
1101+
// biome-ignore lint/suspicious/noTemplateCurlyInString: shell parameter expansion, not a JS template
1102+
'a=(1 2); echo "${a[0]:{{KEY}}}"',
1103+
// biome-ignore lint/suspicious/noTemplateCurlyInString: shell parameter expansion, not a JS template
1104+
'a=(1 2); echo "${a[0]:0:{{KEY}}}"',
1105+
// biome-ignore lint/suspicious/noTemplateCurlyInString: shell parameter expansion, not a JS template
1106+
's=abc; echo "${s:{{KEY}}}"',
1107+
// biome-ignore lint/suspicious/noTemplateCurlyInString: shell parameter expansion, not a JS template
1108+
's=abc; echo "${s:0:{{KEY}}}"',
1109+
// biome-ignore lint/suspicious/noTemplateCurlyInString: shell parameter expansion, not a JS template
1110+
's=abc; echo "${s: -1:{{KEY}}}"',
1111+
// biome-ignore lint/suspicious/noTemplateCurlyInString: shell parameter expansion, not a JS template
1112+
'set -- a b; echo "${@:{{KEY}}}"',
1113+
// biome-ignore lint/suspicious/noTemplateCurlyInString: shell parameter expansion, not a JS template
1114+
's=abc; printf "%s\\n" "${missing:-"${s:{{KEY}}}"}"',
1115+
// biome-ignore lint/suspicious/noTemplateCurlyInString: shell parameter expansion, not a JS template
1116+
'cat <<PAYLOAD\n${a[{{KEY}}]}\nPAYLOAD',
1117+
// biome-ignore lint/suspicious/noTemplateCurlyInString: shell parameter expansion, not a JS template
1118+
'cat <<PAYLOAD\n${s:{{KEY}}}\nPAYLOAD',
10561119
])('rejects shell placeholders whose values enter arithmetic: %s', async (code) => {
10571120
await expect(
10581121
compileCodePlaceholders({
@@ -1087,6 +1150,91 @@ describe('code placeholder compiler', () => {
10871150
)
10881151
})
10891152

1153+
it.each([
1154+
// biome-ignore lint/suspicious/noTemplateCurlyInString: shell parameter expansion, not a JS template
1155+
'printf "%s\\n" "${missing:-https://{{KEY}}}"',
1156+
// biome-ignore lint/suspicious/noTemplateCurlyInString: shell parameter expansion, not a JS template
1157+
'printf "%s\\n" "${missing:-items[{{KEY}}]}"',
1158+
// biome-ignore lint/suspicious/noTemplateCurlyInString: shell parameter expansion, not a JS template
1159+
's=abc; printf "%s\\n" "${s#[{{KEY}}]}"',
1160+
// biome-ignore lint/suspicious/noTemplateCurlyInString: shell parameter expansion, not a JS template
1161+
's=abc; printf "%s\\n" "${s/[{{KEY}}]/x}"',
1162+
'f() { local -i n; }; n="{{KEY}}"',
1163+
'PREFIX="$(printf "%s" "{{KEY}}")" let total=2',
1164+
'printf "%s" a[{{KEY}}]=1',
1165+
'declare -i n; printf "%s" n={{KEY}}',
1166+
'declare -i n; declare +i n; n="{{KEY}}"',
1167+
'declare -i n; n=1 printf "%s" "{{KEY}}"',
1168+
'declare -i n; n=5 text="{{KEY}}"',
1169+
'declare -i +i n="{{KEY}}"',
1170+
'declare -i n; echo "$(declare +i n; n=\'{{KEY}}\'; printf "%s" "$n")"',
1171+
'$(let x=1 <<EOF\n{{KEY}}\nEOF\n)',
1172+
// biome-ignore lint/suspicious/noTemplateCurlyInString: shell parameter expansion, not a JS template
1173+
'declare -A m; m[{{KEY}}]=x; printf "%s\\n" "${m[{{KEY}}]}"',
1174+
'declare -A m; printf "%s\\n" "${m[{{KEY}}]}"',
1175+
'declare -iA m; m[{{KEY}}]=1',
1176+
'let x=1 >"{{KEY}}"',
1177+
'let x=1 > {{KEY}}',
1178+
'declare -i n=1 >"{{KEY}}"',
1179+
'[[ "{{KEY}}" == "-eq" ]]',
1180+
])('compiles parameter and prefix text that is not an arithmetic operand: %s', async (code) => {
1181+
// These forms use the value as pattern, default, or a shielded prefix — never arithmetic — so a
1182+
// conservative scanner must not reject them. Each would fail compilation if wrongly rejected.
1183+
await expect(
1184+
compileCodePlaceholders({
1185+
code,
1186+
language: CodeLanguage.Shell,
1187+
environmentVariables: { KEY: 'values[$(printf injected >&2)]' },
1188+
})
1189+
).resolves.toBeDefined()
1190+
})
1191+
1192+
it('keeps literal single quotes inside a double-quoted default expansion', async () => {
1193+
const compiled = await compileCodePlaceholders({
1194+
// biome-ignore lint/suspicious/noTemplateCurlyInString: shell parameter expansion, not a JS template
1195+
code: 'printf "%s\\n" "${missing:-\'{{KEY}}\'}"',
1196+
language: CodeLanguage.Shell,
1197+
environmentVariables: { KEY: 'hello world' },
1198+
})
1199+
expect(executeShell(compiled.code, compiled.bindings)).toBe("'hello world'\n")
1200+
})
1201+
1202+
it('compiles shell placeholders beside arithmetic that never evaluates them', async () => {
1203+
const value = 'values[$(printf injected >&2)]'
1204+
const compiled = await compileCodePlaceholders({
1205+
code: [
1206+
'[ "{{KEY}}" -eq 0 ] 2>/dev/null || printf "%s\\n" not-zero',
1207+
'[[ "{{KEY}}" == values* && 1 -eq 1 ]] && printf "%s\\n" matched',
1208+
'let total=1+1; printf "%s\\n" "{{KEY}}"',
1209+
'f() { local copy="{{KEY}}"; printf "%s\\n" "$copy"; }; f',
1210+
'declare copy="{{KEY}}"; printf "%s\\n" "$copy"',
1211+
// biome-ignore lint/suspicious/noTemplateCurlyInString: shell parameter expansion, not a JS template
1212+
'printf "%s\\n" "${missing:-{{KEY}}}"',
1213+
// biome-ignore lint/suspicious/noTemplateCurlyInString: shell parameter expansion, not a JS template
1214+
'a=(x y); printf "%s\\n" "${a[1]}{{KEY}}"',
1215+
'printf "%s\\n" "let {{KEY}}"',
1216+
'printf "%s\\n" "items[{{KEY}}]"',
1217+
'PREFIX="{{KEY}}" let total=2',
1218+
'# declare -i n',
1219+
'n="{{KEY}}"; printf "%s\\n" "$n"',
1220+
'let total=1 <<EOF',
1221+
'{{KEY}}',
1222+
'EOF',
1223+
'printf "%s\\n" "$total"',
1224+
'cat <<PAYLOAD',
1225+
'{{KEY}} $(( 1 + 1 ))',
1226+
'PAYLOAD',
1227+
].join('\n'),
1228+
language: CodeLanguage.Shell,
1229+
environmentVariables: { KEY: value },
1230+
})
1231+
1232+
expect(executeShell(`{\n${compiled.code}\n} 2>&1`, compiled.bindings)).toBe(
1233+
`not-zero\nmatched\n${value}\n${value}\n${value}\n${value}\ny${value}\n` +
1234+
`let ${value}\nitems[${value}]\n${value}\n1\n${value} 2\n`
1235+
)
1236+
})
1237+
10901238
it('discovers shell arithmetic placeholders without compiling missing values', async () => {
10911239
const code = 'total=$(( {{MISSING}} + {{KEY}} ))'
10921240
await expect(analyzeCodePlaceholders(code, CodeLanguage.Shell)).resolves.toEqual([

‎apps/sim/lib/execution/code-placeholders/shared.ts‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -327,12 +327,12 @@ export function createOffsetRangeLookup(
327327
* The placeholders lying wholly inside `[start, end]`. Occurrences are ordered and never
328328
* overlap, so the matches are one contiguous run found by bisection.
329329
*/
330-
export function occurrencesWithin(
331-
occurrences: readonly CodePlaceholderOccurrence[],
330+
export function occurrencesWithin<T extends Pick<CodePlaceholderOccurrence, 'start' | 'end'>>(
331+
occurrences: readonly T[],
332332
start: number,
333333
end: number
334-
): CodePlaceholderOccurrence[] {
335-
const matches: CodePlaceholderOccurrence[] = []
334+
): T[] {
335+
const matches: T[] = []
336336
for (
337337
let index = partitionPoint(occurrences, (occurrence) => occurrence.start < start);
338338
index < occurrences.length && occurrences[index].end <= end;

0 commit comments

Comments
 (0)