Skip to content

Conversation

@olomix
Copy link
Collaborator

@olomix olomix commented Oct 16, 2025

  • Refactored buffer validation in groth16_prover_prove: Previously, buffer validation happened twice—first checking against minimum sizes before proof generation, then again against actual sizes after. This meant callers could
    receive PROVER_ERROR_SHORT_BUFFER twice: once for undersized buffers, then again after reallocating to minimum size if the actual proof was larger. Now validation occurs only after proof generation. Callers should use
    groth16_public_size_for_zkey_buf() or groth16_public_size_for_zkey_file() to pre-allocate minimum-sized buffers. If buffers are still insufficient after proof generation, the error message returns exact required sizes, allowing
    single reallocation.
  • Improved error handling: Replaced strncpy() with snprintf()/vsnprintf() for safer string handling. Added CopyErrorFmt() with printf-style formatting and compile-time format checking. Input validation now uses early-return
    pattern instead of exceptions.
  • Removed dead code: Deleted ShortBufferException, CheckAndUpdateBufferSizes(), and unused proofBufferMinSize()/publicBufferMinSize() methods.
  • Documentation: Fixed PPOVER_ERROR → PROVER_ERROR typos. Added detailed parameter docs for groth16_prover_prove() clarifying in/out semantics and null terminator behavior.
  • CI fix: Changed ctest to run from build_prover_macos_arm64 directory on macOS ARM64.

…rors

Add PROVER_ERROR_INSUFFICIENT_BUFFER to distinguish between buffer size
failures that occur before vs after proof generation:

- PROVER_ERROR_SHORT_BUFFER: Buffer smaller than minimum size, checked
  before calling the expensive prove() operation. Allows early return
  without wasting computation.

- PROVER_ERROR_INSUFFICIENT_BUFFER: Buffer smaller than actual proof
  output size, checked after prove() completes. Occurs when proof size
  exceeds the minimum estimate.

This two-phase validation prevents unnecessary proof generation when
buffers are obviously too small, while handling edge cases where the
actual proof exceeds minimum size estimates.

Additional improvements:
- Add CopyErrorFmt() for safe variadic error formatting
- Fix error messages to show original (not updated) buffer sizes
- Add overflow protection for buffer size calculations
- Replace strncpy with memcpy for explicit string handling
- Remove unused ShortBufferException and CheckAndUpdateBufferSizes
- Document buffer size semantics (output excludes null terminator)
- Fix CopyError to guarantee null-termination with snprintf
@olomix olomix closed this Nov 6, 2025
@olomix olomix deleted the macos26 branch November 6, 2025 13:15
@olomix olomix restored the macos26 branch November 6, 2025 13:17
@olomix olomix reopened this Nov 6, 2025
@olomix olomix marked this pull request as draft November 6, 2025 13:18
Remove pre-proof-generation buffer size check. Buffer validation now
happens only after proof generation, checking if the actual output fits.
Remove unused PROVER_ERROR_INSUFFICIENT_BUFFER error code and dead code
from Groth16Prover class. Fix PPOVER_ERROR typos in documentation.
Add PROVER_INVALID_WITNESS_LENGTH to return value documentation
for groth16_prover and groth16_prover_zkey_file.
@olomix olomix marked this pull request as ready for review December 3, 2025 17:25
@olomix olomix merged commit 4f8f547 into main Dec 4, 2025
17 of 21 checks passed
@olomix olomix deleted the macos26 branch December 4, 2025 17:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants