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.

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

fix(builder): validation of template accesses which depend on chainId #1691

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

fix(builder): validation of template accesses which depend on chainId #1691

Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion examples/sample-foundry-project/cannonfile.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name = "greeter-foundry"
name = "greeter"
version = "<%= package.version %>"
description = "Simple project to verify the functionality of cannon"
keywords = ["sample", "greeter"]
Expand Down
2 changes: 1 addition & 1 deletion examples/sample-foundry-project/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "sample-foundry-project",
"version": "2.11.18",
"version": "2.11.20",
"private": true,
"scripts": {
"test": "forge test",
Expand Down
4 changes: 1 addition & 3 deletions examples/sample-hardhat-project/cannonfile.consumer.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ options.salt = "second"
options.msg = "a message from second greeter set"

[invoke.do_change_greeting2]
target = ["greeters.Greeter"]
target = ["greeters.Greeterz"]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this ok?

func = "setGreeting"
args = ["<%= settings.change_greeting2 %>"]

Expand All @@ -40,11 +40,9 @@ args = ["<%= contracts.cloned.address %>", "<%= formatBytes32String('New Greetin

var.NewCloneGreeting.event = "NewGreetingAdded"
var.NewCloneGreeting.arg = 0
var.NewCloneGreeting.artifact = "Greeter"

var.OldCloneGreeting.event = "OldGreetingRemoved"
var.OldCloneGreeting.arg = 0
var.OldCloneGreeting.artifact = "Greeter"

# test to parse through previous emitted event values
[invoke.set_new_greeting_for_next_clones]
Expand Down
62 changes: 35 additions & 27 deletions packages/builder/src/access-recorder.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,82 +1,83 @@
import { computeTemplateAccesses } from './access-recorder';
import { TemplateContext } from './access-recorder';

describe('access-recorder.ts', () => {
describe('computeTemplateAccesses()', () => {
const templateContext = new TemplateContext({ chainId: 45, timestamp: 0, package: { version: '0.0.0' } });
describe('TemplateContext.computeAccesses()', () => {
it('computes dependency with addition operation', () => {
expect(computeTemplateAccesses('<%= settings.value1 + settings.value2 %>')).toEqual({
expect(templateContext.computeAccesses('<%= settings.value1 + settings.value2 %>')).toEqual({
accesses: ['settings.value1', 'settings.value2'],
unableToCompute: false,
});
});

it('computes dependency with addition operation using extras', () => {
expect(computeTemplateAccesses('<%= extras.value1 + extras.value2 %>')).toEqual({
expect(templateContext.computeAccesses('<%= extras.value1 + extras.value2 %>')).toEqual({
accesses: ['extras.value1', 'extras.value2'],
unableToCompute: false,
});
});

it('computes dependency with usage of allowed global variables', () => {
expect(computeTemplateAccesses('<%= parseEther(String(0.3)) %>')).toEqual({
expect(templateContext.computeAccesses('<%= parseEther(String(0.3)) %>')).toEqual({
accesses: [],
unableToCompute: false,
});
});

it('computes simple addition', () => {
expect(computeTemplateAccesses('<%= 1 + 1 %>')).toEqual({
expect(templateContext.computeAccesses('<%= 1 + 1 %>')).toEqual({
accesses: [],
unableToCompute: false,
});
});

it('computes dependency with subtraction operation', () => {
expect(computeTemplateAccesses('<%= settings.value1 - settings.value2 %>')).toEqual({
expect(templateContext.computeAccesses('<%= settings.value1 - settings.value2 %>')).toEqual({
accesses: ['settings.value1', 'settings.value2'],
unableToCompute: false,
});
});

it('computes dependency with multiplication operation', () => {
expect(computeTemplateAccesses('<%= settings.value1 * settings.value2 %>')).toEqual({
expect(templateContext.computeAccesses('<%= settings.value1 * settings.value2 %>')).toEqual({
accesses: ['settings.value1', 'settings.value2'],
unableToCompute: false,
});
});

it('computes dependency with division operation', () => {
expect(computeTemplateAccesses('<%= settings.value1 / settings.value2 %>')).toEqual({
expect(templateContext.computeAccesses('<%= settings.value1 / settings.value2 %>')).toEqual({
accesses: ['settings.value1', 'settings.value2'],
unableToCompute: false,
});
});

it('computes dependency with complex math operation', () => {
expect(
computeTemplateAccesses('<%= (settings.value1 + settings.value2) * settings.value3 / settings.value4 %>')
templateContext.computeAccesses('<%= (settings.value1 + settings.value2) * settings.value3 / settings.value4 %>')
).toEqual({
accesses: ['settings.value1', 'settings.value2', 'settings.value3', 'settings.value4'],
unableToCompute: false,
});
});

it('computes multiple dependencies on different template tags', () => {
expect(computeTemplateAccesses('<%= settings.woot %>-<%= settings.woot2 %>')).toEqual({
expect(templateContext.computeAccesses('<%= settings.woot %>-<%= settings.woot2 %>')).toEqual({
accesses: ['settings.woot', 'settings.woot2'],
unableToCompute: false,
});
});

it('computes simple dependency', () => {
expect(computeTemplateAccesses('<%= settings.woot %>')).toEqual({
expect(templateContext.computeAccesses('<%= settings.woot %>')).toEqual({
accesses: ['settings.woot'],
unableToCompute: false,
});
});

it('computes array dependency', () => {
expect(
computeTemplateAccesses(
templateContext.computeAccesses(
'["<%= settings.camelotSwapPublisherAdmin1 %>","<%= settings.camelotSwapPublisherAdmin2 %>"]'
)
).toEqual({
Expand All @@ -86,48 +87,55 @@ describe('access-recorder.ts', () => {
});

it('computes dependency using simple CannonHelperContext', () => {
expect(computeTemplateAccesses('<%= parseEther(settings.woot) %>')).toEqual({
expect(templateContext.computeAccesses('<%= parseEther(settings.woot) %>')).toEqual({
accesses: ['settings.woot'],
unableToCompute: false,
});
});

it('computes dependency using complex CannonHelperContext', () => {
expect(
computeTemplateAccesses(
templateContext.computeAccesses(
'<%= defaultAbiCoder.encode(parseEther(settings.woot)) %> + <%= defaultAbiCoder.decode(contracts.compound) %>'
)
).toEqual({
accesses: ['contracts.compound', 'settings.woot'],
unableToCompute: false,
});
});

it('computes dependency with chainId as a dynamic value search', () => {
expect(templateContext.computeAccesses('<%= settings[`my_${chainId}`] %>')).toEqual({
accesses: ['settings.my_45'],
unableToCompute: false,
});
})
});

describe('computeTemplateAccesses() syntax validation', () => {
it('handles invalid template syntax - unmatched brackets', () => {
expect(computeTemplateAccesses('<%= settings.value) %>')).toEqual({
expect(templateContext.computeAccesses('<%= settings.value) %>')).toEqual({
accesses: [],
unableToCompute: true,
});
});

it('handles empty template tags', () => {
expect(computeTemplateAccesses('<%=%>')).toEqual({
expect(templateContext.computeAccesses('<%=%>')).toEqual({
accesses: [],
unableToCompute: true,
});
});

it('handles multiple template tags with mixed validity', () => {
expect(computeTemplateAccesses('<%= settings.valid %> and <% invalid.syntax')).toEqual({
expect(templateContext.computeAccesses('<%= settings.valid %> and <% invalid.syntax')).toEqual({
accesses: ['settings.valid'],
unableToCompute: false,
});
});

it('handles template with only whitespace', () => {
expect(computeTemplateAccesses('<%= %>')).toEqual({
expect(templateContext.computeAccesses('<%= %>')).toEqual({
accesses: [],
unableToCompute: true,
});
Expand All @@ -136,58 +144,58 @@ describe('access-recorder.ts', () => {

describe('computeTemplateAccesses() security', () => {
it('prevents direct code execution', () => {
expect(computeTemplateAccesses('<%= process.exit(1) %>')).toEqual({
expect(templateContext.computeAccesses('<%= process.exit(1) %>')).toEqual({
accesses: [],
unableToCompute: true,
});
});

it('prevents access to global objects', () => {
expect(computeTemplateAccesses('<%= global.process %>')).toEqual({
expect(templateContext.computeAccesses('<%= global.process %>')).toEqual({
accesses: [],
unableToCompute: true,
});
});

it('prevents require/import statements', () => {
expect(computeTemplateAccesses('<%= require("fs") %>')).toEqual({
expect(templateContext.computeAccesses('<%= require("fs") %>')).toEqual({
accesses: [],
unableToCompute: true,
});
});

it('prevents eval usage', () => {
expect(computeTemplateAccesses('<%= eval("console.log(\'REKT\')") %>')).toEqual({
expect(templateContext.computeAccesses('<%= eval("console.log(\'REKT\')") %>')).toEqual({
accesses: [],
unableToCompute: true,
});
});

it('prevents Function constructor usage', () => {
expect(computeTemplateAccesses('<%= new Function("return process")() %>')).toEqual({
expect(templateContext.computeAccesses('<%= new Function("return process")() %>')).toEqual({
accesses: [],
unableToCompute: true,
});
});

it('prevents setTimeout/setInterval usage', () => {
expect(computeTemplateAccesses('<%= setTimeout(() => {}, 1000) %>')).toEqual({
expect(templateContext.computeAccesses('<%= setTimeout(() => {}, 1000) %>')).toEqual({
accesses: [],
unableToCompute: true,
});
});

it('prevents overriding console.log', () => {
expect(
computeTemplateAccesses('<%= console.log=function(n){require("fs").writeFileSync("./exploit.log",n)} %>')
templateContext.computeAccesses('<%= console.log=function(n){require("fs").writeFileSync("./exploit.log",n)} %>')
).toEqual({
accesses: [],
unableToCompute: true,
});
});

it('prevents assignment of values', () => {
expect(computeTemplateAccesses('<%= const value = 1 + 2 %>')).toEqual({
expect(templateContext.computeAccesses('<%= const value = 1 + 2 %>')).toEqual({
accesses: [],
unableToCompute: true,
});
Expand Down
Loading
Loading