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

Documentation on the generate() output-size for HMAC-based secret key newtypes is incorrect #169

Closed
brycx opened this issue Feb 2, 2021 · 0 comments · Fixed by #172
Closed
Labels
bug Something isn't working documentation Issues and improvements sorrounding the documentation

Comments

@brycx
Copy link
Member

brycx commented Feb 2, 2021

The documentation states:

https://github.com/brycx/orion/blob/41f805378d3e7318e7ba186569a08c9cee0c0a65/src/typedefs.rs#L637

This is incorrect as it will actually generate equal to the size of the underlying SHA2 blocksize (128). This comment should be made generic, such that it can be valid for the upcoming different variants of SHA2:

// Initialize a secret key with random bytes.

The length of it can always be found with the .len() function.

@brycx brycx added bug Something isn't working documentation Issues and improvements sorrounding the documentation labels Feb 2, 2021
@brycx brycx closed this as completed in #172 Feb 8, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Issues and improvements sorrounding the documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant