jedisct1/libsodium
1
0
Fork 0
mirror of https://github.com/jedisct1/libsodium.git synced 2025-05-08 07:05:59 +08:00
Code Issues Projects Releases Wiki Activity

Nits

Browse Source
This commit is contained in:
Frank Denis 2025-04-30 01:41:10 +02:00
parent 72fdf1b86c
commit d67b1e8f8d
2 changed files with 20 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
src/libsodium/include/sodium/private/common.h
View File

@ -3,17 +3,17 @@
#if !defined(_MSC_VER) && !defined(DEV_MODE) && 1
# warning *** This is unstable, untested, development code.
# warning It might not compile. It might not work as expected.
# warning It might be totally insecure.
# warning Do not use this except if you are planning to contribute code.
# warning Use releases available at https://download.libsodium.org/libsodium/releases/ instead.
# warning Alternatively, use the "stable" branch in the git repository.
# warning *** It might not compile. It might not work as expected.
# warning *** It might be totally insecure.
# warning *** Do not use this except if you are planning to contribute code.
# warning *** Use releases available at https://download.libsodium.org/libsodium/releases/ instead.
# warning *** Alternatively, use the "stable" branch in the git repository.
#endif
#if !defined(_MSC_VER) && (!defined(CONFIGURED) || CONFIGURED != 1)
# warning *** The library is being compiled using an undocumented method.
# warning This is not supported. It has not been tested, it might not
# warning work as expected, and performance is likely to be suboptimal.
# warning *** This is not supported. It has not been tested, it might not
# warning *** work as expected, and performance is likely to be suboptimal.
#endif
#include <stdint.h>

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

@ -109,33 +109,33 @@ int sodium_munlock(void * const addr, const size_t len)
* allocation functions.
*
* They return a pointer to a region filled with 0xd0 bytes, immediately
* followed by a guard page.
* As a result, accessing a single byte after the requested allocation size
* will intentionally trigger a segmentation fault.
* followed by a guard page. As a result, accessing a single byte after the
* requested allocation size will intentionally trigger a segmentation fault.
*
* A canary and an additional guard page placed before the beginning of the
* region may also kill the process if a buffer underflow is detected.
*
* The memory layout is:
* [unprotected region size (read only)][guard page (no access)][unprotected pages (read/write)][guard page (no access)]
* With the layout of the unprotected pages being:
*
* The layout of the unprotected pages is:
* [optional padding][16-bytes canary][user region]
*
* However:
* - These functions are significantly slower than standard functions
* - Each allocation requires 3 or 4 additional pages
* Important limitations:
* - These functions are significantly slower than standard allocation functions.
* - Each allocation requires 3 or 4 additional pages.
* - 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.
* are designed to store data such as secret keys and messages.
*
* sodium_malloc() can be used to allocate any libsodium data structure.
*
* 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. crypto_generichash_statebytes()
* returns the rounded up structure size, and should be preferred to sizeof():
* state = sodium_malloc(crypto_generichash_statebytes());
* either 357 or 361 bytes. When using sodium_malloc() to allocate a
* crypto_generichash_state structure, padding must be added to ensure
* proper alignment. Use crypto_generichash_statebytes() rather than sizeof():
*
* state = sodium_malloc(crypto_generichash_statebytes());
*/
SODIUM_EXPORT