cheng/libsodium
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Mention that sodium_alloc() can be used with sodium data structures

Browse Source 
And explain how to deal with crypto_generichash_state
This commit is contained in:
Frank Denis 2015-01-13 11:04:39 +01:00
parent 43e9187e87
commit 8ba7fbd062
1 changed files with 10 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
src/libsodium/include/sodium/utils.h
View File

@ -65,9 +65,16 @@ int sodium_munlock(void * const addr, const size_t len);
* - The returned address will not be aligned if the allocation size is not
* a multiple of the required alignment. For this reason, these functions
* are designed to store data, such as secret keys and messages.
* They should not be used to store pointers mixed with other types
* in portable code unless extreme care is taken to ensure correct
* pointers alignment.
*
* sodium_malloc() can be used to allocate any libsodium data structure,
* with the exception of crypto_generichash_state.
*
* The crypto_generichash_state structure is packed and its length is
* either 357 or 361 bytes. For this reason, when using sodium_malloc() to
* allocate a crypto_generichash_state structure, padding must be added in
* order to ensure proper alignment:
* state = sodium_malloc((sizeof(crypto_generichash_state)
* + (size_t) 63U) & ~(size_t) 63U);
*/
SODIUM_EXPORT