Fix up path generation to use OPENSSL_MODULES
[openssl.git] / test / secmemtest.c
index 523dffa5eea91fd76e1c6570457c4f214f922541..588f31ae676ac6e872b04c54021331afe30c8299 100644 (file)
+/*
+ * Copyright 2015-2022 The OpenSSL Project Authors. All Rights Reserved.
+ *
+ * Licensed under the Apache License 2.0 (the "License").  You may not use
+ * this file except in compliance with the License.  You can obtain a copy
+ * in the file LICENSE in the source distribution or at
+ * https://www.openssl.org/source/license.html
+ */
 
 #include <openssl/crypto.h>
 
-#define perror_line()    perror_line1(__LINE__)
-#define perror_line1(l)  perror_line2(l)
-#define perror_line2(l)  perror("failed " #l)
+#include "testutil.h"
+#include "internal/e_os.h"
 
-int main(int argc, char **argv)
+static int test_sec_mem(void)
 {
-#if defined(OPENSSL_SYS_LINUX) || defined(OPENSSL_SYS_UNIX)
+#ifndef OPENSSL_NO_SECURE_MEMORY
+    int testresult = 0;
     char *p = NULL, *q = NULL, *r = NULL, *s = NULL;
 
+    TEST_info("Secure memory is implemented.");
+
+    s = OPENSSL_secure_malloc(20);
+    /* s = non-secure 20 */
+    if (!TEST_ptr(s)
+        || !TEST_false(CRYPTO_secure_allocated(s)))
+        goto end;
     r = OPENSSL_secure_malloc(20);
-    /* r = non-secure 20 */
-    if (r == NULL) {
-        perror_line();
-        return 1;
-    }
-    if (!CRYPTO_secure_malloc_init(4096, 32)) {
-        perror_line();
-        return 1;
-    }
-    if (CRYPTO_secure_allocated(r)) {
-        perror_line();
-        return 1;
-    }
+    /* r = non-secure 20, s = non-secure 20 */
+    if (!TEST_ptr(r)
+        || !TEST_true(CRYPTO_secure_malloc_init(4096, 32))
+        || !TEST_false(CRYPTO_secure_allocated(r)))
+        goto end;
     p = OPENSSL_secure_malloc(20);
-    /* r = non-secure 20, p = secure 20 */
-    if (!CRYPTO_secure_allocated(p)) {
-        perror_line();
-        return 1;
-    }
-    /* 20 secure -> 32-byte minimum allocaton unit */
-    if (CRYPTO_secure_used() != 32) {
-        perror_line();
-        return 1;
-    }
+    if (!TEST_ptr(p)
+        /* r = non-secure 20, p = secure 20, s = non-secure 20 */
+        || !TEST_true(CRYPTO_secure_allocated(p))
+        /* 20 secure -> 32-byte minimum allocation unit */
+        || !TEST_size_t_eq(CRYPTO_secure_used(), 32))
+        goto end;
     q = OPENSSL_malloc(20);
-    /* r = non-secure 20, p = secure 20, q = non-secure 20 */
-    if (CRYPTO_secure_allocated(q)) {
-        perror_line();
-        return 1;
-    }
+    if (!TEST_ptr(q))
+        goto end;
+    /* r = non-secure 20, p = secure 20, q = non-secure 20, s = non-secure 20 */
+    if (!TEST_false(CRYPTO_secure_allocated(q)))
+        goto end;
+    OPENSSL_secure_clear_free(s, 20);
     s = OPENSSL_secure_malloc(20);
-    /* r = non-secure 20, p = secure 20, q = non-secure 20, s = secure 20 */
-    if (!CRYPTO_secure_allocated(s)) {
-        perror_line();
-        return 1;
-    }
-    /* 2 * 20 secure -> 64 bytes allocated */
-    if (CRYPTO_secure_used() != 64) {
-        perror_line();
-        return 1;
-    }
-    OPENSSL_secure_free(p);
+    if (!TEST_ptr(s)
+        /* r = non-secure 20, p = secure 20, q = non-secure 20, s = secure 20 */
+        || !TEST_true(CRYPTO_secure_allocated(s))
+        /* 2 * 20 secure -> 64 bytes allocated */
+        || !TEST_size_t_eq(CRYPTO_secure_used(), 64))
+        goto end;
+    OPENSSL_secure_clear_free(p, 20);
+    p = NULL;
     /* 20 secure -> 32 bytes allocated */
-    if (CRYPTO_secure_used() != 32) {
-        perror_line();
-        return 1;
-    }
+    if (!TEST_size_t_eq(CRYPTO_secure_used(), 32))
+        goto end;
     OPENSSL_free(q);
+    q = NULL;
     /* should not complete, as secure memory is still allocated */
-    if (CRYPTO_secure_malloc_done()) {
-        perror_line();
-        return 1;
-    }
-    if (!CRYPTO_secure_malloc_initialized()) {
-        perror_line();
-        return 1;
-    }
+    if (!TEST_false(CRYPTO_secure_malloc_done())
+        || !TEST_true(CRYPTO_secure_malloc_initialized()))
+        goto end;
     OPENSSL_secure_free(s);
+    s = NULL;
     /* secure memory should now be 0, so done should complete */
-    if (CRYPTO_secure_used() != 0) {
-        perror_line();
-        return 1;
-    }
-    if (!CRYPTO_secure_malloc_done()) {
-        perror_line();
-        return 1;
+    if (!TEST_size_t_eq(CRYPTO_secure_used(), 0)
+        || !TEST_true(CRYPTO_secure_malloc_done())
+        || !TEST_false(CRYPTO_secure_malloc_initialized()))
+        goto end;
+
+    TEST_info("Possible infinite loop: allocate more than available");
+    if (!TEST_true(CRYPTO_secure_malloc_init(32768, 16)))
+        goto end;
+    TEST_ptr_null(OPENSSL_secure_malloc((size_t)-1));
+    TEST_true(CRYPTO_secure_malloc_done());
+
+    /*
+     * If init fails, then initialized should be false, if not, this
+     * could cause an infinite loop secure_malloc, but we don't test it
+     */
+    if (TEST_false(CRYPTO_secure_malloc_init(16, 16)) &&
+        !TEST_false(CRYPTO_secure_malloc_initialized())) {
+        TEST_true(CRYPTO_secure_malloc_done());
+        goto end;
     }
-    if (CRYPTO_secure_malloc_initialized()) {
-        perror_line();
-        return 1;
+
+    /*-
+     * There was also a possible infinite loop when the number of
+     * elements was 1<<31, as |int i| was set to that, which is a
+     * negative number. However, it requires minimum input values:
+     *
+     * CRYPTO_secure_malloc_init((size_t)1<<34, 1<<4);
+     *
+     * Which really only works on 64-bit systems, since it took 16 GB
+     * secure memory arena to trigger the problem. It naturally takes
+     * corresponding amount of available virtual and physical memory
+     * for test to be feasible/representative. Since we can't assume
+     * that every system is equipped with that much memory, the test
+     * remains disabled. If the reader of this comment really wants
+     * to make sure that infinite loop is fixed, they can enable the
+     * code below.
+     */
+# if 0
+    /*-
+     * On Linux and BSD this test has a chance to complete in minimal
+     * time and with minimum side effects, because mlock is likely to
+     * fail because of RLIMIT_MEMLOCK, which is customarily [much]
+     * smaller than 16GB. In other words Linux and BSD users can be
+     * limited by virtual space alone...
+     */
+    if (sizeof(size_t) > 4) {
+        TEST_info("Possible infinite loop: 1<<31 limit");
+        if (TEST_true(CRYPTO_secure_malloc_init((size_t)1<<34, 1<<4) != 0))
+            TEST_true(CRYPTO_secure_malloc_done());
     }
+# endif
+
     /* this can complete - it was not really secure */
+    testresult = 1;
+ end:
+    OPENSSL_secure_free(p);
+    OPENSSL_free(q);
     OPENSSL_secure_free(r);
+    OPENSSL_secure_free(s);
+    return testresult;
 #else
+    TEST_info("Secure memory is *not* implemented.");
     /* Should fail. */
-    if (CRYPTO_secure_malloc_init(4096, 32)) {
-        perror_line();
-        return 1;
-    }
+    return TEST_false(CRYPTO_secure_malloc_init(4096, 32));
 #endif
-    return 0;
+}
+
+static int test_sec_mem_clear(void)
+{
+#ifndef OPENSSL_NO_SECURE_MEMORY
+    const int size = 64;
+    unsigned char *p = NULL;
+    int i, res = 0;
+
+    if (!TEST_true(CRYPTO_secure_malloc_init(4096, 32))
+            || !TEST_ptr(p = OPENSSL_secure_malloc(size)))
+        goto err;
+
+    for (i = 0; i < size; i++)
+        if (!TEST_uchar_eq(p[i], 0))
+            goto err;
+
+    for (i = 0; i < size; i++)
+        p[i] = (unsigned char)(i + ' ' + 1);
+
+    OPENSSL_secure_free(p);
+
+    /*
+     * A deliberate use after free here to verify that the memory has been
+     * cleared properly.  Since secure free doesn't return the memory to
+     * libc's memory pool, it technically isn't freed.  However, the header
+     * bytes have to be skipped and these consist of two pointers in the
+     * current implementation.
+     */
+    for (i = sizeof(void *) * 2; i < size; i++)
+        if (!TEST_uchar_eq(p[i], 0))
+            return 0;
+
+    res = 1;
+    p = NULL;
+err:
+    OPENSSL_secure_free(p);
+    CRYPTO_secure_malloc_done();
+    return res;
+#else
+    return 1;
+#endif
+}
+
+int setup_tests(void)
+{
+    ADD_TEST(test_sec_mem);
+    ADD_TEST(test_sec_mem_clear);
+    return 1;
 }