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

enforce a new/check function for custom types? (to properly constrain them) #165

Open
mimoo opened this issue Aug 23, 2024 · 0 comments
Open

Comments

@mimoo
Copy link
Contributor

mimoo commented Aug 23, 2024

There's a few interesting things to discuss here.

First, when we look at the main function, we end up calling handle_arg which ends up calling constrain_inputs_to_main. As the name indicates, the latter function makes sure that any argument to the main function gets properly constrained. For example:

fn main(thing: Bool) { /* ... */ }

will add a boolean constraint to thing. Without these constraints, the circuit wouldn't be secure!

Note

Interestingly, we add constraints to public inputs as well. I think this is debatable and we should actually remove that

the thing is, if we are dealing with a custom type, we don't do any constraining. This is DANGEROUS. For example imagine a custom type like this:

struct Uint8(Field);

fn Uint8.new(val: Field) -> Self {
  is_uint8(val); // add an important constraint!
  return Uint8(val);
}

as this type is intended to be constructed via its new function, it is supposed to be "secure" if used as intended.

Note

and BTW, we don't have anything in noname to enforce that the type is not constructed directly. In Rust you can write things like struct Uint8(pub Field) to allow direct construction and extraction of the inner value. Maybe we should have something like this

But when passed as argument to the main function, one would have to manually check that it is properly constrained:

fn main(thing: Uint8) {
  thing.check(); // this would eventually call `is_uint8` on the inner val
  // ...
}

maybe we add this thing.check() call automatically by enforcing that every custom struct is also defined with a check function that enforces that it is properly constrained.

PS: I'm wondering what Noir is doing there, for example

@mimoo mimoo changed the title enforce a new function for custom types? enforce a new/check function for custom types? (to properly constrain them) Aug 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant