[test] Add generic tests for elliptic curve point multiplication

Signed-off-by: Michael Brown <mcb30@ipxe.org>

diff --git a/src/tests/elliptic_test.c b/src/tests/elliptic_test.c
new file mode 100644 (file)
index 0000000..4c42e58
--- /dev/null
+++ b/src/tests/elliptic_test.c
@@ -0,0 +1,76 @@
+/*
+ * Copyright (C) 2025 Michael Brown <mbrown@fensystems.co.uk>.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License as
+ * published by the Free Software Foundation; either version 2 of the
+ * License, or any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+ * 02110-1301, USA.
+ *
+ * You can also choose to distribute this program under the terms of
+ * the Unmodified Binary Distribution Licence (as given in the file
+ * COPYING.UBDL), provided that you have satisfied its requirements.
+ */
+
+FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+
+/** @file
+ *
+ * Elliptic curve self-tests
+ *
+ */
+
+/* Forcibly enable assertions */
+#undef NDEBUG
+
+#include <stdint.h>
+#include <string.h>
+#include <assert.h>
+#include <ipxe/crypto.h>
+#include <ipxe/test.h>
+#include "elliptic_test.h"
+
+/**
+ * Report elliptic curve point multiplication test result
+ *
+ * @v test             Elliptic curve point multiplication test
+ * @v file             Test code file
+ * @v line             Test code line
+ */
+void elliptic_okx ( struct elliptic_test *test, const char *file,
+                   unsigned int line ) {
+       struct elliptic_curve *curve = test->curve;
+       size_t pointsize = curve->pointsize;
+       size_t keysize = curve->keysize;
+       uint8_t actual[pointsize];
+       int rc;
+
+       /* Sanity checks */
+       okx ( ( test->base_len == pointsize ) || ( ! test->base_len ),
+             file, line );
+       okx ( test->scalar_len == keysize, file, line );
+       okx ( ( test->expected_len == pointsize ) || ( ! test->expected_len ),
+             file, line );
+
+       /* Perform point multiplication */
+       rc = elliptic_multiply ( curve, ( test->base_len ? test->base : NULL ),
+                                test->scalar, actual );
+       if ( test->expected_len ) {
+               okx ( rc == 0, file, line );
+       } else {
+               okx ( rc != 0, file, line );
+       }
+
+       /* Check expected result */
+       okx ( memcmp ( actual, test->expected, test->expected_len ) == 0,
+             file, line );
+}

diff --git a/src/tests/elliptic_test.h b/src/tests/elliptic_test.h
new file mode 100644 (file)
index 0000000..94fca60
--- /dev/null
+++ b/src/tests/elliptic_test.h
@@ -0,0 +1,77 @@
+#ifndef _ELLIPTIC_TEST_H
+#define _ELLIPTIC_TEST_H
+
+FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+
+#include <stdint.h>
+#include <ipxe/crypto.h>
+#include <ipxe/test.h>
+
+/** An elliptic curve point multiplication test */
+struct elliptic_test {
+       /** Elliptic curve */
+       struct elliptic_curve *curve;
+       /** Base point */
+       const void *base;
+       /** Length of base point (or 0 to use generator) */
+       size_t base_len;
+       /** Scalar multiple */
+       const void *scalar;
+       /** Length of scalar multiple */
+       size_t scalar_len;
+       /** Expected result point */
+       const void *expected;
+       /** Length of expected result point (or 0 to expect failure) */
+       size_t expected_len;
+};
+
+/** Define inline base point */
+#define BASE(...) { __VA_ARGS__ }
+
+/** Define base point to be curve's generator */
+#define BASE_GENERATOR BASE()
+
+/** Define inline scalar multiple */
+#define SCALAR(...) { __VA_ARGS__ }
+
+/** Define inline expected result point */
+#define EXPECTED(...) { __VA_ARGS__ }
+
+/** Define result as an expected failure */
+#define EXPECTED_FAIL EXPECTED()
+
+/**
+ * Define an elliptic curve point multiplication test
+ *
+ * @v name             Test name
+ * @v CURVE            Elliptic curve
+ * @v BASE             Base point
+ * @v SCALAR           Scalar multiple
+ * @v EXPECTED         Expected result point
+ * @ret test           Elliptic curve point multiplication test
+ */
+#define ELLIPTIC_TEST( name, CURVE, BASE, SCALAR, EXPECTED )           \
+       static const uint8_t name ## _base[] = BASE;                    \
+       static const uint8_t name ## _scalar[] = SCALAR;                \
+       static const uint8_t name ## _expected[] = EXPECTED;            \
+       static struct elliptic_test name = {                            \
+               .curve = CURVE,                                         \
+               .base = name ## _base,                                  \
+               .base_len = sizeof ( name ## _base ),                   \
+               .scalar = name ## _scalar,                              \
+               .scalar_len = sizeof ( name ## _scalar ),               \
+               .expected = name ## _expected,                          \
+               .expected_len = sizeof ( name ## _expected ),           \
+       };
+
+extern void elliptic_okx ( struct elliptic_test *test, const char *file,
+                          unsigned int line );
+
+/**
+ * Report an elliptic curve point multiplication test result
+ *
+ * @v test             Elliptic curve point multiplication test
+ */
+#define elliptic_ok( test ) elliptic_okx ( test, __FILE__, __LINE__ )
+
+#endif /* _ELLIPTIC_TEST_H */