mbedtls/include/mbedtls
Gilles Peskine 463adf4536 Define indirection macros MBEDTLS_CHECK_RETURN_xxx
Define macros MBEDTLS_CHECK_RETURN_CRITICAL, MBEDTLS_CHECK_RETURN_TYPICAL
and MBEDTLS_CHECK_RETURN_OPTIONAL so that we can indicate on a
function-by-function basis whether checking the function's return value is
almost always necessary (CRITICAL), typically necessary in portable
applications but unnecessary in some reasonable cases (TYPICAL), or
typically unnecessary (OPTIONAL).

Update the documentation of MBEDTLS_CHECK_RETURN accordingly. This is split
between the user documentation (Doxygen, in config.h) and the internal
documentation (non-Doxygen, in platform_util.h, of minor importance since
the macro isn't meant to be used directly).

Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
2021-09-27 19:15:56 +02:00
..
aes.h Move MBEDTLS_CHECK_RETURN to platform_util. 2021-09-27 19:15:56 +02:00
aria.h Move MBEDTLS_ERR_xxx Doxygen comments before the definition 2021-08-02 22:51:03 +02:00
asn1.h Move MBEDTLS_ERR_xxx Doxygen comments before the definition 2021-08-02 22:51:03 +02:00
asn1write.h Replace all inclusions of config.h 2021-06-28 09:24:07 +01:00
base64.h Move MBEDTLS_ERR_xxx Doxygen comments before the definition 2021-08-02 22:51:03 +02:00
bignum.h Move MBEDTLS_ERR_xxx Doxygen comments before the definition 2021-08-02 22:51:03 +02:00
build_info.h Move MBEDTLS_CHECK_RETURN to platform_util. 2021-09-27 19:15:56 +02:00
camellia.h Move MBEDTLS_ERR_xxx Doxygen comments before the definition 2021-08-02 22:51:03 +02:00
ccm.h Replace BAD_SEQUENCE error with BAD_INPUT 2021-09-01 13:26:44 +02:00
chacha20.h Move MBEDTLS_ERR_xxx Doxygen comments before the definition 2021-08-02 22:51:03 +02:00
chachapoly.h Move MBEDTLS_ERR_xxx Doxygen comments before the definition 2021-08-02 22:51:03 +02:00
check_config.h Merge pull request #4659 from spencer-burke/fixing_4222 2021-08-03 12:53:34 +02:00
cipher.h Move MBEDTLS_ERR_xxx Doxygen comments before the definition 2021-08-02 22:51:03 +02:00
cmac.h Replace all inclusions of config.h 2021-06-28 09:24:07 +01:00
compat-2.x.h Code review fixes 2021-06-18 12:59:38 +02:00
config_psa.h Fix typos pointed out by check_names 2021-08-10 11:26:15 +01:00
ctr_drbg.h Move MBEDTLS_ERR_xxx Doxygen comments before the definition 2021-08-02 22:51:03 +02:00
debug.h Replace all inclusions of config.h 2021-06-28 09:24:07 +01:00
des.h Move MBEDTLS_CHECK_RETURN to platform_util. 2021-09-27 19:15:56 +02:00
dhm.h Move MBEDTLS_ERR_xxx Doxygen comments before the definition 2021-08-02 22:51:03 +02:00
ecdh.h Replace all inclusions of config.h 2021-06-28 09:24:07 +01:00
ecdsa.h Merge pull request #4694 from gilles-peskine-arm/out_size-3.0 2021-06-29 09:43:17 +02:00
ecjpake.h Replace all inclusions of config.h 2021-06-28 09:24:07 +01:00
ecp.h Move MBEDTLS_ERR_xxx Doxygen comments before the definition 2021-08-02 22:51:03 +02:00
entropy.h Move MBEDTLS_ERR_xxx Doxygen comments before the definition 2021-08-02 22:51:03 +02:00
error.h Move MBEDTLS_ERR_xxx Doxygen comments before the definition 2021-08-02 22:51:03 +02:00
gcm.h Move MBEDTLS_ERR_xxx Doxygen comments before the definition 2021-08-02 22:51:03 +02:00
hkdf.h Move MBEDTLS_ERR_xxx Doxygen comments before the definition 2021-08-02 22:51:03 +02:00
hmac_drbg.h Move MBEDTLS_ERR_xxx Doxygen comments before the definition 2021-08-02 22:51:03 +02:00
mbedtls_config.h Define indirection macros MBEDTLS_CHECK_RETURN_xxx 2021-09-27 19:15:56 +02:00
md.h Move MBEDTLS_ERR_xxx Doxygen comments before the definition 2021-08-02 22:51:03 +02:00
md5.h Replace all inclusions of config.h 2021-06-28 09:24:07 +01:00
memory_buffer_alloc.h Rename config.h to mbedtls_config.h 2021-06-28 09:28:33 +01:00
net_sockets.h Move MBEDTLS_ERR_xxx Doxygen comments before the definition 2021-08-02 22:51:03 +02:00
nist_kw.h Replace all inclusions of config.h 2021-06-28 09:24:07 +01:00
oid.h Move MBEDTLS_ERR_xxx Doxygen comments before the definition 2021-08-02 22:51:03 +02:00
pem.h Move MBEDTLS_ERR_xxx Doxygen comments before the definition 2021-08-02 22:51:03 +02:00
pk.h Move MBEDTLS_ERR_xxx Doxygen comments before the definition 2021-08-02 22:51:03 +02:00
pkcs5.h Move MBEDTLS_ERR_xxx Doxygen comments before the definition 2021-08-02 22:51:03 +02:00
pkcs12.h Move MBEDTLS_ERR_xxx Doxygen comments before the definition 2021-08-02 22:51:03 +02:00
platform.h Rename config.h to mbedtls_config.h 2021-06-28 09:28:33 +01:00
platform_time.h Rename config.h to mbedtls_config.h 2021-06-28 09:28:33 +01:00
platform_util.h Define indirection macros MBEDTLS_CHECK_RETURN_xxx 2021-09-27 19:15:56 +02:00
poly1305.h Move MBEDTLS_ERR_xxx Doxygen comments before the definition 2021-08-02 22:51:03 +02:00
private_access.h Introduce MBEDTLS_PRIVATE macro. 2021-05-21 18:07:06 +02:00
psa_util.h Replace all inclusions of config.h 2021-06-28 09:24:07 +01:00
ripemd160.h Replace all inclusions of config.h 2021-06-28 09:24:07 +01:00
rsa.h Move MBEDTLS_ERR_xxx Doxygen comments before the definition 2021-08-02 22:51:03 +02:00
sha1.h Move MBEDTLS_ERR_xxx Doxygen comments before the definition 2021-08-02 22:51:03 +02:00
sha256.h Move MBEDTLS_ERR_xxx Doxygen comments before the definition 2021-08-02 22:51:03 +02:00
sha512.h Move MBEDTLS_ERR_xxx Doxygen comments before the definition 2021-08-02 22:51:03 +02:00
ssl.h Add NamedGroup IANA values and helper functions 2021-09-08 09:52:15 +08:00
ssl_cache.h Rename config.h to mbedtls_config.h 2021-06-28 09:28:33 +01:00
ssl_ciphersuites.h Add TLS 1.3 ciphersuites 2021-08-12 06:28:45 +01:00
ssl_cookie.h Rename config.h to mbedtls_config.h 2021-06-28 09:28:33 +01:00
ssl_ticket.h Replace all inclusions of config.h 2021-06-28 09:24:07 +01:00
threading.h Move MBEDTLS_ERR_xxx Doxygen comments before the definition 2021-08-02 22:51:03 +02:00
timing.h Replace all inclusions of config.h 2021-06-28 09:24:07 +01:00
version.h Correct documentation references to Mbed TLS 2021-06-28 10:37:19 +01:00
x509.h Move MBEDTLS_ERR_xxx Doxygen comments before the definition 2021-08-02 22:51:03 +02:00
x509_crl.h Replace all inclusions of config.h 2021-06-28 09:24:07 +01:00
x509_crt.h Replace all inclusions of config.h 2021-06-28 09:24:07 +01:00
x509_csr.h Replace all inclusions of config.h 2021-06-28 09:24:07 +01:00