coffee/mbedtls
1
0
Fork 0
mirror of https://github.com/Mbed-TLS/mbedtls.git synced 2026-07-30 16:26:33 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge cb96ae0b68d4f8233b9232f42c440a09ee5667a8 into f4a1aceb8ca7198b11447d6e1885ce70feb2dcc6

Browse Source
This commit is contained in:
Gilles Peskine 2026-07-27 21:04:44 +01:00 committed by GitHub
commit c4b7ab2a66
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
5 changed files with 136 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
CMakeLists.txt
View File

@ -139,7 +139,7 @@ find_package(Threads)
# If this is the root project add longer list of available CMAKE_BUILD_TYPE values
if(CMAKE_SOURCE_DIR STREQUAL CMAKE_CURRENT_SOURCE_DIR)
set(CMAKE_BUILD_TYPE ${CMAKE_BUILD_TYPE}
CACHE STRING "Choose the type of build: None Debug Release Coverage ASan ASanDbg MemSan MemSanDbg Check CheckFull TSan TSanDbg"
CACHE STRING "Choose the type of build: None Debug Release Coverage ASan ASanDbg CFMemSan CFMemSanDbg MemSan MemSanDbg Check CheckFull TSan TSanDbg"
FORCE)
endif()
@ -264,6 +264,14 @@ if(CMAKE_COMPILER_IS_CLANG)
set(CMAKE_C_FLAGS_TSAN "-fsanitize=thread -O3")
set(CMAKE_C_FLAGS_TSANDBG "-fsanitize=thread -O1 -g3 -fno-omit-frame-pointer -fno-optimize-sibling-calls")
set(CMAKE_C_FLAGS_CHECK "-Os")
set(CMAKE_C_FLAGS_CFMEMSAN "${CMAKE_C_FLAGS_MEMSAN} -DMBEDTLS_TEST_CONSTANT_FLOW_MEMSAN")
set(CMAKE_C_FLAGS_CFMEMSANDBG "${CMAKE_C_FLAGS_MEMSANDBG} -DMBEDTLS_TEST_CONSTANT_FLOW_MEMSAN")
if(CMAKE_C_COMPILER_VERSION VERSION_GREATER 16.0.0)
set(CMAKE_C_FLAGS_CFMEMSAN "${CMAKE_C_FLAGS_CFMEMSAN} -fno-sanitize-memory-param-retval")
set(CMAKE_C_FLAGS_CFMEMSANDBG "${CMAKE_C_FLAGS_CFMEMSANDBG} -fno-sanitize-memory-param-retval")
endif()
endif(CMAKE_COMPILER_IS_CLANG)
if(CMAKE_COMPILER_IS_IAR)

6
include/mbedtls/mbedtls_config.h
View File

@ -2112,8 +2112,10 @@
* clang's MemorySanitizer. This causes some existing tests to also test
* this non-functional property of the code under test.
*
* This setting requires compiling with clang -fsanitize=memory. The test
* suites can then be run normally.
* This setting requires compiling with
* `clang -fsanitize=memory -fno-sanitize-memory-param-retval` with Clang 16
* and above, or `clang -fsanitize=memory` with older Clang.
* The test suites can then be run normally.
*
* \warning This macro is only used for extended testing; it is not considered
* part of the library's API, so it may change or disappear at any time.

14
tests/scripts/components-sanitizers.sh
View File

@ -33,17 +33,16 @@ skip_all_except_given_suite () {
component_test_memsan_constant_flow () {
# This tests both (1) accesses to undefined memory, and (2) branches or
# memory access depending on secret values. To distinguish between those:
# - unset MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN - does the failure persist?
# - or alternatively, change the build type to MemSanDbg, which enables
# - change the build type to MemSan - does the failure persist?
# - or alternatively, change the build type to CFMemSanDbg, which enables
# origin tracking and nicer stack traces (which are useful for debugging
# anyway), and check if the origin was TEST_CF_SECRET() or something else.
msg "build: cmake MSan (clang), full config minus MBEDTLS_USE_PSA_CRYPTO with constant flow testing"
scripts/config.py full
scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
scripts/config.py unset MBEDTLS_HAVE_ASM
CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
CC=clang cmake -D CMAKE_BUILD_TYPE:String=CFMemSan .
make
msg "test: main suites (full minus MBEDTLS_USE_PSA_CRYPTO, Msan + constant flow)"
@ -53,16 +52,15 @@ component_test_memsan_constant_flow () {
component_test_memsan_constant_flow_psa () {
# This tests both (1) accesses to undefined memory, and (2) branches or
# memory access depending on secret values. To distinguish between those:
# - unset MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN - does the failure persist?
# - or alternatively, change the build type to MemSanDbg, which enables
# - change the build type to MemSan - does the failure persist?
# - or alternatively, change the build type to CFMemSanDbg, which enables
# origin tracking and nicer stack traces (which are useful for debugging
# anyway), and check if the origin was TEST_CF_SECRET() or something else.
msg "build: cmake MSan (clang), full config with constant flow testing"
scripts/config.py full
scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
scripts/config.py unset MBEDTLS_HAVE_ASM
CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
CC=clang cmake -D CMAKE_BUILD_TYPE:String=CFMemSan .
make
msg "test: main suites (Msan + constant flow)"

27
tests/suites/test_suite_constant_time.data
View File

@ -1,3 +1,30 @@
Constant-flow instrumentation: NOP
cf_instrumentation:CF_INSTRUMENTATION_NOP
Constant-flow instrumentation: memcpy
cf_instrumentation:CF_INSTRUMENTATION_MEMCPY
Constant-flow instrumentation: memmove
cf_instrumentation:CF_INSTRUMENTATION_MEMMOVE
Constant-flow instrumentation: copy with for loop
cf_instrumentation:CF_INSTRUMENTATION_COPY_LOOP
# Detect sanitizers where a secret value may not be passed to a function.
# Such sanitizers cause false positives in most of the other constant-flow
# tests.
# This is the case with MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN when building
# with Clang >=16 with just -fsanitize=memory. The fix is to pass the
# additional option -fno-sanitize-memory-param-retval to clang.
Constant-flow instrumentation: copy through function
cf_instrumentation:CF_INSTRUMENTATION_COPY_THROUGH_FUNCTION
Constant-flow instrumentation: memset
cf_instrumentation:CF_INSTRUMENTATION_MEMSET
Constant-flow instrumentation: mbedtls_platform_zeroize
cf_instrumentation:CF_INSTRUMENTATION_ZEROIZE
# these are the numbers we'd get with an empty plaintext and truncated HMAC
Constant-flow memcpy from offset: small
mbedtls_ct_memcpy_offset:0:5:10

90
tests/suites/test_suite_constant_time.function
View File

@ -19,8 +19,98 @@
#include <constant_time_internal.h>
#include <test/constant_flow.h>
/* Which kind of smoke test cf_instrumentation will do. */
typedef enum {
CF_INSTRUMENTATION_NOP,
CF_INSTRUMENTATION_MEMCPY,
CF_INSTRUMENTATION_MEMMOVE,
CF_INSTRUMENTATION_COPY_LOOP,
CF_INSTRUMENTATION_COPY_THROUGH_FUNCTION,
CF_INSTRUMENTATION_MEMSET,
CF_INSTRUMENTATION_ZEROIZE,
} cf_instrumentation_method_t;
/* A function that is non-inlined on GCC-like compilers, including Clang.
* Use this to implement CF_INSTRUMENTATION_COPY_THROUGH_FUNCTION.
*/
#if defined(__has_attribute)
#if __has_attribute(noinline)
__attribute__((noinline))
#endif
#endif
static unsigned char u8_identity_function(unsigned char c)
{
return c;
}
/* END_HEADER */
/* BEGIN_CASE */
/* Test the constant-flow instrumentation. If this test function fails,
* something is wrong with the constant-flow instrumentation. */
void cf_instrumentation(int method)
{
unsigned char a[42] = { 0 };
unsigned char *p = NULL;
/* Set the buffer at p to some not-all-zero pattern,
* unless using the NOP method. */
TEST_CALLOC(p, sizeof(a));
if (method != CF_INSTRUMENTATION_NOP) {
for (size_t i = 0; i < sizeof(a); i++) {
p[i] = i & 0xff;
}
}
TEST_CF_SECRET(&a, sizeof(a));
TEST_CF_SECRET(p, sizeof(a));
/* Set the buffer at p to all-zero, possibly using a, in constant time. */
switch (method) {
case CF_INSTRUMENTATION_NOP:
/* p is already zero per above. */
break;
case CF_INSTRUMENTATION_MEMCPY:
memcpy(p, a, sizeof(a));
break;
case CF_INSTRUMENTATION_MEMMOVE:
memmove(p, a, sizeof(a));
break;
case CF_INSTRUMENTATION_COPY_LOOP:
for (size_t i = 0; i < sizeof(a); i++) {
p[i] = a[i];
}
break;
case CF_INSTRUMENTATION_COPY_THROUGH_FUNCTION:
for (size_t i = 0; i < sizeof(a); i++) {
p[i] = u8_identity_function(a[i]);
}
break;
case CF_INSTRUMENTATION_MEMSET:
memset(p, 0, sizeof(a));
break;
case CF_INSTRUMENTATION_ZEROIZE:
mbedtls_platform_zeroize(p, sizeof(a));
break;
default:
TEST_CF_PUBLIC(&a, sizeof(a));
TEST_CF_PUBLIC(p, sizeof(a));
TEST_FAIL("Unknown instrumentation method");
}
/* Check that the buffer at p is now all-zero, not in constant time.
* If this triggers a constant-flow violation, TEST_CF_PUBLIC isn't
* doing its job. */
TEST_CF_PUBLIC(&a, sizeof(a));
TEST_CF_PUBLIC(p, sizeof(a));
ASSERT_COMPARE(a, sizeof(a), p, sizeof(a));
exit:
mbedtls_free(p);
}
/* END_CASE */
/* BEGIN_CASE */
void mbedtls_ct_memcmp_null()
{