frost/secp256k1-zkp
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Improve comments for surctionproof init+alloc/destroy funcs

Browse Source 
The comments with 'XXX' was intended to indicate that the listed
concerns was subject to review and change, but the code with these
comments was merged straight away. This commit replaces comments
with more complete text describing the issues.

This also signifies that the commit that this code was introduced in is
not anymore 'work in progress'.
This commit is contained in:
Dmitry Petukhov 2019-05-26 18:37:29 +05:00 committed by Andrew Poelstra
parent 250ebb364e
commit 6f3b0c05c2
1 changed files with 13 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
src/modules/surjection/main_impl.h
View File

@ -151,7 +151,10 @@ static size_t secp256k1_surjectionproof_csprng_next(secp256k1_surjectionproof_cs
}
}
/* XXX secp256k1_surjectionproof_create is not a good name, because it can be confused with secp256k1_surjectionproof_generate */
/* While '_allocate_initialized' may be a wordy suffix for this function, and '_create'
* may have been more appropriate, '_create' could be confused with '_generate',
* as the meanings for the words are close. Therefore, more wordy, but less
* ambiguous suffix was chosen. */
int secp256k1_surjectionproof_allocate_initialized(const secp256k1_context* ctx, secp256k1_surjectionproof** proof_out_p, size_t *input_index, const secp256k1_fixed_asset_tag* fixed_input_tags, const size_t n_input_tags, const size_t n_input_tags_to_use, const secp256k1_fixed_asset_tag* fixed_output_tag, const size_t n_max_iterations, const unsigned char *random_seed32) {
int ret = 0;
secp256k1_surjectionproof* proof;
@ -174,7 +177,15 @@ int secp256k1_surjectionproof_allocate_initialized(const secp256k1_context* ctx,
return ret;
}
/* XXX add checks to prevent destroy of stack-allocated struct ? */
/* secp256k1_surjectionproof structure may also be allocated on the stack,
* and initialized explicitly via secp256k1_surjectionproof_initialize().
* Supplying stack-allocated struct to _destroy() will result in calling
* free() with the pointer that points at the stack, with disasterous
* consequences. Thus, it is not advised to mix heap- and stack-allocating
* approaches to working with this struct. It is possible to detect this
* situation by using additional field in the struct that can be set to
* special value depending on the allocation path, and check it here.
* But currently, it is not seen as big enough concern to warrant this extra code .*/
void secp256k1_surjectionproof_destroy(secp256k1_surjectionproof* proof) {
if (proof != NULL) {
VERIFY_CHECK(proof->n_inputs <= SECP256K1_SURJECTIONPROOF_MAX_N_INPUTS);