Import libecc v0.9.7vendor/libecc/0.9.7vendor/libecc

libecc will be used privately for upcoming ECC support in pkg(7).  Other
crypto consumers should continue using openssl.

8 files changed, 403 insertions, 0 deletions

diff --git a/include/libecc/utils/dbg_sig.h b/include/libecc/utils/dbg_sig.h
new file mode 100644
index 000000000000..313ba8fa8829
--- /dev/null
+++ b/include/libecc/utils/dbg_sig.h
@@ -0,0 +1,61 @@
+/*
+ *  Copyright (C) 2017 - This file is part of libecc project
+ *
+ *  Authors:
+ *      Ryad BENADJILA <ryadbenadjila@gmail.com>
+ *      Arnaud EBALARD <arnaud.ebalard@ssi.gouv.fr>
+ *      Jean-Pierre FLORI <jean-pierre.flori@ssi.gouv.fr>
+ *
+ *  Contributors:
+ *      Nicolas VIVET <nicolas.vivet@ssi.gouv.fr>
+ *      Karim KHALFALLAH <karim.khalfallah@ssi.gouv.fr>
+ *
+ *  This software is licensed under a dual BSD and GPL v2 license.
+ *  See LICENSE file at the root folder of the project.
+ */
+#ifndef __DBG_SIG_H__
+#define __DBG_SIG_H__
+#include <libecc/utils/print_curves.h>
+#include <libecc/utils/print_keys.h>
+#include <libecc/utils/print_buf.h>
+
+/* Macro to allow inner values of tests vectors print */
+#ifdef VERBOSE_INNER_VALUES
+#ifndef EC_SIG_ALG
+#define EC_SIG_ALG "UNKNOWN_ALG"
+#endif
+
+#define dbg_buf_print(msg, ...) do {\
+	buf_print(EC_SIG_ALG " " msg,  __VA_ARGS__);\
+} while(0)
+#define dbg_nn_print(msg, ...) do {\
+	nn_print(EC_SIG_ALG " " msg, __VA_ARGS__);\
+} while(0)
+#define dbg_ec_point_print(msg, ...) do {\
+	ec_point_print(EC_SIG_ALG " " msg, __VA_ARGS__);\
+} while(0)
+#define dbg_ec_montgomery_point_print(msg, ...) do {\
+	ec_montgomery_point_print(EC_SIG_ALG " " msg, __VA_ARGS__);\
+} while(0)
+#define dbg_ec_edwards_point_print(msg, ...) do {\
+	ec_edwards_point_print(EC_SIG_ALG " " msg, __VA_ARGS__);\
+} while(0)
+#define dbg_priv_key_print(msg, ...) do {\
+	priv_key_print(EC_SIG_ALG " " msg, __VA_ARGS__);\
+} while(0)
+#define dbg_pub_key_print(msg, ...) do {\
+	pub_key_print(EC_SIG_ALG " " msg, __VA_ARGS__);\
+} while(0)
+
+#else /* VERBOSE_INNER_VALUES not defined */
+
+#define dbg_buf_print(msg, ...)
+#define dbg_nn_print(msg, ...)
+#define dbg_ec_point_print(msg, ...)
+#define dbg_ec_montgomery_point_print(msg, ...)
+#define dbg_ec_edwards_point_print(msg, ...)
+#define dbg_priv_key_print(msg, ...)
+#define dbg_pub_key_print(msg, ...)
+
+#endif
+#endif /* __DBG_SIG_H__ */
diff --git a/include/libecc/utils/print_buf.h b/include/libecc/utils/print_buf.h
new file mode 100644
index 000000000000..1516be177310
--- /dev/null
+++ b/include/libecc/utils/print_buf.h
@@ -0,0 +1,18 @@
+/*
+ *  Copyright (C) 2021 - This file is part of libecc project
+ *
+ *  Authors:
+ *      Ryad BENADJILA <ryadbenadjila@gmail.com>
+ *      Arnaud EBALARD <arnaud.ebalard@ssi.gouv.fr>
+ *
+ *  This software is licensed under a dual BSD and GPL v2 license.
+ *  See LICENSE file at the root folder of the project.
+ */
+#ifndef __PRINT_BUF_H__
+#define __PRINT_BUF_H__
+
+#include <libecc/words/words.h>
+
+void buf_print(const char *msg, const u8 *buf, u16 buflen);
+
+#endif /* __PRINT_BUF_H__ */
diff --git a/include/libecc/utils/print_curves.h b/include/libecc/utils/print_curves.h
new file mode 100644
index 000000000000..d6097bd899ae
--- /dev/null
+++ b/include/libecc/utils/print_curves.h
@@ -0,0 +1,28 @@
+/*
+ *  Copyright (C) 2017 - This file is part of libecc project
+ *
+ *  Authors:
+ *      Ryad BENADJILA <ryadbenadjila@gmail.com>
+ *      Arnaud EBALARD <arnaud.ebalard@ssi.gouv.fr>
+ *      Jean-Pierre FLORI <jean-pierre.flori@ssi.gouv.fr>
+ *
+ *  Contributors:
+ *      Nicolas VIVET <nicolas.vivet@ssi.gouv.fr>
+ *      Karim KHALFALLAH <karim.khalfallah@ssi.gouv.fr>
+ *
+ *  This software is licensed under a dual BSD and GPL v2 license.
+ *  See LICENSE file at the root folder of the project.
+ */
+#ifndef __PRINT_CURVES_H__
+#define __PRINT_CURVES_H__
+
+#include <libecc/curves/curves.h>
+#include <libecc/utils/print_fp.h>
+
+void ec_point_print(const char *msg, prj_pt_src_t prj_pt);
+
+void ec_montgomery_point_print(const char *msg, aff_pt_montgomery_src_t pt);
+
+void ec_edwards_point_print(const char *msg, aff_pt_edwards_src_t pt);
+
+#endif /* __PRINT_CURVES_H__ */
diff --git a/include/libecc/utils/print_fp.h b/include/libecc/utils/print_fp.h
new file mode 100644
index 000000000000..0f7ee6356c56
--- /dev/null
+++ b/include/libecc/utils/print_fp.h
@@ -0,0 +1,28 @@
+/*
+ *  Copyright (C) 2017 - This file is part of libecc project
+ *
+ *  Authors:
+ *      Ryad BENADJILA <ryadbenadjila@gmail.com>
+ *      Arnaud EBALARD <arnaud.ebalard@ssi.gouv.fr>
+ *      Jean-Pierre FLORI <jean-pierre.flori@ssi.gouv.fr>
+ *
+ *  Contributors:
+ *      Nicolas VIVET <nicolas.vivet@ssi.gouv.fr>
+ *      Karim KHALFALLAH <karim.khalfallah@ssi.gouv.fr>
+ *
+ *  This software is licensed under a dual BSD and GPL v2 license.
+ *  See LICENSE file at the root folder of the project.
+ */
+#ifndef __PRINT_FP_H__
+#define __PRINT_FP_H__
+
+#include <libecc/fp/fp.h>
+#include <libecc/utils/print_nn.h>
+
+void fp_ctx_print(const char *msg, fp_ctx_src_t ctx);
+
+void fp_print(const char *msg, fp_src_t a);
+
+void fp_print_all(const char *msg, fp_src_t a);
+
+#endif /* __PRINT_FP_H__ */
diff --git a/include/libecc/utils/print_keys.h b/include/libecc/utils/print_keys.h
new file mode 100644
index 000000000000..dcaf8ab5bbb8
--- /dev/null
+++ b/include/libecc/utils/print_keys.h
@@ -0,0 +1,26 @@
+/*
+ *  Copyright (C) 2017 - This file is part of libecc project
+ *
+ *  Authors:
+ *      Ryad BENADJILA <ryadbenadjila@gmail.com>
+ *      Arnaud EBALARD <arnaud.ebalard@ssi.gouv.fr>
+ *      Jean-Pierre FLORI <jean-pierre.flori@ssi.gouv.fr>
+ *
+ *  Contributors:
+ *      Nicolas VIVET <nicolas.vivet@ssi.gouv.fr>
+ *      Karim KHALFALLAH <karim.khalfallah@ssi.gouv.fr>
+ *
+ *  This software is licensed under a dual BSD and GPL v2 license.
+ *  See LICENSE file at the root folder of the project.
+ */
+#ifndef __PRINT_KEYS_H__
+#define __PRINT_KEYS_H__
+
+#include <libecc/sig/ec_key.h>
+#include <libecc/utils/print_curves.h>
+
+void priv_key_print(const char *msg, const ec_priv_key *priv);
+
+void pub_key_print(const char *msg, const ec_pub_key *pub);
+
+#endif /* __PRINT_KEYS_H__ */
diff --git a/include/libecc/utils/print_nn.h b/include/libecc/utils/print_nn.h
new file mode 100644
index 000000000000..a8c47218297c
--- /dev/null
+++ b/include/libecc/utils/print_nn.h
@@ -0,0 +1,24 @@
+/*
+ *  Copyright (C) 2017 - This file is part of libecc project
+ *
+ *  Authors:
+ *      Ryad BENADJILA <ryadbenadjila@gmail.com>
+ *      Arnaud EBALARD <arnaud.ebalard@ssi.gouv.fr>
+ *      Jean-Pierre FLORI <jean-pierre.flori@ssi.gouv.fr>
+ *
+ *  Contributors:
+ *      Nicolas VIVET <nicolas.vivet@ssi.gouv.fr>
+ *      Karim KHALFALLAH <karim.khalfallah@ssi.gouv.fr>
+ *
+ *  This software is licensed under a dual BSD and GPL v2 license.
+ *  See LICENSE file at the root folder of the project.
+ */
+#ifndef __PRINT_NN_H__
+#define __PRINT_NN_H__
+
+#include <libecc/nn/nn.h>
+#include <libecc/external_deps/print.h>
+
+void nn_print(const char *msg, nn_src_t a);
+
+#endif /* __PRINT_NN_H__ */
diff --git a/include/libecc/utils/utils.h b/include/libecc/utils/utils.h
new file mode 100644
index 000000000000..028822853b3d
--- /dev/null
+++ b/include/libecc/utils/utils.h
@@ -0,0 +1,196 @@
+/*
+ *  Copyright (C) 2017 - This file is part of libecc project
+ *
+ *  Authors:
+ *      Ryad BENADJILA <ryadbenadjila@gmail.com>
+ *      Arnaud EBALARD <arnaud.ebalard@ssi.gouv.fr>
+ *      Jean-Pierre FLORI <jean-pierre.flori@ssi.gouv.fr>
+ *
+ *  Contributors:
+ *      Nicolas VIVET <nicolas.vivet@ssi.gouv.fr>
+ *      Karim KHALFALLAH <karim.khalfallah@ssi.gouv.fr>
+ *
+ *  This software is licensed under a dual BSD and GPL v2 license.
+ *  See LICENSE file at the root folder of the project.
+ */
+#ifndef __UTILS_H__
+#define __UTILS_H__
+
+#include <libecc/words/words.h>
+
+/*
+ * At various locations in the code, we expect expect some specific
+ * conditions to be true for correct operation of the code after
+ * those locations. This is commonly the case on input parameters
+ * at the beginning of functions. Other conditions may be expected
+ * but are not necessarily impacting for correct operation of the
+ * code.
+ *
+ * We use the three following macros for that purpose:
+ *
+ * MUST_HAVE(): The condition is always tested, i.e. both in debug
+ * and non debug build. This macros is used when it's better not to
+ * continue if the condition does not hold. In production code,
+ * if the condition does not hold, a while (1) loop is currently
+ * executed (but this may be changed for some specific code the
+ * system provide (e.g. abort())). In debug mode, an assert() is
+ * used when the condition is false.
+ *
+ * SHOULD_HAVE(): the condition is only executed in debug mode and
+ * the whole macros is a nop in production code. This can be used
+ * to add more checks in the code to detect specific conditions
+ * or changes. Those checks may have performance impact which are
+ * acceptable in debug mode but are not in production mode.
+ *
+ * KNOWN_FACT(): the condition is only executed in debug mode and
+ * the whole macro is a nop in production code. This macro is used
+ * to add conditions that are known to be true which may help analysis
+ * tools to work on the code. The macro can be used in order to make
+ * those conditions explicit.
+ */
+
+/* Some helper for printing where we have an issue */
+#if defined(USE_ASSERT_PRINT)
+#include <libecc/external_deps/print.h>
+#define MUST_HAVE_EXT_PRINT do {					\
+	ext_printf("MUST_HAVE error: %s at %d\n", __FILE__,__LINE__);	\
+} while (0)
+#define SHOULD_HAVE_EXT_PRINT do {					\
+	ext_printf("SHOULD_HAVE error: %s at %d\n", __FILE__,__LINE__);	\
+} while (0)
+#define KNOWN_FACT_EXT_PRINT do {					\
+	ext_printf("KNOWN_FACT error: %s at %d\n", __FILE__,__LINE__);	\
+} while (0)
+#else
+#define MUST_HAVE_EXT_PRINT
+#define SHOULD_HAVE_EXT_PRINT
+#define KNOWN_FACT_EXT_PRINT
+#endif
+
+/*
+ * We known it is BAD BAD BAD to define macro with goto inside them
+ * but this is the best way we found to avoid making the code
+ * unreadable with tests of error conditions when implementing
+ * error handling in the project.
+ *
+ * EG stands for Error Goto, which represents the purpose of the
+ * macro, i.e. test a condition cond, and if false goto label
+ * lbl.
+ */
+#define EG(cond,lbl) do { if (cond) { goto lbl ; } } while (0)
+
+/****** Regular DEBUG and production modes cases  ****************/
+
+/****** DEBUG mode ***********************************************/
+#if defined(DEBUG)
+#include <assert.h>
+/*
+ * In DEBUG mode, we enforce a regular assert() in MUST_HAVE,
+ * SHOULD_HAVE and KNOWN_FACT, i.e. they are all the same.
+ */
+
+#define MUST_HAVE(cond, ret, lbl) do {	\
+	if(!(cond)){			\
+		MUST_HAVE_EXT_PRINT;	\
+	}				\
+	assert((cond));			\
+	if (0) { /* silence unused	\
+		    label warning  */	\
+		ret = -1;		\
+		goto lbl;		\
+	}				\
+}  while (0)
+
+#define SHOULD_HAVE(cond, ret, lbl) do {\
+	if(!(cond)){			\
+		SHOULD_HAVE_EXT_PRINT;	\
+	}				\
+	assert((cond));			\
+	if (0) { /* silence unused	\
+		    label warning  */	\
+		ret = -1;		\
+		goto lbl;		\
+	}				\
+}  while (0)
+
+#define KNOWN_FACT(cond, ret, lbl) do {	\
+	if(!(cond)){			\
+		KNOWN_FACT_EXT_PRINT;	\
+	}				\
+	assert((cond));			\
+	if (0) { /* silence unused	\
+		    label warning  */	\
+		ret = -1;		\
+		goto lbl;		\
+	}				\
+}  while (0)
+
+/****** Production mode ******************************************/
+#else /* !defined(DEBUG) */
+
+/*
+ * In regular production mode, SHOULD_HAVE and KNOWN_FACT are void for
+ * performance reasons. MUST_HAVE includes an ext_printf call for
+ * tracing the origin of the error when necessary (if USE_ASSERT_PRINT
+ * is specified by the user).
+ */
+#define MUST_HAVE(cond, ret, lbl) do {		\
+	if (!(cond)) {				\
+		MUST_HAVE_EXT_PRINT;		\
+		ret = -1;			\
+		goto lbl;			\
+	}					\
+}  while (0)
+
+#define SHOULD_HAVE(cond, ret, lbl) do { \
+	if (0) { /* silence unused	 \
+		    label warning  */	 \
+		ret = -1;		 \
+		goto lbl;		 \
+	}				 \
+}  while (0)
+
+#define KNOWN_FACT(cond, ret, lbl)  do { \
+	if (0) { /* silence unused	 \
+		    label warning  */	 \
+		ret = -1;		 \
+		goto lbl;		 \
+	}				 \
+}  while (0)
+
+/******************************************************************/
+#endif  /* defined(DEBUG) */
+
+#define LOCAL_MAX(x, y) (((x) > (y)) ? (x) : (y))
+#define LOCAL_MIN(x, y) (((x) < (y)) ? (x) : (y))
+
+#define BYTECEIL(numbits) (((numbits) + 7) / 8)
+
+ATTRIBUTE_WARN_UNUSED_RET int are_equal(const void *a, const void *b, u32 len, int *check);
+ATTRIBUTE_WARN_UNUSED_RET int local_memcpy(void *dst, const void *src, u32 n);
+ATTRIBUTE_WARN_UNUSED_RET int local_memset(void *v, u8 c, u32 n);
+ATTRIBUTE_WARN_UNUSED_RET int are_str_equal(const char *s1, const char *s2, int *check);
+ATTRIBUTE_WARN_UNUSED_RET int are_str_equal_nlen(const char *s1, const char *s2, u32 maxlen, int *check);
+ATTRIBUTE_WARN_UNUSED_RET int local_strlen(const char *s, u32 *len);
+ATTRIBUTE_WARN_UNUSED_RET int local_strnlen(const char *s, u32 maxlen, u32 *len);
+ATTRIBUTE_WARN_UNUSED_RET int local_strncpy(char *dst, const char *src, u32 n);
+ATTRIBUTE_WARN_UNUSED_RET int local_strncat(char *dest, const char *src, u32 n);
+
+/* Return 1 if architecture is big endian, 0 otherwise. */
+static inline int arch_is_big_endian(void)
+{
+	const u16 val = 0x0102;
+	const u8 *buf = (const u8 *)(&val);
+
+	return buf[0] == 0x01;
+}
+
+#define VAR_ZEROIFY(x) do { \
+		x = 0;      \
+	} while (0)
+
+#define PTR_NULLIFY(x) do { \
+		x = NULL;   \
+	} while (0)
+
+#endif /* __UTILS_H__ */
diff --git a/include/libecc/utils/utils_rand.h b/include/libecc/utils/utils_rand.h
new file mode 100644
index 000000000000..65acdcce9066
--- /dev/null
+++ b/include/libecc/utils/utils_rand.h
@@ -0,0 +1,22 @@
+/*
+ *  Copyright (C) 2023 - This file is part of libecc project
+ *
+ *  Authors:
+ *      Ryad BENADJILA <ryadbenadjila@gmail.com>
+ *      Arnaud EBALARD <arnaud.ebalard@ssi.gouv.fr>
+ *
+ *  This software is licensed under a dual BSD and GPL v2 license.
+ *  See LICENSE file at the root folder of the project.
+ */
+#ifndef __UTILS_RAND_H__
+#define __UTILS_RAND_H__
+
+#include <libecc/words/words.h>
+#include <libecc/external_deps/rand.h>
+
+/* WARNING: use with care, this is useful when "fast" but somehow unsafe
+ * random must be provided.
+ */
+ATTRIBUTE_WARN_UNUSED_RET int get_unsafe_random(unsigned char *buf, u16 len);
+
+#endif /* __UTILS_RAND_H__ */