Skip to content

Commit

Permalink
fix: ensure to_bytes returns the canonical decomposition (#6084)
Browse files Browse the repository at this point in the history
# Description

## Problem\*

Resolves #5846 

## Summary\*
Enforce canonical decomposition for to_bytes


## Additional Context
I also added from_bytes methods since they are often requested


## Documentation\*
I updated the comments, I assume the doc is auto generated but I am not
sure. Let me know if I need to modify it manually.

Check one:
- [ ] No documentation needed.
- [X] Documentation included in this PR.
- [ ] **[For Experimental Features]** Documentation to be submitted in a
separate PR.

# PR Checklist\*

- [X] I have tested the changes locally.
- [X] I have formatted the changes with [Prettier](https://prettier.io/)
and/or `cargo fmt` on default settings.
  • Loading branch information
guipublic authored Oct 1, 2024
1 parent 79f8954 commit b280a79
Show file tree
Hide file tree
Showing 3 changed files with 84 additions and 25 deletions.
99 changes: 81 additions & 18 deletions noir_stdlib/src/field/mod.nr
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
pub mod bn254;
use bn254::lt as bn254_lt;
use crate::runtime::is_unconstrained;

impl Field {
/// Asserts that `self` can be represented in `bit_size` bits.
Expand Down Expand Up @@ -49,39 +50,71 @@ impl Field {
pub fn to_be_bits<let N: u32>(self: Self) -> [u1; N] {}
// docs:end:to_be_bits

/// Decomposes `self` into its little endian byte decomposition as a `[u8]` slice of length `byte_size`.
/// This slice will be zero padded should not all bytes be necessary to represent `self`.
/// Decomposes `self` into its little endian byte decomposition as a `[u8;N]` array
/// This array will be zero padded should not all bytes be necessary to represent `self`.
///
/// # Failures
/// Causes a constraint failure for `Field` values exceeding `2^{8*byte_size}` as the resulting slice will not
/// be able to represent the original `Field`.
/// The length N of the array must be big enough to contain all the bytes of the 'self',
/// and no more than the number of bytes required to represent the field modulus
///
/// # Safety
/// Values of `byte_size` equal to or greater than the number of bytes necessary to represent the `Field` modulus
/// (e.g. 32 for the BN254 field) allow for multiple byte decompositions. This is due to how the `Field` will
/// wrap around due to overflow when verifying the decomposition.
/// The result is ensured to be the canonical decomposition of the field element
// docs:start:to_le_bytes
pub fn to_le_bytes<let N: u32>(self: Self) -> [u8; N] {
self.to_le_radix(256)
// docs:end:to_le_bytes
// Compute the byte decomposition
let bytes = self.to_le_radix(256);

if !is_unconstrained() {
// Ensure that the byte decomposition does not overflow the modulus
let p = modulus_le_bytes();
assert(bytes.len() <= p.len());
let mut ok = bytes.len() != p.len();
for i in 0..N {
if !ok {
if (bytes[N - 1 - i] != p[N - 1 - i]) {
assert(bytes[N - 1 - i] < p[N - 1 - i]);
ok = true;
}
}
}
assert(ok);
}
bytes
}
// docs:end:to_le_bytes

/// Decomposes `self` into its big endian byte decomposition as a `[u8]` slice of length `byte_size`.
/// This slice will be zero padded should not all bytes be necessary to represent `self`.
/// Decomposes `self` into its big endian byte decomposition as a `[u8;N]` array of length required to represent the field modulus
/// This array will be zero padded should not all bytes be necessary to represent `self`.
///
/// # Failures
/// Causes a constraint failure for `Field` values exceeding `2^{8*byte_size}` as the resulting slice will not
/// be able to represent the original `Field`.
/// The length N of the array must be big enough to contain all the bytes of the 'self',
/// and no more than the number of bytes required to represent the field modulus
///
/// # Safety
/// Values of `byte_size` equal to or greater than the number of bytes necessary to represent the `Field` modulus
/// (e.g. 32 for the BN254 field) allow for multiple byte decompositions. This is due to how the `Field` will
/// wrap around due to overflow when verifying the decomposition.
/// The result is ensured to be the canonical decomposition of the field element
// docs:start:to_be_bytes
pub fn to_be_bytes<let N: u32>(self: Self) -> [u8; N] {
self.to_be_radix(256)
// docs:end:to_be_bytes
// Compute the byte decomposition
let bytes = self.to_be_radix(256);

if !is_unconstrained() {
// Ensure that the byte decomposition does not overflow the modulus
let p = modulus_be_bytes();
assert(bytes.len() <= p.len());
let mut ok = bytes.len() != p.len();
for i in 0..N {
if !ok {
if (bytes[i] != p[i]) {
assert(bytes[i] < p[i]);
ok = true;
}
}
}
assert(ok);
}
bytes
}
// docs:end:to_be_bytes

// docs:start:to_le_radix
pub fn to_le_radix<let N: u32>(self: Self, radix: u32) -> [u8; N] {
Expand Down Expand Up @@ -130,6 +163,32 @@ impl Field {
lt_fallback(self, another)
}
}

/// Convert a little endian byte array to a field element.
/// If the provided byte array overflows the field modulus then the Field will silently wrap around.
pub fn from_le_bytes<let N: u32>(bytes: [u8; N]) -> Field {
let mut v = 1;
let mut result = 0;

for i in 0..N {
result += (bytes[i] as Field) * v;
v = v * 256;
}
result
}

/// Convert a big endian byte array to a field element.
/// If the provided byte array overflows the field modulus then the Field will silently wrap around.
pub fn from_be_bytes<let N: u32>(bytes: [u8; N]) -> Field {
let mut v = 1;
let mut result = 0;

for i in 0..N {
result += (bytes[N-1-i] as Field) * v;
v = v * 256;
}
result
}
}

#[builtin(modulus_num_bits)]
Expand Down Expand Up @@ -207,6 +266,7 @@ mod tests {
let field = 2;
let bits: [u8; 8] = field.to_be_bytes();
assert_eq(bits, [0, 0, 0, 0, 0, 0, 0, 2]);
assert_eq(Field::from_be_bytes::<8>(bits), field);
}
// docs:end:to_be_bytes_example

Expand All @@ -216,6 +276,7 @@ mod tests {
let field = 2;
let bits: [u8; 8] = field.to_le_bytes();
assert_eq(bits, [2, 0, 0, 0, 0, 0, 0, 0]);
assert_eq(Field::from_le_bytes::<8>(bits), field);
}
// docs:end:to_le_bytes_example

Expand All @@ -225,6 +286,7 @@ mod tests {
let field = 2;
let bits: [u8; 8] = field.to_be_radix(256);
assert_eq(bits, [0, 0, 0, 0, 0, 0, 0, 2]);
assert_eq(Field::from_be_bytes::<8>(bits), field);
}
// docs:end:to_be_radix_example

Expand All @@ -234,6 +296,7 @@ mod tests {
let field = 2;
let bits: [u8; 8] = field.to_le_radix(256);
assert_eq(bits, [2, 0, 0, 0, 0, 0, 0, 0]);
assert_eq(Field::from_le_bytes::<8>(bits), field);
}
// docs:end:to_le_radix_example
}
1 change: 1 addition & 0 deletions test_programs/execution_success/to_be_bytes/src/main.nr
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,6 @@ fn main(x: Field) -> pub [u8; 31] {
if (bytes[30] != 60) | (bytes[29] != 33) | (bytes[28] != 31) {
assert(false);
}
assert(Field::from_be_bytes::<31>(bytes) == x);
bytes
}
9 changes: 2 additions & 7 deletions test_programs/execution_success/to_le_bytes/src/main.nr
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,12 @@ fn main(x: Field, cond: bool) -> pub [u8; 31] {
// The result of this byte array will be little-endian
let byte_array: [u8; 31] = x.to_le_bytes();
assert(byte_array.len() == 31);

let mut bytes = [0; 31];
for i in 0..31 {
bytes[i] = byte_array[i];
}

assert(Field::from_le_bytes::<31>(byte_array) == x);
if cond {
// We've set x = "2040124" so we shouldn't be able to represent this as a single byte.
let bad_byte_array: [u8; 1] = x.to_le_bytes();
assert_eq(bad_byte_array.len(), 1);
}

bytes
byte_array
}

0 comments on commit b280a79

Please sign in to comment.