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

misleading variable name(s) in Evercrypt_Ed25519.h header #366

Closed
niekbouman opened this issue Oct 7, 2020 · 1 comment
Closed

misleading variable name(s) in Evercrypt_Ed25519.h header #366

niekbouman opened this issue Oct 7, 2020 · 1 comment

Comments

@niekbouman
Copy link

Hi Evercrypt maintainers,

I noticed that in some function prototypes in the header file Evercrypt_Ed25519.h , which is merely a wrapper around Hacl's Ed25519 code, a misleading name is used for some parameters.

For example:

bool EverCrypt_Ed25519_verify(uint8_t *output, uint32_t len, uint8_t *msg, uint8_t *signature);

while 'output' is incorrect here; it is in fact not an output but the public key input, thus the prototype should be:

bool EverCrypt_Ed25519_verify(uint8_t *pub, uint32_t len, uint8_t *msg, uint8_t *signature);

I have not checked whether the same issue is present in other headers as well.

Of course this is not a bug, because the compiler ignores those names, but it might confuse users of the library.

best regards,
Niek

@msprotz
Copy link
Contributor

msprotz commented Nov 17, 2022

This one was fixed by @polubelova and documentation was added too. This is part of a more general issue about consistent naming which is addressed in #675

@msprotz msprotz closed this as completed Nov 17, 2022
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

3 participants