yuzu-emu/mbedtls
1
0
Fork 0
mirror of https://github.com/yuzu-emu/mbedtls.git synced 2024-11-25 14:55:40 +01:00
Code Issues Packages Projects Releases Wiki Activity

Improve some documentation and ChangeLog entry

Browse Source
This commit is contained in:
Manuel Pégourié-Gonnard 2018-12-13 09:45:49 +01:00
parent a4251f4775
commit e7306d30a9
3 changed files with 18 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
ChangeLog
View File

@ -23,10 +23,14 @@ Security
modules.
Features
* Add new config.h flag MBEDTLS_CHECK_PARAMS that enables validation of
more of the parameters by public API functions (see its documentation in
config.h for details). Disabled by default - requires users to provide an
implementation of the callback function or macro.
* Add a new config.h option of MBEDTLS_CHECK_PARAMS that enables additional
validation of parameters in the library's public interface. This does not
change the API of existing functions, but additional clarity has been
added to the defined documentation interface to make clearer what the
interface is designed to accept. See the corresponding API documentation
for each function to see what parameter values are defined as invalid.
This feature is disabled by default. See its API documentation in
config.h for additional steps you have to take when enabling it.
New deprecations
* Deprecate mbedtls_ctr_drbg_update and mbedtls_hmac_drbg_update

9
include/mbedtls/config.h
View File

@ -292,6 +292,9 @@
* calls that function, but does not provide a default definition for it,
* - or provide a different definition of the macro MBEDTLS_PARAM_FAILED()
* below if the above mechanism is not flexible enough to suit your needs.
* Note that you may define it to expand to nothing if you're happy to be
* notified about invalid parameters only in non-void functions, and have
* void function just silently return early on invalid parameters.
*
* Uncomment to enable validation of application-controlled parameters.
*/
@ -3055,6 +3058,12 @@
* from within the library - you can ensure that by providing
* them in this file next to the macro definition).
*
* Note that you may define this macro to expand to nothing, in
* which case you don't have to worry about declarations or
* definitions. However, you will then be notified about invalid
* parameters only in non-void functions, and void function will
* just silently return early on invalid parameters.
*
* \param cond The expression that should evaluate to true, but doesn't.
*/
//#define MBEDTLS_PARAM_FAILED( cond ) assert( cond )

2
tests/suites/helpers.function
View File

@ -199,7 +199,7 @@ typedef enum
* Note: this macro is available even when #MBEDTLS_CHECK_PARAMS is
* disabled, as it makes sense to check that the functions accept all
* legal values even if this option is disabled - only in that case,
* the test if more about whether the function segfaults than about
* the test is more about whether the function segfaults than about
* whether it invokes MBEDTLS_PARAM_FAILED().
*
* \param TEST The test expression to be tested.