Skip to content
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

Scriptlet argument escaping #3588

Merged
merged 6 commits into from
Nov 10, 2023
Merged
Show file tree
Hide file tree
Changes from 5 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
30 changes: 19 additions & 11 deletions packages/adblocker/src/filters/cosmetic.ts
Original file line number Diff line number Diff line change
Expand Up @@ -748,16 +748,22 @@ export default class CosmeticFilter implements IFilter {
return undefined;
}

const args = parts.slice(1).map((part) => {
if (
(part.startsWith(`'`) && part.endsWith(`'`)) ||
(part.startsWith(`"`) && part.endsWith(`"`))
) {
return part.substring(1, part.length - 1);
}
return part;
});

const args = parts
.slice(1)
.map((part) => {
if (
(part.startsWith(`'`) && part.endsWith(`'`)) ||
(part.startsWith(`"`) && part.endsWith(`"`))
) {
return part.substring(1, part.length - 1);
}
return part;
})
.map((part: string) => {
return part
.replace(new RegExp(/\\u002C/, 'g'), ',')
philipp-classen marked this conversation as resolved.
Show resolved Hide resolved
.replace(new RegExp(/\\u005C/, 'g'), '\\');
});
return { name: parts[0], args };
}

Expand All @@ -772,7 +778,9 @@ export default class CosmeticFilter implements IFilter {
let script = js.get(name);
if (script !== undefined) {
for (let i = 0; i < args.length; i += 1) {
script = script.replace(`{{${i + 1}}}`, args[i]);
// escape some characters so they wont get evaluated with escape characters during script injection
const arg = args[i].replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
script = script.replace(`{{${i + 1}}}`, arg);
}

return script;
Expand Down
83 changes: 74 additions & 9 deletions packages/adblocker/test/parsing.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1855,16 +1855,58 @@ describe('Cosmetic filters', () => {
// expect(CosmeticFilter.parse('###.selector /invalid/')).to.be.null;
// });

it('#getScript', () => {
const parsed = CosmeticFilter.parse('foo.com##+js(script.js, arg1, arg2, arg3)');
expect(parsed).not.to.be.null;
if (parsed !== null) {
expect(parsed.getScript(new Map([['script.js', '{{1}},{{2}},{{3}}']]))).to.equal(
'arg1,arg2,arg3',
);
describe('#getScript', () => {
const simpleScriptlet = CosmeticFilter.parse('foo.com##+js(script.js, arg1, arg2, arg3)');

expect(parsed.getScript(new Map())).to.be.undefined;
}
it('returns undefined if script does not exist', () => {
expect(simpleScriptlet?.getScript(new Map())).to.be.undefined;
});

it('returns a script if one exists', () => {
expect(simpleScriptlet?.getScript(new Map([['script.js', 'test']]))).to.equal('test');
});

context('with arguments', () => {
it('inject values', () => {
expect(simpleScriptlet?.getScript(new Map([['script.js', '{{1}},{{2}},{{3}}']]))).to.equal(
'arg1,arg2,arg3',
);
});

it('escapes special characters', () => {
for (const character of [
'.',
'*',
'+',
'?',
'^',
'$',
'{',
'}',
'(',
')',
'|',
'[',
']',
'\\',
]) {
const scriptlet = CosmeticFilter.parse(`foo.com##+js(script.js, ${character})`);
expect(scriptlet?.getScript(new Map([['script.js', '{{1}}']]))).to.equal(
`\\${character}`,
);
}
});

it('handles complex cases', () => {
for (const example of [
[String.raw`'\(a\)'`, String.raw`\\\(a\\\)`],
[String.raw`foo\*`, String.raw`foo\\\*`],
]) {
const scriptlet = CosmeticFilter.parse(`foo.com##+js(script.js, ${example[0]})`);
expect(scriptlet?.getScript(new Map([['script.js', '{{1}}']]))).to.equal(example[1]);
}
});
});
});

describe('#getTokens', () => {
Expand Down Expand Up @@ -2361,4 +2403,27 @@ describe('scriptlets arguments parsing', () => {
);
}
});

it('unescapes escaped scriptlets', () => {
for (const [scriptlet, expected] of [
[
String.raw`script-name, \u005C(a\u005C)`,
{
name: 'script-name',
args: [String.raw`\(a\)`],
},
],
[
String.raw`script-name, {"a":1\u002C"b":2}`,
{
name: 'script-name',
args: [String.raw`{"a":1,"b":2}`],
},
],
] as const) {
expect(CosmeticFilter.parse(`foo.com##+js(${scriptlet})`)?.parseScript(), scriptlet).to.eql(
expected,
);
}
});
});