Revert "Move constant_flow.h into the main library"
This reverts commit fd78c34e23c95a49b0c0790b714aee7cd85335c9.
Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
diff --git a/tests/include/test/constant_flow.h b/tests/include/test/constant_flow.h
new file mode 100644
index 0000000..ff464e6
--- /dev/null
+++ b/tests/include/test/constant_flow.h
@@ -0,0 +1,108 @@
+/**
+ * \file constant_flow.h
+ *
+ * \brief This file contains tools to ensure tested code has constant flow.
+ */
+
+/*
+ * Copyright The Mbed TLS Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#ifndef TEST_CONSTANT_FLOW_H
+#define TEST_CONSTANT_FLOW_H
+
+#include "mbedtls/build_info.h"
+
+/*
+ * This file defines the two macros
+ *
+ * #define TEST_CF_SECRET(ptr, size)
+ * #define TEST_CF_PUBLIC(ptr, size)
+ *
+ * and
+ *
+ * #define TEST_CF_SAVE_SECRET(variable)
+ * #define TEST_CF_RESTORE_SECRET(variable)
+ *
+ * that can be used in tests to mark a memory area as secret (no branch or
+ * memory access should depend on it) or public (default, only needs to be
+ * marked explicitly when it was derived from secret data).
+ *
+ * The SAVE/RESTORE forms mark a variable as public, and subsequently restore its
+ * previous secret/not-secret state. This is used where library code is generating
+ * false positives and needs to temporarily disable Memsan checks for a particular
+ * variable, and then restore it's original state afterwards so it doesn't interfere
+ * with other checks.
+ *
+ * Arguments:
+ * - ptr: a pointer to the memory area to be marked
+ * - size: the size in bytes of the memory area
+ *
+ * - variable: a variable name
+ *
+ * Implementation:
+ * The basic idea is that of ctgrind <https://github.com/agl/ctgrind>: we can
+ * re-use tools that were designed for checking use of uninitialized memory.
+ * This file contains two implementations: one based on MemorySanitizer, the
+ * other on valgrind's memcheck. If none of them is enabled, dummy macros that
+ * do nothing are defined for convenience.
+ *
+ * \note #TEST_CF_SECRET must be called directly from within a .function file,
+ * not indirectly via a macro defined under tests/include or a function
+ * under tests/src. This is because we only run Valgrind for constant
+ * flow on test suites that have greppable annotations inside them (see
+ * `skip_suites_without_constant_flow` in `tests/scripts/all.sh`).
+ */
+
+#if defined(MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN)
+#include <sanitizer/msan_interface.h>
+
+/* Use macros to avoid messing up with origin tracking */
+#define TEST_CF_SECRET __msan_allocated_memory
+// void __msan_allocated_memory(const volatile void* data, size_t size);
+#define TEST_CF_PUBLIC __msan_unpoison
+// void __msan_unpoison(const volatile void *a, size_t size);
+
+#define TEST_CF_SAVE_SECRET(_x) \
+ int _test_cf_is_public_ ## _x = __msan_test_shadow(&(_x), sizeof(_x)) == -1; \
+ TEST_CF_PUBLIC(&(_x), sizeof(_x));
+#define TEST_CF_RESTORE_SECRET(_x) \
+ if (!_test_cf_is_public_ ## _x) TEST_CF_SECRET(&(_x), sizeof(_x));
+
+#elif defined(MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND)
+#include <valgrind/memcheck.h>
+
+#define TEST_CF_SECRET VALGRIND_MAKE_MEM_UNDEFINED
+// VALGRIND_MAKE_MEM_UNDEFINED(_qzz_addr, _qzz_len)
+#define TEST_CF_PUBLIC VALGRIND_MAKE_MEM_DEFINED
+// VALGRIND_MAKE_MEM_DEFINED(_qzz_addr, _qzz_len)
+
+#define TEST_CF_SAVE_SECRET(_x)
+#define TEST_CF_RESTORE_SECRET(_x)
+
+#else /* MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN ||
+ MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND */
+
+#define TEST_CF_SECRET(ptr, size)
+#define TEST_CF_PUBLIC(ptr, size)
+
+#define TEST_CF_SAVE_SECRET(_x)
+#define TEST_CF_RESTORE_SECRET(_x)
+
+#endif /* MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN ||
+ MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND */
+
+#endif /* TEST_CONSTANT_FLOW_H */
diff --git a/tests/src/helpers.c b/tests/src/helpers.c
index 1062560..30fd362 100644
--- a/tests/src/helpers.c
+++ b/tests/src/helpers.c
@@ -15,7 +15,7 @@
* limitations under the License.
*/
-#include "constant_flow.h"
+#include <test/constant_flow.h>
#include <test/helpers.h>
#include <test/macros.h>
#include <string.h>
diff --git a/tests/suites/test_suite_base64.function b/tests/suites/test_suite_base64.function
index acdfbea..e351ad8 100644
--- a/tests/suites/test_suite_base64.function
+++ b/tests/suites/test_suite_base64.function
@@ -2,7 +2,7 @@
#include "mbedtls/base64.h"
#include "base64_internal.h"
#include "constant_time_internal.h"
-#include "constant_flow.h"
+#include <test/constant_flow.h>
#if defined(MBEDTLS_TEST_HOOKS)
static const char base64_digits[] =
diff --git a/tests/suites/test_suite_bignum.function b/tests/suites/test_suite_bignum.function
index edb3695..caa7e04 100644
--- a/tests/suites/test_suite_bignum.function
+++ b/tests/suites/test_suite_bignum.function
@@ -3,7 +3,7 @@
#include "mbedtls/entropy.h"
#include "constant_time_internal.h"
#include "bignum_core.h"
-#include "constant_flow.h"
+#include "test/constant_flow.h"
#if MBEDTLS_MPI_MAX_BITS > 792
#define MPI_MAX_BITS_LARGER_THAN_792
diff --git a/tests/suites/test_suite_bignum_core.function b/tests/suites/test_suite_bignum_core.function
index 3288920..7ac03d0 100644
--- a/tests/suites/test_suite_bignum_core.function
+++ b/tests/suites/test_suite_bignum_core.function
@@ -3,7 +3,7 @@
#include "mbedtls/entropy.h"
#include "bignum_core.h"
#include "constant_time_internal.h"
-#include "constant_flow.h"
+#include "test/constant_flow.h"
/** Verifies mbedtls_mpi_core_add().
*
diff --git a/tests/suites/test_suite_bignum_mod.function b/tests/suites/test_suite_bignum_mod.function
index f166079..4edc0b9 100644
--- a/tests/suites/test_suite_bignum_mod.function
+++ b/tests/suites/test_suite_bignum_mod.function
@@ -4,7 +4,7 @@
#include "bignum_mod.h"
#include "bignum_mod_raw.h"
#include "constant_time_internal.h"
-#include "constant_flow.h"
+#include "test/constant_flow.h"
#define TEST_COMPARE_MPI_RESIDUES(a, b) \
ASSERT_COMPARE((a).p, (a).limbs * sizeof(mbedtls_mpi_uint), \
diff --git a/tests/suites/test_suite_bignum_mod_raw.function b/tests/suites/test_suite_bignum_mod_raw.function
index db4c20f..b67ac51 100644
--- a/tests/suites/test_suite_bignum_mod_raw.function
+++ b/tests/suites/test_suite_bignum_mod_raw.function
@@ -4,7 +4,7 @@
#include "bignum_core.h"
#include "bignum_mod_raw.h"
#include "constant_time_internal.h"
-#include "constant_flow.h"
+#include "test/constant_flow.h"
#include "bignum_mod_raw_invasive.h"
diff --git a/tests/suites/test_suite_constant_time.function b/tests/suites/test_suite_constant_time.function
index 330dc6f..bdd27f5 100644
--- a/tests/suites/test_suite_constant_time.function
+++ b/tests/suites/test_suite_constant_time.function
@@ -18,7 +18,7 @@
#include <mbedtls/constant_time.h>
#include <constant_time_internal.h>
-#include "constant_flow.h"
+#include <test/constant_flow.h>
/* END_HEADER */
/* BEGIN_CASE */
diff --git a/tests/suites/test_suite_constant_time_hmac.function b/tests/suites/test_suite_constant_time_hmac.function
index b7cfb66..902acfa 100644
--- a/tests/suites/test_suite_constant_time_hmac.function
+++ b/tests/suites/test_suite_constant_time_hmac.function
@@ -5,7 +5,7 @@
#include <constant_time_internal.h>
#include "md_psa.h"
-#include "constant_flow.h"
+#include <test/constant_flow.h>
/* END_HEADER */
/* BEGIN_CASE depends_on:MBEDTLS_SSL_SOME_SUITES_USE_MAC:MBEDTLS_SSL_SOME_SUITES_USE_TLS_CBC:MBEDTLS_TEST_HOOKS */
diff --git a/tests/suites/test_suite_ssl.function b/tests/suites/test_suite_ssl.function
index eadf715..a8c714f 100644
--- a/tests/suites/test_suite_ssl.function
+++ b/tests/suites/test_suite_ssl.function
@@ -8,7 +8,7 @@
#include <test/ssl_helpers.h>
#include <constant_time_internal.h>
-#include "constant_flow.h"
+#include <test/constant_flow.h>
#define SSL_MESSAGE_QUEUE_INIT { NULL, 0, 0, 0 }